f8f8dddca7
* add pyserial to manifest pymodbus is very developer oriented and assumes every developer adapt the requierements.txt to his/hers needs. Our requirements.txt is different it contains all posibilities allowing user to later change configuration without having to install extra packages. As a consequence manifest.json needs to include the pyserial. * modbus: make truly async client creation Make hass call listen_once async. Integrate content of start_modbus into async_setup. Do not use the boiler plate create tcp client function from pymodbus as it is sync, and also does not work well with asyncio, instead call the init_<type> directly, since that is async. * both component/modbus and component/serial uses pyserial-async but with slighty different version requirements. Combined the 2. * Review 1 * Review 2 * Review @staticmethod is no good, because the function uses class variables. * Review Pytest is sometimes a bit cryptic, lets hope this does it.
326 lines
10 KiB
Python
326 lines
10 KiB
Python
"""Support for Modbus."""
|
|
import asyncio
|
|
import logging
|
|
|
|
from async_timeout import timeout
|
|
from pymodbus.client.asynchronous.asyncio import (
|
|
AsyncioModbusSerialClient,
|
|
ModbusClientProtocol,
|
|
init_tcp_client,
|
|
init_udp_client,
|
|
)
|
|
from pymodbus.exceptions import ModbusException
|
|
from pymodbus.factory import ClientDecoder
|
|
from pymodbus.pdu import ExceptionResponse
|
|
from pymodbus.transaction import (
|
|
ModbusAsciiFramer,
|
|
ModbusBinaryFramer,
|
|
ModbusRtuFramer,
|
|
ModbusSocketFramer,
|
|
)
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.const import (
|
|
ATTR_STATE,
|
|
CONF_DELAY,
|
|
CONF_HOST,
|
|
CONF_METHOD,
|
|
CONF_NAME,
|
|
CONF_PORT,
|
|
CONF_TIMEOUT,
|
|
CONF_TYPE,
|
|
EVENT_HOMEASSISTANT_STOP,
|
|
)
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
from .const import (
|
|
ATTR_ADDRESS,
|
|
ATTR_HUB,
|
|
ATTR_UNIT,
|
|
ATTR_VALUE,
|
|
CONF_BAUDRATE,
|
|
CONF_BYTESIZE,
|
|
CONF_PARITY,
|
|
CONF_STOPBITS,
|
|
DEFAULT_HUB,
|
|
MODBUS_DOMAIN as DOMAIN,
|
|
SERVICE_WRITE_COIL,
|
|
SERVICE_WRITE_REGISTER,
|
|
)
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
BASE_SCHEMA = vol.Schema({vol.Optional(CONF_NAME, default=DEFAULT_HUB): cv.string})
|
|
|
|
SERIAL_SCHEMA = BASE_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_BAUDRATE): cv.positive_int,
|
|
vol.Required(CONF_BYTESIZE): vol.Any(5, 6, 7, 8),
|
|
vol.Required(CONF_METHOD): vol.Any("rtu", "ascii"),
|
|
vol.Required(CONF_PORT): cv.string,
|
|
vol.Required(CONF_PARITY): vol.Any("E", "O", "N"),
|
|
vol.Required(CONF_STOPBITS): vol.Any(1, 2),
|
|
vol.Required(CONF_TYPE): "serial",
|
|
vol.Optional(CONF_TIMEOUT, default=3): cv.socket_timeout,
|
|
}
|
|
)
|
|
|
|
ETHERNET_SCHEMA = BASE_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_HOST): cv.string,
|
|
vol.Required(CONF_PORT): cv.port,
|
|
vol.Required(CONF_TYPE): vol.Any("tcp", "udp", "rtuovertcp"),
|
|
vol.Optional(CONF_TIMEOUT, default=3): cv.socket_timeout,
|
|
vol.Optional(CONF_DELAY, default=0): cv.positive_int,
|
|
}
|
|
)
|
|
|
|
CONFIG_SCHEMA = vol.Schema(
|
|
{DOMAIN: vol.All(cv.ensure_list, [vol.Any(SERIAL_SCHEMA, ETHERNET_SCHEMA)])},
|
|
extra=vol.ALLOW_EXTRA,
|
|
)
|
|
|
|
SERVICE_WRITE_REGISTER_SCHEMA = vol.Schema(
|
|
{
|
|
vol.Optional(ATTR_HUB, default=DEFAULT_HUB): cv.string,
|
|
vol.Required(ATTR_UNIT): cv.positive_int,
|
|
vol.Required(ATTR_ADDRESS): cv.positive_int,
|
|
vol.Required(ATTR_VALUE): vol.Any(
|
|
cv.positive_int, vol.All(cv.ensure_list, [cv.positive_int])
|
|
),
|
|
}
|
|
)
|
|
|
|
SERVICE_WRITE_COIL_SCHEMA = vol.Schema(
|
|
{
|
|
vol.Optional(ATTR_HUB, default=DEFAULT_HUB): cv.string,
|
|
vol.Required(ATTR_UNIT): cv.positive_int,
|
|
vol.Required(ATTR_ADDRESS): cv.positive_int,
|
|
vol.Required(ATTR_STATE): cv.boolean,
|
|
}
|
|
)
|
|
|
|
|
|
async def async_setup(hass, config):
|
|
"""Set up Modbus component."""
|
|
hass.data[DOMAIN] = hub_collect = {}
|
|
|
|
for client_config in config[DOMAIN]:
|
|
hub_collect[client_config[CONF_NAME]] = ModbusHub(client_config, hass.loop)
|
|
|
|
def stop_modbus(event):
|
|
"""Stop Modbus service."""
|
|
for client in hub_collect.values():
|
|
del client
|
|
|
|
async def write_register(service):
|
|
"""Write Modbus registers."""
|
|
unit = int(float(service.data[ATTR_UNIT]))
|
|
address = int(float(service.data[ATTR_ADDRESS]))
|
|
value = service.data[ATTR_VALUE]
|
|
client_name = service.data[ATTR_HUB]
|
|
if isinstance(value, list):
|
|
await hub_collect[client_name].write_registers(
|
|
unit, address, [int(float(i)) for i in value]
|
|
)
|
|
else:
|
|
await hub_collect[client_name].write_register(
|
|
unit, address, int(float(value))
|
|
)
|
|
|
|
async def write_coil(service):
|
|
"""Write Modbus coil."""
|
|
unit = service.data[ATTR_UNIT]
|
|
address = service.data[ATTR_ADDRESS]
|
|
state = service.data[ATTR_STATE]
|
|
client_name = service.data[ATTR_HUB]
|
|
await hub_collect[client_name].write_coil(unit, address, state)
|
|
|
|
# do not wait for EVENT_HOMEASSISTANT_START, activate pymodbus now
|
|
for client in hub_collect.values():
|
|
await client.setup(hass)
|
|
|
|
# register function to gracefully stop modbus
|
|
hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STOP, stop_modbus)
|
|
|
|
# Register services for modbus
|
|
hass.services.async_register(
|
|
DOMAIN,
|
|
SERVICE_WRITE_REGISTER,
|
|
write_register,
|
|
schema=SERVICE_WRITE_REGISTER_SCHEMA,
|
|
)
|
|
hass.services.async_register(
|
|
DOMAIN, SERVICE_WRITE_COIL, write_coil, schema=SERVICE_WRITE_COIL_SCHEMA,
|
|
)
|
|
return True
|
|
|
|
|
|
class ModbusHub:
|
|
"""Thread safe wrapper class for pymodbus."""
|
|
|
|
def __init__(self, client_config, main_loop):
|
|
"""Initialize the Modbus hub."""
|
|
|
|
# generic configuration
|
|
self._loop = main_loop
|
|
self._client = None
|
|
self._lock = asyncio.Lock()
|
|
self._config_name = client_config[CONF_NAME]
|
|
self._config_type = client_config[CONF_TYPE]
|
|
self._config_port = client_config[CONF_PORT]
|
|
self._config_timeout = client_config[CONF_TIMEOUT]
|
|
self._config_delay = 0
|
|
|
|
if self._config_type == "serial":
|
|
# serial configuration
|
|
self._config_method = client_config[CONF_METHOD]
|
|
self._config_baudrate = client_config[CONF_BAUDRATE]
|
|
self._config_stopbits = client_config[CONF_STOPBITS]
|
|
self._config_bytesize = client_config[CONF_BYTESIZE]
|
|
self._config_parity = client_config[CONF_PARITY]
|
|
else:
|
|
# network configuration
|
|
self._config_host = client_config[CONF_HOST]
|
|
self._config_delay = client_config[CONF_DELAY]
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of this hub."""
|
|
return self._config_name
|
|
|
|
async def _connect_delay(self):
|
|
if self._config_delay > 0:
|
|
await asyncio.sleep(self._config_delay)
|
|
self._config_delay = 0
|
|
|
|
@staticmethod
|
|
def _framer(method):
|
|
if method == "ascii":
|
|
framer = ModbusAsciiFramer(ClientDecoder())
|
|
elif method == "rtu":
|
|
framer = ModbusRtuFramer(ClientDecoder())
|
|
elif method == "binary":
|
|
framer = ModbusBinaryFramer(ClientDecoder())
|
|
elif method == "socket":
|
|
framer = ModbusSocketFramer(ClientDecoder())
|
|
else:
|
|
framer = None
|
|
return framer
|
|
|
|
async def setup(self, hass):
|
|
"""Set up pymodbus client."""
|
|
if self._config_type == "serial":
|
|
# reconnect ??
|
|
framer = self._framer(self._config_method)
|
|
|
|
# just a class creation no IO or other slow items
|
|
self._client = AsyncioModbusSerialClient(
|
|
self._config_port,
|
|
protocol_class=ModbusClientProtocol,
|
|
framer=framer,
|
|
loop=self._loop,
|
|
baudrate=self._config_baudrate,
|
|
bytesize=self._config_bytesize,
|
|
parity=self._config_parity,
|
|
stopbits=self._config_stopbits,
|
|
)
|
|
await self._client.connect()
|
|
elif self._config_type == "rtuovertcp":
|
|
# framer ModbusRtuFramer ??
|
|
# timeout ??
|
|
self._client = await init_tcp_client(
|
|
None, self._loop, self._config_host, self._config_port
|
|
)
|
|
elif self._config_type == "tcp":
|
|
# framer ??
|
|
# timeout ??
|
|
self._client = await init_tcp_client(
|
|
None, self._loop, self._config_host, self._config_port
|
|
)
|
|
elif self._config_type == "udp":
|
|
# framer ??
|
|
# timeout ??
|
|
self._client = await init_udp_client(
|
|
None, self._loop, self._config_host, self._config_port
|
|
)
|
|
else:
|
|
assert False
|
|
|
|
async def _read(self, unit, address, count, func):
|
|
"""Read generic with error handling."""
|
|
await self._connect_delay()
|
|
async with self._lock:
|
|
kwargs = {"unit": unit} if unit else {}
|
|
try:
|
|
async with timeout(self._config_timeout):
|
|
result = await func(address, count, **kwargs)
|
|
except asyncio.TimeoutError:
|
|
result = None
|
|
|
|
if isinstance(result, (ModbusException, ExceptionResponse)):
|
|
_LOGGER.error("Hub %s Exception (%s)", self._config_name, result)
|
|
return result
|
|
|
|
async def _write(self, unit, address, value, func):
|
|
"""Read generic with error handling."""
|
|
await self._connect_delay()
|
|
async with self._lock:
|
|
kwargs = {"unit": unit} if unit else {}
|
|
try:
|
|
async with timeout(self._config_timeout):
|
|
func(address, value, **kwargs)
|
|
except asyncio.TimeoutError:
|
|
return
|
|
|
|
async def read_coils(self, unit, address, count):
|
|
"""Read coils."""
|
|
if self._client.protocol is None:
|
|
return None
|
|
return await self._read(unit, address, count, self._client.protocol.read_coils)
|
|
|
|
async def read_discrete_inputs(self, unit, address, count):
|
|
"""Read discrete inputs."""
|
|
if self._client.protocol is None:
|
|
return None
|
|
return await self._read(
|
|
unit, address, count, self._client.protocol.read_discrete_inputs
|
|
)
|
|
|
|
async def read_input_registers(self, unit, address, count):
|
|
"""Read input registers."""
|
|
if self._client.protocol is None:
|
|
return None
|
|
return await self._read(
|
|
unit, address, count, self._client.protocol.read_input_registers
|
|
)
|
|
|
|
async def read_holding_registers(self, unit, address, count):
|
|
"""Read holding registers."""
|
|
if self._client.protocol is None:
|
|
return None
|
|
return await self._read(
|
|
unit, address, count, self._client.protocol.read_holding_registers
|
|
)
|
|
|
|
async def write_coil(self, unit, address, value):
|
|
"""Write coil."""
|
|
if self._client.protocol is None:
|
|
return None
|
|
return await self._write(unit, address, value, self._client.protocol.write_coil)
|
|
|
|
async def write_register(self, unit, address, value):
|
|
"""Write register."""
|
|
if self._client.protocol is None:
|
|
return None
|
|
return await self._write(
|
|
unit, address, value, self._client.protocol.write_register
|
|
)
|
|
|
|
async def write_registers(self, unit, address, values):
|
|
"""Write registers."""
|
|
if self._client.protocol is None:
|
|
return None
|
|
return await self._write(
|
|
unit, address, values, self._client.protocol.write_registers
|
|
)
|