boneIO 0.1.0.dev15__tar.gz → 0.1.0.dev16__tar.gz

{boneio-0.1.0.dev15 → boneio-0.1.0.dev16}/PKG-INFO

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

{boneio-0.1.0.dev15 → boneio-0.1.0.dev16}/boneio/bonecli.py

@@ -20,6 +20,7 @@ from boneio.const import (
     TOPIC_PREFIX,
     USERNAME,
     LM75,
+    ADC,
 )
 from boneio.helper import CustomValidator, load_yaml_file
 from boneio.manager import Manager
@@ -141,6 +142,7 @@ async def run(ctx, debug: int, config: str, mqttpassword: str = ""):
         mcp23017=_config.get(MCP23017, []),
         lm75=_config.get(LM75),
         oled=_config.get(OLED),
+        adc_list=_config.get(ADC, []),
     )
     tasks = set()
     tasks.update(manager.get_tasks())

{boneio-0.1.0.dev15 → boneio-0.1.0.dev16}/boneio/const.py

@@ -20,6 +20,8 @@ ACTION = "action"
 OUTPUT = "output"
 SWITCH = "switch"
 CONFIG_PIN = "/usr/bin/config-pin"
+UPDATE_INTERVAL = "update_interval"
+ADC = "adc"
 
 # TIMINGS FOR BUTTONS
 DEBOUNCE_DURATION = timedelta(seconds=0.2)

{boneio-0.1.0.dev15 → boneio-0.1.0.dev16}/boneio/helper/__init__.py

@@ -9,16 +9,20 @@ from boneio.helper.gpio import (
     configure_pin,
 )
 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.ha_discovery import (
     ha_relay_availibilty_message,
-    ha_sensor_availibilty_message,
     ha_sensor_temp_availibilty_message,
     ha_binary_sensor_availibilty_message,
+    ha_input_availibilty_message,
+    ha_sensor_availibilty_message,
+    ha_adc_sensor_availibilty_message,
 )
 from boneio.helper.exceptions import GPIOInputException, I2CError
 
+
 __all__ = [
     "CustomValidator",
     "load_yaml_file",
@@ -32,10 +36,13 @@ __all__ = [
     "make_font",
     "ha_relay_availibilty_message",
     "ha_sensor_availibilty_message",
+    "ha_adc_sensor_availibilty_message",
     "ha_sensor_temp_availibilty_message",
     "ha_binary_sensor_availibilty_message",
+    "ha_input_availibilty_message",
     "GPIOInputException",
     "I2CError",
     "GpioBaseClass",
     "configure_pin",
+    "BasicMqtt",
 ]

{boneio-0.1.0.dev15 → boneio-0.1.0.dev16}/boneio/helper/ha_discovery.py

@@ -25,7 +25,9 @@ def ha_relay_availibilty_message(id: str, name: str, topic: str = "boneio"):
     }
 
 
-def ha_sensor_availibilty_message(id: str, name: str, topic: str = "boneio"):
+def ha_availibilty_message(
+    id: str, name: str, topic: str = "boneio", sensor_type: str = INPUT
+):
     """Create availability topic for HA."""
     return {
         "availability": [{"topic": f"{topic}/{STATE}"}],
@@ -38,11 +40,29 @@ def ha_sensor_availibilty_message(id: str, name: str, topic: str = "boneio"):
         },
         "icon": "mdi:gesture-double-tap",
         "name": name,
-        "state_topic": f"{topic}/{INPUT}/{id}",
-        "unique_id": f"{topic}{INPUT}{id}",
+        "state_topic": f"{topic}/{sensor_type}/{id}",
+        "unique_id": f"{topic}{sensor_type}{id}",
     }
 
 
+def ha_input_availibilty_message(**kwargs):
+    return ha_availibilty_message(sensor_type=INPUT, **kwargs)
+
+
+def ha_adc_sensor_availibilty_message(**kwargs):
+    msg = ha_availibilty_message(sensor_type=SENSOR, **kwargs)
+    msg["unit_of_measurement"] = "V"
+    msg["device_class"] = "voltage"
+    msg["state_class"] = "measurement"
+    return msg
+
+
+def ha_sensor_availibilty_message(unit_of_measurement: str = None, **kwargs):
+    msg = ha_availibilty_message(sensor_type=SENSOR, **kwargs)
+    if not unit_of_measurement:
+        return msg
+
+
 def ha_binary_sensor_availibilty_message(id: str, name: str, topic: str = "boneio"):
     """Create availability topic for HA."""
     return {

boneio-0.1.0.dev16/boneio/helper/mqtt.py

@@ -0,0 +1,30 @@
+"""Class to help initialize classes which uses mqtt send."""
+from typing import Callable, Union
+
+
+class BasicMqtt:
+    """Basic MQTT class."""
+
+    def __init__(
+        self,
+        id: str,
+        topic_prefix: str,
+        name: str,
+        send_message: Callable[[str, Union[str, dict]], None],
+        topic_type: str,
+    ):
+        """Initialize module."""
+        self._id = id.replace(" ", "")
+        self._name = name
+        self._send_message = send_message
+        self._send_topic = f"{topic_prefix}/{topic_type}/{self.id}"
+
+    @property
+    def id(self) -> bool:
+        """Id of the module."""
+        return self._id
+
+    @property
+    def name(self):
+        """Return name of the sensor."""
+        return self._name

{boneio-0.1.0.dev15 → boneio-0.1.0.dev16}/boneio/helper/stats.py

@@ -85,9 +85,9 @@ async def get_memory_info(host_data):
         host_data.write(
             MEMORY,
             {
-                "total": f"{floor(vm.total / MEGABYTE)}%",
-                "used": f"{floor(vm.used / MEGABYTE)}%",
-                "free": f"{floor(vm.available / MEGABYTE)}%",
+                "total": f"{floor(vm.total / MEGABYTE)}MB",
+                "used": f"{floor(vm.used / MEGABYTE)}MB",
+                "free": f"{floor(vm.available / MEGABYTE)}MB",
             },
         )
         await asyncio.sleep(10)
@@ -100,9 +100,9 @@ async def get_swap_info(host_data):
         host_data.write(
             SWAP,
             {
-                "total": f"{floor(swap.total / MEGABYTE)}%",
-                "used": f"{floor(swap.used / MEGABYTE)}%",
-                "free": f"{floor(swap.free / MEGABYTE)}%",
+                "total": f"{floor(swap.total / MEGABYTE)}MB",
+                "used": f"{floor(swap.used / MEGABYTE)}MB",
+                "free": f"{floor(swap.free / MEGABYTE)}MB",
             },
         )
         await asyncio.sleep(10)

{boneio-0.1.0.dev15 → boneio-0.1.0.dev16}/boneio/manager.py

@@ -33,11 +33,13 @@ from boneio.const import (
     SHOW_HA,
     BINARY_SENSOR,
     INPUT_SENSOR,
+    UPDATE_INTERVAL,
 )
 from boneio.helper import (
     HostData,
     ha_relay_availibilty_message,
-    ha_sensor_availibilty_message,
+    ha_input_availibilty_message,
+    ha_adc_sensor_availibilty_message,
     ha_sensor_temp_availibilty_message,
     ha_binary_sensor_availibilty_message,
     host_stats,
@@ -66,6 +68,7 @@ class Manager:
         ha_discovery_prefix: str = HOMEASSISTANT,
         mcp23017: Optional[List] = None,
         oled: bool = False,
+        adc_list: Optional[List] = None,
     ) -> None:
         """Initialize the manager."""
         _LOGGER.info("Initializing manager module.")
@@ -126,12 +129,48 @@ class Manager:
                     _LOGGER.error("Can't connect to MCP %s. %s", id, err)
                     pass
 
+        def create_adc():
+            from boneio.sensor import initialize_adc, GpioADCSensor
+
+            initialize_adc()
+
+            ## TODO: find what exception can ADC gpio throw.
+            for gpio in adc_list:
+                name = gpio.get(ID)
+                id = name.replace(" ", "")
+                pin = gpio[PIN]
+                try:
+                    adc = GpioADCSensor(
+                        id=id,
+                        pin=pin,
+                        name=name,
+                        send_message=self.send_message,
+                        topic_prefix=topic_prefix,
+                        update_interval=gpio.get(UPDATE_INTERVAL, 60),
+                    )
+                    self.send_ha_autodiscovery(
+                        id=id,
+                        name=name,
+                        ha_type=SENSOR,
+                        prefix=ha_discovery_prefix,
+                        availibilty_msg_func=ha_adc_sensor_availibilty_message,
+                    )
+                    self._tasks.append(asyncio.create_task(adc.send_state()))
+                except I2CError as err:
+                    _LOGGER.error("Can't configure ADC sensor %s. %s", id, err)
+                    pass
+
+            return True
+
         if lm75:
             create_lm75_sensor()
 
         if mcp23017:
             create_mcp23017()
 
+        if adc_list:
+            create_adc()
+
         def configure_relay(gpio: dict) -> Any:
             """Configure kind of relay. Most common MCP."""
             relay_id = gpio[ID].replace(" ", "")
@@ -212,15 +251,9 @@ class Manager:
                         ),
                         rest_pin=gpio,
                     )
