diff --git a/README.md b/README.md index 5834fd3..b0e8f90 100644 --- a/README.md +++ b/README.md @@ -5,34 +5,36 @@ It it's a great starting point to integrate battery with your home automation. ** I ACCEPT NO RESPONSIBILTY FOR ANY DAMAGE CAUSED, PROCEED AT YOUR OWN RISK ** -Features: -- Low cost (around 20$ in total). -- Adds WiFi capability to your Pylontech US2000B battery. -- Device exposes web interface that allows to: +# Features: + * Low cost (around 20$ in total). + * Adds WiFi capability to your Pylontech US2000B battery. + * Device exposes web interface that allows to: * send console commands and read response over WiFi (no PC needed) * battery information can be retrevied also in JSON format for easy parsing -- Easy to modify code using Arduino IDE and flash new firmware over WiFi (no need to disconnect from the battery). + * Easy to modify code using Arduino IDE and flash new firmware over WiFi (no need to disconnect from the battery). See the project in action on [Youtube](https://youtu.be/7VyQjKU3MsU): -[![See the project in action on YouTube](https://img.youtube.com/vi/7VyQjKU3MsU/1.jpg)](https://www.youtube.com/watch?v=7VyQjKU3MsU) +[![See the project in action on YouTube](https://img.youtube.com/vi/7VyQjKU3MsU/0.jpg)](https://www.youtube.com/watch?v=7VyQjKU3MsU) -Parts needed: -- [Wemos D1 mini microcontroller](https://www.amazon.co.uk/Makerfire-NodeMcu-Development-ESP8266-Compatible/dp/B071S8MWTY/). -- [SparkFun MAX3232 Transceiver](https://www.sparkfun.com/products/11189). -- Cable with RJ10 connector (some RJ10 cables have only two wires, make sure to buy one that has all four wires present). -- Capacitors C1: 10uF, C2: 0.1uF (this is not strictly required, but recommended as Wemos D1 can have large current spikes). + +# Parts needed: + * [Wemos D1 mini microcontroller](https://www.amazon.co.uk/Makerfire-NodeMcu-Development-ESP8266-Compatible/dp/B071S8MWTY/). + * [SparkFun MAX3232 Transceiver](https://www.sparkfun.com/products/11189). + * Cable with RJ10 connector (some RJ10 cables have only two wires, make sure to buy one that has all four wires present). + * Capacitors C1: 10uF, C2: 0.1uF (this is not strictly required, but recommended as Wemos D1 can have large current spikes). ![Schematics](Schemetics.png) -How to get going: -- Get Wemos D1 mini -- Install arduino IDE and ESP8266 libraries as [described here](https://averagemaker.com/2018/03/wemos-d1-mini-setup.html) -- Open [PylontechMonitoring.ino](PylontechMonitoring.ino) in arduino IDE -- Specify your WiFi login and password at the top of the file (line 13-14) -- Upload project to your device -- Connect Wemos D1 mini to the MAX3232 transreceiver -- Connect transreceiver to RJ10 as descibed in the schematics (all three lines need to be connected) -- Connect RJ10 to the serial port of the Pylontech US2000 battery. If you have multiple batteries - connect to the master one. -- Connect Wemos D1 to the power via USB -- Find what IP address was assigned to your Wemos by your router and open it in the web-browser -- You should be able now to connunicate with the battery via WiFi + +# How to get going: + * Get Wemos D1 mini + * Install arduino IDE and ESP8266 libraries as [described here](https://averagemaker.com/2018/03/wemos-d1-mini-setup.html) + * Open [PylontechMonitoring.ino](PylontechMonitoring.ino) in arduino IDE + * Specify your WiFi login and password at the top of the file (line 13-14) + * Upload project to your device + * Connect Wemos D1 mini to the MAX3232 transreceiver + * Connect transreceiver to RJ10 as descibed in the schematics (all three lines need to be connected) + * Connect RJ10 to the serial port of the Pylontech US2000 battery. If you have multiple batteries - connect to the master one. + * Connect Wemos D1 to the power via USB + * Find what IP address was assigned to your Wemos by your router and open it in the web-browser + * You should be able now to connunicate with the battery via WiFi