Browse Source

updated README.md

FloKra 1 year ago
parent
commit
86d70fca96
1 changed files with 12 additions and 7 deletions
  1. 12 7
      S0Meters_py/README.md

+ 12 - 7
S0Meters_py/README.md

@@ -187,11 +187,11 @@ 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, but only A-Z a-z _ and - should be used. Used for MQTT topics "Yesterday__unit" and "Today__unit"
+- **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"
+- **type**: "usage" - not really used for anything right now
 - **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_factor**: factor for conversion to 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
@@ -200,8 +200,9 @@ In this YAML styled config file, all meters/counters are declared. The main iden
 - **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. 
+    Formula for calculation: 
+    ``momValue = (3600000 / dTime / impPerUnit) * momFactor``
+    where ``dTime`` is the measured time between impulses in milliseconds. 
     Normally 1, except if the unit of momentary value should be different - for example:  
     - power meter, 1000 imp per unit = 1 kWh: 
     momFactor=1000 -> output in Watts
@@ -217,7 +218,9 @@ In this YAML styled config file, all meters/counters are declared. The main iden
 - **momDigits_conv1**: integer, number of digits in output of converted momentary value
 
 - **momFactor_conv1**: factor for calculation of converted momentary value
-    Formula for calculation: momValue_conv1 = momValue * momFactor_conv1 (where momValue is the origin unconverted value)
+    Formula for calculation: 
+    ``momValue_conv1 = momValue * momFactor_conv1`` 
+    where ``momValue`` is the origin unconverted value.
     For example: 
     - gas meter, convert m³/h to kW: factor of ~10
     - gas meter, convert m³/h to l/min: factor of 16.6667
@@ -229,7 +232,9 @@ In this YAML styled config file, all meters/counters are declared. The main iden
 - **momDigits_conv2**: integer, number of digits in output of 2nd converted momentary value
 
 - **momFactor_conv2**: factor for calculation of 2nd converted momentary value
-    Formula for calculation: momValue_conv2 = momValue * momFactor_conv2 (where momValue is the origin unconverted value)
+    Formula for calculation: 
+    ``momValue_conv2 = momValue * momFactor_conv2``
+    where ``momValue`` is the origin unconverted value.
     For example: 
     - gas meter, convert m³/h to kW: factor of ~10
     - gas meter, convert m³/h to l/min: factor of 16.6667