Add configurable state_class to Modbus sensors (#54103)

* add configurable state_class

* Add test of new parameter.

Co-authored-by: jan Iversen <jancasacondor@gmail.com>
This commit is contained in:
Matthias Alphart 2021-08-25 11:50:54 +02:00 committed by GitHub
parent 186b8d4f4b
commit 51361fbd2b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 1 deletions

View File

@ -13,6 +13,7 @@ from homeassistant.components.cover import (
) )
from homeassistant.components.sensor import ( from homeassistant.components.sensor import (
DEVICE_CLASSES_SCHEMA as SENSOR_DEVICE_CLASSES_SCHEMA, DEVICE_CLASSES_SCHEMA as SENSOR_DEVICE_CLASSES_SCHEMA,
STATE_CLASSES_SCHEMA as SENSOR_STATE_CLASSES_SCHEMA,
) )
from homeassistant.components.switch import ( from homeassistant.components.switch import (
DEVICE_CLASSES_SCHEMA as SWITCH_DEVICE_CLASSES_SCHEMA, DEVICE_CLASSES_SCHEMA as SWITCH_DEVICE_CLASSES_SCHEMA,
@ -75,6 +76,7 @@ from .const import (
CONF_RETRY_ON_EMPTY, CONF_RETRY_ON_EMPTY,
CONF_REVERSE_ORDER, CONF_REVERSE_ORDER,
CONF_SCALE, CONF_SCALE,
CONF_STATE_CLASS,
CONF_STATE_CLOSED, CONF_STATE_CLOSED,
CONF_STATE_CLOSING, CONF_STATE_CLOSING,
CONF_STATE_OFF, CONF_STATE_OFF,
@ -269,6 +271,7 @@ SENSOR_SCHEMA = vol.All(
BASE_STRUCT_SCHEMA.extend( BASE_STRUCT_SCHEMA.extend(
{ {
vol.Optional(CONF_DEVICE_CLASS): SENSOR_DEVICE_CLASSES_SCHEMA, 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_UNIT_OF_MEASUREMENT): cv.string,
vol.Optional(CONF_REVERSE_ORDER): cv.boolean, vol.Optional(CONF_REVERSE_ORDER): cv.boolean,
} }

View File

@ -41,6 +41,7 @@ CONF_RETRY_ON_EMPTY = "retry_on_empty"
CONF_REVERSE_ORDER = "reverse_order" CONF_REVERSE_ORDER = "reverse_order"
CONF_PRECISION = "precision" CONF_PRECISION = "precision"
CONF_SCALE = "scale" CONF_SCALE = "scale"
CONF_STATE_CLASS = "state_class"
CONF_STATE_CLOSED = "state_closed" CONF_STATE_CLOSED = "state_closed"
CONF_STATE_CLOSING = "state_closing" CONF_STATE_CLOSING = "state_closing"
CONF_STATE_OFF = "state_off" CONF_STATE_OFF = "state_off"

View File

@ -12,6 +12,7 @@ from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
from . import get_hub from . import get_hub
from .base_platform import BaseStructPlatform from .base_platform import BaseStructPlatform
from .const import CONF_STATE_CLASS
from .modbus import ModbusHub from .modbus import ModbusHub
PARALLEL_UPDATES = 1 PARALLEL_UPDATES = 1
@ -48,6 +49,7 @@ class ModbusRegisterSensor(BaseStructPlatform, RestoreEntity, SensorEntity):
"""Initialize the modbus register sensor.""" """Initialize the modbus register sensor."""
super().__init__(hub, entry) super().__init__(hub, entry)
self._attr_native_unit_of_measurement = entry.get(CONF_UNIT_OF_MEASUREMENT) self._attr_native_unit_of_measurement = entry.get(CONF_UNIT_OF_MEASUREMENT)
self._attr_state_class = entry.get(CONF_STATE_CLASS)
async def async_added_to_hass(self): async def async_added_to_hass(self):
"""Handle entity which will be added.""" """Handle entity which will be added."""

View File

@ -9,6 +9,7 @@ from homeassistant.components.modbus.const import (
CONF_LAZY_ERROR, CONF_LAZY_ERROR,
CONF_PRECISION, CONF_PRECISION,
CONF_SCALE, CONF_SCALE,
CONF_STATE_CLASS,
CONF_SWAP, CONF_SWAP,
CONF_SWAP_BYTE, CONF_SWAP_BYTE,
CONF_SWAP_NONE, CONF_SWAP_NONE,
@ -20,7 +21,10 @@ from homeassistant.components.modbus.const import (
DATA_TYPE_STRING, DATA_TYPE_STRING,
DATA_TYPE_UINT, DATA_TYPE_UINT,
) )
from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN from homeassistant.components.sensor import (
DOMAIN as SENSOR_DOMAIN,
STATE_CLASS_MEASUREMENT,
)
from homeassistant.const import ( from homeassistant.const import (
CONF_ADDRESS, CONF_ADDRESS,
CONF_COUNT, CONF_COUNT,
@ -62,6 +66,7 @@ ENTITY_ID = f"{SENSOR_DOMAIN}.{TEST_ENTITY_NAME}"
CONF_PRECISION: 0, CONF_PRECISION: 0,
CONF_SCALE: 1, CONF_SCALE: 1,
CONF_OFFSET: 0, CONF_OFFSET: 0,
CONF_STATE_CLASS: STATE_CLASS_MEASUREMENT,
CONF_LAZY_ERROR: 10, CONF_LAZY_ERROR: 10,
CONF_INPUT_TYPE: CALL_TYPE_REGISTER_HOLDING, CONF_INPUT_TYPE: CALL_TYPE_REGISTER_HOLDING,
CONF_DEVICE_CLASS: "battery", CONF_DEVICE_CLASS: "battery",