Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ArminJo committed Oct 20, 2023
1 parent f24015a commit bf1341c
Show file tree
Hide file tree
Showing 9 changed files with 290 additions and 283 deletions.
2 changes: 1 addition & 1 deletion JK-BMSToPylontechCAN/EasyButtonAtInt01.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the See the See the GNU General Public License for more details.
* See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/gpl.html>.
Expand Down
2 changes: 1 addition & 1 deletion JK-BMSToPylontechCAN/EasyButtonAtInt01.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the See the See the GNU General Public License for more details.
* See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/gpl.html>.
Expand Down
546 changes: 275 additions & 271 deletions JK-BMSToPylontechCAN/SoftI2CMaster.h

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions JK-BMSToPylontechCAN/SoftwareSerialTX.cpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
SoftwareSerialTX.h (from SoftSerial.h) -
SoftwareSerialTX.h (from SoftSerial.h) -
Multi-instance software serial library for Arduino/Wiring
-- Transmit-only imoplementation
-- reduce footprint in code memory and RAM compared to SoftwareSerial
Expand All @@ -13,8 +13,8 @@ version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Expand All @@ -26,17 +26,17 @@ The latest version of this library can always be found at
*/

#if defined(__AVR_ATmega168__) ||defined(__AVR_ATmega168P__) ||defined(__AVR_ATmega328P__)
//
//
// Includes
//
//
#include <Arduino.h>
#include <util/delay_basic.h>
#include "SoftwareSerialTX.h"

//
// Constructor
//
SoftwareSerialTX::SoftwareSerialTX(uint8_t transmitPin)
SoftwareSerialTX::SoftwareSerialTX(uint8_t transmitPin)
{
setTX(transmitPin);
}
Expand Down Expand Up @@ -77,7 +77,7 @@ size_t SoftwareSerialTX::write(uint8_t b)

SREG = oldSREG; // turn interrupts back on
_delay_loop_2(delay);

return 1;
}

Expand Down Expand Up @@ -123,4 +123,4 @@ size_t SoftwareSerialTX::write(const uint8_t *buffer, size_t size)
}
#else
#error unsupported platform
#endif
#endif
2 changes: 1 addition & 1 deletion JK-BMSToPylontechCAN/SoftwareSerialTX.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ If CAN communications breaks, the inverter may use different values for controll
| ![My installation](https://github.com/ArminJo/JK-BMSToPylontechCAN/blob/main/pictures/CompleteInstallation.jpg) | ![Automatic brightness](https://github.com/ArminJo/JK-BMSToPylontechCAN/blob/main/pictures/AutomaticBrightness.jpg) |
| Breadboard detail | |
| ![Breadboard detail](https://github.com/ArminJo/JK-BMSToPylontechCAN/blob/main/pictures/BreadboardDetail.jpg) | |
| Breadboard without BMS connected | Standalone test |
| ![Breadboard detail](https://github.com/ArminJo/JK-BMSToPylontechCAN/blob/main/pictures/BreadboardSimple.jpg) | ![Standalone test](https://github.com/ArminJo/JK-BMSToPylontechCAN/blob/main/pictures/StandaloneTest.jpg) |
| No-breadboard version overview | No-breadboard version overview |
| ![Overview no breadboard](https://github.com/ArminJo/JK-BMSToPylontechCAN/blob/main/pictures/NoBreadboardOverview1.jpg) | ![Overview no breadboard](https://github.com/ArminJo/JK-BMSToPylontechCAN/blob/main/pictures/NoBreadboardOverview2.jpg) |
| Nano top view | Nano bottom view |
Expand Down Expand Up @@ -142,7 +144,7 @@ On the Deye, connect cable before setting `Battery Mode` to `Lithium`, to avoid


[EasyEda shematics by Ngoc Dang Dinh](https://easyeda.com/editor#id=0d1a2556b7634c8bbd22e9c0474cd401|8c434b5057fc4d769d664a0dc9c7d66c)
![EasyEda shematics by Ngoc Dang Dinh](https://user-images.githubusercontent.com/8839597/271840357-741d3036-e734-4fbe-8635-64cbb7f3fe25.png)
![EasyEda shematics by Ngoc Dang Dinh](https://github.com/ArminJo/JK-BMSToPylontechCAN/blob/main/pictures/EasyEda_shematics_by_Ngoc_Dang_Dinh.png)


### Board pinout diagrams
Expand Down Expand Up @@ -235,6 +237,7 @@ This program uses the following libraries, which are already included in this re

# Revision History
### Version 2.2
- Fixed LCD backlight timeout bug introduced in 1.3.0.
- Long press of page button instead of debug button.
- Do not use sleep any more by default.

Expand Down
Binary file added pictures/BreadboardSimple.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pictures/EasyEda_shematics_by_Ngoc_Dang_Dinh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pictures/StandaloneTest.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bf1341c

Please sign in to comment.