Merge pull request #84 from RustyDust/sru_work

RustyDust · web-flow · commit 538e3fd0a368 · 2025-02-08T21:39:43.000+01:00
Rework some services to return more consistent responses:
diff --git a/.github/workflows/hassfest.yaml b/.github/workflows/hassfest.yaml
@@ -4,7 +4,7 @@ on:
   push:
   pull_request:
   schedule:
-    - cron: "0 0 * * *"
+    - cron: "0 0 * * 0"
 
 jobs:
   validate:
diff --git a/README.md b/README.md
@@ -99,6 +99,27 @@ data:
   mode: "automatic"
 ```
 
+##### Response
+The name of the mode that has been set:
+- `manual`
+- `automatic`
+- `timeofuse`
+
+### <a name="set_operatingmode_num"></a>`set_operating_mode_num(mode=<mode>)`
+- Sets the operating mode of your SonnenBatterie.
+- Supported values for `<mode>` are:
+  - `1`
+  - `2`
+  - `10`
+
+##### Code snippet
+``` yaml
+action: sonnenbatterie.set_operating_mode_num
+data:
+  device_id: "<your sb instance's device id>"
+  mode: 2
+```
+
 ##### Response
 An `int` representing the mode that has been set:
 - 1: `manual`
@@ -276,6 +297,38 @@ data:
 }
 ```
 
+### <a name="get_operatingmode"></a>`get_operating_mode()`
+- Retrieves the current operating mode of your SonnenBatterie.
+
+##### Code snippet
+``` yaml
+action: sonnenbatterie.get_operating_mode
+data:
+  device_id: "<your sb instance's device id>"
+```
+
+##### Response
+The name of the mode that has been set:
+- `manual`
+- `automatic`
+- `timeofuse`
+
+### <a name="get_operatingmode_num"></a>`get_operating_mode_num()`
+- Retrieves the current operating mode of your SonnenBatterie in numeric form
+
+##### Code snippet
+``` yaml
+action: sonnenbatterie.get_operating_mode_num
+data:
+  device_id: "<your sb instance's device id>"
+```
+
+##### Response
+An `int` representing the mode that has been set:
+- 1: `manual`
+- 2: `automatic`
+- 10: `timeofuse`
+
 ## Problems and/or unused/unavailable sensors
 Depending on the software on and the operating mode of your Sonnenbatterie some
 sonsors may not be available. The integration does its best to collect as many
@@ -300,4 +353,4 @@ Please put those logs along with the setting you want monitored into
 [hacsbadge]: https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge&logo=homeassistantcommunitystore&logoColor=ccc
 
 [hainstall]: https://my.home-assistant.io/redirect/config_flow_start/?domain=sonnenbatterie
-[hainstallbadge]: https://img.shields.io/badge/dynamic/json?style=for-the-badge&logo=home-assistant&logoColor=ccc&label=usage&suffix=%20installs&cacheSeconds=15600&url=https://analytics.home-assistant.io/custom_integrations.json&query=$.sonnenbatterie.total
+[hainstallbadge]: https://img.shields.io/badge/dynamic/json?style=for-the-badge&logo=home-assistant&logoColor=ccc&label=usage&suffix=%20installs&cacheSeconds=15600&url=https://analytics.home-assistant.io/custom_integrations.json&query=$.sonnenbatterie.total
diff --git a/custom_components/sonnenbatterie/__init__.py b/custom_components/sonnenbatterie/__init__.py
@@ -40,6 +40,13 @@
     }
 )
 
+SCHEMA_SET_OPERATING_MODE_NUM = vol.Schema(
+    {
+        **cv.ENTITY_SERVICE_FIELDS,
+        vol.Required(CONF_SERVICE_MODE, default=2): vol.In(CONF_OPERATING_MODES_NUM),
+    }
+)
+
 SCHEMA_SET_TOU_SCHEDULE_STRING = vol.Schema(
     {
         **cv.ENTITY_SERVICE_FIELDS,
@@ -155,6 +162,14 @@ async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> b
         supports_response=SupportsResponse.OPTIONAL,
     )
 
+    hass.services.async_register(
+        DOMAIN,
+        "set_operating_mode_num",
+        services.set_operating_mode_num,
+        schema=SCHEMA_SET_OPERATING_MODE_NUM,
+        supports_response=SupportsResponse.OPTIONAL,
+    )
+
     hass.services.async_register(
         DOMAIN,
         "set_tou_schedule",
@@ -184,6 +199,13 @@ async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> b
         supports_response=SupportsResponse.OPTIONAL,
     )
 
+    hass.services.async_register(
+        DOMAIN,
+        "get_operating_mode_num",
+        services.get_operating_mode_num,
+        supports_response=SupportsResponse.OPTIONAL,
+    )
+
     # Done setting up the entry
     return True
 
diff --git a/custom_components/sonnenbatterie/const.py b/custom_components/sonnenbatterie/const.py
@@ -28,6 +28,12 @@
     "timeofuse"
 ]
 
