README, config: update after recent changes (#25)

* updating readme * fixup! updating readme * Typo fix * Add missing LF at EOF --------- Co-authored-by: Mariusz Białończyk <[email protected]>
manio · Oct 31, 2023 · 79de27c · 79de27c
1 parent f6f5849
commit 79de27c
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -35,10 +35,31 @@ 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
+          -l <buffersize>       Define the buffersize for the response of raw command. Default value 7. 
           -d                    Additional debugging
 
 ```
 
+#### Configuration hint:
+
+Quite a lot of inverters seams to use this protocol. The base seams not to change but depending on your device, you might have more queries available to comunicate with your device and/or more parameters in query response from inverter. 
+
+Configuration file allow you to custom the buffersize of wrapped queries qmod, qpigs, qpiri, qpiws, in case default value does not match. Those wrapped queries are use to extract part of the data exposed by your device then wrapped into nice json output.
+
+To get the raw output of your device, you can use the rawcmnd option providing the right buffersize of the query (that's where start your guessing game!).
+
+Here some valid example, tested on an Axpert VM3 inverter, of buffer size to provide to the rawcmd for the associated command:
+
+```
+QPI = 8
+QID = 18
+QVFW = 18
+QVFM2 = 19
+QFLAG = 15
+QBOOT = 5
+QOPM = 6
+default: 7, valid value for PE commands
+```
 Note:
 
 - When using the `tx` command, your commands will need to follow the specification outlined [here](https://github.com/ned-kelly/docker-voltronic-homeassistant/blob/master/manual/HS_MS_MSX_RS232_Protocol_20140822_after_current_upgrade.pdf).

diff --git a/inverter.conf b/inverter.conf
@@ -21,3 +21,19 @@ amperage_factor=1.0
 # This allos you to modify the wattage in case the inverter is giving an incorrect
 # reading compared to measurement tools.  Normally this will remain '1'
 watt_factor=1.01
+
+# Depending on the protocol version used and your device, 
+# you might need to change the following parameters
+
+#### For Axpert VM3 inverter like, use those values ###
+# This allows you to modify the buffersize for the qpiri command 
+qpiri=98
+
+# This allows you to modify the buffersize for the qpiws command
+qpiws=36
+
+# This allows you to modify the buffersize for the qmod command
+qmod=5
+
+# This allows you to modify the buffersize for the qpigs command
+qpigs=110