- build 1.0.8

- set timeout to 10sec
- added docu for additional REST Sensor

README.md

@@ -1,35 +1,41 @@
 # Tibber Pulse LOCAL
+
 If you like to access the data of your Tibber Pulse directly (instead via the detour through the cloud), then there is
 a simple approach to read the data directly from the Tibber Pulse Bridge. There are alternative solutions via an
 additional MQTT - but why should the data go through such a proxy, if it can be read directly.
 
 ## Tibber Invitation link
+
 If you want to join Tibber (become a customer), you might consider using my personal invitation link. When you use this
 link, Tibber will we grant you and me a Bonus of 50,-€ for each of us, that then can be used in the Tibber store (not
-for your power bill) - e.g. to but a Tibber Bridge. I am fully aware, that when you are here in this repository the
-chances are very high, that you are already a Tibber customer and have already a Tibber Pulse. But I was asked by a user
-if I could provide my link - so I do:
+for your power bill) - e.g. to buy a Tibber Bridge. I am fully aware, that when you are here in this repository the
+chances are very high, that you are already a Tibber customer and have already a Tibber Pulse.
 
-[My personal Tibber invitation link](https://invite.tibber.com/6o0kqvzf)
+If you are a customer and have not used an invitation link yet, you can also enter one afterward in the Tibber App.
+
+[My personal Tibber invitation link](https://invite.tibber.com/6o0kqvzf) or Enter the Code: 6o0kqvzf (six, oscar, zero,
+kilo, quebec, victor, zulu, foxtrot) in the App - TIA!
 
 ## Know Issues
 
 - No Logo/Icons (Tibber) for the integration (yet)
- 
+
 - The Tibber Pulse Bridge supporting different communication modes (when fetching data from electricity meter). Here
-  I need your help! Obviously I have one electricity meter here at home. This meter is communicating via a protocol 
-  called SML 1.04 and this is currently the __only__ one that is supported/implemented. 
+  I need your help! Obviously I have one electricity meter here at home. This meter is communicating via a protocol
+  called SML 1.04 and this is currently the __only__ one that is supported/implemented.
 
   The Tibber Bridge supporting also the modes: AutoScanMode, IEC-62056.21, Logarex and Impressions (Blinks / kwh) using
   ambient or IR sensors. In order to support these other modes I would need sample data from you. If your Tibber Pulse
   using one of these communications protocols, please be so kind and create here an issue in github - TIA!
 
 - Sometimes the Pulse deliver a data-package that does not contain valid data (looks like the build in webserver have a
-  response buffer issue?). These invalid packages can't be read with the [python SML-Lib](https://github.com/spacemanspiff2007/SmlLib)
+  response buffer issue?). These invalid packages can't be read with
+  the [python SML-Lib](https://github.com/spacemanspiff2007/SmlLib)
   and you will find then in the HA-log some `Bytes missing...` or `CRC while parse data...` messages. (when logging on
   INFO Level)
-
-  If they happen the code will just try to load the data again for one time. Together with the message the actual payload
+
+  If they happen the code will just try to load the data again for one time. Together with the message the actual
+  payload
   (data that has been read from the Tibber Pulse Bridge) will also be logged. So you can verify that the data is indeed
   invalid.
 
@@ -38,7 +44,7 @@ if I could provide my link - so I do:
 - [@spacemanspiff2007](https://github.com/spacemanspiff2007) for providing a Python SML lib that makes reading the
   data from the Pulse almost effortless for a python noob like me
 - [@ProfDrYoMan](https://github.com/ProfDrYoMan) for providing the initial idea. I failed to setup the ESP32 stuff, so
-  I took the approach writing this custom integration 
+  I took the approach writing this custom integration
 
 ## Preparation: Enabling the web frontend of the Tibber Pulse Bridge [*Required*]
 
@@ -47,6 +53,7 @@ frontend for the first time you need to start the Tibber Pulse Bridge in AccessP
 following steps:
 
 ### 1. Start AP-Mode
+
 * Unplug the Tibber bridge.
 * After three seconds, plug the Tibber bridge.
 * After three seconds, unplug the Tibber bridge.
@@ -55,6 +62,7 @@ following steps:
 The LED on the Tibber bridge should now light up green and not light blue anymore.
 
 If this is not the case, then try this alternative:
+
 * Unplug the Tibber bridge.
 * Plug the Tibber bridge
 * When the bridge light in __yellow__ then unplug the bridge again
@@ -64,7 +72,7 @@ NOW the LED on the Tibber bridge should now light up green and not light blue an
 
 ### 2. Connect to the Pulse Bridge WiFi AccessPoint
 
-Now use any device (laptop, tablet, phone) to connect to the `Tibber Bridge` WiFi network.  The password for the WiFi
+Now use any device (laptop, tablet, phone) to connect to the `Tibber Bridge` WiFi network. The password for the WiFi
 is the nine characters printed on the Tibber bridge - it's important to include the dash. The password should have the
 pattern like this example one: `AD56-54BA`.
 
@@ -83,28 +91,30 @@ After setting and saving the value, remember to press *"Store params to flash"*
 
 __Please do not modify and other values in the params__
 
-### 4. Bring your Pulse & Bridge back to normal operation 
+### 4. Bring your Pulse & Bridge back to normal operation
 
 Unplug the Tibber bridge, wait __ten seconds__ and plug it back again. Now it should connect back to your previously
 configured WiFi and should work as before (submit the data to Tibber) - the LED should light up light blue again.
 
 ### 5. Final testing [do not continue if you did not completed this final step]
 
-After you have successfully reset the Tibber bridge (AP mode is OFF and you are back in normal operation mode). Since you
+After you have successfully reset the Tibber bridge (AP mode is OFF and you are back in normal operation mode). Since
+you
 have set the `webserver_force_enable` to `true` the web frontend should now be still accessible via the following URL:
-<http://tibber_bridge/>.
+<http://tibber-host/> or <http://tibber-bridge/>.
 
-If the hostname 'tibber-bridge' is not going to work for you in your LAN, you might like to check the IP-Address of your
-Tibber Pulse Bridge in your Router. __The IP *is not* the `10.133.70.1` any longer!__
+If the hostname 'tibber-host' (or 'tibber-bridge') is not going to work for you in your LAN, you might like to check the
+IP-Address of your Tibber Pulse Bridge in your Router. __The IP *is not* the `10.133.70.1` any longer!__
 
 Personally I have configured my router in a way, that the Pulse Bridge gets allways the same IP assigned. I just can
-recommend to do the same.
+recommend to do the same. Since accessing the device via IP (instead of the host name) will save you DNS-Lookups.
 
 When you open the web frontend of the bridge, you have to provide the user `admin` and the password always.
 
 ![img|160x90](images/web-frontend.png)
 
-Now (when the frontend works for you) all is prepared, so you can install and use this `Tibber Local Polling` integration
+Now (when the frontend works for you) all is prepared, so you can install and use this `Tibber Local Polling`
+integration
 
 ## Installation
 
@@ -120,7 +130,8 @@ Now (when the frontend works for you) all is prepared, so you can install and us
 
 ### Manual
 
-- Copy all files from `custom_components/tibber_local/` to `custom_components/tibber_local/` inside your config Home Assistant
+- Copy all files from `custom_components/tibber_local/` to `custom_components/tibber_local/` inside your config Home
+  Assistant
   directory.
 - Restart Home Assistant to install all dependencies
 
@@ -136,8 +147,136 @@ Add custom integration using the web interface and follow instruction on screen.
 
 - Go to `Configuration -> Integrations` and add "Tibber Pulse Local" integration
 - Specify:
-  - Provide display name for the device
-  - Provide the address (hostname or IP) of the Pulse Bridge
-  - Provide the password of the Pulse Bridge
-  - Provide the update interval (can be 2 Seconds)
-  - Provide area where the Tibber Pule Bridge is located
+    - Provide display name for the device
+    - Provide the address (hostname or IP) of the Pulse Bridge
+    - Provide the password of the Pulse Bridge
+    - Provide the update interval (can be 2 Seconds)
+    - Provide area where the Tibber Pule Bridge is located
+
+## Additional entities to get status information about your Tibber Pulse itself
+
+Beside the data that the Tibber Pulse is reading from your electricity meter, the device is also provide additional
+information about its own status. Since the assumption is that you want to read this additional status information with
+a much lower update-interval (less frequent) the usage of a REST-Entity template a (IMHO) simple way to archive your
+goal.
+
+### REST-Template in your HA configuration.yaml
+
+requesting `http://admin:[BRIDGE_PASSWORD]@http://[YOUR_IP]/metrics.json?node_id=1` will return a json like this one
+here
+
+```json
+{
+  "$type": "node_status",
+  "node_status": {
+    "product_id": 49344,
+    "bootloader_version": 17563650,
+    "meter_mode": 3,
+    "node_battery_voltage": 3.127,
+    "node_temperature": 22.51,
+    "node_avg_rssi": -72.746,
+    "node_avg_lqi": 186.438,
+    "radio_tx_power": 190,
+    "node_uptime_ms": 167656940,
+    "meter_msg_count_sent": 75,
+    "meter_pkg_count_sent": 237,
+    "time_in_em0_ms": 8405,
+    "time_in_em1_ms": 30,
+    "time_in_em2_ms": 291717,
+    "acmp_rx_autolevel_300": 146,
+    "acmp_rx_autolevel_9600": 164
+  },
+  "hub_attachments": {
+    "meter_pkg_count_recv": 237,
+    "meter_reading_count_recv": 75,
+    "node_version": "1007-56bd9fb9"
+  }
+}
+```
+
+Check if you have already a `sensor` section in your `configuration.yaml` file - if there is none - create one on as top
+level entry like this (the line '  - platforms: ...' must (obviously) be replaced with the complete sections shown
+further below):
+
+```yaml
+sensor:
+  - platform: ...
+```
+
+Add in the `sensor` section of your `configuration.yaml` file the following content:
+sections with `[ CHANGE_ME:xxx ]` have to be modified to your requirements. E.g. assuming your assuming password
+is __55AA-CC21__, then you have to replace `[ CHANGE_ME:YOUR-PWD ]` with just `55AA-CC21`
+
+```yaml
+  - platform: rest
+    name: [ CHANGE_ME:Tibber Prices ]
+    unique_id: [ CHANGE_ME:tibber_prices ]
+    resource: http://admin:[ CHANGE_ME:YOUR-PWD ]@http://[ CHANGE_ME:YOUR_IP ]/metrics.json?node_id=1
+    method: GET
+    json_attributes_path: "node_status"
+    json_attributes:
+      - node_temperature
+      - node_avg_rssi
+      - radio_tx_power
+      - [ CHANGE_ME: add/remove as many of the node_status attributes you want to meassure/do not need ]
+    value_template: "{{ value_json.node_status.node_battery_voltage | float }}"
+    # the scan_interval will be specified in seconds...
+    # for update every 5min use 300 (60sec * 5min = 300sec)
+    # for update every 15min use 900 (60sec * 15min = 900sec)
+    # for update every 1h use 3600 (60sec * 60min = 3600sec)
+    # for update every 24h use 86400 (60sec * 60min * 24h = 86400sec)
+    scan_interval: 900
+    headers:
+      Content-Type: application/json
+      User-Agent: REST
+    unit_of_measurement: [ CHANGE_ME:A_UNIT_HERE ]
+```
+
+Here is a complete example assuming the password is __55AA-CC21__ the IP is __192.168.2.213__, and you want to capture
+the __node_battery_voltage__ as main entity information and all other children of the `node_status` as additional
+attributes of the entity that will be requested every 5 minutes:
+
+```yaml
+  - platform: rest
+    name: Tibber Pulse Metrics
+    unique_id: tibber_pulse_metrics
+    resource: http://admin:55AA-CC21@http://192.168.2.213/metrics.json?node_id=1
+    method: GET
+    json_attributes_path: "node_status"
+    json_attributes:
+      - node_temperature
+      - node_avg_rssi
+      - node_avg_lqi
+      - radio_tx_power
+      - node_uptime_ms
+      - meter_msg_count_sent
+      - meter_pkg_count_sent
+      - time_in_em0_ms
+      - time_in_em1_ms
+      - time_in_em2_ms
+      - acmp_rx_autolevel_300
+      - acmp_rx_autolevel_9600
+    value_template: "{{ value_json.node_status.node_battery_voltage | float }}"
+    scan_interval: 300
+    headers:
+      Content-Type: application/json
+      User-Agent: REST
+    unit_of_measurement: V
+```
+
+Here just another example with just a single value (without additional atributes) that will update every hour (just
+again have in mind, that this yaml section have to be under your `sensor` section of your `configuration.yaml` file):
+
+```yaml
+  - platform: rest
+    name: Tibber Pulse Metrics
+    unique_id: tibber_pulse_metrics
+    resource: http://admin:55AA-CC21@http://192.168.2.213/metrics.json?node_id=1
+    method: GET
+    value_template: "{{ value_json.node_status.node_battery_voltage | float }}"
+    scan_interval: 3600
+    headers:
+      Content-Type: application/json
+      User-Agent: REST
+    unit_of_measurement: V
+```

custom_components/tibber_local/__init__.py

@@ -75,7 +75,8 @@ def __init__(self, hass: HomeAssistant, session, config_entry):
         # initial configuration phase - so we read it from the config_entry.data ONLY!
         com_mode = int(config_entry.data.get(CONF_MODE, MODE_3_SML_1_04))
 
-        self.bridge = TibberLocalBridge(host=self._host, pwd=the_pwd, websession=session, com_mode=com_mode, options=None)
+        self.bridge = TibberLocalBridge(host=self._host, pwd=the_pwd, websession=session, com_mode=com_mode,
+                                        options=None)
         self.name = config_entry.title
         self._config_entry = config_entry
         super().__init__(hass, _LOGGER, name=DOMAIN, update_interval=SCAN_INTERVAL)
@@ -189,6 +190,7 @@ def get_as_two_digit_hex(input: int) -> str:
         else:
             return out;
 
+
 class TibberLocalBridge:
 
     # _communication_mode 'MODE_3_SML_1_04' is the initial implemented mode (reading binary sml data)...
@@ -215,7 +217,7 @@ async def detect_com_mode(self):
     async def detect_com_mode_from_node_param27(self):
         # {'param_id': 27, 'name': 'meter_mode', 'size': 1, 'type': 'uint8', 'help': '0:IEC 62056-21, 1:Count impressions', 'value': [3]}
         self._com_mode = MODE_UNKNOWN
-        async with self.websession.get(self.url_mode, ssl=False) as res:
+        async with self.websession.get(self.url_mode, ssl=False, timeout=10.0) as res:
             res.raise_for_status()
             if res.status == 200:
                 json_resp = await res.json()
@@ -233,7 +235,7 @@ async def update(self):
         await self.read_tibber_local(mode=self._com_mode, retry=True)
 
     async def read_tibber_local(self, mode: int, retry: bool):
-        async with self.websession.get(self.url_data, ssl=False) as res:
+        async with self.websession.get(self.url_data, ssl=False, timeout=10.0) as res:
             res.raise_for_status()
             self._obis_values = {}
             if res.status == 200:

custom_components/tibber_local/manifest.json

@@ -10,5 +10,5 @@
   "iot_class": "local_polling",
   "issue_tracker": "https://github.com/marq24/ha-tibber-pulse-local/issues",
   "requirements": ["smllib==1.2"],
-  "version": "1.0.7"
+  "version": "1.0.8"
 }