Modbus coil support

This commit is contained in:
Vitor Espíndola 2015-07-29 14:04:32 -03:00
parent dc2ed19105
commit f82b63483a
2 changed files with 94 additions and 53 deletions

View File

@ -18,6 +18,9 @@ sensor:
name: My boolean sensor name: My boolean sensor
2: 2:
name: My other boolean sensor name: My other boolean sensor
coils:
0:
name: My coil switch
VARIABLES: VARIABLES:
@ -25,6 +28,7 @@ VARIABLES:
- "unit" = unit to attach to value (optional, ignored for boolean sensors) - "unit" = unit to attach to value (optional, ignored for boolean sensors)
- "registers" contains a list of relevant registers to read from - "registers" contains a list of relevant registers to read from
it can contain a "bits" section, listing relevant bits it can contain a "bits" section, listing relevant bits
- "coils" contains a list of relevant coils to read from
- each named register will create an integer sensor - each named register will create an integer sensor
- each named bit will create a boolean sensor - each named bit will create a boolean sensor
@ -49,21 +53,30 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
_LOGGER.error("No slave number provided for serial Modbus") _LOGGER.error("No slave number provided for serial Modbus")
return False return False
registers = config.get("registers") registers = config.get("registers")
for regnum, register in registers.items(): if registers:
if register.get("name"): for regnum, register in registers.items():
sensors.append(ModbusSensor(register.get("name"), if register.get("name"):
sensors.append(ModbusSensor(register.get("name"),
slave,
regnum,
None,
register.get("unit")))
if register.get("bits"):
bits = register.get("bits")
for bitnum, bit in bits.items():
if bit.get("name"):
sensors.append(ModbusSensor(bit.get("name"),
slave,
regnum,
bitnum))
coils = config.get("coils")
if coils:
for coilnum, coil in coils.items():
sensors.append(ModbusSensor(coil.get("name"),
slave, slave,
regnum, coilnum,
None, coil=True))
register.get("unit")))
if register.get("bits"):
bits = register.get("bits")
for bitnum, bit in bits.items():
if bit.get("name"):
sensors.append(ModbusSensor(bit.get("name"),
slave,
regnum,
bitnum))
add_devices(sensors) add_devices(sensors)
@ -71,13 +84,14 @@ class ModbusSensor(Entity):
# pylint: disable=too-many-arguments # pylint: disable=too-many-arguments
""" Represents a Modbus Sensor """ """ Represents a Modbus Sensor """
def __init__(self, name, slave, register, bit=None, unit=None): def __init__(self, name, slave, register, bit=None, unit=None, coil=False):
self._name = name self._name = name
self.slave = int(slave) if slave else 1 self.slave = int(slave) if slave else 1
self.register = int(register) self.register = int(register)
self.bit = int(bit) if bit else None self.bit = int(bit) if bit else None
self._value = None self._value = None
self._unit = unit self._unit = unit
self._coil = coil
def __str__(self): def __str__(self):
return "%s: %s" % (self.name, self.state) return "%s: %s" % (self.name, self.state)
@ -124,13 +138,17 @@ class ModbusSensor(Entity):
return attr return attr
def update(self): def update(self):
result = modbus.NETWORK.read_holding_registers(unit=self.slave, if self._coil:
result = modbus.NETWORK.read_coils(self.register, 1)
self._value = result.bits[0]
else:
result = modbus.NETWORK.read_holding_registers(unit=self.slave,
address=self.register, address=self.register,
count=1) count=1)
val = 0 val = 0
for i, res in enumerate(result.registers): for i, res in enumerate(result.registers):
val += res * (2**(i*16)) val += res * (2**(i*16))
if self.bit: if self.bit:
self._value = val & (0x0001 << self.bit) self._value = val & (0x0001 << self.bit)
else: else:
self._value = val self._value = val

View File

