boneIO 0.6.3.dev3__tar.gz → 0.7.0__tar.gz

{boneIO-0.6.3.dev3 → boneIO-0.7.0}/PKG-INFO

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

{boneIO-0.6.3.dev3 → boneIO-0.7.0}/boneio/bonecli.py

@@ -15,6 +15,7 @@ from yaml import MarkedYAMLError
 from boneio.const import ACTION
 from boneio.helper import load_config_from_file
 from boneio.helper.exceptions import ConfigurationException, RestartRequestException
+from boneio.helper.events import GracefulExit
 from boneio.helper.logger import configure_logger
 from boneio.runner import async_run
 from boneio.version import __version__
@@ -89,8 +90,9 @@ def run(config: str, debug: int, mqttusername: str = "", mqttpassword: str = "")
             ),
         )
         return 0
-    except RestartRequestException as err:
-        _LOGGER.info(err)
+    except (RestartRequestException, GracefulExit) as err:
+        if err is not None:
+            _LOGGER.info(err)
         return 0
     except (ConfigurationException, MarkedYAMLError) as err:
         _LOGGER.error("Failed to load config. %s Exiting.", err)

{boneIO-0.6.3.dev3 → boneIO-0.7.0}/boneio/const.py

@@ -104,14 +104,19 @@ TOPIC_PREFIX = "topic_prefix"
 # I2C, PCA and MCP CONST
 ADDRESS = "address"
 MCP23017 = "mcp23017"
+PCF8575 = "pcf8575"
 PCA9685 = "pca9685"
 MCP = "mcp"
+PCF = "pcf"
 MCP_ID = "mcp_id"
 PCA_ID = "pca_id"
+PCF_ID = "pcf_id"
 INIT_SLEEP = "init_sleep"
+OUTPUT_GROUP = "output_group"
 
 # SENSOR CONST
 TEMPERATURE = "temperature"
+EVENT_ENTITY = "event"
 SENSOR = "sensor"
 BINARY_SENSOR = "binary_sensor"
 LM75 = "lm75"
@@ -140,6 +145,16 @@ OledDataTypes = Literal[UPTIME, NETWORK, CPU, DISK, MEMORY, SWAP, OUTPUT]
 Gpio_States = Literal[HIGH, LOW]
 Gpio_Edges = Literal[BOTH, FALLING]
 InputTypes = Literal[INPUT, INPUT_SENSOR]
+ExpanderTypes = Literal[MCP23017, PCA9685, PCF8575]
 DEVICE_CLASS = "device_class"
 DallasBusTypes = Literal[DS2482, DALLAS]
 FILTERS = "filters"
+
+cover_actions = {
+    "OPEN": "open",
+    "CLOSE": "close",
+    "TOGGLE": "toggle",
+    "STOP": "stop",
+    "TOGGLE_OPEN": "toggle_open",
+    "TOGGLE_CLOSE": "toggle_close",
+}

{boneIO-0.6.3.dev3 → boneIO-0.7.0}/boneio/cover.py

@@ -109,7 +109,7 @@ class Cover(BasicMqtt):
         self._stop_cover(on_exit=True)
 
     @property
-    def cover_state(self) -> CLOSED | OPEN:
+    def cover_state(self) -> str:
         """Current state of cover."""
         return CLOSED if self._closed else OPEN
 

boneIO-0.7.0/boneio/example_config/binary_sensor.yaml

@@ -0,0 +1,21 @@
+- id: IN_47
+  pin: P8_12
+  kind: sensor
+  detection_type: "old"
+- id: IN_48
+  pin: P8_11
+  kind: sensor
+  detection_type: "new"
+- id: IN_49
+  pin: P8_10
+  kind: sensor
+
+- id: IN_50
+  pin: P8_9
+  kind: sensor
+- id: IN_51
+  pin: P8_8
+  kind: sensor
+- id: IN_52
+  pin: P8_7
+  kind: sensor

{boneIO-0.6.3.dev3 → boneIO-0.7.0}/boneio/example_config/config.yaml

@@ -18,7 +18,8 @@ mcp23017:
   - id: mcp2
     address: 0x21
 
-input: !include input.yaml
+event: !include event.yaml
+binary_sensor: !include binary_sensor.yaml
 
 output: !include output32x5A.yaml
 

boneIO-0.6.3.dev3/boneio/example_config/input.yaml → boneIO-0.7.0/boneio/example_config/event.yaml

@@ -1,5 +1,6 @@
 - id: IN_01
   pin: P8_37
+  detection_type: "old"
   actions:
     single:
       - action: output
@@ -9,6 +10,7 @@
         pin: switch 1
 - id: IN_02
   pin: P8_38
