"""Base implementation for all modbus platforms.""" from __future__ import annotations from abc import abstractmethod from datetime import timedelta import logging from typing import Any from homeassistant.const import ( CONF_ADDRESS, CONF_COMMAND_OFF, CONF_COMMAND_ON, CONF_DELAY, CONF_DEVICE_CLASS, CONF_NAME, CONF_SCAN_INTERVAL, CONF_SLAVE, STATE_ON, ) from homeassistant.helpers.entity import Entity from homeassistant.helpers.event import async_call_later, async_track_time_interval from homeassistant.helpers.restore_state import RestoreEntity from .const import ( CALL_TYPE_COIL, CALL_TYPE_REGISTER_HOLDING, CALL_TYPE_WRITE_COIL, CALL_TYPE_WRITE_COILS, CALL_TYPE_WRITE_REGISTER, CALL_TYPE_WRITE_REGISTERS, CALL_TYPE_X_COILS, CALL_TYPE_X_REGISTER_HOLDINGS, CONF_INPUT_TYPE, CONF_STATE_OFF, CONF_STATE_ON, CONF_VERIFY, CONF_WRITE_TYPE, ) from .modbus import ModbusHub PARALLEL_UPDATES = 1 _LOGGER = logging.getLogger(__name__) class BasePlatform(Entity): """Base for readonly platforms.""" def __init__(self, hub: ModbusHub, entry: dict[str, Any]) -> None: """Initialize the Modbus binary sensor.""" self._hub = hub self._name = entry[CONF_NAME] self._slave = entry.get(CONF_SLAVE) self._address = int(entry[CONF_ADDRESS]) self._device_class = entry.get(CONF_DEVICE_CLASS) self._input_type = entry[CONF_INPUT_TYPE] self._value = None self._available = True self._scan_interval = int(entry[CONF_SCAN_INTERVAL]) @abstractmethod async def async_update(self, now=None): """Virtual function to be overwritten.""" async def async_base_added_to_hass(self): """Handle entity which will be added.""" if self._scan_interval > 0: async_track_time_interval( self.hass, self.async_update, timedelta(seconds=self._scan_interval) ) @property def name(self): """Return the name of the sensor.""" return self._name @property def should_poll(self): """Return True if entity has to be polled for state.""" return False @property def device_class(self) -> str | None: """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 class BaseSwitch(BasePlatform, RestoreEntity): """Base class representing a Modbus switch.""" def __init__(self, hub: ModbusHub, config: dict) -> None: """Initialize the switch.""" config[CONF_INPUT_TYPE] = "" super().__init__(hub, config) self._is_on = None convert = { CALL_TYPE_REGISTER_HOLDING: ( CALL_TYPE_REGISTER_HOLDING, CALL_TYPE_WRITE_REGISTER, ), CALL_TYPE_COIL: (CALL_TYPE_COIL, CALL_TYPE_WRITE_COIL), CALL_TYPE_X_COILS: (CALL_TYPE_COIL, CALL_TYPE_WRITE_COILS), CALL_TYPE_X_REGISTER_HOLDINGS: ( CALL_TYPE_REGISTER_HOLDING, CALL_TYPE_WRITE_REGISTERS, ), } self._write_type = convert[config[CONF_WRITE_TYPE]][1] self.command_on = config[CONF_COMMAND_ON] self._command_off = config[CONF_COMMAND_OFF] if CONF_VERIFY in config: if config[CONF_VERIFY] is None: config[CONF_VERIFY] = {} self._verify_active = True self._verify_delay = config[CONF_VERIFY].get(CONF_DELAY, 0) self._verify_address = config[CONF_VERIFY].get( CONF_ADDRESS, config[CONF_ADDRESS] ) self._verify_type = config[CONF_VERIFY].get( CONF_INPUT_TYPE, convert[config[CONF_WRITE_TYPE]][0] ) self._state_on = config[CONF_VERIFY].get(CONF_STATE_ON, self.command_on) self._state_off = config[CONF_VERIFY].get(CONF_STATE_OFF, self._command_off) else: self._verify_active = False async def async_added_to_hass(self): """Handle entity which will be added.""" await self.async_base_added_to_hass() state = await self.async_get_last_state() if state: self._is_on = state.state == STATE_ON @property def is_on(self): """Return true if switch is on.""" return self._is_on async def async_turn(self, command): """Evaluate switch result.""" result = await self._hub.async_pymodbus_call( self._slave, self._address, command, self._write_type ) if result is None: self._available = False self.async_write_ha_state() return self._available = True if not self._verify_active: self._is_on = command == self.command_on self.async_write_ha_state() return if self._verify_delay: async_call_later(self.hass, self._verify_delay, self.async_update) else: await self.async_update() async def async_turn_off(self, **kwargs): """Set switch off.""" await self.async_turn(self._command_off) async def async_update(self, now=None): """Update the entity state.""" # remark "now" is a dummy parameter to avoid problems with # async_track_time_interval if not self._verify_active: self._available = True self.async_write_ha_state() return result = await self._hub.async_pymodbus_call( self._slave, self._verify_address, 1, self._verify_type ) if result is None: self._available = False self.async_write_ha_state() return self._available = True if self._verify_type == CALL_TYPE_COIL: self._is_on = bool(result.bits[0] & 1) else: value = int(result.registers[0]) if value == self._state_on: self._is_on = True elif value == self._state_off: self._is_on = False elif value is not None: _LOGGER.error( "Unexpected response from modbus device slave %s register %s, got 0x%2x", self._slave, self._verify_address, value, ) self.async_write_ha_state()