From 4b65573ed03b47cb1363ea552ca404e83c1d39bc Mon Sep 17 00:00:00 2001 From: TC Date: Sun, 22 Oct 2023 23:07:28 +0200 Subject: [PATCH] modified: README.md modified: src/README.md --- README.md | 1 + src/README.md | 88 ++++----------------------------------------------- 2 files changed, 7 insertions(+), 82 deletions(-) diff --git a/README.md b/README.md index e420e98..63f8c08 100644 --- a/README.md +++ b/README.md @@ -133,6 +133,7 @@ gdzie: ## Znane problemy Czasami w aplikacji Mój Licznik włącza się captha (jeżeli masz dużo danych historycznych lub wielokrotnie instalujesz dodatek) +Dane wytwórcy (energia oddana oraz bilans) nie są dostępne, prace w tym zakresie trwają. ## Uwagi Dostęp do aktualnej wersji API nie jest zabezpieczony tokenem diff --git a/src/README.md b/src/README.md index 153044b..28996c2 100644 --- a/src/README.md +++ b/src/README.md @@ -20,90 +20,14 @@ 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 +## Możliwości: +* Obsługa liczników jako sensory +* Wykresy w Grafana + ## 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. - -## Wersja Docker -``` -docker run -p 8000:8000 -e ENERGA_USERNAME=LoginEnerga -e ENERGA_PASSWORD=HasloEnerga tomcic/energa-meter:v0.1.0 -``` - -## 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 +Instrukcja instalacji jest dostępna pod adresem: [Instrukcja konfiguracji](https://github.com/tcich/ha-addon-energa-meter/blob/main/README.md) +## Motywacja **Podoba Ci się?** [Postaw kawę.](https://buycoffee.to/tcich)