Merge pull request #15 from golles/configure_scan_interval

Make scan interval user configurable

.devcontainer/devcontainer.json

@@ -17,10 +17,14 @@
 		"files.eol": "\n",
 		"editor.tabSize": 4,
 		"terminal.integrated.shell.linux": "/bin/bash",
-		"python.pythonPath": "/usr/bin/python3",
+		"python.pythonPath": "/usr/local/python/bin/python",
 		"python.analysis.autoSearchPaths": false,
 		"python.linting.pylintEnabled": true,
 		"python.linting.enabled": true,
+		"python.linting.pylintArgs": [
+			"--disable",
+			"import-error"
+		],
 		"python.formatting.provider": "black",
 		"editor.formatOnPaste": false,
 		"editor.formatOnSave": true,

custom_components/kamstrup_403/__init__.py

@@ -10,7 +10,7 @@
 import serial
 
 from homeassistant.config_entries import ConfigEntry
-from homeassistant.const import CONF_PORT
+from homeassistant.const import CONF_PORT, CONF_SCAN_INTERVAL
 from homeassistant.core import Config, HomeAssistant
 from homeassistant.exceptions import ConfigEntryNotReady
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
@@ -20,14 +20,13 @@
 
 from .const import (
     DEFAULT_BAUDRATE,
+    DEFAULT_SCAN_INTERVAL,
     DEFAULT_TIMEOUT,
     DOMAIN,
     PLATFORMS,
     SENSORS,
 )
 
-SCAN_INTERVAL = timedelta(seconds=60)
-
 _LOGGER: logging.Logger = logging.getLogger(__package__)
 
 
@@ -42,9 +41,14 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
         hass.data.setdefault(DOMAIN, {})
 
     port = entry.data.get(CONF_PORT)
+    scan_interval_seconds = entry.options.get(CONF_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL)
+    scan_interval = timedelta(seconds=scan_interval_seconds)
+
     client = Kamstrup(port, DEFAULT_BAUDRATE, DEFAULT_TIMEOUT)
 
-    coordinator = KamstrupUpdateCoordinator(hass, client=client)
+    coordinator = KamstrupUpdateCoordinator(
+        hass, client=client, scan_interval=scan_interval
+    )
     await coordinator.async_refresh()
 
     if not coordinator.last_update_success:
@@ -66,24 +70,26 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
 class KamstrupUpdateCoordinator(DataUpdateCoordinator):
     """Class to manage fetching data from the Kamstrup serial reader."""
 
-    def __init__(self, hass: HomeAssistant, client: Kamstrup) -> None:
+    def __init__(
+        self, hass: HomeAssistant, client: Kamstrup, scan_interval: int
+    ) -> None:
         """Initialize."""
         self.kamstrup = client
         self.platforms = []
 
-        super().__init__(hass, _LOGGER, name=DOMAIN, update_interval=SCAN_INTERVAL)
+        super().__init__(hass, _LOGGER, name=DOMAIN, update_interval=scan_interval)
 
     async def _async_update_data(self):
         """Update data via library."""
-        _LOGGER.debug('KamstrupUpdateCoordinator: _async_update_data start')
+        _LOGGER.debug("KamstrupUpdateCoordinator: _async_update_data start")
 
         data = {}
         for key in SENSORS:
             try:
                 value, unit = self.kamstrup.readvar(SENSORS[key]["command"])
                 data[SENSORS[key]["command"]] = {"value": value, "unit": unit}
             except (serial.SerialException):
-                _LOGGER.error('Device disconnected or multiple access on port?')
+                _LOGGER.error("Device disconnected or multiple access on port?")
         return data
 
 

custom_components/kamstrup_403/config_flow.py

@@ -1,16 +1,15 @@
 """Adds config flow for Kamstrup 403."""
 from homeassistant import config_entries
-from homeassistant.const import CONF_PORT
+from homeassistant.const import CONF_PORT, CONF_SCAN_INTERVAL
 from homeassistant.core import callback
-from homeassistant.helpers.aiohttp_client import async_create_clientsession
 import voluptuous as vol
 import serial
 
 from .const import (
     DEFAULT_BAUDRATE,
+    DEFAULT_SCAN_INTERVAL,
     DEFAULT_TIMEOUT,
     DOMAIN,
-    PLATFORMS,
 )
 
 
@@ -98,8 +97,12 @@ async def async_step_user(self, user_input=None):
             step_id="user",
             data_schema=vol.Schema(
                 {
-                    vol.Required(x, default=self.options.get(x, True)): bool
-                    for x in sorted(PLATFORMS)
+                    vol.Optional(
+                        CONF_SCAN_INTERVAL,
+                        default=self.config_entry.options.get(
+                            CONF_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL
+                        ),
+                    ): vol.All(vol.Coerce(int), vol.Range(min=1, max=86400)),
                 }
             ),
         )

