boneIO 0.8.0.dev8__tar.gz → 0.8.0.dev9__tar.gz

{boneIO-0.8.0.dev8 → boneIO-0.8.0.dev9}/PKG-INFO

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

{boneIO-0.8.0.dev8 → boneIO-0.8.0.dev9}/boneio/bonecli.py

@@ -13,7 +13,11 @@ import sys
 from colorlog import ColoredFormatter
 from yaml import MarkedYAMLError
 
-from boneio.modbus.modbuscli import async_run_modbus_set, async_run_modbus_get
+from boneio.modbus.modbuscli import (
+    async_run_modbus_set,
+    async_run_modbus_get,
+    async_run_modbus_search,
+)
 from boneio.modbus.client import VALUE_TYPES
 
 
@@ -99,13 +103,14 @@ def get_arguments() -> argparse.Namespace:
     modbus_parser.add_argument(
         "--address",
         type=lambda x: int(x, 0),
-        required=True,
+        required=False,
+        default=1,
         help="Current device address (hex or integer)",
     )
     modbus_parser.add_argument(
         "--baudrate",
         type=int,
-        choices=[2400, 4800, 9600, 19200],
+        choices=[2400, 4800, 9600, 14400, 19200],
         required=True,
         help="Current baudrate",
     )
@@ -139,11 +144,21 @@ def get_arguments() -> argparse.Namespace:
         dest="modbus_action", required=True
     )
     set_modbus_parser = modbus_sub_parser.add_parser("set")
+    set_modbus_parser.add_argument(
+        "--custom-value",
+        type=int,
+        help="Set Custom value",
+    )
+    set_modbus_parser.add_argument(
+        "--custom-register-address",
+        type=int,
+        help="Register address for custom value",
+    )
     set_modbus_parser.add_argument(
         "--device",
         type=str,
-        choices=["cwt", "r4dcb08"],
-        help="Choose device to set modbus address/baudrate",
+        choices=["cwt", "r4dcb08", "liquid-sensor", "sht20", "custom"],
+        help="Choose device to set modbus address/baudrate. For custom you must provide --custom-value and --custom-register-address",
         required=True,
     )
     set_modbus_parser_group = set_modbus_parser.add_mutually_exclusive_group()
@@ -182,6 +197,23 @@ def get_arguments() -> argparse.Namespace:
         required=True,
     )
     parser.add_argument("--version", action="version", version=__version__)
+    search_modbus_parser = modbus_sub_parser.add_parser(
+        name="search",
+        help="Search for device. Iterate over every address 1-253 with provided register address",
+    )
+    search_modbus_parser.add_argument(
+        "--register-address",
+        type=int,
+        help="Register address",
+        required=True,
+    )
+    search_modbus_parser.add_argument(
+        "--register-type",
+        type=str,
+        choices=["input", "holding"],
+        help="Register type",
+        required=True,
+    )
     arguments = parser.parse_args()
 
     return arguments
