Modbus switch register support (#10563)
* Update modbus.py * Fix blank linea and whitespaces * Fix visual indent * Fix visual indent * fix multiple statements on one line * Typo * Disable pylint check # pylint: disable=super-init-not-called * Fix code style
This commit is contained in:
ziotibia81
Paulus Schoutsen
parent
b2ab4443a7
commit
270846c2f5
1 changed files with 138 additions and 14 deletions
|
|
@ -8,7 +8,8 @@ import logging
|
|||
import voluptuous as vol
|
||||
|
||||
import homeassistant.components.modbus as modbus
|
||||
from homeassistant.const import CONF_NAME, CONF_SLAVE
|
||||
from homeassistant.const import (
|
||||
CONF_NAME, CONF_SLAVE, CONF_COMMAND_ON, CONF_COMMAND_OFF)
|
||||
from homeassistant.helpers.entity import ToggleEntity
|
||||
from homeassistant.helpers import config_validation as cv
|
||||
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
||||
|
|
@ -18,32 +19,76 @@ DEPENDENCIES = ['modbus']
|
|||
|
||||
CONF_COIL = "coil"
|
||||
CONF_COILS = "coils"
|
||||
CONF_REGISTER = "register"
|
||||
CONF_REGISTERS = "registers"
|
||||
CONF_VERIFY_STATE = "verify_state"
|
||||
CONF_VERIFY_REGISTER = "verify_register"
|
||||
CONF_REGISTER_TYPE = "register_type"
|
||||
CONF_STATE_ON = "state_on"
|
||||
CONF_STATE_OFF = "state_off"
|
||||
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||
vol.Required(CONF_COILS): [{
|
||||
vol.Required(CONF_COIL): cv.positive_int,
|
||||
vol.Required(CONF_NAME): cv.string,
|
||||
vol.Optional(CONF_SLAVE): cv.positive_int,
|
||||
}]
|
||||
REGISTER_TYPE_HOLDING = 'holding'
|
||||
REGISTER_TYPE_INPUT = 'input'
|
||||
|
||||
REGISTERS_SCHEMA = vol.Schema({
|
||||
vol.Required(CONF_NAME): cv.string,
|
||||
vol.Optional(CONF_SLAVE): cv.positive_int,
|
||||
vol.Required(CONF_REGISTER): cv.positive_int,
|
||||
vol.Required(CONF_COMMAND_ON): cv.positive_int,
|
||||
vol.Required(CONF_COMMAND_OFF): cv.positive_int,
|
||||
vol.Optional(CONF_VERIFY_STATE, default=True): cv.boolean,
|
||||
vol.Optional(CONF_VERIFY_REGISTER, default=None):
|
||||
cv.positive_int,
|
||||
vol.Optional(CONF_REGISTER_TYPE, default=REGISTER_TYPE_HOLDING):
|
||||
vol.In([REGISTER_TYPE_HOLDING, REGISTER_TYPE_INPUT]),
|
||||
vol.Optional(CONF_STATE_ON, default=None): cv.positive_int,
|
||||
vol.Optional(CONF_STATE_OFF, default=None): cv.positive_int,
|
||||
})
|
||||
|
||||
COILS_SCHEMA = vol.Schema({
|
||||
vol.Required(CONF_COIL): cv.positive_int,
|
||||
vol.Required(CONF_NAME): cv.string,
|
||||
vol.Required(CONF_SLAVE): cv.positive_int,
|
||||
})
|
||||
|
||||
PLATFORM_SCHEMA = vol.All(
|
||||
cv.has_at_least_one_key(CONF_COILS, CONF_REGISTERS),
|
||||
PLATFORM_SCHEMA.extend({
|
||||
vol.Optional(CONF_COILS): [COILS_SCHEMA],
|
||||
vol.Optional(CONF_REGISTERS): [REGISTERS_SCHEMA]
|
||||
}))
|
||||
|
||||
|
||||
def setup_platform(hass, config, add_devices, discovery_info=None):
|
||||
"""Read configuration and create Modbus devices."""
|
||||
switches = []
|
||||
for coil in config.get("coils"):
|
||||
switches.append(ModbusCoilSwitch(
|
||||
coil.get(CONF_NAME),
|
||||
coil.get(CONF_SLAVE),
|
||||
coil.get(CONF_COIL)))
|
||||
if CONF_COILS in config:
|
||||
for coil in config.get(CONF_COILS):
|
||||
switches.append(ModbusCoilSwitch(
|
||||
coil.get(CONF_NAME),
|
||||
coil.get(CONF_SLAVE),
|
||||
coil.get(CONF_COIL)))
|
||||
if CONF_REGISTERS in config:
|
||||
for register in config.get(CONF_REGISTERS):
|
||||
switches.append(ModbusRegisterSwitch(
|
||||
register.get(CONF_NAME),
|
||||
register.get(CONF_SLAVE),
|
||||
register.get(CONF_REGISTER),
|
||||
register.get(CONF_COMMAND_ON),
|
||||
register.get(CONF_COMMAND_OFF),
|
||||
register.get(CONF_VERIFY_STATE),
|
||||
register.get(CONF_VERIFY_REGISTER),
|
||||
register.get(CONF_REGISTER_TYPE),
|
||||
register.get(CONF_STATE_ON),
|
||||
register.get(CONF_STATE_OFF)))
|
||||
add_devices(switches)
|
||||
|
||||
|
||||
class ModbusCoilSwitch(ToggleEntity):
|
||||
"""Representation of a Modbus switch."""
|
||||
"""Representation of a Modbus coil switch."""
|
||||
|
||||
def __init__(self, name, slave, coil):
|
||||
"""Initialize the switch."""
|
||||
"""Initialize the coil switch."""
|
||||
self._name = name
|
||||
self._slave = int(slave) if slave else None
|
||||
self._coil = int(coil)
|
||||
|
|
@ -77,3 +122,82 @@ class ModbusCoilSwitch(ToggleEntity):
|
|||
'No response from modbus slave %s coil %s',
|
||||
self._slave,
|
||||
self._coil)
|
||||
|
||||
|
||||
class ModbusRegisterSwitch(ModbusCoilSwitch):
|
||||
"""Representation of a Modbus register switch."""
|
||||
|
||||
# pylint: disable=super-init-not-called
|
||||
def __init__(self, name, slave, register, command_on,
|
||||
command_off, verify_state, verify_register,
|
||||
register_type, state_on, state_off):
|
||||
"""Initialize the register switch."""
|
||||
self._name = name
|
||||
self._slave = slave
|
||||
self._register = register
|
||||
self._command_on = command_on
|
||||
self._command_off = command_off
|
||||
self._verify_state = verify_state
|
||||
self._verify_register = (
|
||||
verify_register if verify_register else self._register)
|
||||
self._register_type = register_type
|
||||
self._state_on = (
|
||||
state_on if state_on else self._command_on)
|
||||
self._state_off = (
|
||||
state_off if state_off else self._command_off)
|
||||
self._is_on = None
|
||||
|
||||
def turn_on(self, **kwargs):
|
||||
"""Set switch on."""
|
||||
modbus.HUB.write_register(
|
||||
self._slave,
|
||||
self._register,
|
||||
self._command_on)
|
||||
if not self._verify_state:
|
||||
self._is_on = True
|
||||
|
||||
def turn_off(self, **kwargs):
|
||||
"""Set switch off."""
|
||||
modbus.HUB.write_register(
|
||||
self._slave,
|
||||
self._register,
|
||||
self._command_off)
|
||||
if not self._verify_state:
|
||||
self._is_on = False
|
||||
|
||||
def update(self):
|
||||
"""Update the state of the switch."""
|
||||
if not self._verify_state:
|
||||
return
|
||||
|
||||
value = 0
|
||||
if self._register_type == REGISTER_TYPE_INPUT:
|
||||
result = modbus.HUB.read_input_registers(
|
||||
self._slave,
|
||||
self._register,
|
||||
1)
|
||||
else:
|
||||
result = modbus.HUB.read_holding_registers(
|
||||
self._slave,
|
||||
self._register,
|
||||
1)
|
||||
|
||||
try:
|
||||
value = int(result.registers[0])
|
||||
except AttributeError:
|
||||
_LOGGER.error(
|
||||
'No response from modbus slave %s register %s',
|
||||
self._slave,
|
||||
self._verify_register)
|
||||
|
||||
if value == self._state_on:
|
||||
self._is_on = True
|
||||
elif value == self._state_off:
|
||||
self._is_on = False
|
||||
else:
|
||||
_LOGGER.error(
|
||||
'Unexpected response from modbus slave %s '
|
||||
'register %s, got 0x%2x',
|
||||
self._slave,
|
||||
self._verify_register,
|
||||
value)
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue