First init

2023-10-22 01:55:11 +02:00
commit 81b4805c0b
26 changed files with 1266 additions and 0 deletions
--- a/src/README.md
+++ b/src/README.md
@@ -0,0 +1,104 @@
+[![ha_badge](https://img.shields.io/badge/Home%20Assistant-Add%20On-blue.svg)](https://www.home-assistant.io/)
+# [Energa meter](https://github.com/tcich/ha-addon-energa-meter) Home Assistant add-on
+
+[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
+[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
+[armv6-shield]: https://img.shields.io/badge/armv6-yes-green.svg
+[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
+[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
+![aarch64-shield]
+![amd64-shield]
+![armv6-shield]
+![armv7-shield]
+![i386-shield]
+
+**Podoba Ci się?** [Postaw kawę.](https://buycoffee.to/tcich)
+
+
+
+## O dodatku
+
+To jest dodatek dla [Home Assistant](https://www.home-assistant.io/). Instalacja dodatku [Energa meter](https://github.com/tcich/ha-addon-energa-meter) umożliwia cykliczne pobieranie danych z aplikacji [Mój Licznik - Energa](https://mojlicznik.energa-operator.pl) udostępnianej klientom Operatora energetycznego Energa
+
+## Instalacja
+1) Dodaj repozytorium do repozytoriów dodatków swojego HA za pomocą poniższego przycisku
+
+[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Ftcich%2Fha-addon-energa-meter)
+
+Lub zainstaluj manualnie z Ustawienia -> Dodatki -> Sklep z dodatkami -> ⁞ (Menu) -> Repozytoria -> Wpisz `https://github.com/tcich/hassio-mojlicznik` -> Dodaj. Następnie w ⁞ (Menu) -> Sprawdź aktualizacje (może być konieczne przeładowanie strony)
+
+2) Odszukaj dodatek na liście dodatków w sklepie z dodatkami i zainstaluj go.
+
+3) W zakładce konfiguracja uzupełnij nazwę użytkownika oraz hasło do aplikacji Mój Licznik, jeżeli potrzebujesz to zmień udostępniany port dla API
+
+4) Przejdź do zakładki informacje i uruchom dodatek (pierwsze uruchomienie może trwać kilkanaście minut), jeżeli w logu pojawi się informacja *INFO: Czekam...* oznacza to, że pierwsze inicjalne pobieranie danych zostało ukończone.
+
+## Konfiguracja sensorów
+1) Ustal ID Twoich liczników, w tym celu przejdź do adresu Twojego HA na porcie 8000 lub innym jeźeli zmieniłeś go w konfiguracji, np. http://192.168.1.10:8000 wyświetli się w formacie json lista dostępnych liczników, możesz również odszukać ID w logu: *Licznik 12335379 istnieje w systemie*
+2) W pliku configuration.yaml w HA dodaj następującą konfigurację np.:
+
+```
+sensor:
+  - platform: rest
+    resource: http://localhost:8000/meters/12335379
+    name: "Energia aktualna T1"
+    unique_id: 12335379_sumz1
+    unit_of_measurement: "kWh"
+    value_template: "{{ value_json.meter.zone1.meter | round(2) }}"   
+  - platform: rest
+    resource: http://localhost:8000/meters/12335379
+    name: "Dzienny odczyt licznika"
+    unique_id: 12335379_meterz1
+    unit_of_measurement: "kWh"
+    value_template: "{{ value_json.meter.zone1.sum | round(2) }}"
+  - platform: rest
+    resource: http://localhost:8000/meters/12335379
+    name: "Energia aktualna T2"
+    unique_id: 12335379_sumz2
+    unit_of_measurement: "kWh"
+    value_template: "{{ value_json.meter.zone2.meter | round(2) }}"   
+  - platform: rest
+    resource: http://localhost:8000/meters/12335379
+    name: "Dzienny odczyt licznika"
+    unique_id: 12335379_meterz2
+    unit_of_measurement: "kWh"
+    value_template: "{{ value_json.meter.zone2.sum | round(2) }}" 
+```    
+
+# Opis konfiguracji
+| element konfiguracji | Opis |
+|-------------------|-------------------|
+| resource: http://localhost:8000/meters/12335379     | Adres API z danymi konkretnego licznika, podajemy nazwę instancji dockera (**Nazwa hosta** z okna dodatku) lub localhost|
+| name: "Energia aktualna"    | Nazwa sensora, wpisz dowolną|
+| unique_id   | Unikalny ID sensora, nie mogą być w systemie dwa sensory z tym samym ID|
+| unit_of_measurement: "kWh"   | Jednostka miary, nie zmieniaj chyba, że wiesz co robisz|
+| value_template: "{{ value_json.meter.zone2.meter \| round(2) }}"   | Zaokrąglony do dwóch miejsc po przecinku stan sensora|
+
+# Opis konfiguracji cd
+| value_template | Opis |
+|-------------------|-------------------|
+| value_json.meter.zone1.sum     | Suma licznika oraz dziennego zużycia dla tartfy1 (dostępne są: zone1, zone2, zone3)|
+| value_json.meter.zone2.meter     | Stan licznika dziennego dla taryfy1 (dostępne są: zone1, zone2, zone3)|
+
+
+## API dla wykresów, np. Grafana
+Aby pobrać dane z API w formacie JSON należy użyć adresu http://home_assistant:8000/charts/12729?start_date=1695332400129&end_date=1697924583285
+
+gdzie: 
+* 12729 - jest to ID licznika
+* start_date - początek okresu w milisekundach wg. standardu EPOCH (timestamp)
+* end_date - koniec okresu w milisekundach wg. standardu EPOCH (timestamp)
+
+## Jak dodać wykres do Grafana
+
+[Instrukcja konfiguracji Grafana](https://github.com/tcich/ha-addon-energa-meter/blob/main/README.md#jak-doda%C4%87-wykres-do-grafana)
+
+## Znane problemy
+Czasami w aplikacji Mój Licznik włącza się captha (jeżeli masz dużo danych historycznych lub wielokrotnie instalujesz dodatek)
+
+## Uwagi
+Dostęp do aktualnej wersji API nie jest zabezpieczony tokenem
+Każde przeinstalowanie dodatku pobiera ponownie dane z aplikacji Mój Licznik
+
+
+**Podoba Ci się?** [Postaw kawę.](https://buycoffee.to/tcich)