Merge pull request #8 from robbinjanssen/rja/add-cache

Add caching configuration attribute

Author: robbinjanssen

README.md

@@ -38,6 +38,15 @@ sensor:
     host: 192.168.100.100
 ```
 
+By default caching the power today value is enabled, you can disable it using the `cache_power_today` configuration attribute. Check "How does it work?" when/why you might need to disable it.
+
+``` YAML
+sensor:
+  - platform: omnik_inverter
+    host: 192.168.100.100
+    cache_power_today: false
+```
+
 ## How does it work?
 
 The web interface has a javascript file that contains the actual values. This is updated every minute (afaik). Check it out in your browser at `http://<your omnik ip address>/js/status.js`
@@ -58,7 +67,9 @@ This custom component basically requests the URL, looks for the _webData_ part a
 - `sensor.solar_power_today` (kWh)
 - `sensor.solar_power_total` (kWh)
 
-> Note: I ran into the problem that my Omnik inverter resets the `solar_power_today` to 0.0 after 21:00. This component therefor caches the value and only resets to 0.0 after midnight.
+### Caching power today.
+
+In a few cases the Omnik inverter resets the `solar_power_today` to 0.0 after for example 21:00. By setting the `cache_power_today` config attribute to `true` (default) this component will cache the the value and only resets to 0.0 after midnight. If you do not experience this, then disable the cache by setting the config variable to `false`.
 
 ## References
 

custom_components/omnik_inverter/sensor.py

@@ -4,6 +4,7 @@
 sensor:
   - platform: omnik_inverter
     host: 192.168.100.100
+    cache_power_today: true
 """
 import logging
 from datetime import timedelta
@@ -22,7 +23,9 @@
 import re
 import pickle
 
-VERSION = '1.0.1'
+VERSION = '1.1.0'
+
+CONF_CACHE_POWER_TODAY = 'cache_power_today'
 
 BASE_URL = 'http://{0}/js/status.js'
 BASE_CACHE_NAME = '.{0}.pickle'
@@ -37,12 +40,16 @@
     'powertotal': ['Solar Power Total', ENERGY_KILO_WATT_HOUR, 'mdi:chart-line'],
 }
 
-PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({vol.Required(CONF_HOST): cv.string})
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Required(CONF_HOST): cv.string,
+    vol.Optional(CONF_CACHE_POWER_TODAY, default=True): cv.boolean
+})
 
 
 def setup_platform(hass, config, add_devices, discovery_info=None):
     """Setup the Solar Portal sensors."""
     host = config.get(CONF_HOST)
+    cache = config.get(CONF_CACHE_POWER_TODAY)
 
     try:
         data = OmnikInverterWeb(host)
@@ -53,7 +60,7 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
     entities = []
 
     for sensor_type in SENSOR_TYPES:
-        entities.append(OmnikInverterSensor(data, sensor_type))
+        entities.append(OmnikInverterSensor(data, sensor_type, cache))
 
     add_devices(entities)
 
@@ -97,10 +104,11 @@ def update(self):
 class OmnikInverterSensor(Entity):
     """Representation of a OmnikInverter sensor from the web data."""
 
-    def __init__(self, data, sensor_type):
+    def __init__(self, data, sensor_type, cache):
         """Initialize the sensor."""
         self.data = data
         self.type = sensor_type
+        self.cache = cache
         self._name = SENSOR_TYPES[self.type][0]
         self._unit_of_measurement = SENSOR_TYPES[self.type][1]
         self._icon = SENSOR_TYPES[self.type][2]
@@ -151,6 +159,12 @@ def update(self):
             nextValue = int(result[6])
             nextTime = int(datetime.now().strftime('%H%M'))
 
+            # Check if caching is disabled
+            if (self.cache == False):
+                # Update the sensor state, divide by 100 to make it kWh
+                self._state = (nextValue / 100)
+                return
+
             # Fetch data from the cache
             try:
                 cache = pickle.load(open(cacheName, 'rb'))