+  detection_type: "new"
   actions:
     single:
       - action: output
@@ -182,23 +184,3 @@
   pin: P8_14
 - id: IN_46
   pin: P8_13
-
-- id: IN_47
-  pin: P8_12
-  kind: sensor
-- id: IN_48
-  pin: P8_11
-  kind: sensor
-- id: IN_49
-  pin: P8_10
-  kind: sensor
-
-- id: IN_50
-  pin: P8_9
-  kind: sensor
-- id: IN_51
-  pin: P8_8
-  kind: sensor
-- id: IN_52
-  pin: P8_7
-  kind: sensor

boneIO-0.7.0/boneio/example_config/output24x16A_v0.3.yaml

@@ -0,0 +1,143 @@
+- id: OUT_01
+  kind: mcp
+  mcp_id: mcp1
+  pin: 9
+  output_type: light
+
+- id: OUT_02
+  kind: mcp
+  mcp_id: mcp1
+  pin: 8
+  output_type: light
+
+- id: OUT_03
+  kind: mcp
+  mcp_id: mcp2
+  pin: 1
+  output_type: light
+
+- id: OUT_04
+  kind: mcp
+  mcp_id: mcp2
+  pin: 0
+  output_type: light
+
+- id: OUT_05
+  kind: mcp
+  mcp_id: mcp1
+  pin: 13
+  output_type: light
+
+- id: OUT_06
+  kind: mcp
+  mcp_id: mcp1
+  pin: 12
+  output_type: light
+
+- id: OUT_07
+  kind: mcp
+  mcp_id: mcp1
+  pin: 11
+  output_type: light
+
+- id: OUT_08
+  kind: mcp
+  mcp_id: mcp1
+  pin: 10
+  output_type: light
+
+- id: OUT_09
+  kind: mcp
+  mcp_id: mcp2
+  pin: 14
+  output_type: light
+
+- id: OUT_10
+  kind: mcp
+  mcp_id: mcp2
+  pin: 15
+  output_type: light
+
+- id: OUT_11
+  kind: mcp
+  mcp_id: mcp2
+  pin: 13
+  output_type: light
+
+- id: OUT_12
+  kind: mcp
+  mcp_id: mcp2
+  pin: 12
+  output_type: light
+
+- id: OUT_13
+  kind: mcp
+  mcp_id: mcp1
+  pin: 6
+  output_type: light
+
+- id: OUT_14
+  kind: mcp
+  mcp_id: mcp1
+  pin: 5
+  output_type: light
+
+- id: OUT_15
+  kind: mcp
+  mcp_id: mcp1
+  pin: 4
+  output_type: light
+
+- id: OUT_16
+  kind: mcp
+  mcp_id: mcp1
+  pin: 3
+  output_type: light
+
+- id: OUT_17
+  kind: mcp
+  mcp_id: mcp1
+  pin: 2
+  output_type: light
+
+- id: OUT_18
+  kind: mcp
+  mcp_id: mcp1
+  pin: 0
+  output_type: light
+
+- id: OUT_19
+  kind: mcp
+  mcp_id: mcp1
+  pin: 1
+  output_type: light
+
+- id: OUT_20
+  kind: mcp
+  mcp_id: mcp1
+  pin: 7
+  output_type: light
+
+- id: OUT_21
+  kind: mcp
+  mcp_id: mcp2
+  pin: 8
+  output_type: light
+
+- id: OUT_22
+  kind: mcp
+  mcp_id: mcp2
+  pin: 9
+  output_type: light
+
+- id: OUT_23
+  kind: mcp
+  mcp_id: mcp2
+  pin: 11
+  output_type: light
+
+- id: OUT_24
+  kind: mcp
+  mcp_id: mcp2
+  pin: 10
+  output_type: light

boneIO-0.7.0/boneio/group/__init__.py

@@ -0,0 +1,4 @@
+"""Group classes."""
+from .output import OutputGroup
+
+__all__ = ["OutputGroup"]

boneIO-0.7.0/boneio/group/output.py