@ -18,12 +18,16 @@ sensor:
name: My switch name: My switch
2: 2:
name: My other switch name: My other switch
coils:
0:
name: My coil switch
VARIABLES: VARIABLES:
- "slave" = slave number (ignored and can be omitted if not serial Modbus) - "slave" = slave number (ignored and can be omitted if not serial Modbus)
- "registers" contains a list of relevant registers to read from - "registers" contains a list of relevant registers to read from
- it must contain a "bits" section, listing relevant bits - it must contain a "bits" section, listing relevant bits
- "coils" contains a list of relevant coils to read from/write to
- each named bit will create a switch - each named bit will create a switch
""" """
@ -44,28 +48,38 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
_LOGGER.error("No slave number provided for serial Modbus") _LOGGER.error("No slave number provided for serial Modbus")
return False return False
registers = config.get("registers") registers = config.get("registers")
for regnum, register in registers.items(): if registers:
bits = register.get("bits") for regnum, register in registers.items():
for bitnum, bit in bits.items(): bits = register.get("bits")
if bit.get("name"): for bitnum, bit in bits.items():
switches.append(ModbusSwitch(bit.get("name"), if bit.get("name"):
slave, switches.append(ModbusSwitch(bit.get("name"),
regnum, slave,
bitnum)) regnum,
bitnum))
coils = config.get("coils")
if coils:
for coilnum, coil in coils.items():
switches.append(ModbusSwitch(coil.get("name"),
slave,
coilnum,
0,
coil=True))
add_devices(switches) add_devices(switches)
class ModbusSwitch(ToggleEntity): class ModbusSwitch(ToggleEntity):
""" Represents a Modbus switch. """ """ Represents a Modbus switch. """
def __init__(self, name, slave, register, bit): def __init__(self, name, slave, register, bit, coil=False):
self._name = name self._name = name
self.slave = int(slave) if slave else 1 self.slave = int(slave) if slave else 1
self.register = int(register) self.register = int(register)
self.bit = int(bit) self.bit = int(bit)
self._coil = coil
self._is_on = None self._is_on = None
self.register_value = None self.register_value = None
def __str__(self): def __str__(self):
return "%s: %s" % (self.name, self.state) return "%s: %s" % (self.name, self.state)
@ -98,27 +112,36 @@ class ModbusSwitch(ToggleEntity):
return attr return attr
def turn_on(self, **kwargs): def turn_on(self, **kwargs):
if self.register_value is None: if self._coil:
self.update() modbus.NETWORK.write_coil(self.register, True)
val = self.register_value | (0x0001 << self.bit) else:
modbus.NETWORK.write_register(unit=self.slave, if self.register_value is None:
address=self.register, self.update()
value=val) val = self.register_value | (0x0001 << self.bit)
modbus.NETWORK.write_register(unit=self.slave,
address=self.register,
value=val)
def turn_off(self, **kwargs): def turn_off(self, **kwargs):
if self.register_value is None: if self._coil:
self.update() r = modbus.NETWORK.write_coil(self.register, False)
val = self.register_value & ~(0x0001 << self.bit) else:
modbus.NETWORK.write_register(unit=self.slave, if self.register_value is None:
address=self.register, self.update()
value=val) val = self.register_value & ~(0x0001 << self.bit)
modbus.NETWORK.write_register(unit=self.slave,
address=self.register,
value=val)
def update(self): def update(self):
result = modbus.NETWORK.read_holding_registers(unit=self.slave, if self._coil:
address=self.register, result = modbus.NETWORK.read_coils(self.register, 1)
count=1) self.register_value = result.bits[0]
val = 0 self._is_on = self.register_value
for i, res in enumerate(result.registers): else:
val += res * (2**(i*16)) result = modbus.NETWORK.read_holding_registers(unit=self.slave, address=self.register, count=1)
self.register_value = val val = 0
self._is_on = (val & (0x0001 << self.bit) > 0) for i, res in enumerate(result.registers):
val += res * (2**(i*16))
self.register_value = val
self._is_on = (val & (0x0001 << self.bit) > 0)