Add numato integration (#33816)
* Add support for Numato 32 port USB GPIO boards Included are a binary_sensor, sensor and switch component implementations. The binary_sensor interface pushes updates via registered callback functions, so no need to poll here. Unit tests are included to test against a Numato device mockup. * Refactor numato configuration due to PR finding * Resolve minor review findings * Bump numato-gpio requirement * Load numato platforms during domain setup According to review finding * Guard from platform setup without discovery_info According to review finding * Move numato API state into hass.data According to review finding. * Avoid side effects in numato entity constructors According to review finding * Keep only first line of numato module docstrings Removed reference to the documentation. Requested by reviewer. * Minor improvements inspired by review findings * Fix async tests Pytest fixture was returning from the yield too early executing teardown code during test execution. * Improve test coverage * Configure GPIO ports early Review finding * Move read_gpio callback to outside the loop Also continue on failed switch setup, resolve other minor review findings and correct some error messages * Bump numato-gpio requirement This fixes a crash during cleanup. When any device had a communication problem, its cleanup would raise an exception which was not handled, fell through to the caller and prevented the remaining devices from being cleaned up. * Call services directly Define local helper functions for better readability. Resolves a review finding. * Assert something in every test So not only coverage is satisfied but things are actually tested to be in the expected state. Resolves a review finding. * Clarify scope of notification tests Make unit test for hass NumatoAPI independent of Home Assistant (very basic test of notifications). Improve the regular operations test for notifications. * Test for hass.states after operating switches Resolves a review finding. * Check for wrong port directions * WIP: Split numato tests to multiple files test_hass_binary_sensor_notification still fails. * Remove pytest asyncio decorator Apears to be redundant. Resolves a review finding. * Call switch services directly. Resolves a review finding. * Remove obsolete inline pylint config Co-Authored-By: Martin Hjelmare <marhje52@gmail.com> * Improve the numato_gpio module mockup Resolves a review finding. * Remove needless explicit conversions to str Resolves review findings. * Test setup of binary_sensor callbacks * Fix test_hass_binary_sensor_notification * Add forgotten await Review finding. Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
1 parent
b4083dc14f
commit
15b1a9ecea
16 files changed
+1135
No files matched your search
@@ -0,0 +1,108 @@
|
||||
"""Switch platform integration for Numato USB GPIO expanders."""
|
||||
import logging
|
||||
|
||||
from numato_gpio import NumatoGpioError
|
||||
|
||||
from homeassistant.const import (
|
||||
CONF_DEVICES,
|
||||
CONF_ID,
|
||||
CONF_SWITCHES,
|
||||
DEVICE_DEFAULT_NAME,
|
||||
)
|
||||
from homeassistant.helpers.entity import ToggleEntity
|
||||
|
||||
from . import CONF_INVERT_LOGIC, CONF_PORTS, DATA_API, DOMAIN
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def setup_platform(hass, config, add_entities, discovery_info=None):
|
||||
"""Set up the configured Numato USB GPIO switch ports."""
|
||||
if discovery_info is None:
|
||||
return
|
||||
|
||||
api = hass.data[DOMAIN][DATA_API]
|
||||
switches = []
|
||||
devices = hass.data[DOMAIN][CONF_DEVICES]
|
||||
for device in [d for d in devices if CONF_SWITCHES in d]:
|
||||
device_id = device[CONF_ID]
|
||||
platform = device[CONF_SWITCHES]
|
||||
invert_logic = platform[CONF_INVERT_LOGIC]
|
||||
ports = platform[CONF_PORTS]
|
||||
for port, port_name in ports.items():
|
||||
try:
|
||||
api.setup_output(device_id, port)
|
||||
api.write_output(device_id, port, 1 if invert_logic else 0)
|
||||
except NumatoGpioError as err:
|
||||
_LOGGER.error(
|
||||
"Failed to initialize switch '%s' on Numato device %s port %s: %s",
|
||||
port_name,
|
||||
device_id,
|
||||
port,
|
||||
err,
|
||||
)
|
||||
continue
|
||||
switches.append(
|
||||
NumatoGpioSwitch(port_name, device_id, port, invert_logic, api,)
|
||||
)
|
||||
add_entities(switches, True)
|
||||
|
||||
|
||||
class NumatoGpioSwitch(ToggleEntity):
|
||||
"""Representation of a Numato USB GPIO switch port."""
|
||||
|
||||
def __init__(self, name, device_id, port, invert_logic, api):
|
||||
"""Initialize the port."""
|
||||
self._name = name or DEVICE_DEFAULT_NAME
|
||||
self._device_id = device_id
|
||||
self._port = port
|
||||
self._invert_logic = invert_logic
|
||||
self._state = False
|
||||
self._api = api
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""Return the name of the switch."""
|
||||
return self._name
|
||||
|
||||
@property
|
||||
def should_poll(self):
|
||||
"""No polling needed."""
|
||||
return False
|
||||
|
||||
@property
|
||||
def is_on(self):
|
||||
"""Return true if port is turned on."""
|
||||
return self._state
|
||||
|
||||
def turn_on(self, **kwargs):
|
||||
"""Turn the port on."""
|
||||
try:
|
||||
self._api.write_output(
|
||||
self._device_id, self._port, 0 if self._invert_logic else 1
|
||||
)
|
||||
self._state = True
|
||||
self.schedule_update_ha_state()
|
||||
except NumatoGpioError as err:
|
||||
_LOGGER.error(
|
||||
"Failed to turn on Numato device %s port %s: %s",
|
||||
self._device_id,
|
||||
self._port,
|
||||
err,
|
||||
)
|
||||
|
||||
def turn_off(self, **kwargs):
|
||||
"""Turn the port off."""
|
||||
try:
|
||||
self._api.write_output(
|
||||
self._device_id, self._port, 1 if self._invert_logic else 0
|
||||
)
|
||||
self._state = False
|
||||
self.schedule_update_ha_state()
|
||||
except NumatoGpioError as err:
|
||||
_LOGGER.error(
|
||||
"Failed to turn off Numato device %s port %s: %s",
|
||||
self._device_id,
|
||||
self._port,
|
||||
err,
|
||||
)
|
||||
Reference in new issue
Block a user