update docs

carlokarton · Jun 9, 2023 · fbf2ee4 · fbf2ee4
1 parent e99b583
commit fbf2ee4
Show file tree

Hide file tree

Showing 10 changed files with 150 additions and 134 deletions.
diff --git a/README.md b/README.md
@@ -36,21 +36,21 @@ Once installed, use Add Integration -> Ecoflow Cloud.
 - Inv Out Temperature
 - Cycles
 - Battery Temperature
-- Min Cell Temperature
-- Max Cell Temperature
-- Battery Volts
-- Min Cell Volts
-- Max Cell Volts
-- Slave Battery Level
-- Slave Battery Temperature
-- Slave Min Cell Temperature
-- Slave Max Cell Temperature
-- Slave Battery Volts
-- Slave Min Cell Volts
-- Slave Max Cell Volts
-- Slave Cycles
-- Slave In Power
-- Slave Out Power
+- Min Cell Temperature  _(disabled)_
+- Max Cell Temperature  _(disabled)_
+- Battery Volts  _(disabled)_
+- Min Cell Volts  _(disabled)_
+- Max Cell Volts  _(disabled)_
+- Slave Battery Level  _(auto)_
+- Slave Battery Temperature  _(auto)_
+- Slave Min Cell Temperature  _(disabled)_
+- Slave Max Cell Temperature  _(disabled)_
+- Slave Battery Volts  _(disabled)_
+- Slave Min Cell Volts  _(disabled)_
+- Slave Max Cell Volts  _(disabled)_
+- Slave Cycles  _(auto)_
+- Slave In Power  _(auto)_
+- Slave Out Power  _(auto)_
 
 *Switches*
 - Beeper 
@@ -96,11 +96,11 @@ Once installed, use Add Integration -> Ecoflow Cloud.
 - Inv Out Temperature
 - Cycles
 - Battery Temperature
-- Min Cell Temperature
-- Max Cell Temperature
-- Battery Volts
-- Min Cell Volts
-- Max Cell Volts
+- Min Cell Temperature  _(disabled)_
+- Max Cell Temperature  _(disabled)_
+- Battery Volts  _(disabled)_
+- Min Cell Volts  _(disabled)_
+- Max Cell Volts  _(disabled)_
 
 *Switches*
 - AC Enabled 
@@ -121,13 +121,15 @@ Once installed, use Add Integration -> Ecoflow Cloud.
 
 </p></details>
 
-<details><summary> RIVER_2_MAX <i>(sensors: 21, switches: 3, sliders: 3, selects: 5)</i> </summary>
+<details><summary> RIVER_2_MAX <i>(sensors: 23, switches: 3, sliders: 3, selects: 5)</i> </summary>
 <p>
 
 *Sensors*
 - Main Battery Level
 - Total In Power
 - Total Out Power
+- Solar In Current
+- Solar In Voltage
 - AC In Power
 - Type-C In Power
 - Solar In Power
@@ -141,11 +143,11 @@ Once installed, use Add Integration -> Ecoflow Cloud.
 - Inv Out Temperature
 - Cycles
 - Battery Temperature
-- Min Cell Temperature
-- Max Cell Temperature
-- Battery Volts
-- Min Cell Volts
-- Max Cell Volts
+- Min Cell Temperature  _(disabled)_
+- Max Cell Temperature  _(disabled)_
+- Battery Volts  _(disabled)_
+- Min Cell Volts  _(disabled)_
+- Max Cell Volts  _(disabled)_
 
 *Switches*
 - AC Enabled 
@@ -186,11 +188,11 @@ Once installed, use Add Integration -> Ecoflow Cloud.
 - Inv Out Temperature
 - Cycles
 - Battery Temperature
-- Min Cell Temperature
-- Max Cell Temperature
-- Battery Volts
-- Min Cell Volts
-- Max Cell Volts
+- Min Cell Temperature  _(disabled)_
+- Max Cell Temperature  _(disabled)_
+- Battery Volts  _(disabled)_
+- Min Cell Volts  _(disabled)_
+- Max Cell Volts  _(disabled)_
 
 *Switches*
 - AC Enabled 
@@ -234,19 +236,19 @@ Once installed, use Add Integration -> Ecoflow Cloud.
 - Discharge Remaining Time
 - Cycles
 - Battery Temperature