+CONF_OPERATING_MODES_NUM = [
+    "1",
+    "2",
+    "10"
+]
+
 CONF_CHARGE_WATT  = "power"
 CONF_COORDINATOR = "coordinator"
 CONF_INVERTER_MAX = "inverter_max"
diff --git a/custom_components/sonnenbatterie/manifest.json b/custom_components/sonnenbatterie/manifest.json
@@ -8,5 +8,5 @@
     "iot_class": "local_polling",
     "issue_tracker": "https://github.com/weltmeyer/ha_sonnenbatterie/issues",
     "requirements": ["requests","sonnenbatterie>=0.5.2"],
-    "version": "2025.01.03"
+    "version": "2025.02.01"
 }
diff --git a/custom_components/sonnenbatterie/service.py b/custom_components/sonnenbatterie/service.py
@@ -17,6 +17,7 @@
     DOMAIN,
     LOGGER,
     SB_OPERATING_MODES,
+    SB_OPERATING_MODES_NUM,
     SONNENBATTERIE_ISSUE_URL,
 )
 
@@ -55,9 +56,7 @@ async def charge_battery(self, call: ServiceCall) -> ServiceResponse:
             power = 0
         # Make sure we have an sb2 object
         sb_conn = self._get_sb_connection(call.data)
-        # await sb_conn.login()
         response = await sb_conn.sb2.charge_battery(power)
-        # await sb_conn.logout()
         return {
             "charge": response,
         }
@@ -68,19 +67,15 @@ async def discharge_battery(self, call: ServiceCall) -> ServiceResponse:
         if power < 0:
             power = 0
         sb_conn = self._get_sb_connection(call.data)
-        # await sb_conn.login()
         response = await sb_conn.sb2.discharge_battery(power)
-        # await sb_conn.logout()
         return {
             "discharge": response,
         }
 
     async def set_battery_reserve(self, call: ServiceCall) -> ServiceResponse:
         value = call.data.get(CONF_SERVICE_VALUE)
         sb_conn = self._get_sb_connection(call.data)
-        # await sb_conn.login()
         response = int((await sb_conn.sb2.set_battery_reserve(value))["EM_USOC"])
-        # await sb_conn.logout()
         return {
             "battery_reserve": response,
         }
@@ -89,21 +84,25 @@ async def set_config_item(self, call: ServiceCall) -> ServiceResponse:
         item = call.data.get(CONF_SERVICE_ITEM)
         value = call.data.get(CONF_SERVICE_VALUE)
         sb_conn = self._get_sb_connection(call.data)
-        # await sb_conn.login()
         response = await sb_conn.sb2.set_config_item(item, value)
-        # await sb_conn.logout()
         return {
             "response": response,
         }
 
     async def set_operating_mode(self, call: ServiceCall) -> ServiceResponse:
         mode = SB_OPERATING_MODES.get(call.data.get('mode'))
         sb_conn = self._get_sb_connection(call.data)
-        # await sb_conn.login()
         response = await sb_conn.set_operating_mode(mode)
-        # await sb_conn.logout()
         return {
-            "mode": response,
+            "mode": SB_OPERATING_MODES_NUM.get(str(response), "UNKNOWN")
+        }
+
+    async def set_operating_mode_num(self, call: ServiceCall) -> ServiceResponse:
+        mode = call.data.get('mode')
+        sb_conn = self._get_sb_connection(call.data)
+        response = await sb_conn.set_operating_mode(mode)
+        return {
+            "mode": response
         }
 
     async def set_tou_schedule(self, call: ServiceCall) -> ServiceResponse:
@@ -122,38 +121,37 @@ async def set_tou_schedule(self, call: ServiceCall) -> ServiceResponse:
             raise HomeAssistantError(f"Schedule is not a valid schedule: '{schedule}'") from t
 
         sb_conn = self._get_sb_connection(call.data)
-        # await sb_conn.login()
         response = await sb_conn.sb2.set_tou_schedule_string(schedule)
-        # await sb_conn.logout()
         return {
             "schedule": response["EM_ToU_Schedule"],
         }
 
     # noinspection PyUnusedLocal
     async def get_tou_schedule(self, call: ServiceCall) -> ServiceResponse:
         sb_conn = self._get_sb_connection(call.data)
