This is a fork of a fork from catalinbordan (https://github.com/catalinbordan/docker-voltronic-homeassistant)
It didn't seem to be active anymore, so I decided to cook my own souce.
I ran into a couple of issues during installation and use of the original fork. I hope my install.sh script mitegates most of my installation issues and helps to set it up quickly. Furthermore, I couldn't get this project to initialize the /dev/ttyS0. My workaround was to execute axpert-query at reboot in a crontab of my VM (Im running the docker under a Proxmox VM with ubuntu server on it). Check it out here: https://github.com/b48736/axpert-monitor/ I'm planning on implementing a fix for this in this fork. Quick setup:
# Install cron
sudo apt update && sudo apt install cron
# Edit crontab:
sudo crontab -e
# Add '@reboot axpert-query -c QPIGS -p /dev/ttyS0'
# Be sure to replace the paramter with your own. In in doupt, check out the project!I am implementig multi inverter support. Thanks saschalenz for getting me started! But for my inverter the command 'QPIGS2' to get data from other MPPTs inside a inverter didn't work to get data from multiple inverters. So I may have reverse engineered WatchPower a bit and working on a solution. I may release a guide on how to do it. If i do, I'll link to it here. So in the meantime, if you need support for a second MPPT check out his fork: https://github.com/saschalenz/docker-voltronic-homeassistant/tree/master I found out that QPGSx (x = inverter number) seems to be the right command, but I am currently fixing the response to long error...
Currently, this fork is work in progress, if something is brocken, please check back later. For now, I just want to get my setup at home working (EFFEKTA AX M2 5000) and do not want to hussle arround with diffrent branches. Feel free to create a pull request! I'll happily look over it if I find some spare time.
I may port it over to ESP32 (in ESP-IDF not Arduino; I just hate the implementation...) and also add support for Pylontech (US5000) batteries... If I'll ever come around to do it, I'll link to it here too.
Many thanks to all people who worked on this project so hard to get it to where it is now!
I've cut out anything from the readme file that I've found not helpful. I encourage you to check out the readme of catalinbordan and the original branch.
This project was derived from the 'skymax' C based monitoring application designed to take the monitoring data from Voltronic, Axpert, Mppsolar PIP, Voltacon, Effekta, and other branded OEM Inverters and send it to a Home Assistant MQTT server for ingestion...
The program can also receive commands from Home Assistant (via MQTT) to change the state of the inverter remotely.
By remotely setting values via MQTT you can implement many more complex forms of automation (triggered from Home Assistant) such as:
-
Changing the power mode to 'solar only' during the day, but then change back to 'grid mode charging' for your AGM or VLRA batteries in the evenings, but if it's raining (based on data from your weather station), set the charge mode to
PCP02(Charge based on 'Solar and Utility') so that the following day there's plenty of juice in your batteries... -
Programatically set the charge & float voltages based on additional sensors (such as a Zigbee Temperature Sensor, or a DHT-22 + ESP8266) - This way if your battery box is too hot/cold you can dynamically adjust the voltage so that the batteries are not damaged...
-
Dynamically adjust the inverter's "solar power balance" and other configuration options to ensure that you get the most "bang for your buck" out of your setup...
The program is designed to be run in a Docker Container, and can be deployed on a lightweight SBC next to your Inverter (i.e. an Orange Pi Zero running Arabian), and read data via the RS232 or USB ports on the back of the Inverter.
Example #1: My "Lovelace" dashboard using data collected from the Inverter & the ability to change modes/configuration via MQTT.
Example #2: Grafana summary allowing more detailed analysis of data collected, and the ability to 'deep-dive' historical data.
If you are using the install.sh, you dont have to install docker, docker-compose or nano prior installation.
- Docker
- Docker-compose
- Voltronic/Axpert/MPPSolar based inverter that you want to monitor
- Home Assistant running with a MQTT Server
If you like you you can use my install.sh:
# Let's download the install.sh manually:
wget https://raw.githubusercontent.com/technickfreak2000/docker-voltronic-homeassistant/master/install.sh
# Maybe you need to run
chmod +x install.sh
# To execute it run
./install.sh
# Or
bash install.shIt's pretty straightforward to install it manually to, just clone down the sources, compile it and set the configuration files in the config/ directory.
If you have an old installation, remove it first:
# Go into your old installation
cd /opt/ha-inverter-mqtt-agent
# Stop docker
sudo docker-compose down
# Delete old files (Maybe save old config for reference! Be sure not to copy only whats needed!)
# Move out of the folder to delete it
cd ..
sudo rm -rf ha-inverter-mqtt-agentNow you can install the project:
# Clone down sources on the host you want to monitor...
git clone --recurse-submodules https://github.com/technickfreak2000/docker-voltronic-homeassistant.git /opt/ha-inverter-mqtt-agent
cd /opt/ha-inverter-mqtt-agent
# Configure the 'device=' directive (in inverter.conf) to suit for RS232. Only edit this file if you don't have usb cable to inverter!
nano config/inverter.conf
# Configure your MQTT server's IP/Host Name, Port, Credentials, HA topic, and name of the Inverter that you want displayed in Home Assistant...
# If your MQTT server does not need a username/password just leave these values empty.
nano config/mqtt.json
# Now build the docker container
sudo docker-compose buildThen, plug in your Serial or USB cable to the Inverter & stand up the container:
docker-compose up -dTest the communication with the inverter.
sudo docker exec -it voltronic-mqtt bash -c '/opt/inverter-cli/bin/inverter_poller -d -1'It should output something like that:
Wed Jun 15 19:14:55 2022 INVERTER: Debug set
Wed Jun 15 19:14:55 2022 DEBUG: Current CRC: 49 C1
Wed Jun 15 19:14:55 2022 DEBUG: Send buffer hex bytes: ( 51 4d 4f 44 49 c1 0d )
Wed Jun 15 19:14:55 2022 DEBUG: 7 bytes written, 7 bytes sent, 0 bytes remaining
Wed Jun 15 19:14:55 2022 DEBUG: 8 bytes read, 8 total bytes: 28 42 e7 c9 0d 00 00 00
Wed Jun 15 19:14:55 2022 DEBUG: Found reply <cr> at byte: 5
Wed Jun 15 19:14:55 2022 DEBUG: QMOD: 8 bytes read: (B
Wed Jun 15 19:14:55 2022 DEBUG: QMOD query finished
Wed Jun 15 19:14:56 2022 DEBUG: Current CRC: B7 A9
Wed Jun 15 19:14:56 2022 DEBUG: Send buffer hex bytes: ( 51 50 49 47 53 b7 a9 0d )
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes written, 8 bytes sent, 0 bytes remaining
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 8 total bytes: 28 32 33 31 2e 37 20 34
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 16 total bytes: 39 2e 39 20 32 33 30 2e
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 24 total bytes: 32 20 35 30 2e 30 20 30
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 32 total bytes: 33 39 31 20 30 31 34 37
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 40 total bytes: 20 30 31 33 20 33 35 38
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 48 total bytes: 20 32 35 2e 39 38 20 30
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 56 total bytes: 30 30 20 31 30 30 20 30
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 64 total bytes: 30 33 36 20 30 30 30 30
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 72 total bytes: 20 30 30 30 2e 30 20 30
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 80 total bytes: 30 2e 30 30 20 30 30 30
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 88 total bytes: 30 36 20 30 30 30 31 30
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 96 total bytes: 30 30 30 20 30 30 20 30
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 104 total bytes: 30 20 30 30 30 30 30 20
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 112 total bytes: 30 31 31 5c c6 0d 00 00
Wed Jun 15 19:14:56 2022 DEBUG: Found reply <cr> at byte: 110
Wed Jun 15 19:14:56 2022 DEBUG: QPIGS: 112 bytes read: (231.7 49.9 230.2 50.0 0391 0147 013 358 25.98 000 100 0036 0000 000.0 00.00 00006 00010000 00 00 00000 011
Wed Jun 15 19:14:56 2022 DEBUG: QPIGS query finished
Wed Jun 15 19:14:56 2022 DEBUG: Current CRC: F8 54
Wed Jun 15 19:14:56 2022 DEBUG: Send buffer hex bytes: ( 51 50 49 52 49 f8 54 0d )
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes written, 8 bytes sent, 0 bytes remaining
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 8 total bytes: 28 32 33 30 2e 30 20 31
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 16 total bytes: 33 2e 30 20 32 33 30 2e
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 24 total bytes: 30 20 35 30 2e 30 20 31
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 32 total bytes: 33 2e 30 20 33 30 30 30
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 40 total bytes: 20 33 30 30 30 20 32 34
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 48 total bytes: 2e 30 20 32 32 2e 30 20
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 56 total bytes: 32 31 2e 30 20 32 38 2e
Wed Jun 15 19:14:56 2022 DEBUG: 8 bytes read, 64 total bytes: 32 20 32 37 2e 34 20 32
Wed Jun 15 19:14:57 2022 DEBUG: 8 bytes read, 72 total bytes: 20 30 32 20 30 37 30 20
Wed Jun 15 19:14:57 2022 DEBUG: 8 bytes read, 80 total bytes: 31 20 32 20 32 20 31 20
Wed Jun 15 19:14:57 2022 DEBUG: 8 bytes read, 88 total bytes: 30 31 20 30 20 30 20 32
Wed Jun 15 19:14:57 2022 DEBUG: 8 bytes read, 96 total bytes: 36 2e 30 20 30 20 31 d7
Wed Jun 15 19:14:57 2022 DEBUG: 8 bytes read, 104 total bytes: e2 0d 00 00 00 00 00 00
Wed Jun 15 19:14:57 2022 DEBUG: Found reply <cr> at byte: 98
Wed Jun 15 19:14:57 2022 DEBUG: QPIRI: 104 bytes read: (230.0 13.0 230.0 50.0 13.0 3000 3000 24.0 22.0 21.0 28.2 27.4 2 02 070 1 2 2 1 01 0 0 26.0 0 1
Wed Jun 15 19:14:57 2022 DEBUG: QPIRI query finished
Wed Jun 15 19:14:57 2022 DEBUG: Current CRC: B4 DA
Wed Jun 15 19:14:57 2022 DEBUG: Send buffer hex bytes: ( 51 50 49 57 53 b4 da 0d )
Wed Jun 15 19:14:57 2022 DEBUG: 8 bytes written, 8 bytes sent, 0 bytes remaining
Wed Jun 15 19:14:57 2022 DEBUG: 8 bytes read, 8 total bytes: 28 30 30 30 30 30 30 30
Wed Jun 15 19:14:57 2022 DEBUG: 8 bytes read, 16 total bytes: 30 30 30 30 30 30 30 30
Wed Jun 15 19:14:57 2022 DEBUG: 8 bytes read, 24 total bytes: 30 30 30 30 30 30 30 30
Wed Jun 15 19:14:57 2022 DEBUG: 8 bytes read, 32 total bytes: 30 30 30 30 30 30 30 30
Wed Jun 15 19:14:57 2022 DEBUG: 8 bytes read, 40 total bytes: 30 eb e4 0d 00 00 00 00
Wed Jun 15 19:14:57 2022 DEBUG: Found reply <cr> at byte: 36
Wed Jun 15 19:14:57 2022 DEBUG: QPIWS: 40 bytes read: (00000000000000000000000000000000
Wed Jun 15 19:14:57 2022 DEBUG: QPIWS query finished
Wed Jun 15 19:14:57 2022 DEBUG: Start loop
INVERTER: ampfactor from config is 1.00
INVERTER: wattfactor from config is 1.00
{
"Inverter_mode":4,
"AC_grid_voltage":231.7,
"AC_grid_frequency":49.9,
"AC_out_voltage":230.2,
"AC_out_frequency":50.0,
"PV_in_voltage":0.0,
"PV_in_current":0.0,
"PV_in_watts":0.0,
"SCC_voltage":0.0000,
"Load_pct":13,
"Load_watt":147,
"Load_va":391,
"Bus_voltage":358,
"Heatsink_temperature":36,
"Battery_capacity":100,
"Battery_voltage":25.98,
"Battery_charge_current":0,
"Battery_discharge_current":6,
"Load_status_on":1,
"SCC_charge_on":0,
"AC_charge_on":0,
"Battery_voltage_offset_for_fans_on":0,
"Eeprom_version":0,
"PV_charging_power":0,
"Charging_to_floating_mode":0,
"Switch_On":1,
"Dustproof_installed":1,
"Battery_recharge_voltage":22.0,
"Battery_under_voltage":21.0,
"Battery_bulk_voltage":28.2,
"Battery_float_voltage":27.4,
"Max_grid_charge_current":2,
"Max_charge_current":70,
"Out_source_priority":2,
"Charger_source_priority":2,
"Battery_redischarge_voltage":26.0,
"Warnings":"00000000000000000000000000000000"
}
Wed Jun 15 19:14:57 2022 INVERTER: All queries complete, exiting loop.
If you cant see this or have an endless loop, try my fix with axpert-query as I've described above.
(see protocol manual for complete list of supported commands)
DESCRIPTION: PAYLOAD: OPTIONS:
----------------------------------------------------------------
Set output source priority POP00 (Utility first)
POP01 (Solar first)
POP02 (SBU)
Set charger priority PCP00 (Utility first)
PCP01 (Solar first)
PCP02 (Solar and utility)
PCP03 (Solar only)
Set the Charge/Discharge Levels & Cutoff
PBDV26.9 (Don't discharge the battery unless it is at 26.9v or more)
PBCV24.8 (Switch back to 'grid' when battery below 24.8v)
PBFT27.1 (Set the 'float voltage' to 27.1v)
PCVV28.1 (Set the 'charge voltage' to 28.1v)
Set other commands PEa / PDa (Enable/disable buzzer)
PEb / PDb (Enable/disable overload bypass)
PEj / PDj (Enable/disable power saving)
PEu / PDu (Enable/disable overload restart);
PEx / PDx (Enable/disable backlight)
NOTE: When setting/configuring your charge, discharge, float & cutoff voltages for the first time, it's worth understanding how to optimize charging conditions to extend service life of your battery: https://batteryuniversity.com/learn/article/charging_the_lead_acid_battery
Since I had to dig a little deeper, I have decided to include my findings in 'Commands Inverter.ods' in the near future!
This project uses heavily modified sources, from manio's original demo, and be compiled to run standalone on Linux, Mac, and Windows (via Cygwin).
Just head to the sources/inverter-cli directory and build it directly using: cmake . && make.
Basic arguments supported are:
USAGE: ./inverter_poller <args> [-r <command>], [-h | --help], [-1 | --run-once]
SUPPORTED ARGUMENTS:
-r <raw-command> TX 'raw' command to the inverter
-h | --help This Help Message
-1 | --run-once Runs one iteration on the inverter, and then exits
-d Additional debugging
The arguments are the same as using the inverter_poller directly. You only need to add the docker part.
Here is a example to set the battery re-discharge voltage to 26.1V
sudo docker exec -it voltronic-mqtt bash -c '/opt/inverter-cli/bin/inverter_poller -d -r PBDV26.1'
Providing you have setup MQTT with Home Assistant, the device will automatically register in your Home Assistant when the container starts for the first time -- You do not need to manually define any sensors.
From here you can setup Graphs to display sensor data, and optionally change state of the inverter by "publishing" a string to the inverter's primary topic like so:
Example: Changing the Charge Priority of the Inverter
There are some Lovelace dashboard files in the homeassistant/ directory, however you will need to need to adapt to your own Home Assistant configuration and/or name of the inverter if you have changed it in the mqtt.json config file.
For the input buttons you will need to use the helpers in HA to create them. The names and the options of them are in the automation examples.
Note that in addition to merging the sample Yaml files with your Home Assistant, you will need the following custom Lovelace cards installed if you wish to use my templates:
Credit and many thanks to catalinbordan, saschalenz, kchiem, dilyanpalauzov, nrm21 and all other who worked on this!
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent