Script a nastavení Home Assistant slouží pro vyčítání dat o spotřebě a výrobě elektřiny z distribučního portálu https://www.cezdistribuce.cz/ v denních úhrnech

Pokud se vám řešení líbí, můžete mne podpořit v další tvorbě a rozvoji - za což vám předem děkuji :)

Po správném nastavení a spuštění scripu vznikou v Home Assistant tyto senzory:

• sensor.pnd_data (obsahujíc data výroby a spotřeby za vámi zvolený interval - např období vyúčtování)
• sensor.pnd_consumption a sensor.pnd_production v KWh je to den zpětně souhrn za den (data se vyčítají po půlnoci za den zpětně)
• sensor.pnd_total_interval_consumption resp sensor.pnd_total_interval_production v KWh součet za období
• sensor.pnd_production2consumption poměr mezi výrobou a spotřebou s max hodnotou 100% (např. jako indikátor Virtuální Baterie)
• sensor.pnd_production2consumptionfull stejný jako předchozí, bez omezení na 100%
• sensor.pnd_production2consumptionfloor rezerva virtuální baterie, tj cokoliv co je nad 100% s minimem 0% pokud je poměr pod 100%
• sensor.pnd_running kontrolní senzor který se zapne při spuštění a vypne při úspěšném dokončení (úspěšnost je +/-95%) lze použít v automatizaci pro opětovné spuštění skriptu
• sensor.pnd_script_duration kontrolní senzor obsahující délku běhu skriptu (čas se nezapíše pokud se vyskytne chyba)
• sensor.pnd_script_status kontrolní senzor obsahující stav skriptu:
  • Stav: Running - atribut Status: OK
  • Stav: Stopped - atribut Status: Finished
  • Stav: Error - atribut Status: chyba, kde se skript zastavil
• sensor.pnd_app_version senzor s verzí aplikace PND

Výsledkem pak může být například takovýto dashboard (návod na jeho výrobu je popsán níže)

POZOR: Pokud již používáte AppDaemon nebo máte ve svém HA výše uvedené entity, návod je potřeba odpovídajícím způsobem upravit, abyste zachovali to co již používáte. Takové úpravy nejsou v návodu uvedeny.

1. Přihlášení do Distribučního Portálu
2. HomeAssistant
   • AddOn AppDaemon
   • AddOn File Editor (nebo jakoukoliv možnost úpravy konfiguračních souborů v HA)
   • Script pro stažení dat
   • Řešení problémů
   • Naplánování automatické aktualizace
   • HACS
   • ApexCharts Card
3. Tvorba Dashboardu
4. Nápady a plány
5. Změny (Changelog)

Zažádejte si o přihlášení do Distribučního Portálu na webu https://dip.cezdistribuce.cz/irj/portal/ obvykle vyřízeno do druhého dne.

Po přihlášení ověřte, že máte k dispozici váš elektroměr v sekci "Množina zařízení". V tuto chvíli script stahuje všechna data, tedy pokud máte více elektroměrů, nemusí script fungovat správně.

Pozn.: Skript prozatím neumí správně pracovat s uživatelskými sestavami a více elektroměry. Zvolte v portále "Rychlá sestava" a "Všechny EANy" nebo odpovídající elektroměr a odhlaste se z portálu.

Pokud toto čtete, více k čemu je HomeAssistant dobrý, pokud přeci ne, více na stránkách projektu.Kromě funkčního HomeAssistanta je nutné mít také k dispozici přihlašovací token, který snadno vytvoříte:

1. Klikněte na vaše jméno vlevo dole
2. Klikněte na záložku "Zabezpečení" nahoře
3. V dolní části stránky klikněte na "Vytvořit token"
4. Token pojmenujte např. "AppDaemon" (bez uvozovek) a klikněte na OK
5. zobrazený token si zkopírujte, budete jej za chvíli potřebovat. POZOR: Token se zobrazí pouze zde a pouze jednou, pokud si jej nezkopírujete, nebude již přístupný a bude nutné vytvořit nový

AppDaemon je volně spojené, vícevláknové, sandboxované prostředí pro spouštění Pythonu, určené pro psaní automačních aplikací pro software domácí automatizace Home Assistant. Více o AppDaemon naleznete na GitHubu autora

1. V nastavení HA zvolte "Doplňky" a dále pak "Obchod s doplňky"
2. Vyhledejte AppDaemon, zvolte jej a klikněte na "Nainstalovat". Instalace dle rychlosti vašeho HW a internetu je hotova do několika minut.
3. Po instalaci přejděte do nastavení AppDaemon
   • v části "System Packages" přidejte chromium-chromedriver a chromium. Pozn.: pokaždé vložte jeden název a stiskněte enter, je nutné přidávat postupně
   • v části "Python packages" přidejte selenium, pandas a bs4. Pozn.: pokaždé vložte jeden název a stiskněte enter, je nutné přidávat postupně
   • Klikněte na "Uložit". Konfigurace by měla odpovídat obrázku níže
4. Spusťte doplněk AppDaemon

1. V nastavení File editoru vypněte možnost "Enforce Basepath" a zvolte "Uložit" (doplněk se restartuje)
2. Spusťte File File Editor a otevřete soubor addon_configs/a0d7b954_appdaemon/appdaemon.yaml. (pozor je nutné ve File Editoru přejít do kořenové složky, proto se nastavovala volba výše.
3. v části plugins>HASS doplňte

ha_url: http://ip-adresa-nebo-url-vaseho-ha:8123
token: vas-token-ktery-jste-si-vytvorili-vyse

4. v části appdaemon doplňte

app_dir: /homeassistant/appdaemon/apps

5. přidejte část:

logs:
  pnd:
    name: pnd
    filename: /homeassistant/appdaemon/pnd.log

6. soubor uložte a restartujte doplněk AppDaemon

Celý appdaemon.yaml vypadá nějak takto:

---
appdaemon:
  latitude: 52.379189
  longitude: 4.899431
  elevation: 2
  time_zone: Europe/Amsterdam
  thread_duration_warning_threshold: 60
  plugins:
    HASS:
      type: hass
      ha_url: http://192.168.1.100:8123
      token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxx
  app_dir: /homeassistant/appdaemon/apps
http:
  url: http://127.0.0.1:5050
admin:
api:
hadashboard:
logs:
  pnd:
    name: pnd
    filename: /homeassistant/appdaemon/pnd.log

1. ve File Editor přejdět do složky homeassistant/
2. vytvořte složku appdaemon a přejděte do ní
3. vytvořte složku apps a přejděte do ní
4. vytvořte složku pnd
5. ve složce apps vytvořte soubor apps.yaml s obsahem:
   • parametr PNDUserName je váš email s přihlášením do portálu
   • parametr PNDUserPassword je heslo pro přihláše
   • parametr DataInterval je interval dat, které budete chtít stahovat - například období fixace smlouvy. Nedoporučuji víc jak rok, mohlo by zahltit databázi.
   • parametr ELM je číslo (pouze číslo, nikoliv ELM 3000000000) vašeho elektroměru, který chcete sledovat v HA. zjistíte jej v Portále - viz obrázek níže

---
pnd:
  module: pnd
  class: pnd
  log: pnd
  PNDUserName: "vas email s prihlasenim do portalu distribuce"
  PNDUserPassword: "vase heslo do portalu distribuce"
  DataInterval: "27.10.2023 00:00 - 27.10.2024 00:00"
  ELM: "3000012345"
  DownloadFolder: "/homeassistant/appdaemon/apps/pnd"

6. soubor uložte
7. do složky apps nahrajte soubor pnd.py
8. restartujte doplněk AppDaemon. Pozn.: při aktualizaci souboru pnd.py za novější, není nutné doplněk restartovat

** POZOR: Data se neaktualizují sama od sebe, ale pouze automatickým nebo ručním spuštěním automatizace (viz níže)** případně ručním vyvoláním události run_pnd v nástrojích pro vývojáře.

Při úspěšném chodu skriptu:

• jsou vytvořeny soubory ve složce /homeassistant/appdaemon/apps/pnd
• je vypnut binární senzor pnd_running (pokud není tento senzor vypnut po cca 2 minutách, přejděte na řešení problémů

Skript, který získává data vyčkává na událost run_pnd v rámci Home Assistant. Nejsnazší cestou je vytvoření automatizace, která v pravidelném čase stažení dat spustí.

1. V Home Assistant zvolit "Nastavení" > "Automatizace a scény"
2. Vytvořit novou automatizaci
   • parametr "Když" > "Přidat spouštěč" zvolit "Čas" a zvolte čas, ve kterém se má spouštět. Data na portále jsou dostupná několik minut po půlnoci, můžete nastavit např. 00:30:00 AM tedy 30 minut po půlnoci se spustí.
   • parametr "Pak provést" zvolit "Ruční událost" do "Typ události" zadat run_pnd
3. Uložit automatizaci - zvolte jméno automatizace, které si přejete

Ověřte funkčnost nastavení (AppDaemon, skript a automatizace) > vpravo nahoře tři tečky > "Spustit"

Chod skriptu trvá cca 50vteřin, poté byste měli vidět odpovídající entity v HA.

YAML kód automatizace

alias: Run PDN
description: ""
trigger:
  - platform: time
    at: "00:30:00"
condition: []
action:
  - event: run_pnd
    event_data: {}
mode: single

Nejprve zkuste spustit znovu, skript simuluje pohyb na webové stránce a není garantováno, že stránka bude vždy stejná a skript doběhne úspěšně dokonce, případně restartujte AppDaemon a spusťe skript znovu.

Pokud se vyskytne problém (např data se nestahují):

• Přepněte nastavení "Log Level" v AppDaemon na Info a restartujte AppDaemon.
• V doplňku AppDaemon je záložka log, zobrazí kde přesně skript selhal (skript končí chybou) - přidejte tento log do problému zde na GITu nebo v osobní komunikaci (na FB posílejte otisk obrazovky)
• Po doběhnutí skriptu (pokud neskončí chybou) je vytvořený soubor /homeassistant/appdaemon/apps/pnd/debug.zip. Obsahuje složku pnd. Soubor neobsahuje žádná osobní či přihlašovací data - při řešení problémů připojte tento soubor.

• Postupoval jsem dle návodu, ale entity se neobjevily: Řešení - vytvořili jste automatizaci pro vyvolání události? Pokud ještě neuplynul čas do spuštění, spusťe automatizaci ručně

Postup instalalce je uvedený na stránkách projektu

Postup instalace je uvedený na stránkách projektu

Cílem návodu není do detailu popisovat jak v Home Assistant vytvářet dashboardy, níže uvádím ukázky grafů, které lze s výše získaných dat vytvořit. Pokud vytvoříte nějaký super graf, přidejte kód zde na Gitu.

Pokud jste postupovali dle návodu a máte data v Home Assistantu, pak stačí vytvořit novou "Manuální kartu" a do ní zkopírovat kód jednotlivých karet níže.

Využívá senzory sensor.pnd_consumption a sensor.pnd_production které obsahují denní spotřebu resp výrobu za předchozí den. Senzory jsou třídy (device_class) energy a jsou tedy automaticky ukládány do dlouhodobých dat v HomeAssistant

type: custom:apexcharts-card
stacked: true
graph_span: 7d
span:
  end: day
header:
  show: true
  title: PND Včerejší stav
series:
  - entity: sensor.pnd_consumption
    name: Spotřeba
    color: var(--error-color)
    opacity: 0.8
    invert: true
    type: column
    group_by:
      func: last
      duration: 1d
  - entity: sensor.pnd_production
    name: Výroba
    color: var(--success-color)
    opacity: 0.8
    type: column
    group_by:
      func: last
      duration: 1d

Používá kartu rychlý náhled. Jsou využita data ze senzorů sensor.pnd_total_interval_consumption resp sensor.pnd_total_interval_production

show_name: true
show_icon: true
show_state: true
type: glance
entities:
  - entity: sensor.pnd_total_interval_consumption
    name: Spotřeba za Období
  - entity: sensor.pnd_total_interval_production
    name: Výroba za Období
  - entity: sensor.pnd_production2consumption
    name: Využití VB
state_color: false
title: Celkový přehled

Jedná se o poměr mezi výrobou a spotřebou, maximální hodnota je 100 (tj pokud je výroba větší nežli spotřeba, bude hodnota 100%). Využívá standardní kartu Home Assistanta

type: gauge
entity: sensor.pnd_production2consumption
name: Využití Virtuální Baterie
min: 0
max: 100
needle: false

Jsou využita data ze senzorů sensor.pnd_total_interval_consumption resp sensor.pnd_total_interval_production

type: custom:apexcharts-card
chart_type: donut
header:
  show: true
  title: PND Shrnutí Období
apex_config:
  plotOptions:
    pie:
      donut:
        total:
          show: true
          showAlways: true
series:
  - entity: sensor.pnd_total_interval_production
    name: Výroba
    color: var(--success-color)
  - entity: sensor.pnd_total_interval_consumption
    name: Spotřeba
    color: var(--error-color)

Využívá data sensor.pnd_data

type: custom:apexcharts-card
stacked: true
graph_span: 10d
span:
  end: day
header:
  show: true
  title: PND Posledních 10 dní
series:
  - entity: sensor.pnd_data
    name: Výroba
    attribute: production
    data_generator: |
      return entity.attributes.pnddate.map((pnd, index) => {
        return [new Date(pnd).getTime(), entity.attributes.production[index]];
      });
    color: var(--success-color)
    opacity: 0.8
    invert: false
    type: column
  - entity: sensor.pnd_data
    name: Spotřeba
    attribute: consumption
    data_generator: |
      return entity.attributes.pnddate.map((pnd, index) => {
        return [new Date(pnd).getTime(), entity.attributes.consumption[index]];
      });
    color: var(--error-color)
    opacity: 0.8
    invert: true
    type: column

type: custom:apexcharts-card
stacked: true
graph_span: 1y
span:
  end: week
header:
  show: true
  title: PND Historická Data (Týdenní agregace)
series:
  - entity: sensor.pnd_data
    name: Výroba
    attribute: production
    data_generator: |
      return entity.attributes.pnddate.map((pnd, index) => {
        return [new Date(pnd).getTime(), entity.attributes.production[index]];
      });
    color: var(--success-color)
    opacity: 0.8
    invert: false
    type: column
    group_by:
      func: sum
      duration: 7d
  - entity: sensor.pnd_data
    name: Spotřeba
    attribute: consumption
    data_generator: |
      return entity.attributes.pnddate.map((pnd, index) => {
        return [new Date(pnd).getTime(), entity.attributes.consumption[index]];
      });
    color: var(--error-color)
    opacity: 0.8
    invert: true
    type: column
    group_by:
      func: sum
      duration: 7d

type: custom:apexcharts-card
stacked: true
graph_span: 1y
span:
  end: day
header:
  show: true
  title: PND Historická Data (Měsíční agregace)
series:
  - entity: sensor.pnd_data
    name: Výroba
    attribute: production
    data_generator: |
      return entity.attributes.pnddate.map((pnd, index) => {
        return [new Date(pnd).getTime(), entity.attributes.production[index]];
      });
    color: var(--success-color)
    opacity: 0.8
    invert: false
    type: column
    group_by:
      func: sum
      duration: 1month
  - entity: sensor.pnd_data
    name: Spotřeba
    attribute: consumption
    data_generator: |
      return entity.attributes.pnddate.map((pnd, index) => {
        return [new Date(pnd).getTime(), entity.attributes.consumption[index]];
      });
    color: var(--error-color)
    opacity: 0.8
    invert: true
    type: column
    group_by:
      func: sum
      duration: 1month

Pokud máte nějaké přání, nápad na vylepšení - vytvořte požadavek zde na GitHubu

• Zpracování více EANů (Elektroměrů)
• Uživatelské sestavy, které by obsahovaly VT/NT,...??
• Vyřešit unikátní ID senzorů, aby senzor byl spravovatelný v HA
• Distribuce a aktualizace přes HACS

• Přidán senzor: sensor.pnd_production2consumptionfull - zobrazuje poměr mezi výrobou a spoetřebou, bez omezení na 100%
• Přidán senzor: sensor.pnd_production2consumptionfloor - např rezerva virtuální baterie, tj cokoliv co je nad 100% s minimem 0% pokud je poměr pod 100%. např: poměr je 60%, tento senzor bude 0%, poměr je 115%, tento senzor bude 15%

• Lepší ošetření chybových stavů, kontroly interakce s portálem (např chybné heslo) #16
• Přidán sensor.pnd_script_duration pro sledování délky běhu při normálním chodu
• Přidán sensor.pnd_script_status pro sledování stavu, chování a případné chyby skriptu
• Přidán sensor.pnd_app_version s verzí aplikace PND
• Optimalizace časování skriptu - zrychlení
• Vyčištění kódu o pracovní části
• Oprava návodu u grafu měsíční agregace #15
• Přidán ukázkový soubor pro senzory sensors.yaml #4

• Přidána kontrola dostupných ELM
• Doplněna závislost na modulu bs4 - viz nastavení doplňku AppDaemon

• Oprava chyby #7 - přidána podpora více oken v PND

• Kompletní přepracování způsobu a kontroly výběru ELM
• Vylepšené logování, po dokončení skriptu (pokud neskončí chybou) vytvořený debug.zip - prosím zasílejte tento soubor při řešení nesouladu dat

• Změna označení elektromůru z EAN na ELM v konfiguračním souboru + aktualizace dokumentace
• Změna logování scriptu, detailní běh není ukládán do pnd.log ale přímo do AppDaemon logu - při řešení problémů prosím o zaslání Doplňky > AppDaemon > Log
• U kritických fází je ukládán otisk obrazovky (identická cesta, kam jsou ukládány soubory s daty - parametr DownloadFolder v pnd.yaml) pro případné řešení problémů - v případě potřeby prosím o jejich poskytnutí
• Optimalizace kódu

• Přidán sensor.pnd_production2consumption jako procentuální poměr mezi výrobou a spotřebou (např. využití Virtuální Baterie)
• Aktualizovaná karta celkového přehledu o sensor.pnd_production2consumption
• Přidán parametr EAN do konfigurace
• Přidán výběr EAN a Rychlá sestava pro případ, kdy si nastavení portálu pamatuje předchozí hodnoty EAN a uživatelské sestavy
• Lepší ošetření chybových stavů a rozložení Portálu
• Změna způsobu exportu dat z portálu z tabulky
• upřesnění dílčích částí návodu

• Změna vyhledání intervalu z ID na nadřazený název
• Vynucení "Výchozí sestava" a "Všechny EANy"
• Vytvořen changelog