boneIO 0.11.3__tar.gz → 0.12.0.dev1__tar.gz

{boneio-0.11.3 → boneio-0.12.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: boneio
-Version: 0.11.3
+Version: 0.12.0.dev1
 Summary: Python App for BoneIO
 License: GNU General Public License v3.0
 Author-email: Paweł Szafer <pszafer@gmail.com>

{boneio-0.11.3 → boneio-0.12.0.dev1}/boneio/const.py

@@ -47,6 +47,7 @@ MAC = "mac"
 NONE = "none"
 MODBUS = "modbus"
 MODBUS_SENSOR  = "modbus_sensor"
+MODBUS_DEVICE = "modbus_device"
 UART = "uart"
 RX = "rx"
 TX = "tx"
@@ -126,6 +127,10 @@ OUTPUT_GROUP = "output_group"
 TEMPERATURE = "temperature"
 EVENT_ENTITY = "event"
 SENSOR = "sensor"
+TEXT_SENSOR = "text_sensor"
+SELECT = "select"
+CLIMATE = "climate"
+NUMERIC = "number"
 BINARY_SENSOR = "binary_sensor"
 LM75 = "lm75"
 MCP_TEMP_9808 = "mcp9808"

{boneio-0.11.3 → boneio-0.12.0.dev1}/boneio/example_config/24x16/event.yaml

@@ -3,25 +3,25 @@
 # PINs are shared between event.yaml and binary_sensor.yaml.
 # Don't duplicate PINs.
 
-# IN_01 and IN_02 are enabled in binary_sensor.yaml by default.
-# - id: IN_01
-#   boneio_input: IN_01
-#   actions:
-#     single:
-#       - action: output
-#         pin: OUT_01
-#     double:
-#       - action: output
-#         pin: OUT_01
-# - id: IN_02
-#   boneio_input: IN_02
-#   actions:
-#     single:
-#       - action: output
-#         pin: OUT_01
-#     double:
-#       - action: output
-#         pin: OUT_01
+# IN_48 and IN_49 are enabled in binary_sensor.yaml by default.
+- id: IN_01
+  boneio_input: IN_01
+  actions:
+    single:
+      - action: output
+        pin: OUT_01
+    double:
+      - action: output
+        pin: OUT_01
+- id: IN_02
+  boneio_input: IN_02
+  actions:
+    single:
+      - action: output
+        pin: OUT_01
+    double:
+      - action: output
+        pin: OUT_01
 - id: IN_03
   boneio_input: IN_03
   actions:
@@ -191,7 +191,6 @@
   boneio_input: IN_38
 - id: IN_39
   boneio_input: IN_39
-
 - id: IN_40
   boneio_input: IN_40
 - id: IN_41
@@ -206,8 +205,8 @@
   boneio_input: IN_45
 - id: IN_46
   boneio_input: IN_46
-# - id: IN_47
-#   boneio_input: IN_47
+- id: IN_47
+  boneio_input: IN_47
 # - id: IN_48
 #   boneio_input: IN_48
 # - id: IN_49

{boneio-0.11.3 → boneio-0.12.0.dev1}/boneio/example_config/32x10/binary_sensor.yaml

@@ -3,18 +3,23 @@
 # PINs are shared between event.yaml and binary_sensor.yaml.
 # Don't duplicate PINs.
 
-- id: IN_01
-  boneio_input: IN_01
+- id: IN_48
+  boneio_input: IN_48
   actions:
     pressed:
       - action: output
         pin: OUT_01
-- id: IN_02
-  boneio_input: IN_02
+- id: IN_49
+  boneio_input: IN_49
   actions:
     pressed:
       - action: output
         pin: OUT_02
+
+# - id: IN_01
+#   boneio_input: IN_01
+# - id: IN_02
+#   boneio_input: IN_02
 # - id: IN_03
 #   boneio_input: IN_03
 # - id: IN_04
@@ -104,8 +109,4 @@
 # - id: IN_46
 #   boneio_input: IN_46
 # - id: IN_47
-#   boneio_input: IN_47
-# - id: IN_48
-#   boneio_input: IN_48
-# - id: IN_49
-#   boneio_input: IN_49
+#   boneio_input: IN_47

{boneio-0.11.3 → boneio-0.12.0.dev1}/boneio/example_config/32x10/event.yaml

@@ -3,25 +3,25 @@
 # PINs are shared between event.yaml and binary_sensor.yaml.
 # Don't duplicate PINs.
 
-# IN_01 and IN_02 are enabled in binary_sensor.yaml by default.
-# - id: IN_01
-#   boneio_input: IN_01
-#   actions:
-#     single:
-#       - action: output
-#         pin: OUT_01
-#     double:
-#       - action: output
-#         pin: OUT_01
-# - id: IN_02
-#   boneio_input: IN_02
-#   actions:
-#     single:
-#       - action: output
-#         pin: OUT_01
-#     double:
-#       - action: output
-#         pin: OUT_01
+# IN_48 and IN_49 are enabled in binary_sensor.yaml by default.
+- id: IN_01
+  boneio_input: IN_01
+  actions:
+    single:
+      - action: output
+        pin: OUT_01
+    double:
+      - action: output
+        pin: OUT_01
+- id: IN_02
+  boneio_input: IN_02
+  actions:
+    single:
+      - action: output
+        pin: OUT_01
+    double:
+      - action: output
+        pin: OUT_01
 - id: IN_03
   boneio_input: IN_03
   actions:
@@ -239,8 +239,8 @@
   boneio_input: IN_45
 - id: IN_46
   boneio_input: IN_46
-# - id: IN_47
-#   boneio_input: IN_47
+- id: IN_47
+  boneio_input: IN_47
 # - id: IN_48
 #   boneio_input: IN_48
 # - id: IN_49

{boneio-0.11.3 → boneio-0.12.0.dev1}/boneio/helper/config.py

@@ -15,8 +15,11 @@ from boneio.const import (
     EVENT_ENTITY,
     HOMEASSISTANT,
     LIGHT,
+    NUMERIC,
+    SELECT,
     SENSOR,
     SWITCH,
+    TEXT_SENSOR,
     VALVE,
 )
 from boneio.helper.util import sanitize_mqtt_topic
@@ -51,6 +54,9 @@ class ConfigHelper:
             BUTTON: {},
             EVENT_ENTITY: {},
             VALVE: {},
+            TEXT_SENSOR: {},
+            SELECT: {},
+            NUMERIC: {},
         }
         self.manager_ready: bool = False
         self._network_info = network_info