@@ -0,0 +1,64 @@
+"""Cover module."""
+from __future__ import annotations
+import logging
+import asyncio
+from typing import List
+
+from boneio.const import COVER, SWITCH, ON, OFF
+from boneio.relay.basic import BasicRelay
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class OutputGroup(BasicRelay):
+    """Cover class of boneIO"""
+
+    def __init__(
+        self,
+        members: List[BasicRelay],
+        output_type: str = SWITCH,
+        restored_state: bool = True,
+        **kwargs,
+    ) -> None:
+        """Initialize cover class."""
+        self._loop = asyncio.get_event_loop()
+        super().__init__(
+            **kwargs, output_type=output_type, restored_state=restored_state, topic_type="group"
+        )
+        self._group_members = [x for x in members if x.output_type != COVER]
+        self._timer_handle = None
+        for member in self._group_members:
+            self._event_bus.add_output_listener(member.id, self.event_listener)
+
+    async def event_listener(self, relay_id=None) -> None:
+        """Listen for events called by children relays."""
+        state = OFF
+        for x in self._group_members:
+            if x.state == ON:
+                state = ON
+                break
+        if state != self._state or not relay_id:
+            self._state = state
+            self._loop.call_soon_threadsafe(self.send_state)
+
+    def turn_on(self) -> None:
+        """Call turn on action."""
+        for x in self._group_members:
+            asyncio.create_task(x.async_turn_on())
+
+    def turn_off(self) -> None:
+        """Call turn off action."""
+        for x in self._group_members:
+            asyncio.create_task(x.async_turn_off())
+
+    def toggle(self) -> None:
+        """Toggle group."""
+        _LOGGER.debug("Toggle relay.")
+        if self._state == ON:
+            self.turn_off()
+        else:
+            self.turn_on()
+
+    def send_state(self) -> None:
+        """Send state to Mqtt on action."""
+        self._send_message(topic=self._send_topic, payload=self.payload(), retain=True)

{boneIO-0.6.3.dev3 → boneIO-0.7.0}/boneio/helper/__init__.py

