127 lines
3.7 KiB
Python
127 lines
3.7 KiB
Python
"""Support for Modbus Coil and Discrete Input sensors."""
|
|
import logging
|
|
from typing import Optional
|
|
|
|
from pymodbus.exceptions import ConnectionException, ModbusException
|
|
from pymodbus.pdu import ExceptionResponse
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.binary_sensor import (
|
|
DEVICE_CLASSES_SCHEMA,
|
|
PLATFORM_SCHEMA,
|
|
BinarySensorEntity,
|
|
)
|
|
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]),
|
|
}
|
|
),
|
|
)
|
|
]
|
|
}
|
|
),
|
|
)
|
|
|
|
|
|
def 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(BinarySensorEntity):
|
|
"""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
|
|
|
|
def update(self):
|
|
"""Update the state of the sensor."""
|
|
try:
|
|
if self._input_type == CALL_TYPE_COIL:
|
|
result = self._hub.read_coils(self._slave, self._address, 1)
|
|
else:
|
|
result = self._hub.read_discrete_inputs(self._slave, self._address, 1)
|
|
except ConnectionException:
|
|
self._available = False
|
|
return
|
|
|
|
if isinstance(result, (ModbusException, ExceptionResponse)):
|
|
self._available = False
|
|
return
|
|
|
|
self._value = result.bits[0]
|
|
self._available = True
|