Update docs

longzheng · Dec 20, 2024 · f676e76 · f676e76
1 parent 6889370
commit f676e76
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 7 deletions.
diff --git a/docs/configuration/inverter-control.md b/docs/configuration/inverter-control.md
@@ -26,14 +26,14 @@ The inverter control loop will attempt to aggregate and average a window of meas
 
 ## Frequency
 
-The inverter control loop will attempt to control the inverter with a rate limit to prevent over-correcting and leading to osscilations. The `config.json` option `inverterControl.controlFrequencyMinimumSeconds` can be used to adjust the frequency in seconds.
+The inverter control loop will attempt to control the inverter with a rate limit to prevent over-correcting and leading to osscilations. The `config.json` option `inverterControl.intervalSeconds` can be used to adjust the frequency in seconds.
 
 The rate limit will be influenced by the latency of sending commands to the inverter (e.g. over WiFi) and the inverter's response time, so the frequency configuration is a minimum and not a guaranteed rate.
 
 ```js
 {
     "inverterControl": {
-        "controlFrequencyMinimumSeconds": 5 // (number) optional: the frequency in seconds to control the inverter
+        "intervalSeconds": 5 // (number) optional: the frequency in seconds to control the inverter
     },
     ...
 }

diff --git a/docs/configuration/inverters.md b/docs/configuration/inverters.md
@@ -23,7 +23,8 @@ To configure a SMA inverter connection, add the following property to `config.js
                 "ip": "192.168.1.6", // (string) required: the IP address of the inverter
                 "port": 502 // (number) required: the Modbus TCP port of the inverter
             },
-            "unitId": 1 // (number) required: the Modbus unit ID of the inverter
+            "unitId": 1 // (number) required: the Modbus unit ID of the inverter,
+            "pollingIntervalMs":  // (number) optional: the polling interval in milliseconds, default 200
         }
     ],
     ...
@@ -50,7 +51,8 @@ To configure a SunSpec inverter connection over TCP, add the following property
                 "ip": "192.168.1.6", // (string) required: the IP address of the inverter
                 "port": 502 // (number) required: the Modbus TCP port of the inverter
             },
-            "unitId": 1 // (number) required: the Modbus unit ID of the inverter
+            "unitId": 1 // (number) required: the Modbus unit ID of the inverter,
+            "pollingIntervalMs":  // (number) optional: the polling interval in milliseconds, default 200
         }
     ],
     ...

diff --git a/docs/configuration/meter.md b/docs/configuration/meter.md
@@ -18,6 +18,7 @@ To configure a MQTT meter connection, add the following property to `config.json
         "username": "user", // (string) optional: the MQTT broker username
         "password": "password", // (string) optional: the MQTT broker password
         "topic": "site" // (string) required: the MQTT topic to read
+        "pollingIntervalMs":  // (number) optional: the polling interval in milliseconds, default 200
     }
     ...
 }
@@ -147,7 +148,8 @@ To configure a SMA inverter with meter connection, add the following property to
             "port": 502 // (number) required: the Modbus TCP port of the inverter
         },
         "unitId": 240 // (number) required: the SunSpec unit ID of the meter
-        "location": "feedin" // (string) optional: the location of the meter (feedin or consumption)
+        "location": "feedin" // (string) optional: the location of the meter (feedin or consumption),
+        "pollingIntervalMs":  // (number) optional: the polling interval in milliseconds, default 200
     }
     ...
 }
@@ -175,7 +177,8 @@ To configure a SunSpec meter connection over TCP, add the following property to
             "port": 502 // (number) required: the Modbus TCP port of the inverter
         },
         "unitId": 240 // (number) required: the SunSpec unit ID of the meter
-        "location": "feedin" // (string) optional: the location of the meter (feedin or consumption)
+        "location": "feedin" // (string) optional: the location of the meter (feedin or consumption),
+        "pollingIntervalMs":  // (number) optional: the polling interval in milliseconds, default 200
     }
     ...
 }
@@ -208,7 +211,8 @@ Sites with a Tesla Powerwall 2 can use the Backup Gateway 2's meter and local AP
     "meter": {
         "type": "powerwall2", // (string) required: the type of meter
         "ip": "192.168.1.68", // (string) required: the IP address of the Powerwall 2 Gateway
-        "password": "ABCDE" // (string) required: the password to access the Powerwall 2 API (the last 5 characters of the password sticker)
+        "password": "ABCDE" // (string) required: the password to access the Powerwall 2 API (the last 5 characters of the password sticker),
+        "pollingIntervalMs":  // (number) optional: the polling interval in milliseconds, default 200
     }
     ...
 ```