Home-Assistant
/
core
mirror of https://github.com/home-assistant/core.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add virtual_count == slave_count in modbus configuration (#100398) 

* Add virtual_count as config parameter.

* Review (other PR) comments.

* Review.

* Review comment.
pull/100434/head
jan iversen 2023-09-15 14:00:02 +02:00 committed by GitHub
parent c173ebd11a
commit ec2364ef43
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 29 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
homeassistant/components/modbus/__init__.py
View File

@ -106,6 +106,7 @@ from .const import ( # noqa: F401
CONF_TARGET_TEMP,
CONF_TARGET_TEMP_WRITE_REGISTERS,
CONF_VERIFY,
CONF_VIRTUAL_COUNT,
CONF_WRITE_REGISTERS,
CONF_WRITE_TYPE,
CONF_ZERO_SUPPRESS,
@ -310,7 +311,8 @@ SENSOR_SCHEMA = vol.All(
vol.Optional(CONF_DEVICE_CLASS): SENSOR_DEVICE_CLASSES_SCHEMA,
vol.Optional(CONF_STATE_CLASS): SENSOR_STATE_CLASSES_SCHEMA,
vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
vol.Optional(CONF_SLAVE_COUNT, default=0): cv.positive_int,
vol.Exclusive(CONF_VIRTUAL_COUNT, "vir_sen_count"): cv.positive_int,
vol.Optional(CONF_SLAVE_COUNT, "vir_sen_count"): cv.positive_int,
vol.Optional(CONF_MIN_VALUE): number_validator,
vol.Optional(CONF_MAX_VALUE): number_validator,
vol.Optional(CONF_NAN_VALUE): nan_validator,
@ -330,7 +332,8 @@ BINARY_SENSOR_SCHEMA = BASE_COMPONENT_SCHEMA.extend(
CALL_TYPE_REGISTER_INPUT,
]
),
vol.Optional(CONF_SLAVE_COUNT, default=0): cv.positive_int,
vol.Exclusive(CONF_VIRTUAL_COUNT, "vir_bin_count"): cv.positive_int,
vol.Exclusive(CONF_SLAVE_COUNT, "vir_bin_count"): cv.positive_int,
}
)

5
homeassistant/components/modbus/base_platform.py
View File

