Le plance (o “dashboards”) di Home Assistant: cosa sono e come si gestiscono

Come sa bene chi utilizza da tempo Home Assistant – forse il più noto tra gli HUB personali software – l’interfaccia utente (UI) è lo strumento preposto sia per interrogare la propria domotica personale (eg. leggere il valore di un sensore) sia per comandarla nei più disparati modi. Una volta chiamata “Lovelace”, oggi si chiama “Dashboards” (“plance”) è essenzialmente basata sul web; può essere interpellata sia tramite tradizionale browser che tramite l’appropriata app Home Assistant Companion: si tratta infatti di un’interfaccia web responsiva, ovvero in grado di adeguarsi al mezzo di visualizzazione.

Nel dettaglio, abbiamo già redatto un articolo ad hoc che spiega la modellazione tecnica di tale strato software. Il presente articolo, invece, spiega in senso pratico come gestire e amministrare le proprie plance.

Dashboards

Prima di comprendere come gestire, organizzare e creare nuove Dashboard, bisogna esser consapevoli che esistano due metodi (con i rispettivi pro e contro) per farlo:

• tramite l’interfaccia stessa di Home Assistant;
• tramite appositi file di configurazione.

In entrambi i casi, l’elenco delle Dashboard disponibili sarà visibile nella sezione “Impostazioni” > “Plance“):

Oltre all’elenco, sono presenti altre due informazioni importanti, visualizzate su altrettante colonne:

• “Solo per l’Amministratore”: impostato a “-” se la dashboard è disponibile per tutti gli utenti e, viceversa, “✓” se la dashboard è visibile solo per l’amministratore dell’istanza di Home Assistant;
• “Mostra nella barra laterale”: impostato a “-” se l’icona della dashboard non è presente nella sidebar, “✓” se l’icona è invece presente.

Plance (via frontend)

La gestione delle Plance tramite il frontend di Home Assistant ha sicuramente il vantaggio di essere una soluzione immediata e pratica. Creazione e relative modifiche possono essere eseguite tramite dei passaggi semplicissimi.

CREAZIONE

Per creare una nuova Plancia, basta cliccare (sempre presso “Impostazioni” > “Plance“) su “+ Aggiungi Plancia“:

A questo punto si aprirà la finestra di configurazione:

La funzione dei campi è facilmente intuibile:

• Titolo: è il nome della nuova dashboard;
• Icona: tramite la ricerca integrata è possibile assegnare alla dashboard un’icona (fra quelle presenti su Material Design Icons – ma ne possono essere usate anche di custom, locali);
• Solo per l’amministratore: da attivare nel caso in cui non si voglia mostrare la dashboard agli utenti non configurati quali amministratori dell’HUB;
• Mostra nella barra laterale: serve per mostrare o nascondere la dashboard dalla sidebar laterale;

Infine, per creare la nuova Dashboard, basterà cliccare su “Crea“.

MODIFICA

Non appena si sarà creata una nuova plancia, la sua icona apparirà nella sidebar (a patto che in precedenza si sia lasciata attiva l’opzione “Mostra nella barra laterale“). Di default, essa verrà generata in automatico da Home Assistant, che inserirà tutte le entità presenti in quel momento nel nostro HUB Domotico.

Questo, nella maggior parte dei casi, può servire in un primo momento per prendere familiarità col frontend, ma non è quasi mai il risultato finale desiderato. Per fare in modo di organizzare le card a proprio piacimento, oltre che selezionare solo quelle che si ritengano interessanti, sarà sufficiente cliccare sui 3 puntini posizionati in alto a destra nella dashboard di default e selezionare l’opzione “Modifica Plancia“.

Successivamente – e solo la prima volta che si andrà a modificare la plancia – apparirà un avviso in cui viene spiegato come esse siano gestite da Home Assistant, il quale la manterrà aggiornata man mano che si andranno ad aggiungere/togliere entità. Verrà quindi richiesto se ricominciare da zero (con una plancia completamente vuota) o se mantenere la configurazione attuale quale base di partenza per le successive modifiche.