-- Min Cell Temperature
-- Max Cell Temperature
-- Battery Volts
-- Min Cell Volts
-- Max Cell Volts
-- Slave 1 Battery Level
-- Slave 1 Battery Temperature
-- Slave 1 In Power
-- Slave 1 Out Power
-- Slave 2 Battery Level
-- Slave 2 Battery Temperature
-- Slave 2 In Power
-- Slave 2 Out Power
+- Min Cell Temperature  _(disabled)_
+- Max Cell Temperature  _(disabled)_
+- Battery Volts  _(disabled)_
+- Min Cell Volts  _(disabled)_
+- Max Cell Volts  _(disabled)_
+- Slave 1 Battery Level  _(auto)_
+- Slave 1 Battery Temperature  _(auto)_
+- Slave 1 In Power  _(auto)_
+- Slave 1 Out Power  _(auto)_
+- Slave 2 Battery Level  _(auto)_
+- Slave 2 Battery Temperature  _(auto)_
+- Slave 2 In Power  _(auto)_
+- Slave 2 Out Power  _(auto)_
 
 *Switches*
 - Beeper 
@@ -287,19 +289,19 @@ Once installed, use Add Integration -> Ecoflow Cloud.
 - Remaining Time
 - Cycles
 - Battery Temperature
-- Min Cell Temperature
-- Max Cell Temperature
-- Battery Volts
-- Min Cell Volts
-- Max Cell Volts
-- Slave Battery Level
-- Slave Battery Temperature
-- Slave Min Cell Temperature
-- Slave Max Cell Temperature
-- Battery Volts
-- Min Cell Volts
-- Max Cell Volts
-- Slave Cycles
+- Min Cell Temperature  _(disabled)_
+- Max Cell Temperature  _(disabled)_
+- Battery Volts  _(disabled)_
+- Min Cell Volts  _(disabled)_
+- Max Cell Volts  _(disabled)_
+- Slave Battery Level  _(auto)_
+- Slave Battery Temperature  _(auto)_
+- Slave Min Cell Temperature  _(disabled)_
+- Slave Max Cell Temperature  _(disabled)_
+- Battery Volts  _(disabled)_
+- Min Cell Volts  _(disabled)_
+- Max Cell Volts  _(disabled)_
+- Slave Cycles  _(auto)_
 
 *Switches*
 - Beeper 
@@ -308,7 +310,7 @@ Once installed, use Add Integration -> Ecoflow Cloud.
 - X-Boost Enabled 
 
 *Sliders (numbers)*
-- Max Charge Level  (read-only)
+- Max Charge Level  _(read-only)_
 
 *Selects*
 - Unit Timeout 
@@ -337,16 +339,16 @@ Once installed, use Add Integration -> Ecoflow Cloud.
 - Cycles
 
 *Switches*
-- Beeper  (read-only)
-- AC Enabled  (read-only)
-- X-Boost Enabled  (read-only)
+- Beeper  _(read-only)_
+- AC Enabled  _(read-only)_
+- X-Boost Enabled  _(read-only)_
 
 *Sliders (numbers)*
-- Max Charge Level  (read-only)
+- Max Charge Level  _(read-only)_
 
 *Selects*
-- Unit Timeout  (read-only)
-- AC Timeout  (read-only)
+- Unit Timeout  _(read-only)_
+- AC Timeout  _(read-only)_
 
 </p></details>
 
@@ -373,11 +375,11 @@ Once installed, use Add Integration -> Ecoflow Cloud.
 - Inv Out Temperature
 - Cycles
 - Battery Temperature
-- Min Cell Temperature
-- Max Cell Temperature
-- Battery Volts
-- Min Cell Volts
-- Max Cell Volts
+- Min Cell Temperature  _(disabled)_
+- Max Cell Temperature  _(disabled)_
+- Battery Volts  _(disabled)_
+- Min Cell Volts  _(disabled)_
+- Max Cell Volts  _(disabled)_
 
 *Switches*
 - Beeper 
@@ -399,6 +401,5 @@ Once installed, use Add Integration -> Ecoflow Cloud.
 
 </p></details>
 
-
 ## How to
 - [Add/update device](docs/integration.md)
