mirror of
https://github.com/home-assistant/core.git
synced 2026-03-05 09:07:40 +00:00
dd3cd95954
* modbus: bumb pymodbus version to 2.3.0 pymodbus version 1.5.2 did not support asyncio, and in general the async handling have been improved a lot in version 2.3.0. updated core/requirement*txt * updated core/CODEOWNERS committing result of 'python3 -m script.hassfest'. * modbus: change core connection to async change setup() --> async_setup and update() --> async_update() Use async_setup_platform() to complete the async connection to core. listen for EVENT_HOMEASSISTANT_START happens in async_setup() so it needs to be async_listen. But listen for EVENT_HOMEASSISTANT_STOP happens in start_modbus() which is a sync. function so it continues to be listen(). * modbus: move setup of pymodbus into modbushub setup of pymodbus is logically connected to the class modbushub, therefore move it into the class. Delay construction of pymodbus client until event EVENT_HOMEASSISTANT_START arrives. * modbus: use pymodbus async library convert pymodbus calls to refer to the async library. Remark: connect() is no longer needed, it is done when constructing the client. There are also automatic reconnect. * modbus: use async update for read/write Use async functions for read/write from pymodbus. change thread.Lock() to asyncio.Lock() * Modbus: patch for slow tcp equipment When connecting, via Modbus-TCP, so some equipment (like the huawei sun2000 inverter), they need time to prepare the protocol. Solution is to add a asyncio.sleep(x) after the connect() and before sending the first message. Add optional parameter "delay" to Modbus configuration. Default is 0, which means do not execute asyncio.sleep(). * Modbus: silence pylint false positive pylint does not accept that a class construction __new__ can return a tuple. * Modbus: move constants to const.py Create const.py with constants only used in the modbus integration. Duplicate entries are removed, but NOT any entry that would lead to a configuration change. Some entries were the same but with different names, in this case renaming is done. Also correct the tests. * Modbus: move connection error handling to ModbusHub Connection error handling depends on the hub, not the entity, therefore it is logical to have the handling in ModbusHub. All pymodbus call are added to 2 generic functions (read/write) in order not to duplicate the error handling code. Added property "available" to signal if the hub is connected. * Modbus: CI cleanup Solve CI problems. * Modbus: remove close of client close() no longer exist in the pymodbus library, use del client instead. * Modbus: correct review comments Adjust code based on review comments. * Modbus: remove twister dependency Pymodbus in asyncio mode do not use twister but still throws a warning if twister is not installed, this warning goes into homeassistant.log and can thus cause confusion among users. However installing twister just to avoid the warning is not the best solution, therefore removing dependency on twister. * Modbus: review, remove comments. remove commented out code.
125 lines
3.7 KiB
Python
125 lines
3.7 KiB
Python
"""Support for Modbus Coil and Discrete Input sensors."""
|
|
import logging
|
|
from typing import Optional
|
|
|
|
from pymodbus.exceptions import ModbusException
|
|
from pymodbus.pdu import ExceptionResponse
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.binary_sensor import (
|
|
DEVICE_CLASSES_SCHEMA,
|
|
PLATFORM_SCHEMA,
|
|
BinarySensorDevice,
|
|
)
|
|
from homeassistant.const import CONF_DEVICE_CLASS, CONF_NAME, CONF_SLAVE
|
|
from homeassistant.helpers import config_validation as cv
|
|
|
|
from .const import (
|
|
CALL_TYPE_COIL,
|
|
CALL_TYPE_DISCRETE,
|
|
CONF_ADDRESS,
|
|
CONF_COILS,
|
|
CONF_HUB,
|
|
CONF_INPUT_TYPE,
|
|
CONF_INPUTS,
|
|
DEFAULT_HUB,
|
|
MODBUS_DOMAIN,
|
|
)
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
PLATFORM_SCHEMA = vol.All(
|
|
cv.deprecated(CONF_COILS, CONF_INPUTS),
|
|
PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_INPUTS): [
|
|
vol.All(
|
|
cv.deprecated(CALL_TYPE_COIL, CONF_ADDRESS),
|
|
vol.Schema(
|
|
{
|
|
vol.Required(CONF_ADDRESS): cv.positive_int,
|
|
vol.Required(CONF_NAME): cv.string,
|
|
vol.Optional(CONF_DEVICE_CLASS): DEVICE_CLASSES_SCHEMA,
|
|
vol.Optional(CONF_HUB, default=DEFAULT_HUB): cv.string,
|
|
vol.Optional(CONF_SLAVE): cv.positive_int,
|
|
vol.Optional(
|
|
CONF_INPUT_TYPE, default=CALL_TYPE_COIL
|
|
): vol.In([CALL_TYPE_COIL, CALL_TYPE_DISCRETE]),
|
|
}
|
|
),
|
|
)
|
|
]
|
|
}
|
|
),
|
|
)
|
|
|
|
|
|
async def async_setup_platform(hass, config, add_entities, discovery_info=None):
|
|
"""Set up the Modbus binary sensors."""
|
|
sensors = []
|
|
for entry in config[CONF_INPUTS]:
|
|
hub = hass.data[MODBUS_DOMAIN][entry[CONF_HUB]]
|
|
sensors.append(
|
|
ModbusBinarySensor(
|
|
hub,
|
|
entry[CONF_NAME],
|
|
entry.get(CONF_SLAVE),
|
|
entry[CONF_ADDRESS],
|
|
entry.get(CONF_DEVICE_CLASS),
|
|
entry[CONF_INPUT_TYPE],
|
|
)
|
|
)
|
|
|
|
add_entities(sensors)
|
|
|
|
|
|
class ModbusBinarySensor(BinarySensorDevice):
|
|
"""Modbus binary sensor."""
|
|
|
|
def __init__(self, hub, name, slave, address, device_class, input_type):
|
|
"""Initialize the Modbus binary sensor."""
|
|
self._hub = hub
|
|
self._name = name
|
|
self._slave = int(slave) if slave else None
|
|
self._address = int(address)
|
|
self._device_class = device_class
|
|
self._input_type = input_type
|
|
self._value = None
|
|
self._available = True
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return self._name
|
|
|
|
@property
|
|
def is_on(self):
|
|
"""Return the state of the sensor."""
|
|
return self._value
|
|
|
|
@property
|
|
def device_class(self) -> Optional[str]:
|
|
"""Return the device class of the sensor."""
|
|
return self._device_class
|
|
|
|
@property
|
|
def available(self) -> bool:
|
|
"""Return True if entity is available."""
|
|
return self._available
|
|
|
|
async def async_update(self):
|
|
"""Update the state of the sensor."""
|
|
if self._input_type == CALL_TYPE_COIL:
|
|
result = await self._hub.read_coils(self._slave, self._address, 1)
|
|
else:
|
|
result = await self._hub.read_discrete_inputs(self._slave, self._address, 1)
|
|
if result is None:
|
|
self._available = False
|
|
return
|
|
if isinstance(result, (ModbusException, ExceptionResponse)):
|
|
self._available = False
|
|
return
|
|
|
|
self._value = result.bits[0]
|
|
self._available = True
|