boneIO 0.1.2__tar.gz → 0.1.3__tar.gz

{boneio-0.1.2/boneio.egg-info → boneio-0.1.3}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: boneio
-Version: 0.1.2
+Version: 0.1.3
 Summary: Python App for BoneIO
 Home-page: https://github.com/boneIO-eu/app_bbb
 License: GNU General Public License v3.0
-Download-URL: https://github.com/boneIO-eu/app_bbb/archive/0.1.2.zip
+Download-URL: https://github.com/boneIO-eu/app_bbb/archive/0.1.3.zip
 Platform: UNKNOWN
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.7

{boneio-0.1.2 → boneio-0.1.3}/boneio/bonecli.py

@@ -26,7 +26,7 @@ from boneio.const import (
     TOPIC_PREFIX,
     USERNAME,
 )
-from boneio.helper import CustomValidator, load_yaml_file
+from boneio.helper import load_config_from_file
 from boneio.manager import Manager
 from boneio.mqtt_client import MQTTClient
 from boneio.version import __version__
@@ -124,13 +124,9 @@ async def run(ctx, debug: int, config: str, mqttpassword: str = ""):
         logging.getLogger("pymodbus.client").setLevel(logging.DEBUG)
     else:
         logging.getLogger(PAHO).setLevel(logging.WARN)
-    schema = load_yaml_file(os.path.join(MAINPATH, "schema.yaml"))
-    v = CustomValidator(schema, purge_unknown=True)
-    config_yaml = load_yaml_file(config)
-    if not config_yaml:
-        _LOGGER.info("Missing file.")
+    _config = load_config_from_file(config_file=config)
+    if not _config:
         return
