Browse Source

updated README.md

FloKra 1 year ago
parent
commit
fc49e108ea
1 changed files with 8 additions and 8 deletions
  1. 8 8
      S0Meters_py/README.md

+ 8 - 8
S0Meters_py/README.md

@@ -186,19 +186,19 @@ In this YAML styled config file, all meters/counters are declared. The main iden
 ```
 
 - **name**: free text, used for path of file log and internally
-
 - **impPerUnit**: integer, normally 10, 100 or 1000, used for calculation of momentary units
-
-- **unit**: free text, currently only used in MQTT JSON output
-
+- **unit**: free text, but only A-Z a-z _ and - should be used. Used for MQTT topics "Yesterday__unit" and "Today__unit"
 - **digits**: integer, number of digits in output of counter reading
-
+- **type**: "usage"
+- **conv_unit**: unit for converted value, used for Today and Yesterday readings (currently not for Total)
+- **conv_factor**: factor for conversion in a different unit
+- **conv_digits**: digits to round convertion to
+- **cost_unit**: currency for cost calculation, used in MQTT topic
+- **cost_per_unit**: price of one energy-unit
+- **cost_from_conv**: True or False - if True, cost will be calculated from the converted value, if False from the origin
 - **momType**: type of momentary reading. used as MQTT sub-topic
-
 - **momUnit**: free text, currently only used in MQTT JSON output
-
 - **momDigits**: integer, number of digits in output of momentary value
-
 - **momFactor**: factor for calculation of momentary value
     Formula for calculation: momValue = (3600000 / dTime / impPerUnit) * momFactor
     where dTime = time between impulses in milliseconds.