{boneio-0.11.3 → boneio-0.12.0.dev1}/boneio/helper/events.py

@@ -327,8 +327,9 @@ def as_utc(dattim: dt.datetime) -> dt.datetime:
 @callback
 def async_track_point_in_time(
     loop: asyncio.AbstractEventLoop,
-    action,
+    job,
     point_in_time: datetime,
+    **kwargs
 ) -> CALLBACK_TYPE:
     """Add a listener that fires once after a specific point in UTC time."""
     # Ensure point_in_time is UTC
@@ -356,10 +357,13 @@ def async_track_point_in_time(
             cancel_callback = loop.call_later(delta, run_action, job)
             return
 
-        loop.call_soon(job, utc_point_in_time)
+        if asyncio.iscoroutinefunction(job):
+            loop.create_task(job(utc_point_in_time, **kwargs))
+        else:
+            loop.call_soon(job, utc_point_in_time, **kwargs)
 
     delta = expected_fire_timestamp - time.time()
-    cancel_callback = loop.call_later(delta, run_action, action)
+    cancel_callback = loop.call_later(delta, run_action, job)
 
     @callback
     def unsub_point_in_time_listener() -> None:

{boneio-0.11.3 → boneio-0.12.0.dev1}/boneio/helper/filter.py

@@ -14,7 +14,8 @@ FILTERS = {
     "multiply": lambda x, y: x * y if x else x,
     "filter_out": lambda x, y: None if x == y else x,
     "filter_out_greater": lambda x, y: None if x > y else x,
-    "filter_out_lower": lambda x, y: None if x < y else x
+    "filter_out_lower": lambda x, y: None if x < y else x,
+    "encode_temperature": lambda x, y: (int(x * y) << 1) | 1,
 }
 
 

{boneio-0.11.3 → boneio-0.12.0.dev1}/boneio/helper/ha_discovery.py

@@ -9,11 +9,13 @@ from boneio.const import (
     INPUT,
     INPUT_SENSOR,
     LONG,
+    NUMERIC,
     OFF,
     ON,
     OPEN,
     OPENING,
     RELAY,
+    SELECT,
     SENSOR,
     SINGLE,
     STATE,
@@ -215,6 +217,31 @@ def ha_sensor_temp_availabilty_message(
         **kwargs,
     }
 
+def modbus_availabilty_message(
+    id: str,
+    entity_id: str,
+    name: str,
+    state_topic_base: str,
+    topic: str,
+    model: str,
+    device_type: str = SENSOR,
+    **kwargs,
+):
+    """Create Modbus availability topic for HA."""
+    return {
+        "availability": [{"topic": f"{topic}/{id}/{STATE}"}],
+        "device": {
+            "identifiers": [id],
+            "manufacturer": "boneIO",
+            "model": model,
+            "name": name,
+            "sw_version": __version__,
+        },
+        "name": entity_id,
+        "state_topic": f"{topic}/{device_type}/{id}/{state_topic_base}",
+        "unique_id": f"{topic}{entity_id.replace('_', '').lower()}{name.lower()}",
+        **kwargs,
+    }
 
 def modbus_sensor_availabilty_message(
     id: str,
@@ -242,6 +269,59 @@ def modbus_sensor_availabilty_message(
         **kwargs,
     }
 
+def modbus_select_availabilty_message(
+    id: str,
+    entity_id: str,
+    name: str,
+    state_topic_base: str,
+    topic: str,
+    model: str,
+    device_type: str = SELECT,
+    **kwargs,
+):
+    """Create Modbus Select availability topic for HA."""
+    return {
+        "availability": [{"topic": f"{topic}/{id}/{STATE}"}],
+        "device": {
+            "identifiers": [id],
+            "manufacturer": "boneIO",
+            "model": model,
+            "name": name,
+            "sw_version": __version__,
+        },
+        "name": entity_id,
+        "state_topic": f"{topic}/{device_type}/{id}/{state_topic_base}",
+        "unique_id": f"{topic}{entity_id.replace('_', '').lower()}{name.lower()}",
+        **kwargs,
+    }
+
+
+def modbus_numeric_availabilty_message(
+    id: str,
+    entity_id: str,
+    name: str,
+    state_topic_base: str,
+    topic: str,
+    model: str,
+    device_type: str = NUMERIC,
+    **kwargs,
+):
+    """Create Modbus Numeric availability topic for HA."""
+    return {
+        "availability": [{"topic": f"{topic}/{id}/{STATE}"}],
+        "device": {
+            "identifiers": [id],
+            "manufacturer": "boneIO",
+            "model": model,
+            "name": name,
+            "sw_version": __version__,
+        },
+        "name": entity_id,
+        "state_topic": f"{topic}/{device_type}/{id}/{state_topic_base}",
+        "unique_id": f"{topic}{entity_id.replace('_', '').lower()}{name.lower()}",
+        **kwargs,
+    }
+
 
 def ha_cover_availabilty_message(
     id: str, name: str, device_class: str, topic: str = "boneIO", model: str = "boneIO Relay Board", **kwargs

{boneio-0.11.3 → boneio-0.12.0.dev1}/boneio/helper/util.py

@@ -1,6 +1,6 @@
-import unicodedata
-import os
 import json
+import os
+import unicodedata
 from typing import Any, Callable, TypeVar
 
 CALLABLE_T = TypeVar("CALLABLE_T", bound=Callable[..., Any])
@@ -39,6 +39,7 @@ def sanitize_mqtt_topic(name: str) -> str:
         str: Sanitized string
     """
     import re
+
     from .logger import _LOGGER
 
     original = name
@@ -58,3 +59,9 @@ def open_json(path: str, model: str) -> dict:
     with open(file, "r") as db_file:
         datastore = json.load(db_file)
         return datastore
+
+def find_key_by_value(d, value):
+    for k, v in d.items():
+        if v == value:
+            return k
+    return None

{boneio-0.11.3 → boneio-0.12.0.dev1}/boneio/manager.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import asyncio
+import json
 import logging
 from collections import deque
 from typing import Callable, Coroutine, List, Optional, Set, Tuple
@@ -28,7 +29,6 @@ from boneio.const import (
     LM75,
     MCP,
     MCP_TEMP_9808,
-    MODBUS,
     MQTT,
     NONE,
     ON,
@@ -118,6 +118,7 @@ class Manager:
         output_group: List = [],
         sensors: dict = {},
         modbus: dict = {},
+        modbus_devices: dict = {},
         pca9685: list = [],
         mcp23017: list = [],
         pcf8575: list = [],
@@ -252,7 +253,7 @@ class Manager:
             message_bus=self._message_bus,
             topic_prefix=self._config_helper.topic_prefix,
         )
-        self._modbus_coordinators = self._configure_modbus_coordinators(entries=sensors)
+        self._modbus_coordinators = self._configure_modbus_coordinators(devices=modbus_devices)
 
         if oled.get("enabled", False):
             from boneio.oled import Oled
@@ -628,15 +629,15 @@ class Manager:
                 if ina219:
                     self._ina219_sensors.append(ina219)
 
-    def _configure_modbus_coordinators(self, entries: dict) -> dict:
-        if entries.get(MODBUS) and self._modbus:
+    def _configure_modbus_coordinators(self, devices: dict) -> dict:
+        if devices and self._modbus:
             from boneio.helper.loader import create_modbus_coordinators
 
             return create_modbus_coordinators(
                 manager=self,
                 message_bus=self._message_bus,
                 event_bus=self._event_bus,
-                entries=entries.get(MODBUS),
+                entries=devices,
                 modbus=self._modbus,
                 config_helper=self._config_helper,
             )
@@ -947,6 +948,13 @@ class Manager:
             elif device_id == "cover_reload" and message == "cover_reload":
                 _LOGGER.info("Reloading covers actions")
                 self._configure_covers(reload_config=True)
+        elif msg_type == "modbus" and command == "set":
+            target_device = self._modbus_coordinators.get(device_id)
+            if target_device:
+                if isinstance(message, str):
+                    message = json.loads(message)
+                    if "device" in message and "value" in message:
+                        await target_device.write_register(value=message["value"], entity=message["device"])
 
     async def restart_request(self) -> None:
         _LOGGER.info("Restarting process. Systemd should restart it soon.")

{boneio-0.11.3 → boneio-0.12.0.dev1}/boneio/modbus/client.py

@@ -7,6 +7,11 @@ import time
 from concurrent.futures import ThreadPoolExecutor
 from typing import Any
 
+from pymodbus.client.common import (
+    ReadCoilsResponse,
+    ReadHoldingRegistersResponse,
+    WriteSingleRegisterResponse,
+)
 from pymodbus.client.sync import BaseModbusClient, ModbusSerialClient
 from pymodbus.constants import Endian
 from pymodbus.exceptions import ModbusException
@@ -127,6 +132,7 @@ class Modbus:
             self._read_methods = {
                 "input": self._client.read_input_registers,
                 "holding": self._client.read_holding_registers,
+                "coil": self._client.read_coils,
             }
         except ModbusException as exception_error:
             _LOGGER.error(exception_error)
@@ -202,7 +208,7 @@ class Modbus:
             )
 
             # Run the read operation in the executor
-            result: ReadInputRegistersResponse = read_method(address, **kwargs)
+            result: ReadInputRegistersResponse | ReadHoldingRegistersResponse | ReadCoilsResponse = read_method(address, **kwargs)
 
             if not hasattr(result, REGISTERS):
                 _LOGGER.error("No result from read: %s", str(result))
@@ -232,6 +238,54 @@ class Modbus:
             )
             return result
 
+    def write_register_blocking(self, unit: int | str, address: int, value: int | float) -> ModbusResponse:
+        """Call async pymodbus."""
+        start_time = time.perf_counter()
+        result = None
+        try:
+            # Run connection in the executor
+            connected = self._pymodbus_connect()
+            if not connected:
+                _LOGGER.error("Can't connect to Modbus.")
+                return None
+
+            _LOGGER.debug(
+                "Writing register %s with value %s to device %s.",
+                address,
+                value,
+                unit,
+            )
+
+            # Run the read operation in the executor
+            result: WriteSingleRegisterResponse = self._client.write_register(address=address, value=value, unit=unit)
+
+            if result.isError():
+                _LOGGER.error("Operation failed.")
+                result = None
+
+        except ValueError as exception_error:
+            _LOGGER.error("ValueError: Error writing registers: %s", exception_error)
+            pass
+        except (ModbusException, struct.error) as exception_error:
+            _LOGGER.error("ModbusException: Error writing registers: %s", exception_error)
+            pass
+        except asyncio.TimeoutError:
+            _LOGGER.error("Timeout writing registers to device %s", unit)
+            pass
+        except asyncio.CancelledError as err:
+            _LOGGER.error("Operation cancelled writing registers to device %s with error %s", unit, err)
+            pass
+        except Exception as e:
+            _LOGGER.error(f"Unexpected error writing registers: {type(e).__name__} - {e}")
+            pass
+        finally:
+            end_time = time.perf_counter()
+            _LOGGER.debug(
+                "Write completed in %.3f seconds.",
+                end_time - start_time,
+            )
+            return result
+
     async def read_registers(
         self,
         unit: int | str,  # device address
@@ -251,3 +305,8 @@ class Modbus:
         )
         value = getattr(decoder, _payload_type["f"])()
         return value
+
+    async def write_register(self, unit: int | str, address: int, value: int | float) -> ModbusResponse:
+        """Call async pymodbus."""
+        async with self._lock:
+            return await self._loop.run_in_executor(self._executor, self.write_register_blocking, unit, address, value)