diff --git a/custom_components/ecoflow_cloud/entities/__init__.py b/custom_components/ecoflow_cloud/entities/__init__.py
@@ -29,6 +29,10 @@ def __init__(self, client: EcoflowMQTTClient, mqtt_key: str, title: str, enabled
     def mqtt_key(self):
         return self._mqtt_key
 
+    @property
+    def auto_enable(self):
+        return self._auto_enable
+
     @property
     def enabled_default(self):
         return self._attr_entity_registry_enabled_default

diff --git a/docs/devices/DELTA_2.md b/docs/devices/DELTA_2.md
@@ -20,21 +20,21 @@
 - Inv Out Temperature (`inv.outTemp`)
 - Cycles (`bms_bmsStatus.cycles`)
 - Battery Temperature (`bms_bmsStatus.temp`)
-- Min Cell Temperature (`bms_bmsStatus.minCellTemp`)   _disabled_
-- Max Cell Temperature (`bms_bmsStatus.maxCellTemp`)   _disabled_
-- Battery Volts (`bms_bmsStatus.vol`)   _disabled_
-- Min Cell Volts (`bms_bmsStatus.minCellVol`)   _disabled_
-- Max Cell Volts (`bms_bmsStatus.maxCellVol`)   _disabled_
-- Slave Battery Level (`bms_slave.soc`)   _disabled_
-- Slave Battery Temperature (`bms_slave.temp`)   _disabled_
-- Slave Min Cell Temperature (`bms_slave.minCellTemp`)   _disabled_
-- Slave Max Cell Temperature (`bms_slave.maxCellTemp`)   _disabled_
-- Slave Battery Volts (`bms_slave.vol`)   _disabled_
-- Slave Min Cell Volts (`bms_slave.minCellVol`)   _disabled_
-- Slave Max Cell Volts (`bms_slave.maxCellVol`)   _disabled_
-- Slave Cycles (`bms_slave.cycles`)   _disabled_
-- Slave In Power (`bms_slave.inputWatts`)   _disabled_
-- Slave Out Power (`bms_slave.outputWatts`)   _disabled_
+- Min Cell Temperature (`bms_bmsStatus.minCellTemp`)   _(disabled)_
+- Max Cell Temperature (`bms_bmsStatus.maxCellTemp`)   _(disabled)_
+- Battery Volts (`bms_bmsStatus.vol`)   _(disabled)_
+- Min Cell Volts (`bms_bmsStatus.minCellVol`)   _(disabled)_
+- Max Cell Volts (`bms_bmsStatus.maxCellVol`)   _(disabled)_
+- Slave Battery Level (`bms_slave.soc`)   _(auto)_
+- Slave Battery Temperature (`bms_slave.temp`)   _(auto)_
+- Slave Min Cell Temperature (`bms_slave.minCellTemp`)   _(disabled)_
+- Slave Max Cell Temperature (`bms_slave.maxCellTemp`)   _(disabled)_
+- Slave Battery Volts (`bms_slave.vol`)   _(disabled)_
+- Slave Min Cell Volts (`bms_slave.minCellVol`)   _(disabled)_
+- Slave Max Cell Volts (`bms_slave.maxCellVol`)   _(disabled)_
+- Slave Cycles (`bms_slave.cycles`)   _(auto)_
+- Slave In Power (`bms_slave.inputWatts`)   _(auto)_
+- Slave Out Power (`bms_slave.outputWatts`)   _(auto)_
 
 *Switches*
 - Beeper (`mppt.beepState` -> `{"moduleType": 5, "operateType": "quietMode", "params": {"enabled": "VALUE"}}`)

diff --git a/docs/devices/DELTA_MAX.md b/docs/devices/DELTA_MAX.md
@@ -20,11 +20,11 @@
 - Inv Out Temperature (`inv.outTemp`)
 - Cycles (`bmsMaster.cycles`)
 - Battery Temperature (`bmsMaster.temp`)
-- Min Cell Temperature (`bmsMaster.minCellTemp`)   _disabled_
-- Max Cell Temperature (`bmsMaster.maxCellTemp`)   _disabled_
-- Battery Volts (`bmsMaster.vol`)   _disabled_
-- Min Cell Volts (`bmsMaster.minCellVol`)   _disabled_
-- Max Cell Volts (`bmsMaster.maxCellVol`)   _disabled_
+- Min Cell Temperature (`bmsMaster.minCellTemp`)   _(disabled)_
+- Max Cell Temperature (`bmsMaster.maxCellTemp`)   _(disabled)_
+- Battery Volts (`bmsMaster.vol`)   _(disabled)_
+- Min Cell Volts (`bmsMaster.minCellVol`)   _(disabled)_
+- Max Cell Volts (`bmsMaster.maxCellVol`)   _(disabled)_
 
 *Switches*
 - Beeper (`pd.beepState` -> `{"moduleType": 5, "operateType": "quietMode", "params": {"enabled": "VALUE"}}`)

diff --git a/docs/devices/DELTA_PRO.md b/docs/devices/DELTA_PRO.md
@@ -20,19 +20,19 @@
 - Discharge Remaining Time (`ems.dsgRemainTime`)
 - Cycles (`bmsMaster.cycles`)
 - Battery Temperature (`bmsMaster.temp`)
-- Min Cell Temperature (`bmsMaster.minCellTemp`)   _disabled_
-- Max Cell Temperature (`bmsMaster.maxCellTemp`)   _disabled_
-- Battery Volts (`bmsMaster.vol`)   _disabled_
-- Min Cell Volts (`bmsMaster.minCellVol`)   _disabled_
-- Max Cell Volts (`bmsMaster.maxCellVol`)   _disabled_
-- Slave 1 Battery Level (`bmsSlave1.soc`)   _disabled_
-- Slave 1 Battery Temperature (`bmsSlave1.temp`)   _disabled_
-- Slave 1 In Power (`bmsSlave1.inputWatts`)   _disabled_
-- Slave 1 Out Power (`bmsSlave1.outputWatts`)   _disabled_
-- Slave 2 Battery Level (`bmsSlave2.soc`)   _disabled_
-- Slave 2 Battery Temperature (`bmsSlave2.temp`)   _disabled_
-- Slave 2 In Power (`bmsSlave2.inputWatts`)   _disabled_
-- Slave 2 Out Power (`bmsSlave2.outputWatts`)   _disabled_
+- Min Cell Temperature (`bmsMaster.minCellTemp`)   _(disabled)_
+- Max Cell Temperature (`bmsMaster.maxCellTemp`)   _(disabled)_
+- Battery Volts (`bmsMaster.vol`)   _(disabled)_
+- Min Cell Volts (`bmsMaster.minCellVol`)   _(disabled)_
+- Max Cell Volts (`bmsMaster.maxCellVol`)   _(disabled)_
+- Slave 1 Battery Level (`bmsSlave1.soc`)   _(auto)_
+- Slave 1 Battery Temperature (`bmsSlave1.temp`)   _(auto)_
+- Slave 1 In Power (`bmsSlave1.inputWatts`)   _(auto)_
+- Slave 1 Out Power (`bmsSlave1.outputWatts`)   _(auto)_
+- Slave 2 Battery Level (`bmsSlave2.soc`)   _(auto)_
+- Slave 2 Battery Temperature (`bmsSlave2.temp`)   _(auto)_
+- Slave 2 In Power (`bmsSlave2.inputWatts`)   _(auto)_
+- Slave 2 Out Power (`bmsSlave2.outputWatts`)   _(auto)_
 
 *Switches*
 - Beeper (`mppt.beepState` -> `{"moduleType": 0, "operateType": "TCP", "params": {"id": 38, "enabled": "VALUE"}}`)

diff --git a/docs/devices/RIVER_2.md b/docs/devices/RIVER_2.md
@@ -16,11 +16,11 @@
 - Inv Out Temperature (`inv.outTemp`)
 - Cycles (`bms_bmsStatus.cycles`)
 - Battery Temperature (`bms_bmsStatus.temp`)
-- Min Cell Temperature (`bms_bmsStatus.minCellTemp`)   _disabled_
-- Max Cell Temperature (`bms_bmsStatus.maxCellTemp`)   _disabled_
-- Battery Volts (`bms_bmsStatus.vol`)   _disabled_
-- Min Cell Volts (`bms_bmsStatus.minCellVol`)   _disabled_
-- Max Cell Volts (`bms_bmsStatus.maxCellVol`)   _disabled_
+- Min Cell Temperature (`bms_bmsStatus.minCellTemp`)   _(disabled)_
+- Max Cell Temperature (`bms_bmsStatus.maxCellTemp`)   _(disabled)_
+- Battery Volts (`bms_bmsStatus.vol`)   _(disabled)_
+- Min Cell Volts (`bms_bmsStatus.minCellVol`)   _(disabled)_
+- Max Cell Volts (`bms_bmsStatus.maxCellVol`)   _(disabled)_
 
 *Switches*
 - AC Enabled (`mppt.cfgAcEnabled` -> `{"moduleType": 5, "operateType": "acOutCfg", "params": {"enabled": "VALUE", "out_voltage": -1, "out_freq": 255, "xboost": 255}}`)

diff --git a/docs/devices/RIVER_2_MAX.md b/docs/devices/RIVER_2_MAX.md
@@ -4,6 +4,8 @@
 - Main Battery Level (`pd.soc`)
 - Total In Power (`pd.wattsInSum`)
 - Total Out Power (`pd.wattsOutSum`)
+- Solar In Current (`inv.dcInAmp`)
+- Solar In Voltage (`inv.dcInVol`)
 - AC In Power (`inv.inputWatts`)
 - Type-C In Power (`pd.typecChaWatts`)
 - Solar In Power (`mppt.inWatts`)
@@ -17,11 +19,11 @@
 - Inv Out Temperature (`inv.outTemp`)
 - Cycles (`bms_bmsStatus.cycles`)
 - Battery Temperature (`bms_bmsStatus.temp`)
-- Min Cell Temperature (`bms_bmsStatus.minCellTemp`)   _disabled_
-- Max Cell Temperature (`bms_bmsStatus.maxCellTemp`)   _disabled_
-- Battery Volts (`bms_bmsStatus.vol`)   _disabled_
-- Min Cell Volts (`bms_bmsStatus.minCellVol`)   _disabled_
-- Max Cell Volts (`bms_bmsStatus.maxCellVol`)   _disabled_
+- Min Cell Temperature (`bms_bmsStatus.minCellTemp`)   _(disabled)_
+- Max Cell Temperature (`bms_bmsStatus.maxCellTemp`)   _(disabled)_
+- Battery Volts (`bms_bmsStatus.vol`)   _(disabled)_
+- Min Cell Volts (`bms_bmsStatus.minCellVol`)   _(disabled)_
+- Max Cell Volts (`bms_bmsStatus.maxCellVol`)   _(disabled)_
 
 *Switches*
 - AC Enabled (`mppt.cfgAcEnabled` -> `{"moduleType": 5, "operateType": "acOutCfg", "params": {"enabled": "VALUE", "out_voltage": -1, "out_freq": 255, "xboost": 255}}`)

diff --git a/docs/devices/RIVER_2_PRO.md b/docs/devices/RIVER_2_PRO.md
@@ -17,11 +17,11 @@
 - Inv Out Temperature (`inv.outTemp`)
 - Cycles (`bms_bmsStatus.cycles`)
 - Battery Temperature (`bms_bmsStatus.temp`)
-- Min Cell Temperature (`bms_bmsStatus.minCellTemp`)   _disabled_
-- Max Cell Temperature (`bms_bmsStatus.maxCellTemp`)   _disabled_
-- Battery Volts (`bms_bmsStatus.vol`)   _disabled_
-- Min Cell Volts (`bms_bmsStatus.minCellVol`)   _disabled_
-- Max Cell Volts (`bms_bmsStatus.maxCellVol`)   _disabled_
+- Min Cell Temperature (`bms_bmsStatus.minCellTemp`)   _(disabled)_
+- Max Cell Temperature (`bms_bmsStatus.maxCellTemp`)   _(disabled)_
+- Battery Volts (`bms_bmsStatus.vol`)   _(disabled)_
+- Min Cell Volts (`bms_bmsStatus.minCellVol`)   _(disabled)_
+- Max Cell Volts (`bms_bmsStatus.maxCellVol`)   _(disabled)_
 
 *Switches*
 - AC Enabled (`mppt.cfgAcEnabled` -> `{"moduleType": 5, "operateType": "acOutCfg", "params": {"enabled": "VALUE", "out_voltage": -1, "out_freq": 255, "xboost": 255}}`)