Merge pull request #153 from oischinger/premium_subscription

Increase update rate for premium subscription

Author: oischinger

custom_components/vicare/__init__.py

@@ -23,7 +23,13 @@
 from homeassistant.helpers import entity_registry as er
 from homeassistant.helpers.storage import STORAGE_DIR
 
-from .const import DEFAULT_SCAN_INTERVAL, DOMAIN, PLATFORMS, VICARE_DEVICE_CONFIG
+from .const import (
+    CONF_PREMIUM,
+    DEFAULT_SCAN_INTERVAL,
+    DOMAIN,
+    PLATFORMS,
+    VICARE_DEVICE_CONFIG,
+)
 from .helpers import get_unique_device_id
 
 _LOGGER = logging.getLogger(__name__)
@@ -147,6 +153,10 @@ def setup_vicare_api(hass, entry):
     vicare_api = vicare_login(hass, entry.data)
     scan_interval = max(DEFAULT_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL * len(vicare_api.devices))
 
+    # Premium subscription allows 3000 vs 1450 API calls per day
+    if CONF_PREMIUM in entry.data and entry.data[CONF_PREMIUM]:
+        scan_interval = scan_interval/2
+    
     _LOGGER.info(
          "Setting up API with scan interval %i seconds.", scan_interval
     )

custom_components/vicare/config_flow.py

@@ -20,7 +20,7 @@
 from homeassistant.helpers.device_registry import format_mac
 
 from . import vicare_login
-from .const import DOMAIN, VICARE_NAME
+from .const import CONF_PREMIUM, DOMAIN, VICARE_NAME
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -41,6 +41,7 @@ async def async_step_user(
             vol.Required(CONF_USERNAME): cv.string,
             vol.Required(CONF_PASSWORD): cv.string,
             vol.Required(CONF_CLIENT_ID): cv.string,
+            vol.Optional(CONF_PREMIUM): cv.boolean,
         }
         errors: dict[str, str] = {}
         description_placeholders: dict[str, str] = {}

custom_components/vicare/const.py

@@ -21,6 +21,7 @@
 CONF_CIRCUIT = "circuit"
 
 DEFAULT_SCAN_INTERVAL = 60
+CONF_PREMIUM = "subscription_premium"
 
 VICARE_CUBIC_METER = "cubicMeter"
 VICARE_KWH = "kilowattHour"

custom_components/vicare/strings.json

@@ -8,6 +8,7 @@
           "username": "[%key:common::config_flow::data::email%]",
           "password": "[%key:common::config_flow::data::password%]",
           "client_id": "[%key:common::config_flow::data::api_key%]",
+          "subscription_premium": "Premium subscription (3000 API calls/day)",
           "heating_type": "Heating type"
         }
       }

custom_components/vicare/translations/en.json

@@ -17,7 +17,8 @@
           "client_id": "API Key",
           "heating_type": "Heating type",
           "password": "Password",
-          "username": "Email"
+          "username": "Email",
+          "subscription_premium": "Premium subscription (3000 API calls/day)"
         },
         "description": "Set up ViCare integration. To generate API key go to https://developer.viessmann.com"
       }