Fixed various bugs, added new sensor and renamed old one, added facil…

…ity_id
linsvensson · Jun 29, 2022 · 3f0a015 · 3f0a015
1 parent ee7e060
commit 3f0a015
Show file tree

Hide file tree

Showing 5 changed files with 268 additions and 170 deletions.
diff --git a/README.md b/README.md
@@ -1,17 +1,20 @@
 # sensor.greenely
 ![GitHub release (latest by date)](https://img.shields.io/github/v/release/linsvensson/sensor.greenely?color=pink&style=for-the-badge)
 ![GitHub last commit](https://img.shields.io/github/last-commit/linsvensson/sensor.greenely?color=pink&style=for-the-badge)    
-
-[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg?color=pink&style=for-the-badge)](https://github.com/hacs/integration)
+[![hacs_badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg?color=pink&style=for-the-badge)](https://github.com/hacs/integration)
 
 _Custom component to get usage data and prices from [Greenely](https://www.greenely.se/) for [Home Assistant](https://www.home-assistant.io/)._
 
 Because Greenely doesn't have an open api yet, we are using the Android user-agent to access data.
 Data is fetched every hour.
 
 ## Installation
-### Install with HACS (recommended)
-- Add the url to the repository as a custom integration.
+### HACS (recommended)
+- Have [HACS](https://hacs.xyz/docs/setup/download) installed, this will allow you to easily manage and track updates.
+- Search for 'Greenely'.
+- Click Install below the found integration.
+- Configure using the configuration instructions below.
+- Restart Home-Assistant.
 
 ### Manual
 - Copy directory `custom_components/greenely` to your `<config dir>/custom_components` directory.
@@ -35,13 +38,14 @@ sensor:
   - platform: greenely
     email: [email protected]
     password: 1234
-    usage: true
+    facility_id: '77081'
+    daily_usage: true
+    hourly_usage: true
+    hourly_offset_days: 2
+    usage_days: 4
     prices: false
     sold: true
-    show_hourly: true
     sold_daily: true
-    usage_days: 4
-    hourly_offset_days: 2
     sold_measure: 6
     time_format: '%H'
     date_format: '%d/%m/%Y'
@@ -53,11 +57,12 @@ key | type | description
 **platform (Required)** | string | `greenely`
 **email (Required)** | string | Your Greenely username.
 **password (Required)** | string | Your Greenely password.
-**usage (Optional)** | boolean | Creates a sensor showing usage data. The state of this sensor is yesterday's total usage. Default `true`.
+**facility_id (Optional)** | string | If you have more than one facility and know the facility ID you want data from, put it here. Default `primary`.
+**daily_usage (Optional)** | boolean | Creates a sensor showing daily usage data. The state of this sensor is yesterday's total usage. Default `true`.
+**hourly_usage (Optional)** | boolean | Creates a sensor showing yesterday's hourly usage data. Default `false`.
 **sold (Optional)** | boolean | Creates a sensor showing sold electricity data. The state of this sensor is the total value. Default `false`.
-**prices (Optional)** | boolean | Creates a sensor showing price data. Default `true`.
-**show_hourly (Optional)** | boolean | Show yesterday's hourly data. Default `false`.
-**hourly_offset_days (Optional)** | number | How many days ago you want the hourly data from. Can't be greater than **usage_days** Default `1` (yesterday's data).
+**prices (Optional)** | boolean | Creates a sensor showing price data in kr/kWh. Default `true`.
+**hourly_offset_days (Optional)** | number | How many days ago you want the hourly data from. Default `1` (yesterday's data).
 **usage_days (Optional)** | number | How many days of usage data you want. Default `10`.
 **sold_measure (Optional)** | number | How many months or days of sold data you want to see. Default `2`.
 **sold_daily (Optional)** | boolean | Show daily sold data instead of monthly. Default `false`.
@@ -68,8 +73,7 @@ key | type | description
 **Example chart with [ApexCharts Card](https://github.com/RomRider/apexcharts-card):**
 Use these configurations for the sensor
 ```yaml
-show_hourly: true
-time_format: '%Y-%m-%dT%H:%M'
+hourly_usage: true
 date_format: '%Y-%m-%d'
 ```
 ```yaml
@@ -99,17 +103,16 @@ date_format: '%Y-%m-%d'
     stroke:
       width: 4
   series:
-    - entity: sensor.greenely_usage
+    - entity: sensor.greenely_hourly_usage
       name: Förbrukning
       yaxis_id: first
       type: column
       color: red
-      extend_to_end: false
       show:
         legend_value: false
       data_generator: |
-        return entity.attributes.hourly.map((entry) => {
-          return [new Date(entry.time), entry.usage];
+        return entity.attributes.data.map((entry) => {
+          return [new Date(entry.localtime), entry.usage];
         }); 
     - entity: sensor.greenely_prices
       data_generator: |
@@ -122,30 +125,29 @@ date_format: '%Y-%m-%d'
       name: Elpris
       show:
         legend_value: false
-      extend_to_end: false
 ```
 
-![image](https://user-images.githubusercontent.com/55505550/145798605-c6add66f-d047-4576-9fcf-17e09c133663.png)
+![image](https://user-images.githubusercontent.com/5594088/176283193-648e09cc-cd79-4807-a07b-0141071b9b64.PNG)
 
 **Example usage with [flex-table-card](https://github.com/custom-cards/flex-table-card):**
 ```yaml
 - type: 'custom:flex-table-card'
-  title: Greenely Usage
+  title: Greenely Daily Usage
   sort_by: date
   entities:
-    include: sensor.greenely_usage
+    include: sensor.greenely_daily_usage
   columns:
     - name: date
-      attr_as_list: days
+      attr_as_list: data
       modify: x.date
       icon: mdi:calendar
     - name: kWh
-      attr_as_list: days
+      attr_as_list: data
       modify: x.usage
       icon: mdi:flash
 ```
 
-![image](https://user-images.githubusercontent.com/5594088/72650563-2b67aa80-3981-11ea-8101-d54dfb337ee8.PNG)
+![image](https://user-images.githubusercontent.com/5594088/176284102-302906ca-5a23-4bcc-8700-415db6b30dd9.PNG)
 
 **Example prices with [flex-table-card](https://github.com/custom-cards/flex-table-card):**
 ```yaml
@@ -165,7 +167,7 @@ date_format: '%Y-%m-%d'
               icon: mdi:clock
             - name: price(öre/kWh)
               attr_as_list: current_day
-              modify: Math.round(x.price * 10) / 10
+              modify: Math.round(x.price * 100)
               icon: mdi:cash
         - type: 'custom:flex-table-card'
           title: Tomorrow
@@ -179,18 +181,18 @@ date_format: '%Y-%m-%d'
               icon: mdi:clock
             - name: price(öre/kWh)
               attr_as_list: next_day
-              modify: Math.round(x.price * 10) / 10
+              modify: Math.round(x.price * 100)
               icon: mdi:cash
 ```
 
-![image](https://user-images.githubusercontent.com/5594088/162276616-148f44da-99a5-4108-be0e-ef324466ec8d.PNG)
+![image](https://user-images.githubusercontent.com/5594088/176283756-3361f5ed-6003-40aa-b2f1-2891d286bb3b.PNG)
 
 **Example usage with [Node-Red Companion](https://github.com/zachowj/hass-node-red) and tts**
 ![image](https://user-images.githubusercontent.com/5594088/116883602-140c0980-ac26-11eb-843c-409604e4b93e.png)
 <details>
   <summary>Clipboard</summary>
 
-```[{"id":"3d82b277.52bb3e","type":"subflow","name":"volume adjustment 70%","info":"","category":"","in":[{"x":40,"y":200,"wires":[{"id":"ace99ba9.14ecf8"}]}],"out":[],"env":[]},{"id":"a6b88b50.4af618","type":"api-call-service","z":"3d82b277.52bb3e","name":"Set volume to 70%","server":"78ca140a.63476c","version":1,"debugenabled":false,"service_domain":"media_player","service":"volume_set","entityId":"media_player.google","data":"{\"volume_level\":0.7}","dataType":"json","mergecontext":"","output_location":"payload","output_location_type":"msg","mustacheAltTags":false,"x":530,"y":140,"wires":[[]]},{"id":"bd929e33.12a5a","type":"switch","z":"3d82b277.52bb3e","name":"70% ?","property":"data.attributes.volume_level","propertyType":"msg","rules":[{"t":"neq","v":"0.7","vt":"num"}],"checkall":"true","repair":false,"outputs":1,"x":330,"y":200,"wires":[["a6b88b50.4af618","c810b1a6.ad421"]]},{"id":"c810b1a6.ad421","type":"function","z":"3d82b277.52bb3e","name":"previous volume","func":"msg.payload =\n{\n    \"data\":{\n      \"entity_id\":\"media_player.google\",\n      \"volume_level\": 0.4\n    }\n}\nreturn msg;","outputs":1,"noerr":0,"x":500,"y":200,"wires":[["8876effc.617e4"]]},{"id":"8876effc.617e4","type":"delay","z":"3d82b277.52bb3e","name":"","pauseType":"delay","timeout":"8","timeoutUnits":"seconds","rate":"1","nbRateUnits":"1","rateUnits":"second","randomFirst":"1","randomLast":"5","randomUnits":"seconds","drop":false,"x":700,"y":200,"wires":[["f0ffa361.42bab"]]},{"id":"f0ffa361.42bab","type":"api-call-service","z":"3d82b277.52bb3e","name":"set volume to previous","server":"78ca140a.63476c","version":1,"debugenabled":false,"service_domain":"media_player","service":"volume_set","entityId":"media_player.google","data":"{\"volume_level\":\"{{msg.payload.data.volume_level}}\"}","dataType":"json","mergecontext":"","output_location":"payload","output_location_type":"msg","mustacheAltTags":false,"x":920,"y":200,"wires":[[]]},{"id":"ace99ba9.14ecf8","type":"api-current-state","z":"3d82b277.52bb3e","name":"speaker","server":"78ca140a.63476c","version":1,"outputs":1,"halt_if":"","halt_if_type":"str","halt_if_compare":"is","override_topic":true,"entity_id":"media_player.google","state_type":"str","state_location":"payload","override_payload":"msg","entity_location":"data","override_data":"msg","blockInputOverrides":false,"x":180,"y":200,"wires":[["bd929e33.12a5a"]]},{"id":"bf9a6d11.435ea","type":"api-call-service","z":"816aff66.f144b","name":"tts","server":"78ca140a.63476c","version":1,"debugenabled":false,"service_domain":"tts","service":"google_say","entityId":"media_player.google","data":"","dataType":"jsonata","mergecontext":"","output_location":"payload","output_location_type":"msg","mustacheAltTags":false,"x":872,"y":2829,"wires":[["c692e642.c2ba58"]]},{"id":"584c5e33.b7901","type":"function","z":"816aff66.f144b","name":"get current price","func":"var price = msg.data.attributes.current_price;\nif (price !== undefined) {\n    msg = {payload: {data: {message: \"The current price is \" + Math.round(price) }}};\n} else {\n    msg = {payload: {data: {message: \"Sorry, I was unable to fetch the current price\" }}};\n}\nreturn msg;","outputs":1,"noerr":0,"x":701,"y":2829,"wires":[["bf9a6d11.435ea"]]},{"id":"c692e642.c2ba58","type":"subflow:3d82b277.52bb3e","z":"816aff66.f144b","name":"","x":1170,"y":2840,"wires":[]},{"id":"fb18952.6043c68","type":"api-current-state","z":"816aff66.f144b","name":"","server":"78ca140a.63476c","version":1,"outputs":1,"halt_if":"","halt_if_type":"str","halt_if_compare":"is","override_topic":false,"entity_id":"sensor.greenely_prices","state_type":"str","state_location":"payload","override_payload":"msg","entity_location":"data","override_data":"msg","blockInputOverrides":false,"x":430,"y":2800,"wires":[["584c5e33.b7901"]]},{"id":"1d10e908.28fea7","type":"ha-entity","z":"816aff66.f144b","name":"","server":"78ca140a.63476c","version":1,"debugenabled":false,"outputs":2,"entityType":"switch","config":[{"property":"name","value":"scene_electricity_price"},{"property":"device_class","value":""},{"property":"icon","value":""},{"property":"unit_of_measurement","value":""}],"state":"payload","stateType":"msg","attributes":[],"resend":true,"outputLocation":"","outputLocationType":"none","inputOverride":"allow","outputOnStateChange":false,"outputPayload":"$entity().state ? \"on\": \"off\"","outputPayloadType":"jsonata","x":150,"y":2840,"wires":[["fb18952.6043c68"],[]]},{"id":"78ca140a.63476c","type":"server","z":"","name":"Home Assistant","legacy":false,"addon":false,"rejectUnauthorizedCerts":false,"ha_boolean":"y|yes|true|on|home|open","connectionDelay":true,"cacheJson":true}]\```
+```[{"id":"3d82b277.52bb3e","type":"subflow","name":"volume adjustment 70%","info":"","category":"","in":[{"x":40,"y":200,"wires":[{"id":"ace99ba9.14ecf8"}]}],"out":[],"env":[]},{"id":"a6b88b50.4af618","type":"api-call-service","z":"3d82b277.52bb3e","name":"Set volume to 70%","server":"78ca140a.63476c","version":1,"debugenabled":false,"service_domain":"media_player","service":"volume_set","entityId":"media_player.google","data":"{\"volume_level\":0.7}","dataType":"json","mergecontext":"","output_location":"payload","output_location_type":"msg","mustacheAltTags":false,"x":530,"y":140,"wires":[[]]},{"id":"bd929e33.12a5a","type":"switch","z":"3d82b277.52bb3e","name":"70% ?","property":"data.attributes.volume_level","propertyType":"msg","rules":[{"t":"neq","v":"0.7","vt":"num"}],"checkall":"true","repair":false,"outputs":1,"x":330,"y":200,"wires":[["a6b88b50.4af618","c810b1a6.ad421"]]},{"id":"c810b1a6.ad421","type":"function","z":"3d82b277.52bb3e","name":"previous volume","func":"msg.payload =\n{\n    \"data\":{\n      \"entity_id\":\"media_player.google\",\n      \"volume_level\": 0.4\n    }\n}\nreturn msg;","outputs":1,"noerr":0,"x":500,"y":200,"wires":[["8876effc.617e4"]]},{"id":"8876effc.617e4","type":"delay","z":"3d82b277.52bb3e","name":"","pauseType":"delay","timeout":"8","timeoutUnits":"seconds","rate":"1","nbRateUnits":"1","rateUnits":"second","randomFirst":"1","randomLast":"5","randomUnits":"seconds","drop":false,"x":700,"y":200,"wires":[["f0ffa361.42bab"]]},{"id":"f0ffa361.42bab","type":"api-call-service","z":"3d82b277.52bb3e","name":"set volume to previous","server":"78ca140a.63476c","version":1,"debugenabled":false,"service_domain":"media_player","service":"volume_set","entityId":"media_player.google","data":"{\"volume_level\":\"{{msg.payload.data.volume_level}}\"}","dataType":"json","mergecontext":"","output_location":"payload","output_location_type":"msg","mustacheAltTags":false,"x":920,"y":200,"wires":[[]]},{"id":"ace99ba9.14ecf8","type":"api-current-state","z":"3d82b277.52bb3e","name":"speaker","server":"78ca140a.63476c","version":1,"outputs":1,"halt_if":"","halt_if_type":"str","halt_if_compare":"is","override_topic":true,"entity_id":"media_player.google","state_type":"str","state_location":"payload","override_payload":"msg","entity_location":"data","override_data":"msg","blockInputOverrides":false,"x":180,"y":200,"wires":[["bd929e33.12a5a"]]},{"id":"bf9a6d11.435ea","type":"api-call-service","z":"816aff66.f144b","name":"tts","server":"78ca140a.63476c","version":1,"debugenabled":false,"service_domain":"tts","service":"google_say","entityId":"media_player.google","data":"","dataType":"jsonata","mergecontext":"","output_location":"payload","output_location_type":"msg","mustacheAltTags":false,"x":872,"y":2829,"wires":[["c692e642.c2ba58"]]},{"id":"584c5e33.b7901","type":"function","z":"816aff66.f144b","name":"get current price","func":"var price = msg.data.attributes.current_price;\nif (price !== undefined) {\n    msg = {payload: {data: {message: \"The current price is \" + Math.round(price * 100) }}};\n} else {\n    msg = {payload: {data: {message: \"Sorry, I was unable to fetch the current price\" }}};\n}\nreturn msg;","outputs":1,"noerr":0,"x":701,"y":2829,"wires":[["bf9a6d11.435ea"]]},{"id":"c692e642.c2ba58","type":"subflow:3d82b277.52bb3e","z":"816aff66.f144b","name":"","x":1170,"y":2840,"wires":[]},{"id":"fb18952.6043c68","type":"api-current-state","z":"816aff66.f144b","name":"","server":"78ca140a.63476c","version":1,"outputs":1,"halt_if":"","halt_if_type":"str","halt_if_compare":"is","override_topic":false,"entity_id":"sensor.greenely_prices","state_type":"str","state_location":"payload","override_payload":"msg","entity_location":"data","override_data":"msg","blockInputOverrides":false,"x":430,"y":2800,"wires":[["584c5e33.b7901"]]},{"id":"1d10e908.28fea7","type":"ha-entity","z":"816aff66.f144b","name":"","server":"78ca140a.63476c","version":1,"debugenabled":false,"outputs":2,"entityType":"switch","config":[{"property":"name","value":"scene_electricity_price"},{"property":"device_class","value":""},{"property":"icon","value":""},{"property":"unit_of_measurement","value":""}],"state":"payload","stateType":"msg","attributes":[],"resend":true,"outputLocation":"","outputLocationType":"none","inputOverride":"allow","outputOnStateChange":false,"outputPayload":"$entity().state ? \"on\": \"off\"","outputPayloadType":"jsonata","x":150,"y":2840,"wires":[["fb18952.6043c68"],[]]},{"id":"78ca140a.63476c","type":"server","z":"","name":"Home Assistant","legacy":false,"addon":false,"rejectUnauthorizedCerts":false,"ha_boolean":"y|yes|true|on|home|open","connectionDelay":true,"cacheJson":true}]\```
 
 </details>
 
@@ -211,11 +213,11 @@ Add this to your configuration.yaml to debug the component
 ```
 **days**
 ```json
-[{ "date": "Jan 12 2020", "usage": "11.0" }]
+[{ "localtime": "Jan 12 2020", "usage": "11.0" }]
 ```
 **hourly**
 ```json
-[{ "time": "10:00", "usage": "1.0" }]
+[{ "localtime": "Jan 12 2020 10:00", "usage": "1.0" }]
 ```
 **sold_data**
 ```json