-        # await sb_conn.login()
         response = await sb_conn.sb2.get_tou_schedule_string()
-        # await sb_conn.logout()
         return {
             "schedule": response,
         }
 
     # noinspection PyUnusedLocal
     async def get_battery_reserve(self, call: ServiceCall) -> ServiceResponse:
         sb_conn = self._get_sb_connection(call.data)
-        # await sb_conn.login()
         response = await sb_conn.sb2.get_battery_reserve()
-        # await sb_conn.logout()
         return {
             "backup_reserve": response,
         }
 
     async def get_operating_mode(self, call: ServiceCall) -> ServiceResponse:
         sb_conn = self._get_sb_connection(call.data)
-        # await sb_conn.login()
         response = await sb_conn.sb2.get_operating_mode()
-        # await sb_conn.logout()
+        return {
+            "operating_mode": SB_OPERATING_MODES_NUM.get(str(response), "UNKNOWN")
+        }
+
+    async def get_operating_mode_num(self, call: ServiceCall) -> ServiceResponse:
+        sb_conn = self._get_sb_connection(call.data)
+        response = await sb_conn.sb2.get_operating_mode()
         return {
             "operating_mode": response,
         }
diff --git a/custom_components/sonnenbatterie/services.yaml b/custom_components/sonnenbatterie/services.yaml
@@ -10,7 +10,28 @@ set_operating_mode:
       example: "timeofuse"
       default: "automatic"
       selector:
-        text:
+        select:
+          options:
+            - "manual"
+            - "automatic"
+            - "timeofuse"
+set_operating_mode_num:
+  fields:
+    device_id:
+      required: true
+      selector:
+        device:
+          integration: sonnenbatterie
+    mode:
+      required: true
+      example: 10
+      default: 2
+      selector:
+        select:
+          options:
+            - "1"
+            - "2"
+            - "10"
 charge_battery:
   fields:
     device_id:
@@ -100,3 +121,10 @@ get_operating_mode:
       selector:
         device:
           integration: sonnenbatterie
+get_operating_mode_num:
+  fields:
+    device_id:
+      required: true
+      selector:
+        device:
+          integration: sonnenbatterie
diff --git a/custom_components/sonnenbatterie/translations/de.json b/custom_components/sonnenbatterie/translations/de.json
@@ -194,6 +194,22 @@
                 }
             }
         },
+        "set_operating_mode_num": {
+            "name": "Setze numerischen Sonnenbatterie-Betriebsmodus",
+            "description": "Setzt den numerischen Betriebsmodus der Sonnenbatterie",
+            "fields": {
+                "device_id": {
+                    "description": "HomeAssistant ID des Geräts",
+                    "name": "Device ID",
+                    "example": "1234567890"
+                },
+                "mode": {
+                    "description": "Der zu setzende numerische Betriebsmodus ('1', '2', '10')",
+                    "name": "Betriebsmodus",
+                    "example": "2"
+                }
+            }
+        },
         "charge_battery": {
             "name": "Sonnenbatterie laden",
             "description": "Erzwingt das Laden der Sonnenbatterie mit der angegebenen Leistung",
@@ -303,7 +319,18 @@
         },
         "get_operating_mode": {
             "name": "Betriebsmodus auslesen",
-            "description": "Liefert den aktuellen Betriebsmodus der Sonnebatterie in numerischer Form",
+            "description": "Liefert den aktuellen Betriebsmodus der Sonnenbatterie in Textform",
+            "fields": {
+                "device_id": {
+                    "description": "HomeAssistant ID des Geräts",
+                    "name": "Device ID",
+                    "example": "1234567890"
+                }
+            }
+        },
+        "get_operating_mode_num": {
+            "name": "Betriebsmodus auslesen (numerisch)",
+            "description": "Liefert den aktuellen Betriebsmodus der Sonnenbatterie in numerischer Form",
             "fields": {
                 "device_id": {
                     "description": "HomeAssistant ID des Geräts",
diff --git a/custom_components/sonnenbatterie/translations/en.json b/custom_components/sonnenbatterie/translations/en.json
diff --git a/hacs.json b/hacs.json

Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,5 @@`
`8`	`8`	`"iot_class": "local_polling",`
`9`	`9`	`"issue_tracker": "https://github.com/weltmeyer/ha_sonnenbatterie/issues",`
`10`	`10`	`"requirements": ["requests","sonnenbatterie>=0.5.2"],`
`11`		`- "version": "2025.01.03"`
	`11`	`+ "version": "2025.02.01"`
`12`	`12`	`}`