boneIO 0.5.1__tar.gz → 0.6.0.dev1__tar.gz

{boneIO-0.5.1 → boneIO-0.6.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: boneIO
-Version: 0.5.1
+Version: 0.6.0dev1
 Summary: Python App for BoneIO
 License: GNU General Public License v3.0
 Author-email: Paweł Szafer <pszafer@gmail.com>
@@ -17,7 +17,7 @@ boneio run -dd -c config.yaml
 # Installation instructions
 
 ```
-sudo apt-get install libopenjp2-7-dev libatlas-base-dev python3-venv
+sudo apt-get install libopenjp2-7-dev libatlas-base-dev python3-venv libjpeg-dev zlib1g-dev
 mkdir ~/boneio
 python3 -m venv ~/boneio/venv
 source ~/boneio/venv/bin/activate

{boneIO-0.5.1 → boneIO-0.6.0.dev1}/README.md

@@ -4,7 +4,7 @@ boneio run -dd -c config.yaml
 # Installation instructions
 
 ```
-sudo apt-get install libopenjp2-7-dev libatlas-base-dev python3-venv
+sudo apt-get install libopenjp2-7-dev libatlas-base-dev python3-venv libjpeg-dev zlib1g-dev
 mkdir ~/boneio
 python3 -m venv ~/boneio/venv
 source ~/boneio/venv/bin/activate

{boneIO-0.5.1 → boneIO-0.6.0.dev1}/boneio/const.py

@@ -15,19 +15,22 @@ NONE = "none"
 
 # MISCELLANEOUS CONSTS
 RELAY = "relay"
+LED = "led"
 ON = "ON"
 OFF = "OFF"
 STATE = "state"
+BRIGHTNESS = "brightness"
+SET_BRIGHTNESS = "set_brightness"
 ENABLED = "enabled"
 OUTPUT = "output"
 PIN = "pin"
 ID = "id"
 KIND = "kind"
 GPIO = "gpio"
+PCA = "pca"
 GPIO_MODE = "gpio_mode"
 ACTIONS = "actions"
 ACTION = "action"
-OUTPUT = "output"
 SWITCH = "switch"
 LIGHT = "light"
 BUTTON = "button"
@@ -97,11 +100,13 @@ OFFLINE = "offline"
 TOPIC = "topic"
 TOPIC_PREFIX = "topic_prefix"
 
-# I2C and MCP CONST
+# I2C, PCA and MCP CONST
 ADDRESS = "address"
 MCP23017 = "mcp23017"
+PCA9685 = "pca9685"
 MCP = "mcp"
 MCP_ID = "mcp_id"
+PCA_ID = "pca_id"
 INIT_SLEEP = "init_sleep"
 
 # SENSOR CONST

boneIO-0.6.0.dev1/boneio/example_config/led32x4A.yaml

@@ -0,0 +1,226 @@
+# pca1 - upper 12 outputs
+- id: PWM_01
+  kind: pca
+  pca_id: pca1
+  pin: 0
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_02
+  kind: pca
+  pca_id: pca1
+  pin: 1
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_03
+  kind: pca
+  pca_id: pca1
+  pin: 2
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_04
+  kind: pca
+  pca_id: pca1
+  pin: 3
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_05
+  kind: pca
+  pca_id: pca1
+  pin: 4
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_06
+  kind: pca
+  pca_id: pca1
+  pin: 5
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_07
+  kind: pca
+  pca_id: pca1
+  pin: 6
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_08
+  kind: pca
+  pca_id: pca1
+  pin: 7
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_09
+  kind: pca
+  pca_id: pca1
+  pin: 8
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_10
+  kind: pca
+  pca_id: pca1
+  pin: 9
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_11
+  kind: pca
+  pca_id: pca1
+  pin: 10
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_12
+  kind: pca
+  pca_id: pca1
+  pin: 11
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_13
+  kind: pca
+  pca_id: pca1
+  pin: 12
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_14
+  kind: pca
+  pca_id: pca1
+  pin: 13
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_15
+  kind: pca
+  pca_id: pca1
+  pin: 14
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_16
+  kind: pca
+  pca_id: pca1
+  pin: 15
+  output_type: led
+  percentage_default_brightness: 1
+
+# pca2 - lower 12 outputs
+
+- id: PWM_17
+  kind: pca
+  pca_id: pca2
+  pin: 0
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_18
+  kind: pca
+  pca_id: pca2
+  pin: 1
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_19
+  kind: pca
+  pca_id: pca2
+  pin: 2
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_20
+  kind: pca
+  pca_id: pca2
+  pin: 3
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_21
+  kind: pca
+  pca_id: pca2
+  pin: 4
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_22
+  kind: pca
+  pca_id: pca2
+  pin: 5
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_23
+  kind: pca
+  pca_id: pca2
+  pin: 6
+  output_type: led
+
+  percentage_default_brightness: 1
+- id: PWM_24
+  kind: pca
+  pca_id: pca2
+  pin: 7
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_25
+  kind: pca
+  pca_id: pca2
+  pin: 8
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_26
+  kind: pca
+  pca_id: pca2
+  pin: 9
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_27
+  kind: pca
+  pca_id: pca2
+  pin: 10
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_28
+  kind: pca
+  pca_id: pca2
+  pin: 11
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_29
+  kind: pca
+  pca_id: pca2
+  pin: 12
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_30
+  kind: pca
+  pca_id: pca2
+  pin: 13
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_31
+  kind: pca
+  pca_id: pca2
+  pin: 14
+  output_type: led
+  percentage_default_brightness: 1
+
+- id: PWM_32
+  kind: pca
+  pca_id: pca2
+  pin: 15
+  output_type: led
+  percentage_default_brightness: 1

{boneIO-0.5.1 → boneIO-0.6.0.dev1}/boneio/example_config/output32x5A.yaml

@@ -131,7 +131,7 @@
 - id: OUT_22
   kind: mcp
   mcp_id: mcp1
-  pin: 13
+  pin: 10
   output_type: light
 
 - id: OUT_23
@@ -157,7 +157,7 @@
 - id: OUT_26
   kind: mcp
   mcp_id: mcp2
-  pin: 9
+  pin: 14
   output_type: light
 
 - id: OUT_27
@@ -193,5 +193,5 @@
 - id: OUT_32
   kind: mcp
   mcp_id: mcp2
-  pin: 15
+  pin: 8
   output_type: light

{boneIO-0.5.1 → boneIO-0.6.0.dev1}/boneio/helper/__init__.py

@@ -1,6 +1,6 @@
 """Helper dir for BoneIO."""
 
-from boneio.helper.exceptions import GPIOInputException, I2CError
+from boneio.helper.exceptions import GPIOInputException, GPIOOutputException, I2CError
 from boneio.helper.gpio import (
     GpioBaseClass,
     configure_pin,
@@ -19,6 +19,7 @@ from boneio.helper.ha_discovery import (
     ha_sensor_availabilty_message,
     ha_sensor_temp_availabilty_message,
     ha_switch_availabilty_message,
+    ha_led_availabilty_message,
 )
 from boneio.helper.mqtt import BasicMqtt
 from boneio.helper.async_updater import AsyncUpdater
@@ -53,7 +54,9 @@ __all__ = [
     "ha_binary_sensor_availabilty_message",
     "ha_button_availabilty_message",
     "ha_input_availabilty_message",
+    "ha_led_availabilty_message",
     "GPIOInputException",
+    "GPIOOutputException",
     "I2CError",
     "GpioBaseClass",
     "StateManager",

{boneIO-0.5.1 → boneIO-0.6.0.dev1}/boneio/helper/exceptions.py

@@ -8,6 +8,9 @@ class BoneIOException(Exception):
 class GPIOInputException(BoneIOException):
     """GPIOInput Exception."""
 
+class GPIOOutputException(BoneIOException):
+    """GPIOInput Exception."""
+
 
 class I2CError(BoneIOException):
     """I2C Exception."""

{boneIO-0.5.1 → boneIO-0.6.0.dev1}/boneio/helper/ha_discovery.py

@@ -45,12 +45,24 @@ def ha_availabilty_message(
 def ha_light_availabilty_message(id: str, topic: str = "boneIO", **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["command_topic"] = f"{topic}/cmd/{RELAY}/{id}/set"
     msg["payload_off"] = OFF
     msg["payload_on"] = ON
     msg["state_value_template"] = "{{ value_json.state }}"
     return msg
 
+def ha_led_availabilty_message(id: str, topic: str = "boneIO", **kwargs):
+    """Create LED 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["brightness_state_topic"] = f"{topic}/{RELAY}/{id}"
+    msg["brightness_command_topic"] = f"{topic}/cmd/{RELAY}/{id}/set_brightness"
+    msg["brightness_scale"] = 65535
+    msg["payload_off"] = OFF
+    msg["payload_on"] = ON
+    msg["state_value_template"] = "{{ value_json.state }}"
+    msg["brightness_value_template"] = "{{ value_json.brightness }}"
+    return msg
 
 def ha_button_availabilty_message(id: str, topic: str = "boneIO", **kwargs):
     """Create BUTTON availability topic for HA."""

{boneIO-0.5.1 → boneIO-0.6.0.dev1}/boneio/helper/loader.py

@@ -6,6 +6,7 @@ from collections import namedtuple
 from typing import TYPE_CHECKING, Any, Callable, Dict, Union
 
 from adafruit_mcp230xx.mcp23017 import MCP23017
+from adafruit_pca9685 import PCA9685
 
 from boneio.const import (
     ACTIONS,
@@ -15,6 +16,7 @@ from boneio.const import (
     DEVICE_CLASS,
     FILTERS,
     GPIO,
+    PCA,
     ID,
     INIT_SLEEP,
     INPUT,
@@ -23,6 +25,7 @@ from boneio.const import (
     LM75,
     MCP,
     MCP_ID,
+    PCA_ID,
     MCP_TEMP_9808,
     MODEL,
     NONE,
@@ -38,6 +41,7 @@ from boneio.const import (
 from boneio.cover import Cover
 from boneio.helper import (
     GPIOInputException,
+    GPIOOutputException,
     I2CError,
     StateManager,
     ha_adc_sensor_availabilty_message,
@@ -64,7 +68,7 @@ if TYPE_CHECKING:
 
 from busio import I2C
 
-from boneio.relay import GpioRelay, MCPRelay
+from boneio.relay import GpioRelay, MCPRelay, PWMPCA
 from boneio.sensor import GpioADCSensor, initialize_adc
 from boneio.sensor.gpio import GpioInputSensor
 
@@ -167,6 +171,30 @@ def create_mcp23017(
     return grouped_outputs
 
 
+def create_pca9685(
+    manager: Manager,
+    pca9685: list,
+    i2cbusio: I2C,
+) -> dict:
+    """Create MCP23017."""
+    grouped_outputs = {}
+    for pca in pca9685:
+        id = pca[ID] or pca[ADDRESS]
+        try:
+            manager._pca[id] = PCA9685(i2c_bus=i2cbusio, address=pca[ADDRESS])
+            manager._pca[id].frequency = 500
+            sleep_time = pca.get(INIT_SLEEP, TimePeriod(seconds=0))
+            _LOGGER.debug(
+                f"Sleeping for {sleep_time.total_seconds}s while PCA {id} is initializing."
+            )
+            time.sleep(sleep_time.total_seconds)
+            grouped_outputs[id] = {}
+        except TimeoutError as err:
+            _LOGGER.error("Can't connect to PCA %s. %s", id, err)
+            pass
+    return grouped_outputs
+
+
 def create_modbus_sensors(manager: Manager, sensors, **kwargs) -> None:
     """Create Modbus sensor for each device."""
     from boneio.sensor.modbus import ModbusSensor
@@ -197,12 +225,18 @@ def create_modbus_sensors(manager: Manager, sensors, **kwargs) -> None:
 OutputEntry = namedtuple("OutputEntry", "OutputClass output_kind output_id")
 
 
-def output_chooser(output_kind: str, mcp_id: str | None):
+def output_chooser(output_kind: str, config):
     """Get named tuple based on input."""
     if output_kind == MCP:
-        return OutputEntry(MCPRelay, MCP, mcp_id)
-    else:
+        output_id = config.pop(MCP_ID, None)
+        return OutputEntry(MCPRelay, MCP, output_id)
+    elif output_kind == GPIO:
         return OutputEntry(GpioRelay, GPIO, GPIO)
+    elif output_kind == PCA:
+        output_id = config.pop(PCA_ID, None)
+        return OutputEntry(PWMPCA, PCA, output_id)
+    else:
+        raise GPIOOutputException(f"""Output type {output_kind} dont exists""")
 
 
 def configure_relay(
@@ -225,9 +259,7 @@ def configure_relay(
         state_manager.del_attribute(attr_type=RELAY, attribute=relay_id)
         restored_state = False
 
-    output = output_chooser(
-        output_kind=config.pop(KIND), mcp_id=config.pop(MCP_ID, None)
-    )
+    output = output_chooser(output_kind=config.pop(KIND), config=config)
 
     if getattr(output, "output_kind") == MCP:
         mcp = manager.mcp.get(getattr(output, "output_id"))
@@ -240,6 +272,17 @@ def configure_relay(
             "mcp_id": getattr(output, "output_id"),
             "output_type": output_type,
         }
+    elif getattr(output, "output_kind") == PCA:
+        pca = manager.pca.get(getattr(output, "output_id"))
+        if not pca:
+            _LOGGER.error("No such PCA configured!")
+            return None
+        kwargs = {
+            "pin": int(config.pop(PIN)),
+            "pca": pca,
+            "pca_id": getattr(output, "output_id"),
+            "output_type": output_type,
+        }
     elif getattr(output, "output_kind") == GPIO:
         if GPIO not in manager.grouped_outputs:
             manager.grouped_outputs[GPIO] = {}
@@ -247,7 +290,11 @@ def configure_relay(
             "pin": config.pop(PIN),
         }
     else:
+        _LOGGER.error(
+            "Output kind: %s is not configured", getattr(output, "output_kind")
+        )
         return
+
     relay = getattr(output, "OutputClass")(
         send_message=manager.send_message,
         topic_prefix=topic_prefix,

{boneIO-0.5.1 → boneIO-0.6.0.dev1}/boneio/helper/yaml_util.py

@@ -79,6 +79,15 @@ class BoneIOLoader(SafeLoader):
                 mapping.update(loaded_yaml)
         return mapping
 
+    def construct_include_files(self, node):
+        files = os.path.join(self._root, self.construct_scalar(node)).split()
+        merged_list = []
+        for fname in files:
+            loaded_yaml = load_yaml_file(fname.strip())
+            if isinstance(loaded_yaml, list):
+                merged_list.extend(loaded_yaml)
+        return merged_list
+
 
 BoneIOLoader.add_constructor("!include", BoneIOLoader.include)
 BoneIOLoader.add_constructor("!secret", BoneIOLoader.construct_secret)
@@ -94,6 +103,9 @@ BoneIOLoader.add_constructor(
 BoneIOLoader.add_constructor(
     "!include_dir_merge_named", BoneIOLoader.construct_include_dir_merge_named
 )
+BoneIOLoader.add_constructor(
+    "!include_files", BoneIOLoader.construct_include_files
+)
 
 
 def filter_yaml_files(files):
@@ -218,10 +230,11 @@ class CustomValidator(Validator):
             return super()._lookup_field(path)
 
     def _check_with_output_id_uniqueness(self, field, value):
-        """Check if outputs ids are unique."""
-        all_ids = [x[ID] for x in self.document[OUTPUT]]
-        if len(all_ids) != len(set(all_ids)):
-            self._error(field, "Output IDs are not unique.")
+        """Check if outputs ids are unique if they exists."""
+        if self.document[OUTPUT] is not None:
+            all_ids = [x[ID] for x in self.document[OUTPUT]]
+            if len(all_ids) != len(set(all_ids)):
+                self._error(field, "Output IDs are not unique.")
 
     def _normalize_coerce_to_bool(self, value):
         return True

{boneIO-0.5.1 → boneIO-0.6.0.dev1}/boneio/manager.py

@@ -34,6 +34,9 @@ from boneio.const import (
     InputTypes,
     relay_actions,
     DS2482,
+    LIGHT,
+    LED,
+    SET_BRIGHTNESS,
 )
 from boneio.helper import (
     GPIOInputException,
@@ -43,6 +46,7 @@ from boneio.helper import (
     ha_button_availabilty_message,
     ha_light_availabilty_message,
     ha_switch_availabilty_message,
+    ha_led_availabilty_message
 )
 from boneio.helper.config import ConfigHelper
 from boneio.helper.events import EventBus
@@ -53,6 +57,7 @@ from boneio.helper.loader import (
     configure_relay,
     create_dallas_sensor,
     create_mcp23017,
+    create_pca9685,
     create_temp_sensor,
 )
 from boneio.helper.logger import configure_logger
@@ -63,10 +68,13 @@ from w1thermsensor.errors import KernelModuleLoadError
 
 _LOGGER = logging.getLogger(__name__)
 
+AVAILABILITY_FUNCTION_CHOOSER = {
+  LIGHT: ha_light_availabilty_message,
+  LED: ha_led_availabilty_message,
+}
 
 class Manager:
     """Manager to communicate MQTT with GPIO inputs and outputs."""
-
     def __init__(
         self,
         send_message: Callable[[str, Union[str, dict], bool], None],
@@ -77,6 +85,7 @@ class Manager:
         input_pins: List = [],
         sensors: dict = {},
         modbus: dict = None,
+        pca9685: Optional[List] = None,
         mcp23017: Optional[List] = None,
         ds2482: Optional[List] = [],
         dallas: Optional[dict] = None,
@@ -100,6 +109,7 @@ class Manager:
         self._input_pins = input_pins
         self._i2cbusio = I2C(SCL, SDA)
         self._mcp = {}
+        self._pca = {}
         self._output = {}
         self._oled = None
         self._tasks: List[asyncio.Task] = []
@@ -119,6 +129,9 @@ class Manager:
         self.grouped_outputs = create_mcp23017(
             manager=self, mcp23017=mcp23017, i2cbusio=self._i2cbusio
         )
+        self.grouped_outputs.update(create_pca9685(
+            manager=self, pca9685=pca9685, i2cbusio=self._i2cbusio
+        ))
 
         self._configure_adc(adc_list=adc_list)
 
@@ -136,14 +149,13 @@ class Manager:
                 continue
             self._output[_id] = out
             if out.output_type != NONE:
-                self.send_ha_autodiscovery(
-                    id=out.id,
-                    name=out.name,
-                    ha_type=out.output_type,
-                    availability_msg_func=ha_light_availabilty_message
-                    if out.is_light
-                    else ha_switch_availabilty_message,
-                )
+                if out.output_type in AVAILABILITY_FUNCTION_CHOOSER:
+                    self.send_ha_autodiscovery(
+                        id=out.id,
+                        name=out.name,
+                        ha_type=LIGHT if out.output_type == LED else out.output_type,
+                        availability_msg_func=AVAILABILITY_FUNCTION_CHOOSER.get(out.output_type, ha_switch_availabilty_message)
+                    )
             self._loop.call_soon_threadsafe(
                 self._loop.call_later,
                 0.5,
@@ -404,6 +416,11 @@ class Manager:
         """Get MCP by it's id."""
         return self._mcp
 
+    @property
+    def pca(self):
+        """Get PCA by it's id."""
+        return self._pca
+
     def press_callback(
         self, x: ClickTypes, inpin: str, actions: List, input_type: InputTypes = INPUT
     ) -> None:
@@ -485,7 +502,6 @@ class Manager:
         except IndexError:
             _LOGGER.error("Part of topic is missing. Not invoking command.")
             return
-
         if msg_type == RELAY and command == "set":
             target_device = self._output.get(device_id)
 
@@ -497,6 +513,12 @@ class Manager:
                     _LOGGER.debug("Action not exist %s.", message.upper())
             else:
                 _LOGGER.debug("Target device not found %s.", device_id)
+        elif msg_type == RELAY and command == SET_BRIGHTNESS:
+            target_device = self._output.get(device_id)
+            if target_device and target_device.output_type != NONE and message is not '':
+                target_device.set_brightness(int(message))
+            else:
+                _LOGGER.debug("Target device not found %s.", device_id)
         elif msg_type == COVER:
             cover = self._covers.get(device_id)
             if not cover:

{boneIO-0.5.1 → boneIO-0.6.0.dev1}/boneio/relay/__init__.py

@@ -1,5 +1,6 @@
 """Relay module."""
 from boneio.relay.gpio import GpioRelay
 from boneio.relay.mcp import MCPRelay
+from boneio.relay.pca import PWMPCA
 
-__all__ = ["MCPRelay", "GpioRelay"]
+__all__ = ["MCPRelay", "GpioRelay", "PWMPCA"]