custom_components/kamstrup_403/const.py

@@ -6,20 +6,23 @@
     DEVICE_CLASS_TEMPERATURE,
 )
 from homeassistant.components.sensor import (
-    STATE_CLASS_MEASUREMENT,
     ATTR_STATE_CLASS,
+    STATE_CLASS_MEASUREMENT,
+    SensorStateClass,
 )
 
-# Todo, import next two from: homeassistant.sensor import SensorStateClass
-TOTAL_INCREASING = "total_increasing"
-
 # Base component constants
 NAME = "Kamstrup 403"
 DOMAIN = "kamstrup_403"
 MODEL = "403"
 MANUFACTURER = "Kamstrup"
 ATTRIBUTION = "Data provided by Kamstrup 403 meter"
 
+# Defaults
+DEFAULT_BAUDRATE = 1200
+DEFAULT_SCAN_INTERVAL = 60
+DEFAULT_TIMEOUT = 2.0
+
 # Platforms
 SENSOR = "sensor"
 PLATFORMS = [SENSOR]
@@ -35,7 +38,7 @@
         # "attributes": [
         #     {
         #         "name": ATTR_STATE_CLASS,
-        #         "value": TOTAL_INCREASING,
+        #         "value": SensorStateClass.TOTAL_INCREASING,
         #     },
         # ],
     },
@@ -106,7 +109,7 @@
         "attributes": [
             {
                 "name": ATTR_STATE_CLASS,
-                "value": TOTAL_INCREASING,
+                "value": SensorStateClass.TOTAL_INCREASING,
             },
         ],
     },
@@ -310,12 +313,8 @@
         "attributes": [
             {
                 "name": ATTR_STATE_CLASS,
-                "value": TOTAL_INCREASING,
+                "value": SensorStateClass.TOTAL_INCREASING,
             },
         ],
     },
 }
-
-# Defaults
-DEFAULT_BAUDRATE = 1200
-DEFAULT_TIMEOUT = 2.0

custom_components/kamstrup_403/translations/en.json

@@ -20,9 +20,7 @@
         "step": {
             "user": {
                 "data": {
-                    "binary_sensor": "Binary sensor enabled",
-                    "sensor": "Sensor enabled",
-                    "switch": "Switch enabled"
+                    "scan_interval": "Scan Interval (seconds)"
                 }
             }
         }

custom_components/kamstrup_403/translations/nl.json

@@ -20,7 +20,7 @@
         "step": {
             "user": {
                 "data": {
-                    "sensor": "Sensor ingeschakeld"
+                    "scan_interval": "Scaninterval (seconden)"
                 }
             }
         }

tests/const.py

@@ -1,5 +1,6 @@
 """Constants for kamstrup_403 tests."""
-from homeassistant.const import CONF_PORT
+from homeassistant.const import CONF_PORT, CONF_SCAN_INTERVAL
 
 # Mock config data to be used across multiple tests
 MOCK_CONFIG = {CONF_PORT: "/dev/ttyUSB0"}
+MOCK_UPDATE_CONFIG = {CONF_SCAN_INTERVAL: 120}

tests/test_config_flow.py

@@ -2,17 +2,13 @@
 from unittest.mock import patch
 
 from homeassistant import config_entries, data_entry_flow
-from homeassistant.const import CONF_PORT
+from homeassistant.const import CONF_PORT, CONF_SCAN_INTERVAL
 import pytest
 from pytest_homeassistant_custom_component.common import MockConfigEntry
 
-from custom_components.kamstrup_403.const import (
-    DOMAIN,
-    PLATFORMS,
-    SENSOR,
-)
+from custom_components.kamstrup_403.const import DOMAIN, SENSOR
 
-from .const import MOCK_CONFIG
+from .const import MOCK_CONFIG, MOCK_UPDATE_CONFIG
 
 # This fixture bypasses the actual setup of the integration
 # since we only want to test the config flow. We test the
@@ -96,12 +92,12 @@ async def test_options_flow(hass):
     # Enter some fake data into the form
     result = await hass.config_entries.options.async_configure(
         result["flow_id"],
-        user_input={platform: platform != SENSOR for platform in PLATFORMS},
+        user_input=MOCK_UPDATE_CONFIG,
     )
 
     # Verify that the flow finishes
     assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
     assert result["title"] == "/dev/ttyUSB0"
 
     # Verify that the options were updated
-    assert entry.options == {SENSOR: False}
+    assert entry.options == MOCK_UPDATE_CONFIG