-                    availibilty_msg_func = ha_sensor_availibilty_message
+                    availibilty_msg_func = ha_input_availibilty_message
                     ha_type = SENSOR
                 if gpio.get(SHOW_HA, True):
-                    print(
-                        "INPUT sending disco",
-                        ha_type,
-                        ha_discovery_prefix,
-                        availibilty_msg_func,
-                    )
                     self.send_ha_autodiscovery(
                         id=pin,
                         name=gpio.get(ID, pin),
@@ -250,7 +283,7 @@ class Manager:
                 self._oled = Oled(
                     host_data=self._host_data, output_groups=list(self._grouped_outputs)
                 )
-            except GPIOInputException as err:
+            except (GPIOInputException, I2CError) as err:
                 _LOGGER.error("Can't configure OLED display. %s", err)
 
         self.send_message(topic=f"{topic_prefix}/{STATE}", payload=ONLINE)

{boneio-0.1.0.dev15 → boneio-0.1.0.dev16}/boneio/oled.py

@@ -5,10 +5,18 @@ from typing import List
 from luma.core.interface.serial import i2c
 from luma.core.render import canvas
 from luma.oled.device import sh1106
+from luma.core.error import DeviceNotFoundError
 from PIL import ImageDraw
 
 from boneio.const import CPU, DISK, MEMORY, NETWORK, OLED_PIN, SWAP, UPTIME, WHITE
-from boneio.helper import HostData, configure_pin, edge_detect, make_font, setup_input
+from boneio.helper import (
+    HostData,
+    configure_pin,
+    edge_detect,
+    make_font,
+    setup_input,
+    I2CError,
+)
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -38,8 +46,11 @@ class Oled:
         configure_pin(OLED_PIN)
         setup_input(OLED_PIN)
         edge_detect(pin=OLED_PIN, callback=self._handle_press, bounce=50)
-        serial = i2c(port=2, address=0x3C)
-        self._device = sh1106(serial)
+        try:
+            serial = i2c(port=2, address=0x3C)
+            self._device = sh1106(serial)
+        except DeviceNotFoundError as err:
+            raise I2CError(err)
         _LOGGER.debug("Configuring OLED screen.")
 
     def _draw_standard(self, data: dict, draw: ImageDraw) -> None:

{boneio-0.1.0.dev15 → boneio-0.1.0.dev16}/boneio/relay/basic.py

@@ -2,31 +2,23 @@
 
 import asyncio
 import logging
-from typing import Callable, Union
+from typing import Callable
 
 from boneio.const import OFF, ON, RELAY, STATE, SWITCH
+from boneio.helper import BasicMqtt
 
 _LOGGER = logging.getLogger(__name__)
 
 
-class BasicRelay:
+class BasicRelay(BasicMqtt):
     """Basic relay class."""
 
     def __init__(
-        self,
-        send_message: Callable[[str, Union[str, dict]], None],
-        callback: Callable,
-        topic_prefix: str,
-        id: str = None,
-        ha_type=SWITCH,
+        self, callback: Callable, id: str = None, ha_type=SWITCH, **kwargs
     ) -> None:
         """Initialize Basic relay."""
-        self._id = id.replace(" ", "")
-        self._name = id
+        super().__init__(id=id, name=id, topic_type=RELAY, **kwargs)
         self._ha_type = ha_type
-        self._send_message = send_message
-        self._relay_topic = f"{topic_prefix}/{RELAY}/"
-        self._send_topic = f"{self._relay_topic}{self.id}"
         self._state = False
         self._callback = callback
         self._loop = asyncio.get_running_loop()

{boneio-0.1.0.dev15 → boneio-0.1.0.dev16}/boneio/schema.yaml

@@ -225,3 +225,34 @@ input:
                 type: string
               message:
                 type: string
+
+adc:
+  type: list
+  meta:
+    label: GPIO ADC section
+  schema:
+    type: dict
+    schema:
+      id:
+        type: string
+        required: False
+        meta:
+          label: Id to use in HA if needed. Default to pin number.
+      pin:
+        type: string
+        required: True
+        allowed: ['P9_33', 'P9_35', 'P9_36', 'P9_37', 'P9_38', 'P9_39', 'P9_40']
+        meta:
+          label: PIN to use.
+      update_interval:
+        type: integer
+        required: True
+        default: 60
+        meta:
+          label: Update interval in seconds.
+      show_in_ha:
+        type: boolean
+        required: True
+        default: True
+        meta:
+          label: If you want you can disable discovering this input in HA.

boneio-0.1.0.dev16/boneio/sensor/__init__.py

@@ -0,0 +1,6 @@
+"""Sensor module."""
+from boneio.sensor.lm75 import LM75Sensor
+from boneio.sensor.gpio import GpioInputSensor
+from boneio.sensor.adc import initialize_adc, GpioADCSensor
+
+__all__ = ["LM75Sensor", "GpioInputSensor", "initialize_adc", "GpioADCSensor"]

boneio-0.1.0.dev16/boneio/sensor/adc.py

@@ -0,0 +1,38 @@
+"""ADC GPIO BBB sensor."""
+import logging
+import asyncio
+
+from boneio.const import SENSOR
+from boneio.helper import BasicMqtt
+import Adafruit_BBIO.ADC as ADC
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def initialize_adc():
+    ADC.setup()
+
+
+class GpioADCSensor(BasicMqtt):
+    """Represent Gpio ADC sensor."""
+
+    def __init__(self, pin: str, update_interval: int = 60, **kwargs) -> None:
+        """Setup GPIO ADC Sensor"""
+        super().__init__(topic_type=SENSOR, **kwargs)
+        self._pin = pin
+        self._update_interval = update_interval
+        _LOGGER.debug("Configured sensor pin %s", self._pin)
+
+    @property
+    def state(self):
+        """Give rounded value of temperature."""
+        return round(ADC.read(self._pin) * 1.8, 2)
+
+    async def send_state(self):
+        """Fetch temperature periodically and send to MQTT."""
+        while True:
+            self._send_message(
+                topic=self._send_topic,
+                payload=self.state,
+            )
+            await asyncio.sleep(self._update_interval)

{boneio-0.1.0.dev15 → boneio-0.1.0.dev16}/boneio/sensor/lm75.py

@@ -2,39 +2,23 @@
 
 import asyncio
 from adafruit_pct2075 import PCT2075
-from typing import Callable, Union
 from boneio.const import STATE, SENSOR, LM75
 
 from boneio.helper.exceptions import I2CError
+from boneio.helper import BasicMqtt
 
 
-class LM75Sensor:
+class LM75Sensor(BasicMqtt):
     """Represent LM75 sensor in BoneIO."""
 
-    def __init__(
-        self,
-        i2c,
-        address,
-        topic_prefix: str,
-        name: str,
-        send_message: Callable[[str, Union[str, dict]], None],
-        id: str = LM75,
-    ):
+    def __init__(self, i2c, address, id: str = LM75, **kwargs):
         """Initialize LM75 class."""
-        self._id = id
-        self._name = name
-        self._send_message = send_message
-        self._send_topic = f"{topic_prefix}/{SENSOR}/{self._id}"
+        super().__init__(id=id, topic_type=SENSOR, **kwargs)
         try:
             self._pct = PCT2075(i2c_bus=i2c, address=address)
         except ValueError as err:
             raise I2CError(err)
 
-    @property
-    def name(self):
-        """Return name of the sensor."""
-        return self._name
-
     @property
     def state(self):
         """Give rounded value of temperature."""

boneio-0.1.0.dev16/boneio/version.py

@@ -0,0 +1,2 @@
+# flake8: noqa
+__version__ = "0.1.0.dev16"

{boneio-0.1.0.dev15 → boneio-0.1.0.dev16}/boneio.egg-info/PKG-INFO

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

{boneio-0.1.0.dev15 → boneio-0.1.0.dev16}/boneio.egg-info/SOURCES.txt

@@ -21,6 +21,7 @@ boneio/helper/__init__.py
 boneio/helper/exceptions.py
 boneio/helper/gpio.py
 boneio/helper/ha_discovery.py
+boneio/helper/mqtt.py
 boneio/helper/oled.py
 boneio/helper/stats.py
 boneio/helper/yaml.py
@@ -31,5 +32,6 @@ boneio/relay/basic.py
 boneio/relay/gpio.py
 boneio/relay/mcp.py
 boneio/sensor/__init__.py
+boneio/sensor/adc.py
 boneio/sensor/gpio.py
 boneio/sensor/lm75.py

boneio-0.1.0.dev15/boneio/sensor/__init__.py

@@ -1,5 +0,0 @@
-"""Sensor module."""
-from boneio.sensor.lm75 import LM75Sensor
-from boneio.sensor.gpio import GpioInputSensor
-
-__all__ = ["LM75Sensor", "GpioInputSensor"]

boneio-0.1.0.dev15/boneio/version.py

@@ -1,2 +0,0 @@
-# flake8: noqa
-__version__ = "0.1.0.dev15"