@@ -223,6 +255,7 @@ def run_modbus_command(
     _LOGGER.info("BoneIO %s starting.", __version__)
     try:
         configure_logger(log_config={}, debug=args.debug)
+        ret = 0
         if args.modbus_action == "set":
             ret = asyncio.run(
                 async_run_modbus_set(
@@ -235,9 +268,11 @@ def run_modbus_command(
                     stopbits=args.stopbits,
                     new_baudrate=args.new_baudrate,
                     new_address=args.new_address,
+                    custom_address=args.custom_register_address,
+                    custom_value=args.custom_value,
                 ),
             )
-        else:
+        elif args.modbus_action == "get":
             ret = asyncio.run(
                 async_run_modbus_get(
                     uart=args.uart,
@@ -251,6 +286,18 @@ def run_modbus_command(
                     value_type=args.value_type,
                 ),
             )
+        else:
+            ret = asyncio.run(
+                async_run_modbus_search(
+                    uart=args.uart,
+                    baudrate=args.baudrate,
+                    register_address=args.register_address,
+                    register_type=args.register_type,
+                    parity=args.parity,
+                    bytesize=args.bytesize,
+                    stopbits=args.stopbits,
+                ),
+            )
         return ret
     except (RestartRequestException, GracefulExit) as err:
         if err is not None:
@@ -281,7 +328,10 @@ def main() -> int:
             args=args,
         )
 
-    _LOGGER.info("Exiting with exit code %s", exit_code)
+    if exit_code == 0:
+        _LOGGER.info("Exiting with exit code %s", exit_code)
+    else:
+        _LOGGER.error("Exiting with exit code %s", exit_code)
     return exit_code
 
 

{boneIO-0.8.0.dev8 → boneIO-0.8.0.dev9}/boneio/helper/filter.py

@@ -19,8 +19,9 @@ FILTERS = {
 class Filter:
     _filters = []
 
-    def _apply_filters(self, value: float) -> float | None:
-        for filter in self._filters:
+    def _apply_filters(self, value: float, filters: list = []) -> float | None:
+        filters = filters if filters else self._filters
+        for filter in filters:
             for k, v in filter.items():
                 if k not in FILTERS:
                     _LOGGER.warning(

{boneIO-0.8.0.dev8 → boneIO-0.8.0.dev9}/boneio/helper/loader.py

@@ -211,6 +211,7 @@ def create_modbus_sensors(manager: Manager, sensors, **kwargs) -> None:
                 update_interval=sensor.get(
                     UPDATE_INTERVAL, TimePeriod(seconds=60)
                 ),
+                sensors_filters=sensor.get("sensors_filters", {}),
                 **kwargs,
             )
         except FileNotFoundError as err:

{boneIO-0.8.0.dev8 → boneIO-0.8.0.dev9}/boneio/modbus/client.py

@@ -43,6 +43,7 @@ class Modbus:
         stopbits: int = 1,
         bytesize: int = 8,
         parity: str = "N",
+        timeout: float = 3,
     ) -> None:
         """Initialize the Modbus hub."""
         rx = uart.get(RX)
@@ -68,6 +69,7 @@ class Modbus:
                 stopbits=stopbits,
                 bytesize=bytesize,
                 parity=parity,
+                timeout=timeout,
             )
             self._read_methods = {
                 "input": self._client.read_input_registers,

{boneIO-0.8.0.dev8 → boneIO-0.8.0.dev9}/boneio/modbus/cwt.json

@@ -4,7 +4,7 @@
     "set_address_address": 2000,
     "set_baudrate": {
       "address": 2001,
-      "possible_baudrates": [2400, 4800, 9600, 19200]
+      "possible_baudrates": { "2400": 0, "4800": 1, "9600": 2, "19200": 3 }
     }
   },
   "registers_base": [

boneIO-0.8.0.dev9/boneio/modbus/liquid-sensor.json

@@ -0,0 +1,37 @@
+{
+  "model": "Liquid sensor",
+  "set_base": {
+    "set_address_address": 0,
+    "set_baudrate": {
+      "address": 1,
+      "possible_baudrates": {
+        "1200": 0,
+        "2400": 1,
+        "4800": 2,
+        "9600": 3,
+        "19200": 4,
+        "38400": 5,
+        "57600": 6,
+        "115200": 7
+      }
+    }
+  },
+  "registers_base": [
+    {
+      "base": 0,
+      "length": 2,
+      "register_type": "holding",
+      "registers": [
+        {
+          "name": "Immersion depth",
+          "address": 0,
+          "unit_of_measurement": "mm",
+          "state_class": "measurement",
+          "device_class": "humidity",
+          "value_type": "S_WORD",
+          "filters": [{ "multiply": 0.1 }]
+        }
+      ]
+    }
+  ]
+}

{boneIO-0.8.0.dev8 → boneIO-0.8.0.dev9}/boneio/modbus/modbuscli.py

@@ -78,7 +78,7 @@ class ModbusHelper:
 
     def set_connection_speed(self, new_baudrate: int) -> int:
         baudrate_model = self._model[SET_BAUDRATE]
-        ind = baudrate_model["possible_baudrates"].index(new_baudrate)
+        ind = baudrate_model["possible_baudrates"].get(str(new_baudrate))
         if ind:
             result = self._modbus.client.write_register(
                 address=baudrate_model["address"],
@@ -110,6 +110,19 @@ class ModbusHelper:
         else:
             _LOGGER.error("Invalid new address.")
 
+    def set_custom_command(self, register_address: int, value: int | float):
+        result = self._modbus.client.write_register(
+            address=register_address,
+            value=value,
+            unit=self._device_address,
+        )
+        if result.isError():
+            _LOGGER.error("Operation failed.")
+        else:
+            _LOGGER.info(
+                "Operation succeeded. Now restart device by disconnecting it."
+            )
+
 
 async def async_run_modbus_set(
     device: str,
@@ -118,6 +131,8 @@ async def async_run_modbus_set(
     baudrate: int,
     new_baudrate: int,
     new_address: int,
+    custom_address: int,
+    custom_value: int,
     stopbits: int = 1,
     bytesize: int = 8,
     parity: str = "N",
@@ -125,15 +140,21 @@ async def async_run_modbus_set(
     """Run Modbus Set Function."""
     if new_address and new_baudrate:
         _LOGGER.error("Can't set both methods new_address and new_baudrate.")
-    _db = open_json(path=os.path.dirname(__file__), model=device)
-    set_base = _db.get(SET_BASE, {})
-    first_reg_base = _db.get(REGISTERS_BASE, [])[0]
-    if not first_reg_base:
-        return False
-    first_record = first_reg_base.get(REGISTERS, [])[0]
-    _LOGGER.debug(
-        f"Connecting with params uart: {uart}, baudrate: {baudrate}, stopbits: {stopbits}, bytesize: {bytesize}, parity: {parity}."
-    )
+    custom_cmd = True if device == "custom" else False
+    set_base = {}
+    if not custom_cmd:
+        _db = open_json(path=os.path.dirname(__file__), model=device)
+        set_base = _db.get(SET_BASE, {})
+        first_reg_base = _db.get(REGISTERS_BASE, [])[0]
+        if not first_reg_base:
+            return False
+        first_record = first_reg_base.get(REGISTERS, [])[0]
+        _LOGGER.debug(
+            f"Connecting with params uart: {uart}, baudrate: {baudrate}, stopbits: {stopbits}, bytesize: {bytesize}, parity: {parity}."
+        )
+    else:
+        first_record = {}
+        first_reg_base = {}
     modbus_helper = ModbusHelper(
         device=device,
         uart=uart,
@@ -146,17 +167,69 @@ async def async_run_modbus_set(
         bytesize=bytesize,
         parity=parity,
     )
-    if not await modbus_helper.check_connection():
-        _LOGGER.error("Can't connect with sensor. Exiting")
-        return 1
-    if new_baudrate:
-        return modbus_helper.set_connection_speed(new_baudrate=new_baudrate)
-    if new_address:
-        modbus_helper.set_new_address(new_address=new_address)
-        return 0
+
+    async def default_action():
+        if not await modbus_helper.check_connection():
+            _LOGGER.error("Can't connect with sensor. Exiting")
+            return 1
+        if new_baudrate:
+            return modbus_helper.set_connection_speed(new_baudrate=new_baudrate)
+        if new_address:
+            modbus_helper.set_new_address(new_address=new_address)
+            return 0
+
+    if not custom_cmd:
+        _LOGGER.debug("Invoking default action.")
+        return await default_action()
+    elif custom_address is not None and custom_value is not None:
+        _LOGGER.debug("Invoking custom command action.")
+        modbus_helper.set_custom_command(
+            register_address=custom_address, value=custom_value
+        )
     return 1
 
 
+async def async_run_modbus_search(
+    uart: str,
+    baudrate: int,
+    register_address: int,
+    register_type: str = "holding",
+    stopbits: int = 1,
+    bytesize: int = 8,
+    parity: str = "N",
+):
+    """Run Modbus Seach Function."""
+    _modbus = Modbus(
+        uart=UARTS[uart],
+        baudrate=baudrate,
+        stopbits=stopbits,
+        bytesize=bytesize,
+        parity=parity,
+        timeout=0.1,
+    )
+    units_found = []
+    for unit_id in range(1, 248):  # Modbus RTU address range is 1 to 247
+        _LOGGER.debug(f"Searching device at address {unit_id}.")
+        value = await _modbus.read_registers(
+            unit=unit_id,
+            address=register_address,
+            count=2,
+            method=register_type,
+        )
+        if value:
+            units_found.append(unit_id)
+            _LOGGER.info(f"Found device at address {unit_id}.")
+        else:
+            _LOGGER.debug(f"No device found at address {unit_id}.")
+    if units_found:
+        _LOGGER.info(
+            "Found devices: [%s]", ", ".join(str(x) for x in units_found)
+        )
+    else:
+        _LOGGER.info("No devices found.")
+    return 0
+
+
 async def async_run_modbus_get(
     uart: str,
     device_address: int,

{boneIO-0.8.0.dev8 → boneIO-0.8.0.dev9}/boneio/modbus/r4dcb08.json

@@ -4,7 +4,13 @@
     "set_address_address": 254,
     "set_baudrate": {
       "address": 255,
-      "possible_baudrates": [1200, 2400, 4800, 9600, 19200]
+      "possible_baudrates": {
+        "1200": 0,
+        "2400": 1,
+        "4800": 2,
+        "9600": 3,
+        "19200": 4
+      }
     }
   },
   "registers_base": [

{boneIO-0.8.0.dev8 → boneIO-0.8.0.dev9}/boneio/modbus/sensor.py

@@ -4,6 +4,8 @@ import logging
 import os
 from datetime import datetime
 from typing import Optional
+
+from boneio.helper.filter import Filter
 from .utils import CONVERT_METHODS, REGISTERS_BASE, allowed_operations
 from boneio.const import (
     ADDRESS,
@@ -26,7 +28,7 @@ from boneio.helper.util import open_json
 _LOGGER = logging.getLogger(__name__)
 
 
-class ModbusSensor(BasicMqtt, AsyncUpdater):
+class ModbusSensor(BasicMqtt, AsyncUpdater, Filter):
     """Represent Modbus sensor in BoneIO."""
 
     SensorClass = None
@@ -37,6 +39,7 @@ class ModbusSensor(BasicMqtt, AsyncUpdater):
         modbus: Modbus,
         address: str,
         model: str,
+        sensors_filters: dict,
         config_helper: ConfigHelper,
         event_bus: EventBus,
         id: str = DefaultName,
@@ -56,6 +59,9 @@ class ModbusSensor(BasicMqtt, AsyncUpdater):
         self._address = address
         self._discovery_sent = False
         self._payload_online = OFFLINE
+        self._sensors_filters = {
+            k.lower(): v for k, v in sensors_filters.items()
+        }
         event_bus.add_haonline_listener(target=self.set_payload_offline)
         AsyncUpdater.__init__(self, **kwargs)
 
@@ -154,7 +160,9 @@ class ModbusSensor(BasicMqtt, AsyncUpdater):
                 method=data.get("register_type", "input"),
             )
             if self._payload_online == OFFLINE and values:
-                _LOGGER.info("Sending online payload about device.")
+                _LOGGER.info(
+                    "Sending online payload about device %s.", self._name
+                )
                 self._payload_online = ONLINE
                 self._send_message(
                     topic=f"{self._config_helper.topic_prefix}/{self._id}{STATE}",
@@ -204,6 +212,12 @@ class ModbusSensor(BasicMqtt, AsyncUpdater):
                         if key in allowed_operations:
                             lamda_function = allowed_operations[key]
                             decoded_value = lamda_function(decoded_value, value)
+                name = register.get("name").replace(" ", "")
+                user_filters = self._sensors_filters.get(name.lower(), [])
+                decoded_value = self._apply_filters(
+                    value=decoded_value,
+                    filters=user_filters,
+                )
                 output[register.get("name").replace(" ", "")] = decoded_value
             self._send_message(
                 topic=f"{self._send_topic}/{data[BASE]}",

boneIO-0.8.0.dev9/boneio/modbus/sht20.json

@@ -0,0 +1,37 @@
+{
+  "model": "SHT20 Temp and Humidity sensor",
+  "set_base": {
+    "set_address_address": 257,
+    "set_baudrate": {
+      "address": 258,
+      "possible_baudrates": { "9600": 9600, "14400": 14400, "19200": 19200 }
+    }
+  },
+  "registers_base": [
+    {
+      "base": 1,
+      "length": 2,
+      "register_type": "input",
+      "registers": [
+        {
+          "name": "Temperature",
+          "address": 1,
+          "unit_of_measurement": "°C",
+          "state_class": "measurement",
+          "device_class": "temperature",
+          "value_type": "S_WORD",
+          "filters": [{ "multiply": 0.1 }]
+        },
+        {
+          "name": "Humidity",
+          "address": 2,
+          "unit_of_measurement": "%",
+          "state_class": "measurement",
+          "device_class": "humidity",
+          "value_type": "S_WORD",
+          "filters": [{ "multiply": 0.1 }]
+        }
+      ]
+    }
+  ]
+}

{boneIO-0.8.0.dev8 → boneIO-0.8.0.dev9}/boneio/schema/schema.yaml

@@ -170,6 +170,14 @@ modbus_sensors:
         default: 30s
         meta:
           label: Update interval.
+      sensors_filters:
+        type: dict
+        required: False
+        meta:
+          label: List of sub sensors to use to filter. Available values are temperature or humidity.
+        schema:
+          temperature: !include filters.yaml
+          humidity: !include filters.yaml
 lm75:
   type: list
   required: False

{boneIO-0.8.0.dev8 → boneIO-0.8.0.dev9}/boneio/sensor/ina219.py

@@ -15,7 +15,7 @@ unit_converter = {"current": "A", "power": "W", "voltage": "V"}
 
 
 class INA219Sensor(BasicMqtt, Filter):
-    """Represent singel value from INA219 as sensor."""
+    """Represent single value from INA219 as sensor."""
 
     def __init__(
         self, device_class: str, filters: list, state: float | None, **kwargs
@@ -52,7 +52,7 @@ class INA219Sensor(BasicMqtt, Filter):
         return self._unit_of_measurement
 
     def update(self, time: datetime) -> None:
-        """Fetch temperature periodically and send to MQTT."""
+        """Fetch sensor data periodically and send to MQTT."""
         _state = (
             self._apply_filters(value=self._raw_state)
             if self._raw_state
@@ -111,4 +111,4 @@ class INA219(AsyncUpdater, Filter):
         for k, sensor in self._sensors.items():
             if sensor.raw_state != self._states[k]:
                 sensor.raw_state = self._states[k]
-                self._loop.call_soon(sensor.update, time)
+                self._loop.call_soon_threadsafe(sensor.update, time)

boneIO-0.8.0.dev9/boneio/version.py

@@ -0,0 +1,2 @@
+# flake8: noqa
+__version__ = "0.8.0dev9"

{boneIO-0.8.0.dev8 → boneIO-0.8.0.dev9}/pyproject.toml

@@ -30,7 +30,7 @@ dependencies = [
     "Adafruit-BBIO>=1.2.0",
 ]
 requires-python = ">=3.7"
-version = "0.8.0.dev8"
+version = "0.8.0.dev9"
 
 [project.license]
 text = "GNU General Public License v3.0"

boneIO-0.8.0.dev8/boneio/version.py

@@ -1,2 +0,0 @@
-# flake8: noqa
-__version__ = "0.8.0dev8"