Da questo momento in poi sarà possibile personalizzare la plancia a seconda delle proprie preferenze e necessità.

title: HA Test
views:
  - path: default_view
    title: Home
    cards:

Plance (via YAML)

La gestione delle dashboard tramite file in notazione YAML, a questo punto, potrebbe sembrare superflua o inutilmente complessa. In realtà, questo metodo ha grandi potenzialità in quanto permette di creare delle plance molto articolate che implica una quantità di codice altrettanto elevata. Mediante l’utilizzo editor di testo avanzati, risulta molto più ordinato e semplice gestire grandi quantità di codice, magari splittandolo in più file esattamente come avviene per i package di Home Assistant.

CREAZIONE

Per procedere alla creazione di plance via YAML, si dovrà prima di tutto modificare il file di configurazione dell’HUB aggiungendo il seguente blocco di codice:

lovelace:
  mode: storage
  dashboards:

La chiave mode: storage è molto importante: significa che potrete utilizzare sia plance create da Frontend che in modalità YAML.

Continuare, subito sotto alla chiave dashboards, definendo quelle che saranno le caratteristiche della nuova plancia:

lovelace:
  mode: storage
  dashboards:
   nome_dashboard:
      mode: yaml
      title: Dashboard Test
      icon: mdi:home-assistant
      show_in_sidebar: true
      filename: dashboard-test.yamlyaml 

Analizzando nel dettaglio:

• nome_dashboard: il nome – a piacimento – della plancia;
  
• mode: impostatao a yaml, indica che la dashboard che si sta definendo sarà gestita via YAML;
• title: titolo – a piacimento – della plancia;
• icon: l’eventuale icona assegnata alla plancia;
• show_in_sidebar: impostato a true, visualizza la plancia nella sidebar, mentre false la nasconde;
  
• filename: il nome del file che andremo a creare contenente la configurazione della nuova plancia.
  

Il blocco da inserire nel file di configurazione dell’HUB, quindi, si presenterà in modo simile a quanto segue:

lovelace:
  mode: storage
  dashboards:
    mode: yaml 
    title: Dashboard Test
    icon: mdi:home-assistant 
    show_in_sidebar: true 
    filename: dashboard-test.yaml 

Ora, finalmente, si può procedere alla creazione vera e propria della plancia, creando un nuovo file nel percorso dove sono presenti i file di configurazione YAML di Home Assistant. Il nuovo file dovrà avere lo stesso nome menzionato precedentemente nella chiave filename.

MODIFICA

In questo caso, a differenza di quanto visto in precedenza nella sezione dedicata alla gestione via frontend, la plancia creata si presenterà completamente vuota. Non solo: mancheranno anche tutte le istruzioni di base per iniziare ad inserire le prime card.

Le primissime informazioni da inserire nel file dashboard-test.yaml, quindi, saranno le seguenti:

title: Nome dahsboard
views:

Dove title rappresenterà il titolo della plancia e views servirà, subito dopo, a definire quante “viste” (o pagine) vorremo inserire:

 - path: Vista 1
   title: Home
   cards:

Conclusione

Concludendo, è giusto specificare come entrambe le soluzioni descritte (frontend/YAML) offrano le stesse funzioni “generali”, come la gestione delle viste e delle card. Infatti, queste funzioni, saranno sempre inserite in un file testuale sia che esse vengano gstite da frontend che direttamente da file YAML.

Quello che può offrire in più la modalità YAML è la creazione di file contenenti template da utilizzare all’occorrenza, senza la necessità di scrivere ripetutamente lo stesso codice per card molto simili tra loro. Questa possibilità, oltre a quanto descritto in precedenza, è di grande utilità per coloro che intendono costruire dashboard molto complesse con, ad esempio, l’utilizzo di alcune Card Custom.