Simplify DATA_TYPE -> struct conversion. (#53805)
This commit is contained in:
jan iversen
GitHub
parent
f1f293de02
commit
3d52bfc8f6
3 changed files with 71 additions and 68 deletions
|
|
@ -1,5 +1,4 @@
|
|||
"""Constants used in modbus integration."""
|
||||
|
||||
from homeassistant.components.binary_sensor import DOMAIN as BINARY_SENSOR_DOMAIN
|
||||
from homeassistant.components.climate.const import DOMAIN as CLIMATE_DOMAIN
|
||||
from homeassistant.components.cover import DOMAIN as COVER_DOMAIN
|
||||
|
|
@ -110,18 +109,8 @@ DEFAULT_HUB = "modbus_hub"
|
|||
DEFAULT_SCAN_INTERVAL = 15 # seconds
|
||||
DEFAULT_SLAVE = 1
|
||||
DEFAULT_STRUCTURE_PREFIX = ">f"
|
||||
DEFAULT_STRUCT_FORMAT = {
|
||||
DATA_TYPE_INT16: ["h", 1],
|
||||
DATA_TYPE_INT32: ["i", 2],
|
||||
DATA_TYPE_INT64: ["q", 4],
|
||||
DATA_TYPE_UINT16: ["H", 1],
|
||||
DATA_TYPE_UINT32: ["I", 2],
|
||||
DATA_TYPE_UINT64: ["Q", 4],
|
||||
DATA_TYPE_FLOAT16: ["e", 1],
|
||||
DATA_TYPE_FLOAT32: ["f", 2],
|
||||
DATA_TYPE_FLOAT64: ["d", 4],
|
||||
DATA_TYPE_STRING: ["s", 1],
|
||||
}
|
||||
|
||||
|
||||
DEFAULT_TEMP_UNIT = "C"
|
||||
MODBUS_DOMAIN = "modbus"
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
"""Support for Modbus."""
|
||||
import asyncio
|
||||
from copy import deepcopy
|
||||
from collections import namedtuple
|
||||
import logging
|
||||
|
||||
from pymodbus.client.sync import ModbusSerialClient, ModbusTcpClient, ModbusUdpClient
|
||||
|
|
@ -54,54 +54,52 @@ from .const import (
|
|||
SERVICE_WRITE_REGISTER,
|
||||
)
|
||||
|
||||
ENTRY_FUNC = "func"
|
||||
ENTRY_ATTR = "attr"
|
||||
ENTRY_NAME = "name"
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
PYMODBUS_CALL = {
|
||||
CALL_TYPE_COIL: {
|
||||
ENTRY_ATTR: "bits",
|
||||
ENTRY_NAME: "read_coils",
|
||||
ENTRY_FUNC: None,
|
||||
},
|
||||
CALL_TYPE_DISCRETE: {
|
||||
ENTRY_ATTR: "bits",
|
||||
ENTRY_NAME: "read_discrete_inputs",
|
||||
ENTRY_FUNC: None,
|
||||
},
|
||||
CALL_TYPE_REGISTER_HOLDING: {
|
||||
ENTRY_ATTR: "registers",
|
||||
ENTRY_NAME: "read_holding_registers",
|
||||
ENTRY_FUNC: None,
|
||||
},
|
||||
CALL_TYPE_REGISTER_INPUT: {
|
||||
ENTRY_ATTR: "registers",
|
||||
ENTRY_NAME: "read_input_registers",
|
||||
ENTRY_FUNC: None,
|
||||
},
|
||||
CALL_TYPE_WRITE_COIL: {
|
||||
ENTRY_ATTR: "value",
|
||||
ENTRY_NAME: "write_coil",
|
||||
ENTRY_FUNC: None,
|
||||
},
|
||||
CALL_TYPE_WRITE_COILS: {
|
||||
ENTRY_ATTR: "count",
|
||||
ENTRY_NAME: "write_coils",
|
||||
ENTRY_FUNC: None,
|
||||
},
|
||||
CALL_TYPE_WRITE_REGISTER: {
|
||||
ENTRY_ATTR: "value",
|
||||
ENTRY_NAME: "write_register",
|
||||
ENTRY_FUNC: None,
|
||||
},
|
||||
CALL_TYPE_WRITE_REGISTERS: {
|
||||
ENTRY_ATTR: "count",
|
||||
ENTRY_NAME: "write_registers",
|
||||
ENTRY_FUNC: None,
|
||||
},
|
||||
}
|
||||
ConfEntry = namedtuple("ConfEntry", "call_type attr func_name")
|
||||
RunEntry = namedtuple("RunEntry", "attr func")
|
||||
PYMODBUS_CALL = [
|
||||
ConfEntry(
|
||||
CALL_TYPE_COIL,
|
||||
"bits",
|
||||
"read_coils",
|
||||
),
|
||||
ConfEntry(
|
||||
CALL_TYPE_DISCRETE,
|
||||
"bits",
|
||||
"read_discrete_inputs",
|
||||
),
|
||||
ConfEntry(
|
||||
CALL_TYPE_REGISTER_HOLDING,
|
||||
"registers",
|
||||
"read_holding_registers",
|
||||
),
|
||||
ConfEntry(
|
||||
CALL_TYPE_REGISTER_INPUT,
|
||||
"registers",
|
||||
"read_input_registers",
|
||||
),
|
||||
ConfEntry(
|
||||
CALL_TYPE_WRITE_COIL,
|
||||
"value",
|
||||
"write_coil",
|
||||
),
|
||||
ConfEntry(
|
||||
CALL_TYPE_WRITE_COILS,
|
||||
"count",
|
||||
"write_coils",
|
||||
),
|
||||
ConfEntry(
|
||||
CALL_TYPE_WRITE_REGISTER,
|
||||
"value",
|
||||
"write_register",
|
||||
),
|
||||
ConfEntry(
|
||||
CALL_TYPE_WRITE_REGISTERS,
|
||||
"count",
|
||||
"write_registers",
|
||||
),
|
||||
]
|
||||
|
||||
|
||||
async def async_modbus_setup(
|
||||
|
|
@ -197,7 +195,7 @@ class ModbusHub:
|
|||
self._config_name = client_config[CONF_NAME]
|
||||
self._config_type = client_config[CONF_TYPE]
|
||||
self._config_delay = client_config[CONF_DELAY]
|
||||
self._pb_call = deepcopy(PYMODBUS_CALL)
|
||||
self._pb_call = {}
|
||||
self._pb_class = {
|
||||
CONF_SERIAL: ModbusSerialClient,
|
||||
CONF_TCP: ModbusTcpClient,
|
||||
|
|
@ -246,8 +244,9 @@ class ModbusHub:
|
|||
self._log_error(str(exception_error), error_state=False)
|
||||
return False
|
||||
|
||||
for entry in self._pb_call.values():
|
||||
entry[ENTRY_FUNC] = getattr(self._client, entry[ENTRY_NAME])
|
||||
for entry in PYMODBUS_CALL:
|
||||
func = getattr(self._client, entry.func_name)
|
||||
self._pb_call[entry.call_type] = RunEntry(entry.attr, func)
|
||||
|
||||
await self.async_connect_task()
|
||||
return True
|
||||
|
|
@ -301,12 +300,13 @@ class ModbusHub:
|
|||
def _pymodbus_call(self, unit, address, value, use_call):
|
||||
"""Call sync. pymodbus."""
|
||||
kwargs = {"unit": unit} if unit else {}
|
||||
entry = self._pb_call[use_call]
|
||||
try:
|
||||
result = self._pb_call[use_call][ENTRY_FUNC](address, value, **kwargs)
|
||||
result = entry.func(address, value, **kwargs)
|
||||
except ModbusException as exception_error:
|
||||
self._log_error(str(exception_error))
|
||||
return None
|
||||
if not hasattr(result, self._pb_call[use_call][ENTRY_ATTR]):
|
||||
if not hasattr(result, entry.attr):
|
||||
self._log_error(str(result))
|
||||
return None
|
||||
self._in_error = False
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
"""Validate Modbus configuration."""
|
||||
from __future__ import annotations
|
||||
|
||||
from collections import namedtuple
|
||||
import logging
|
||||
import struct
|
||||
from typing import Any
|
||||
|
|
@ -29,12 +30,12 @@ from .const import (
|
|||
DATA_TYPE_INT16,
|
||||
DATA_TYPE_INT32,
|
||||
DATA_TYPE_INT64,
|
||||
DATA_TYPE_STRING,
|
||||
DATA_TYPE_UINT,
|
||||
DATA_TYPE_UINT16,
|
||||
DATA_TYPE_UINT32,
|
||||
DATA_TYPE_UINT64,
|
||||
DEFAULT_SCAN_INTERVAL,
|
||||
DEFAULT_STRUCT_FORMAT,
|
||||
PLATFORMS,
|
||||
)
|
||||
|
||||
|
|
@ -57,6 +58,19 @@ OLD_DATA_TYPES = {
|
|||
4: DATA_TYPE_FLOAT64,
|
||||
},
|
||||
}
|
||||
ENTRY = namedtuple("ENTRY", ["struct_id", "register_count"])
|
||||
DEFAULT_STRUCT_FORMAT = {
|
||||
DATA_TYPE_INT16: ENTRY("h", 1),
|
||||
DATA_TYPE_INT32: ENTRY("i", 2),
|
||||
DATA_TYPE_INT64: ENTRY("q", 4),
|
||||
DATA_TYPE_UINT16: ENTRY("H", 1),
|
||||
DATA_TYPE_UINT32: ENTRY("I", 2),
|
||||
DATA_TYPE_UINT64: ENTRY("Q", 4),
|
||||
DATA_TYPE_FLOAT16: ENTRY("e", 1),
|
||||
DATA_TYPE_FLOAT32: ENTRY("f", 2),
|
||||
DATA_TYPE_FLOAT64: ENTRY("d", 4),
|
||||
DATA_TYPE_STRING: ENTRY("s", 1),
|
||||
}
|
||||
|
||||
|
||||
def struct_validator(config):
|
||||
|
|
@ -79,9 +93,9 @@ def struct_validator(config):
|
|||
if structure:
|
||||
error = f"{name} structure: cannot be mixed with {data_type}"
|
||||
raise vol.Invalid(error)
|
||||
structure = f">{DEFAULT_STRUCT_FORMAT[data_type][0]}"
|
||||
structure = f">{DEFAULT_STRUCT_FORMAT[data_type].struct_id}"
|
||||
if CONF_COUNT not in config:
|
||||
config[CONF_COUNT] = DEFAULT_STRUCT_FORMAT[data_type][1]
|
||||
config[CONF_COUNT] = DEFAULT_STRUCT_FORMAT[data_type].register_count
|
||||
else:
|
||||
if not structure:
|
||||
error = (
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue