Merge pull request #247 from plugwise/enable_production

bouwew · web-flow · commit 999044e12704 · 2025-06-01T17:12:46.000+02:00
Implement enable/disable production services
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 ## Versions from 0.4x
 
+### v0.51.0
+
+- Bump plugwise to [v0.41.0](https://github.com/plugwise/python-plugwise-usb/releases/tag/v0.41.0)
+- Implement services for enabling/disabling of production logging ([#247](https://github.com/plugwise/plugwise_usb-beta/pull/247))
+
 ### v0.50.1
 
 - Fix error in Number platform
diff --git a/custom_components/plugwise_usb/__init__.py b/custom_components/plugwise_usb/__init__.py
@@ -4,6 +4,7 @@
 import logging
 from typing import Any, TypedDict
 
+from homeassistant.components.device_tracker import ATTR_MAC
 from homeassistant.core import HomeAssistant, ServiceCall, callback
 from homeassistant.exceptions import ConfigEntryNotReady, HomeAssistantError
 from homeassistant.helpers import device_registry as dr, entity_registry as er
@@ -18,6 +19,9 @@
     NODES,
     PLUGWISE_USB_PLATFORMS,
     SERVICE_AUTO_JOIN,
+    SERVICE_DISABLE_PRODUCTION,
+    SERVICE_ENABLE_PRODUCTION,
+    SERVICE_USB_DEVICE_SCHEMA,
     STICK,
 )
 from .coordinator import PlugwiseUSBConfigEntry, PlugwiseUSBDataUpdateCoordinator
@@ -124,7 +128,31 @@ async def enable_auto_joining(call: ServiceCall) -> bool:
             raise HomeAssistantError(f"Failed to enable auto-joining: {exc}") from exc
         return result
 
+    async def enable_production(call: ServiceCall) -> bool:
+        """Enable production-logging for a Node."""
+        mac = call.data[ATTR_MAC]
+        try:
+            result = await api_stick.set_energy_intervals(mac, 60, 60)
+        except (NodeError, StickError) as exc:
+            raise HomeAssistantError(f"Failed to enable production: {exc}") from exc
+        return result
+
+    async def disable_production(call: ServiceCall) -> bool:
+        """Disable production-logging for a Node."""
+        mac = call.data[ATTR_MAC]
+        try:
+            result = await api_stick.set_energy_intervals(mac, 60, 0)
+        except (NodeError, StickError) as exc:
+            raise HomeAssistantError(f"Failed to disable production: {exc}") from exc
+        return result
+
     hass.services.async_register(DOMAIN, SERVICE_AUTO_JOIN, enable_auto_joining)
+    hass.services.async_register(
+        DOMAIN, SERVICE_ENABLE_PRODUCTION, enable_production, SERVICE_USB_DEVICE_SCHEMA
+    )
+    hass.services.async_register(
+        DOMAIN, SERVICE_DISABLE_PRODUCTION, disable_production, SERVICE_USB_DEVICE_SCHEMA
+    )
 
     # Initiate background nodes discovery task
     config_entry.async_create_task(
diff --git a/custom_components/plugwise_usb/const.py b/custom_components/plugwise_usb/const.py
@@ -5,45 +5,50 @@
 
 import voluptuous as vol
 
+from homeassistant.components.device_tracker import ATTR_MAC
 from homeassistant.const import Platform
 from homeassistant.helpers import config_validation as cv
 
-DOMAIN: Final = "plugwise_usb"
+DOMAIN: Final[str] = "plugwise_usb"
 
 LOGGER = logging.getLogger(__package__)
-UNSUB_NODE_LOADED: Final = "Unsubcribe_from_node_loaded_event"
-COORDINATOR: Final = "coordinator"
-CONF_MANUAL_PATH: Final = "Enter Manually"
-MANUAL_PATH: Final = "manual_path"
-STICK: Final = "stick"
-NODES: Final = "nodes"
-USB: Final = "usb"
+UNSUB_NODE_LOADED: Final[str] = "Unsubcribe_from_node_loaded_event"
+COORDINATOR: Final[str] = "coordinator"
+CONF_MANUAL_PATH: Final[str] = "Enter Manually"
+MANUAL_PATH: Final[str] = "manual_path"
+STICK: Final[str] = "stick"
+NODES: Final[str] = "nodes"
+USB: Final[str] = "usb"
 
-UNDO_UPDATE_LISTENER: Final = "undo_update_listener"
+UNDO_UPDATE_LISTENER: Final[str] = "undo_update_listener"
 
 PLUGWISE_USB_PLATFORMS: Final[list[str]] = [
     Platform.BINARY_SENSOR,
     Platform.NUMBER,
     Platform.SENSOR,
     Platform.SWITCH,
 ]
-CONF_USB_PATH: Final = "usb_path"
-
-ATTR_MAC_ADDRESS: Final = "mac"
-
-SERVICE_AUTO_JOIN: Final = "enable_auto_joining"
+CONF_USB_PATH: Final[str] = "usb_path"
+SERVICE_AUTO_JOIN: Final[str] = "enable_auto_joining"
+SERVICE_DISABLE_PRODUCTION: Final[str] = "disable_production"
+SERVICE_ENABLE_PRODUCTION: Final[str] = "enable_production"
 SERVICE_USB_DEVICE_SCHEMA: Final = vol.Schema(
-    {vol.Required(ATTR_MAC_ADDRESS): cv.string}
+    {
+        vol.Required(ATTR_MAC): vol.All(
+            cv.string,
+            vol.Match(r"^[0-9A-Fa-f]{16}$")
+        )
+    }
 )
 
 # USB SED (battery powered) device constants
-ATTR_SED_STAY_ACTIVE: Final = "stay_active"
-ATTR_SED_SLEEP_FOR: Final = "sleep_for"
-ATTR_SED_MAINTENANCE_INTERVAL: Final = "maintenance_interval"
-ATTR_SED_CLOCK_SYNC: Final = "clock_sync"
-ATTR_SED_CLOCK_INTERVAL: Final = "clock_interval"
+ATTR_SED_STAY_ACTIVE: Final[str] = "stay_active"
+ATTR_SED_SLEEP_FOR: Final[str] = "sleep_for"
+ATTR_SED_MAINTENANCE_INTERVAL: Final[str] = "maintenance_interval"
+ATTR_SED_CLOCK_SYNC: Final[str] = "clock_sync"
+ATTR_SED_CLOCK_INTERVAL: Final[str] = "clock_interval"
 
-SERVICE_USB_SED_BATTERY_CONFIG: Final = "configure_battery_savings"
+SERVICE_USB_SED_BATTERY_CONFIG: Final[str] = "configure_battery_savings"
 SERVICE_USB_SED_BATTERY_CONFIG_SCHEMA: Final = {
     vol.Required(ATTR_SED_STAY_ACTIVE): vol.All(
         vol.Coerce(int), vol.Range(min=1, max=120)
@@ -62,20 +67,20 @@
 
 
 # USB Scan device constants
-ATTR_SCAN_DAYLIGHT_MODE: Final = "day_light"
-ATTR_SCAN_SENSITIVITY_MODE: Final = "sensitivity_mode"
-ATTR_SCAN_RESET_TIMER: Final = "reset_timer"
+ATTR_SCAN_DAYLIGHT_MODE: Final[str] = "day_light"
+ATTR_SCAN_SENSITIVITY_MODE: Final[str] = "sensitivity_mode"
+ATTR_SCAN_RESET_TIMER: Final[str] = "reset_timer"
 
-SCAN_SENSITIVITY_HIGH: Final = "high"
-SCAN_SENSITIVITY_MEDIUM: Final = "medium"
-SCAN_SENSITIVITY_OFF: Final = "off"
+SCAN_SENSITIVITY_HIGH: Final[str] = "high"
+SCAN_SENSITIVITY_MEDIUM: Final[str] = "medium"
+SCAN_SENSITIVITY_OFF: Final[str] = "off"
 SCAN_SENSITIVITY_MODES = [
     SCAN_SENSITIVITY_HIGH,
     SCAN_SENSITIVITY_MEDIUM,
     SCAN_SENSITIVITY_OFF,
 ]
 
-SERVICE_USB_SCAN_CONFIG: Final = "configure_scan"
+SERVICE_USB_SCAN_CONFIG: Final[str] = "configure_scan"
 SERVICE_USB_SCAN_CONFIG_SCHEMA = (
     {
         vol.Required(ATTR_SCAN_SENSITIVITY_MODE): vol.In(SCAN_SENSITIVITY_MODES),
diff --git a/custom_components/plugwise_usb/manifest.json b/custom_components/plugwise_usb/manifest.json
@@ -8,6 +8,6 @@
   "integration_type": "hub",
   "iot_class": "local_polling",
   "loggers": ["plugwise_usb"],
-  "requirements": ["plugwise-usb==0.40.0"],
-  "version": "0.50.2"
+  "requirements": ["plugwise-usb==0.41.0"],
+  "version": "0.51.0"
 }
diff --git a/custom_components/plugwise_usb/services.yaml b/custom_components/plugwise_usb/services.yaml
@@ -1,5 +1,15 @@
 enable_auto_joining:
   description: First enable auto-joining, then reset the Plugwise devices
+enable_production:
+  description: "Enable production logging for a Plugwise USB node by MAC address"
+  fields:
+    mac:
+      example: "data: {mac: 0123456789ABCDEF}"
+disable_production:
+  description: "Disable production logging for a Plugwise USB node by MAC address"
+  fields:
+    mac:
+      example: "data: {mac: 0123456789ABCDEF}"
 configure_scan:
   fields:
     entity_id:
diff --git a/custom_components/plugwise_usb/strings.json b/custom_components/plugwise_usb/strings.json
@@ -27,6 +27,26 @@
       "name": "Enable Plugwise device auto-joining (temporarily)",
       "description": "First enable this service then reset the Plugwise device(s) to join"
     },
+    "enable_production":{
+      "name": "Enable production logging",
+      "description": "Enter the mac of the Node: (data = mac: 0123456789ABCDEF)",
+      "fields": {
+        "mac": {
+          "name": "MAC address",
+          "description": "The full 16 character MAC address of the plugwise device."
+        }
+      }
+    },
+    "disable_production":{
+      "name": "Disable production logging, return to consumption logging only",
+      "description": "Enter the mac of the Node: (data = mac: 0123456789ABCDEF)",
+      "fields": {
+        "mac": {
+          "name": "MAC address",
+          "description": "The full 16 character MAC address of the plugwise device."
+        }
+      }
+    },
     "configure_scan": {
       "name": "Configure motion settings",
       "description": "Configure the motion settings for a Plugwise Scan device. The new configuration will be send soon as the Scan devices is awake to receive configuration changes. For quick activation press the local button to awake the device.",
diff --git a/custom_components/plugwise_usb/translations/en.json b/custom_components/plugwise_usb/translations/en.json
@@ -27,6 +27,26 @@
       "name": "Enable Plugwise device auto-joining (temporarily)",
       "description": "First enable this service then reset the Plugwise device(s) to join"
     },
+    "enable_production":{
+      "name": "Enable production logging",
+      "description": "Enter the mac of the Node: (data = mac: 0123456789ABCDEF)",
+      "fields": {
+        "mac": {
+          "name": "MAC address",
+          "description": "The full 16 character MAC address of the plugwise device."
+        }
+      }
+    },
+    "disable_production":{
+      "name": "Disable production logging, return to consumption logging only",
+      "description": "Enter the mac of the Node: (data = mac: 0123456789ABCDEF)",
+      "fields": {
+        "mac": {
+          "name": "MAC address",
+          "description": "The full 16 character MAC address of the plugwise device."
+        }
+      }
+    },
     "configure_scan": {
       "name": "Configure motion settings",
       "description": "Configure the motion settings for a Plugwise Scan device. The new configuration will be send soon as the Scan devices is awake to receive configuration changes. For quick activation press the local button to awake the device.",
diff --git a/custom_components/plugwise_usb/translations/nl.json b/custom_components/plugwise_usb/translations/nl.json
@@ -27,6 +27,26 @@
       "name": "Zet Plugwise auto-toevoegen aan (tijdelijk)",
       "description": "Voer eerst deze service uit en reset dan het toe te voegen Plugwise apparaat"
     },
+    "enable_production":{
+      "name": "Zet productie-loggen aan",
+      "description": "Voer het mac-adres van de Node in: (data = mac: 0123456789ABSDEF)",
+      "fields": {
+        "mac": {
+          "name": "MAC adres",
+          "description": "Het volledige MAC address (16 karakters) van het plugwise apparaat."
+        }
+      }
+    },
+    "disable_production":{
+      "name": "Zet productie-loggen uit, alleen consumptie-loggen actief",
+      "description": "Voer het mac-adres van de Node in: (data = mac: 0123456789ABSDEF)",
+      "fields": {
+        "mac": {
+          "name": "MAC adres",
+          "description": "Het volledige MAC address (16 karakters) van het plugwise apparaat."
+        }
+      }
+    },
     "configure_scan": {
       "name": "Configureer bewegingsinstellingen voor een Plugwise Scan apparaat",
       "description": "Configureert bewegingsinstellingen voor een Plugwise Scan apparaat.",

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,6 @@`
`8`	`8`	`"integration_type": "hub",`
`9`	`9`	`"iot_class": "local_polling",`
`10`	`10`	`"loggers": ["plugwise_usb"],`
`11`		`- "requirements": ["plugwise-usb==0.40.0"],`
`12`		`- "version": "0.50.2"`
	`11`	`+ "requirements": ["plugwise-usb==0.41.0"],`
	`12`	`+ "version": "0.51.0"`
`13`	`13`	`}`