-    _config = v.normalized(config_yaml)
     _LOGGER.info("Connecting to MQTT.")
     client = MQTTClient(
         host=_config[MQTT][HOST],

{boneio-0.1.2 → boneio-0.1.3}/boneio/const.py

@@ -3,6 +3,8 @@ from datetime import timedelta
 from Adafruit_BBIO.GPIO import HIGH, LOW, BOTH, FALLING
 from typing_extensions import Literal
 
+BONEIO = "boneIO"
+
 
 # MISCELLANEOUS CONSTS
 RELAY = "relay"
@@ -46,6 +48,7 @@ SECOND_DELAY_DURATION = 0.3
 HOMEASSISTANT = "homeassistant"
 HA_DISCOVERY = "ha_discovery"
 HA_TYPE = "ha_type"
+OUTPUT_TYPE = "output_type"
 SHOW_HA = "show_in_ha"
 
 # OLED CONST

{boneio-0.1.2 → boneio-0.1.3}/boneio/helper/__init__.py

@@ -11,7 +11,13 @@ from boneio.helper.gpio import (
 from boneio.helper.oled import make_font
 from boneio.helper.mqtt import BasicMqtt
 from boneio.helper.stats import HostData, host_stats
-from boneio.helper.yaml import CustomValidator, load_yaml_file
+from boneio.helper.yaml import (
+    CustomValidator,
+    load_yaml_file,
+    schema_file,
+    load_config_from_string,
+    load_config_from_file,
+)
 from boneio.helper.ha_discovery import (
     ha_relay_availabilty_message,
     ha_sensor_temp_availabilty_message,
@@ -47,4 +53,7 @@ __all__ = [
     "configure_pin",
     "BasicMqtt",
     "UniqueQueue",
+    "schema_file",
+    "load_config_from_string",
+    "load_config_from_file",
 ]

{boneio-0.1.2 → boneio-0.1.3}/boneio/helper/ha_discovery.py

@@ -4,16 +4,16 @@ from boneio.version import __version__
 from boneio.const import INPUT, OFF, ON, RELAY, STATE, SENSOR, INPUT_SENSOR
 
 
-def ha_relay_availabilty_message(id: str, name: str, topic: str = "boneio"):
+def ha_relay_availabilty_message(id: str, name: str, topic: str = "boneIO"):
     """Create availability topic for HA."""
     return {
         "availability": [{"topic": f"{topic}/{STATE}"}],
         "command_topic": f"{topic}/relay/{id}/set",
         "device": {
             "identifiers": [topic],
-            "manufacturer": "BoneIO",
-            "model": "BoneIO Relay Board",
-            "name": f"BoneIO {topic}",
+            "manufacturer": "boneIO",
+            "model": "boneIO Relay Board",
+            "name": f"boneIO {topic}",
             "sw_version": __version__,
         },
         "name": name,
@@ -26,16 +26,16 @@ def ha_relay_availabilty_message(id: str, name: str, topic: str = "boneio"):
 
 
 def ha_availabilty_message(
-    id: str, name: str, topic: str = "boneio", sensor_type: str = INPUT
+    id: str, name: str, topic: str = "boneIO", sensor_type: str = INPUT
 ):
     """Create availability topic for HA."""
     return {
         "availability": [{"topic": f"{topic}/{STATE}"}],
         "device": {
             "identifiers": [topic],
-            "manufacturer": "BoneIO",
-            "model": "BoneIO Relay Board",
-            "name": f"BoneIO {topic}",
+            "manufacturer": "boneIO",
+            "model": "boneIO Relay Board",
+            "name": f"boneIO {topic}",
             "sw_version": __version__,
         },
         "icon": "mdi:gesture-double-tap",
@@ -63,15 +63,15 @@ def ha_sensor_availabilty_message(unit_of_measurement: str = None, **kwargs):
         return msg
 
 
-def ha_binary_sensor_availabilty_message(id: str, name: str, topic: str = "boneio"):
+def ha_binary_sensor_availabilty_message(id: str, name: str, topic: str = "boneIO"):
     """Create availability topic for HA."""
     return {
         "availability": [{"topic": f"{topic}/{STATE}"}],
         "device": {
             "identifiers": [topic],
-            "manufacturer": "BoneIO",
-            "model": "BoneIO Relay Board",
-            "name": f"BoneIO {topic}",
+            "manufacturer": "boneIO",
+            "model": "boneIO Relay Board",
+            "name": f"boneIO {topic}",
             "sw_version": __version__,
         },
         "payload_on": "pressed",
@@ -82,15 +82,15 @@ def ha_binary_sensor_availabilty_message(id: str, name: str, topic: str = "bonei
     }
 
 
-def ha_sensor_temp_availabilty_message(id: str, name: str, topic: str = "boneio"):
+def ha_sensor_temp_availabilty_message(id: str, name: str, topic: str = "boneIO"):
     """Create availability topic for HA."""
     return {
         "availability": [{"topic": f"{topic}/{STATE}"}],
         "device": {
             "identifiers": [topic],
-            "manufacturer": "BoneIO",
-            "model": "BoneIO Relay Board",
-            "name": f"BoneIO {topic}",
+            "manufacturer": "boneIO",
+            "model": "boneIO Relay Board",
+            "name": f"boneIO {topic}",
             "sw_version": __version__,
         },
         "name": name,
@@ -115,10 +115,10 @@ def sdm630_availabilty_message(
     return {
         "availability": [{"topic": f"{topic}/{id}{STATE}"}],
         "device": {
-            "identifiers": [topic, id],
-            "manufacturer": "BoneIO",
+            "identifiers": [id],
+            "manufacturer": "boneIO",
             "model": "SDM630",
-            "name": f"BoneIO {name.upper()}",
+            "name": f"boneIO {name.upper()}",
             "sw_version": __version__,
         },
         "name": sensor_id,

{boneio-0.1.2 → boneio-0.1.3}/boneio/helper/yaml.py

@@ -1,9 +1,13 @@
+import logging
 from typing import Any
 import os
 from cerberus import Validator
 from boneio.const import ID, OUTPUT
 from yaml import load, YAMLError, SafeLoader
 
+schema_file = os.path.join(os.path.dirname(__file__), "../schema.yaml")
+_LOGGER = logging.getLogger(__name__)
+
 
 class Loader(SafeLoader):
     """Loader which support for include in yaml files."""
@@ -33,6 +37,20 @@ def load_yaml_file(filename: str) -> Any:
             raise exception
 
 
+def load_config_from_string(config_yaml: str):
+    schema = load_yaml_file(schema_file)
+    v = CustomValidator(schema, purge_unknown=True)
+    return v.normalized(config_yaml)
+
+
+def load_config_from_file(config_file: str):
+    config_yaml = load_yaml_file(config_file)
+    if not config_yaml:
+        _LOGGER.info("Missing file.")
+        return None
+    return load_config_from_string(config_yaml)
+
+
 class CustomValidator(Validator):
     """Custom validator of cerberus"""
 

{boneio-0.1.2 → boneio-0.1.3}/boneio/manager.py

@@ -12,8 +12,10 @@ from boneio.const import (
     ACTION,
     ACTIONS,
     ADDRESS,
+    BONEIO,
     GPIO,
     HA_TYPE,
+    OUTPUT_TYPE,
     HOMEASSISTANT,
     ID,
     INIT_SLEEP,
@@ -66,10 +68,10 @@ class Manager:
     def __init__(
         self,
         send_message: Callable[[str, Union[str, dict]], None],
-        topic_prefix: str,
-        relay_pins: List,
-        input_pins: List,
+        relay_pins: List = [],
+        input_pins: List = [],
         sensors: dict = {},
+        topic_prefix: str = BONEIO,
         modbus: dict = None,
         ha_discovery: bool = True,
         ha_discovery_prefix: str = HOMEASSISTANT,
@@ -239,7 +241,7 @@ class Manager:
                     topic_prefix=topic_prefix,
                     mcp=mcp,
                     mcp_id=mcp_id,
-                    ha_type=gpio[HA_TYPE],
+                    output_type=gpio[OUTPUT_TYPE],
                     callback=lambda: self._host_data_callback(mcp_id),
                 )
                 self._grouped_outputs[mcp_id][relay_id] = mcp_relay
@@ -257,17 +259,18 @@ class Manager:
                 self._grouped_outputs[GPIO][relay_id] = gpio_relay
                 return gpio_relay
 
-        self.output = {
+        self._output = {
             gpio[ID].replace(" ", ""): configure_relay(gpio) for gpio in relay_pins
         }
-        for out in self.output.values():
-            self.send_ha_autodiscovery(
-                id=out.id,
-                name=out.name,
-                ha_type=out.ha_type,
-                ha_discovery_prefix=ha_discovery_prefix,
-                availabilty_msg_func=ha_relay_availabilty_message,
-            )
+        for out in self._output.values():
+            if out.output_type != "none":
+                self.send_ha_autodiscovery(
+                    id=out.id,
+                    name=out.name,
+                    ha_type=out.output_type,
+                    ha_discovery_prefix=ha_discovery_prefix,
+                    availabilty_msg_func=ha_relay_availabilty_message,
+                )
             self._loop.call_soon_threadsafe(
                 self._loop.call_later,
                 0.5,
@@ -359,7 +362,7 @@ class Manager:
         if action:
             if action[ACTION] == OUTPUT:
                 """For now only output type is supported"""
-                relay = self.output.get(action[PIN].replace(" ", ""))
+                relay = self._output.get(action[PIN].replace(" ", ""))
                 if relay:
                     relay.toggle()
         # This is similar how Z2M is clearing click sensor.
@@ -370,8 +373,8 @@ class Manager:
         id: str,
         name: str,
         ha_discovery_prefix: str,
+        ha_type: str,
         availabilty_msg_func: Callable,
-        ha_type: str = "switch",
         topic_prefix: str = None,
         **kwargs,
     ) -> None:
@@ -390,9 +393,14 @@ class Manager:
         extracted_relay = topic.replace(f"{self._topic_prefix}/{RELAY}/", "").replace(
             "/set", ""
         )
-        target_device = self.output.get(extracted_relay)
+        target_device = self._output.get(extracted_relay)
         if target_device:
             if message == ON:
                 target_device.turn_on()
             elif message == OFF:
                 target_device.turn_off()
+
+    @property
+    def output(self) -> dict:
+        """Get list of output."""
+        return self._output

{boneio-0.1.2 → boneio-0.1.3}/boneio/relay/basic.py

@@ -14,11 +14,11 @@ class BasicRelay(BasicMqtt):
     """Basic relay class."""
 
     def __init__(
-        self, callback: Callable, id: str = None, ha_type=SWITCH, **kwargs
+        self, callback: Callable, id: str = None, output_type=SWITCH, **kwargs
     ) -> None:
         """Initialize Basic relay."""
         super().__init__(id=id, name=id, topic_type=RELAY, **kwargs)
-        self._ha_type = ha_type
+        self._output_type = output_type
         self._state = False
         self._callback = callback
         self._loop = asyncio.get_running_loop()
@@ -28,6 +28,11 @@ class BasicRelay(BasicMqtt):
         """Check if relay is mcp type."""
         return False
 
+    @property
+    def output_type(self) -> str:
+        """HA type."""
+        return self._output_type
+
     @property
     def id(self) -> bool:
         """Id of the relay.

{boneio-0.1.2 → boneio-0.1.3}/boneio/relay/mcp.py

@@ -25,6 +25,11 @@ class MCPRelay(BasicRelay):
         """Check if relay is mcp type."""
         return True
 
+    @property
+    def pin_id(self) -> str:
+        """Return PIN id."""
+        return self._pin_id
+
     @property
     def mcp_id(self) -> str:
         """Retrieve parent MCP ID."""
@@ -40,11 +45,6 @@ class MCPRelay(BasicRelay):
         """PIN of the relay"""
         return self._pin
 
-    @property
-    def ha_type(self) -> str:
-        """HA type."""
-        return self._ha_type
-
     def turn_on(self) -> None:
         """Call turn on action."""
         self.pin.value = True

{boneio-0.1.2 → boneio-0.1.3}/boneio/schema.yaml

@@ -174,13 +174,13 @@ output:
         required: True
         meta:
           label: PIN to use.
-      ha_type:
+      output_type:
         type: string
         required: True
-        allowed: ['switch', 'light']
+        allowed: ['switch', 'light', 'none']
         default: 'switch'
         meta:
-          label: If HA discovery is used device if relay is light or switch.
+          label: If HA discovery is used device if relay is light or switch. If None is declared then any state is not published to MQTT (used for cover).
 
 
 input:

{boneio-0.1.2 → boneio-0.1.3}/boneio/sensor/sdm630.py

@@ -135,7 +135,7 @@ class Sdm630(BasicMqtt):
         _LOGGER.debug("Sending HA discovery for sensor %s %s.", sdm_name, sensor_id)
         self._send_message(
             topic=(
-                f"{self._ha_discovery_prefix}/{SENSOR}/{self._topic_prefix}"
+                f"{self._ha_discovery_prefix}/{SENSOR}/{self._topic_prefix}{id}"
                 f"/{id}{sensor_id.replace('_', '').lower()}/config"
             ),
             payload=sdm630_availabilty_message(

boneio-0.1.3/boneio/version.py

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

{boneio-0.1.2 → boneio-0.1.3/boneio.egg-info}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: boneio
-Version: 0.1.2
+Version: 0.1.3
 Summary: Python App for BoneIO
 Home-page: https://github.com/boneIO-eu/app_bbb
 License: GNU General Public License v3.0
-Download-URL: https://github.com/boneIO-eu/app_bbb/archive/0.1.2.zip
+Download-URL: https://github.com/boneIO-eu/app_bbb/archive/0.1.3.zip
 Platform: UNKNOWN
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.7

boneio-0.1.2/boneio/version.py

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