@@ -15,7 +15,7 @@ from boneio.helper.ha_discovery import (
     ha_adc_sensor_availabilty_message,
     ha_binary_sensor_availabilty_message,
     ha_button_availabilty_message,
-    ha_input_availabilty_message,
+    ha_event_availabilty_message,
     ha_light_availabilty_message,
     ha_sensor_availabilty_message,
     ha_sensor_temp_availabilty_message,
@@ -54,7 +54,7 @@ __all__ = [
     "ha_sensor_temp_availabilty_message",
     "ha_binary_sensor_availabilty_message",
     "ha_button_availabilty_message",
-    "ha_input_availabilty_message",
+    "ha_event_availabilty_message",
     "ha_led_availabilty_message",
     "GPIOInputException",
     "GPIOOutputException",

{boneIO-0.6.3.dev3 → boneIO-0.7.0}/boneio/helper/async_updater.py

@@ -15,7 +15,7 @@ class AsyncUpdater:
         self._update_interval = update_interval or TimePeriod(seconds=60)
         self.manager.append_task(coro=self._refresh, name=self.id)
 
-    async def _refresh(self):
+    async def _refresh(self) -> None:
         while True:
             if hasattr(self, "async_update"):
                 update_interval = (

{boneIO-0.6.3.dev3 → boneIO-0.7.0}/boneio/helper/click_timer.py

@@ -24,9 +24,10 @@ class ClickTimer:
             self._remove_listener = None
 
     async def _start_async_timer(self) -> None:
+        start = time.time()
         await asyncio.sleep(self._delay)
         self._remove_listener = None
-        self._action(time.time())
+        self._action(round(time.time() - start, 2))
 
     def start_timer(self) -> None:
         """Start timer."""

{boneIO-0.6.3.dev3 → boneIO-0.7.0}/boneio/helper/config.py

@@ -4,7 +4,7 @@ Module to provide basic config options.
 from __future__ import annotations
 from _collections_abc import dict_values
 from typing import Union
-from boneio.const import BONEIO, HOMEASSISTANT, LIGHT, SENSOR, COVER, BUTTON, SWITCH, BINARY_SENSOR
+from boneio.const import BONEIO, HOMEASSISTANT, LIGHT, SENSOR, COVER, BUTTON, SWITCH, BINARY_SENSOR, EVENT_ENTITY
 
 
 class ConfigHelper:
@@ -24,7 +24,8 @@ class ConfigHelper:
             BINARY_SENSOR: {},
             SENSOR: {},
             COVER: {},
-            BUTTON: {}
+            BUTTON: {},
+            EVENT_ENTITY: {}
         }
         self.manager_ready: bool = False
 
@@ -63,6 +64,9 @@ class ConfigHelper:
             if topic in self._autodiscovery_messages[ha_type]:
                 return True
         return False
+    
+    def clear_autodiscovery_type(self, ha_type: str):
+        self._autodiscovery_messages[ha_type] = {}
 
 
 

{boneIO-0.6.3.dev3 → boneIO-0.7.0}/boneio/helper/events.py

@@ -81,6 +81,7 @@ class EventBus:
         """Initialize handler"""
         self._loop = loop or asyncio.get_event_loop()
         self._listeners = {}
+        self._output_listeners = {}
         self._sigterm_listeners = []
         self._haonline_listeners = []
         self._timer_handle = _async_create_timer(self._loop, self._run_second_event)
@@ -102,9 +103,11 @@ class EventBus:
         """Function to call on exit. Should invoke all sigterm listeners."""
         _LOGGER.debug("Exiting process started.")
         self._listeners = {}
+        self._output_listeners = {}
         for target in self._sigterm_listeners:
             target()
         self._timer_handle()
+
         _LOGGER.info("Shutdown gracefully.")
         raise GracefulExit(code=0)
 
@@ -117,6 +120,19 @@ class EventBus:
         """Add sigterm listener."""
         self._sigterm_listeners.append(target)
 
+    def add_output_listener(self, name, target):
+        """Add output listener."""
+        self._output_listeners[name] = ListenerJob(target=target)
+        return self._output_listeners[name]
+    
+    def trigger_output_event(self, event):
+        asyncio.create_task(self.async_trigger_output_event(event=event))
+    
+    async def async_trigger_output_event(self, event):
+        listener = self._output_listeners.get(event)
+        if listener:
+            await listener.target(event)
+
     def add_haonline_listener(self, target):
         """Add HA Online listener."""
         self._haonline_listeners.append(target)

{boneIO-0.6.3.dev3 → boneIO-0.7.0}/boneio/helper/gpio.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 import asyncio
 import logging
 
@@ -104,7 +105,7 @@ class GpioBaseClass:
     """Base class for initialize GPIO"""
 
     def __init__(
-        self, pin: str, press_callback: Callable[[ClickTypes, str], None], **kwargs
+        self, pin: str, press_callback: Callable[[ClickTypes, str, bool | None], None], **kwargs
     ) -> None:
         """Setup GPIO Input Button"""
         self._pin = pin
@@ -114,7 +115,15 @@ class GpioBaseClass:
         self._press_callback = press_callback
         setup_input(pin=self._pin, pull_mode=gpio_mode)
 
+    def set_press_callback(self, press_callback: Callable[[ClickTypes, str, bool | None], None]) -> None:
+        self._press_callback = press_callback
+
     @property
     def is_pressed(self) -> bool:
         """Is button pressed."""
         return read_input(self._pin)
+    
+    @property
+    def pin(self) -> str:
+        """Return configured pin."""
+        return self._pin

{boneIO-0.6.3.dev3 → boneIO-0.7.0}/boneio/helper/ha_discovery.py

@@ -13,6 +13,9 @@ from boneio.const import (
     SENSOR,
     STATE,
     STOP,
+    SINGLE,
+    DOUBLE,
+    LONG
 )
 from boneio.version import __version__
 
@@ -42,10 +45,10 @@ def ha_availabilty_message(
     }
 
 
-def ha_light_availabilty_message(id: str, topic: str = "boneIO", **kwargs):
+def ha_light_availabilty_message(id: str, topic: str = "boneIO", device_type: str = RELAY, **kwargs):
     """Create LIGHT availability topic for HA."""
-    msg = ha_availabilty_message(device_type=RELAY, topic=topic, id=id, **kwargs)
-    msg["command_topic"] = f"{topic}/cmd/{RELAY}/{id}/set"
+    msg = ha_availabilty_message(device_type=device_type, topic=topic, id=id, **kwargs)
+    msg["command_topic"] = f"{topic}/cmd/{device_type}/{id}/set"
     msg["payload_off"] = OFF
     msg["payload_on"] = ON
     msg["state_value_template"] = "{{ value_json.state }}"
@@ -76,19 +79,20 @@ def ha_button_availabilty_message(
     return msg
 
 
-def ha_switch_availabilty_message(id: str, topic: str = "boneIO", **kwargs):
+def ha_switch_availabilty_message(id: str, topic: str = "boneIO", device_type: str = RELAY, **kwargs):
     """Create SWITCH availability topic for HA."""
-    msg = ha_availabilty_message(device_type=RELAY, topic=topic, id=id, **kwargs)
-    msg["command_topic"] = f"{topic}/cmd/relay/{id}/set"
+    msg = ha_availabilty_message(device_type=device_type, topic=topic, id=id, **kwargs)
+    msg["command_topic"] = f"{topic}/cmd/{device_type}/{id}/set"
     msg["payload_off"] = OFF
     msg["payload_on"] = ON
     msg["value_template"] = "{{ value_json.state }}"
     return msg
 
 
-def ha_input_availabilty_message(**kwargs):
+def ha_event_availabilty_message(**kwargs):
     msg = ha_availabilty_message(device_type=INPUT, **kwargs)
     msg["icon"] = "mdi:gesture-double-tap"
+    msg["event_types"] = [SINGLE, DOUBLE, LONG]
     return msg