@ -59,6 +59,7 @@ from .const import (
CONF_SWAP_WORD,
CONF_SWAP_WORD_BYTE,
CONF_VERIFY,
CONF_VIRTUAL_COUNT,
CONF_WRITE_TYPE,
CONF_ZERO_SUPPRESS,
SIGNAL_START_ENTITY,
@ -166,7 +167,9 @@ class BaseStructPlatform(BasePlatform, RestoreEntity):
if self._scale < 1 and not self._precision:
self._precision = 2
self._offset = config[CONF_OFFSET]
self._slave_count = config.get(CONF_SLAVE_COUNT, 0)
self._slave_count = config.get(CONF_SLAVE_COUNT, None) or config.get(
CONF_VIRTUAL_COUNT, 0
)
self._slave_size = self._count = config[CONF_COUNT]
def _swap_registers(self, registers: list[int], slave_count: int) -> list[int]:

11
homeassistant/components/modbus/binary_sensor.py
View File

@ -24,7 +24,12 @@ from homeassistant.helpers.update_coordinator import (
from . import get_hub
from .base_platform import BasePlatform
from .const import CALL_TYPE_COIL, CALL_TYPE_DISCRETE, CONF_SLAVE_COUNT
from .const import (
CALL_TYPE_COIL,
CALL_TYPE_DISCRETE,
CONF_SLAVE_COUNT,
CONF_VIRTUAL_COUNT,
)
from .modbus import ModbusHub
_LOGGER = logging.getLogger(__name__)
@ -46,7 +51,9 @@ async def async_setup_platform(
sensors: list[ModbusBinarySensor | SlaveSensor] = []
hub = get_hub(hass, discovery_info[CONF_NAME])
for entry in discovery_info[CONF_BINARY_SENSORS]:
slave_count = entry.get(CONF_SLAVE_COUNT, 0)
slave_count = entry.get(CONF_SLAVE_COUNT, None) or entry.get(
CONF_VIRTUAL_COUNT, 0
)
sensor = ModbusBinarySensor(hub, entry, slave_count)
if slave_count > 0:
sensors.extend(await sensor.async_setup_slaves(hass, slave_count, entry))

1
homeassistant/components/modbus/const.py
View File

@ -62,6 +62,7 @@ CONF_HVAC_MODE_DRY = "state_dry"
CONF_HVAC_MODE_FAN_ONLY = "state_fan_only"
CONF_WRITE_REGISTERS = "write_registers"
CONF_VERIFY = "verify"
CONF_VIRTUAL_COUNT = "virtual_count"
CONF_WRITE_TYPE = "write_type"
CONF_ZERO_SUPPRESS = "zero_suppress"

6
homeassistant/components/modbus/sensor.py
View File

@ -28,7 +28,7 @@ from homeassistant.helpers.update_coordinator import (
from . import get_hub
from .base_platform import BaseStructPlatform
from .const import CONF_SLAVE_COUNT
from .const import CONF_SLAVE_COUNT, CONF_VIRTUAL_COUNT
from .modbus import ModbusHub
_LOGGER = logging.getLogger(__name__)
@ -50,7 +50,9 @@ async def async_setup_platform(
sensors: list[ModbusRegisterSensor | SlaveSensor] = []
hub = get_hub(hass, discovery_info[CONF_NAME])
for entry in discovery_info[CONF_SENSORS]:
slave_count = entry.get(CONF_SLAVE_COUNT, 0)
slave_count = entry.get(CONF_SLAVE_COUNT, None) or entry.get(
CONF_VIRTUAL_COUNT, 0
)
sensor = ModbusRegisterSensor(hub, entry, slave_count)
if slave_count > 0:
sensors.extend(await sensor.async_setup_slaves(hass, slave_count, entry))

7
homeassistant/components/modbus/validators.py
View File

@ -33,6 +33,7 @@ from .const import (
CONF_SWAP_NONE,
CONF_SWAP_WORD,
CONF_SWAP_WORD_BYTE,
CONF_VIRTUAL_COUNT,
CONF_WRITE_TYPE,
DEFAULT_HUB,
DEFAULT_SCAN_INTERVAL,
@ -98,6 +99,10 @@ def struct_validator(config: dict[str, Any]) -> dict[str, Any]:
count = config.get(CONF_COUNT, None)
structure = config.get(CONF_STRUCTURE, None)
slave_count = config.get(CONF_SLAVE_COUNT, None)
slave_name = CONF_SLAVE_COUNT
if not slave_count:
slave_count = config.get(CONF_VIRTUAL_COUNT, 0)
slave_name = CONF_VIRTUAL_COUNT
swap_type = config.get(CONF_SWAP, CONF_SWAP_NONE)
validator = DEFAULT_STRUCT_FORMAT[data_type].validate_parm
if count and not validator.count:
@ -113,7 +118,7 @@ def struct_validator(config: dict[str, Any]) -> dict[str, Any]:
error = f"{name}: `{CONF_STRUCTURE}` missing or empty, demanded with `{CONF_DATA_TYPE}: {data_type}`"
raise vol.Invalid(error)
if slave_count and not validator.slave_count:
error = f"{name}: `{CONF_SLAVE_COUNT}: {slave_count}` cannot be combined with `{CONF_DATA_TYPE}: {data_type}`"
error = f"{name}: `{slave_name}: {slave_count}` cannot be combined with `{CONF_DATA_TYPE}: {data_type}`"
raise vol.Invalid(error)
if swap_type != CONF_SWAP_NONE:
swap_type_validator = {