Cos’è YAML?

Quando si parla di configurare software o strumenti digitali, potresti imbatterti nel termine YAML. Ma cos'è esattamente YAML? In questo articolo, esploreremo cos'è YAML, come funziona e perché è così utilizzato, il tutto con un linguaggio semplice ed esempi pratici per aiutarti a comprenderlo, anche se non hai mai avuto esperienza con la programmazione o i file di configurazione. In particolare, ci concentreremo su come YAML sia un elemento fondamentale per configurare piattaforme di automazione domestica come Home Assistant.

Ma cos'è esattamente?

YAML è un acronimo che sta per "YAML Ain't Markup Language". In pratica, è un formato di serializzazione dei dati, simile a JSON o XML, che viene spesso utilizzato per creare file di configurazione. L'idea alla base di YAML è quella di essere semplice da leggere e scrivere sia per gli esseri umani che per i computer. È pensato per essere intuitivo, con una struttura molto simile a quella di una lista o di una oggetto che potresti scrivere su carta.

YAML è utilizzato per rappresentare dati in modo strutturato, ma senza l'eccesso di simboli o caratteri speciali che si trovano spesso in altri formati di configurazione. Il suo obiettivo principale è rendere i file di configurazione leggibili e modificabili da chiunque, anche da chi non è esperto di informatica. La sua semplicità lo rende particolarmente apprezzato per applicazioni che richiedono configurazioni complesse ma facilmente comprensibili, come l'automazione della casa.

Come Funziona YAML?

YAML è organizzato in una struttura gerarchica. Questo significa che i dati vengono rappresentati in modo visivo con rientri (spaziature), che indicano la relazione tra vari elementi. Non c'è bisogno di parentesi o tag complessi: il layout è quello che guida la comprensione del contenuto.

Attraverso YAML possiamo rappresentare i seguenti elementi

• Liste: Per elenchi di elementi, preceduti da -.
• Dizionari: Per associare chiavi e valori, senza -.
• Scalari: Stringhe, numeri, booleani, valori null.
• Testo Multilinea: Per rappresentare blocchi di testo su più righe.
• Ancora e Alias: Per riutilizzare blocchi di configurazione.
• Date e Orari: Per rappresentare date e timestamp.
• Liste di Mappe: Per rappresentare più oggetti con attributi comuni.
• Commenti: Per aggiungere note e descrizioni.

Liste in YAML

Le liste in YAML sono utilizzate per rappresentare un insieme ordinato di elementi. In YAML, per definire una lista, si utilizza il trattino - davanti a ciascun elemento. Ogni trattino indica che l'elemento successivo fa parte della stessa lista. Le liste possono contenere singoli valori (come numeri, stringhe, o booleani) oppure interi dizionari, rendendo possibile la creazione di strutture complesse. Questo è simile a come si farebbe una lista a mano, scrivendo un punto elenco davanti a ogni elemento. Ad esempio, una lista della spesa in YAML potrebbe essere scritta così:

Lista di elementi semplici

 cibi:
  - pane
  - pasta
  - pomodori

In questo esempio:

• La parola "cibi" rappresenta l'oggetto principale.
• Gli elementi della lista (pane, pasta, pomodori) sono indicati da un trattino - davanti a ciascun elemento. In questo esempio la lista è composta da elementi semplici di tipo stringa.
• Ogni elemento è considerato parte della stessa lista perché sono allineati e preceduti dal trattino.

Lista di elementi complessi

Le liste possono anche contenere oggetti più complessi, come una lista di cibi dove ogni elemento è un dizionario:

cibi:
  - nome: "pane"
    categoria: "forno"
    quantità: 2
    descrizione: "Pane fresco da forno"
  - nome: "pasta"
    categoria: "pasta secca"
    quantità: 500
    descrizione: "Pasta di semola di grano duro"
  - nome: "pomodori"
    categoria: "verdura"
    quantità: 5
    descrizione: "Pomodori freschi e maturi"

In questo esempio, la lista cibi contiene tre elementi, e ciascuno di essi è un dizionario con le proprietà del dispositivo. Quindi è una lista contenente 3 elementi di tipo dizionario/oggetto cosi composto:

nome: "pane"
categoria: "forno"
quantità: 2
unità: "pezzi"
descrizione: "Pane fresco da forno"

Questo tipo di lista è utile quando si ha una serie di elementi simili che si desidera trattare come un gruppo ordinato.

Quando utilizzare le liste:

• Quando si vuole rappresentare un insieme di elementi dove l'ordine è importante.
• Quando si desidera avere una raccolta di oggetti simili (come dispositivi) senza necessariamente identificare ciascun elemento con un nome specifico.
• Ideale per rappresentare sequenze, come liste di attività, oggetti o configurazioni ripetitive.

Dizionari in YAML

I dizionari, noti anche come oggetti, sono un modo per organizzare informazioni tramite coppie di chiavi e valori. Immagina un dizionario come una scheda descrittiva, dove ogni chiave (o parametro) rappresenta un attributo specifico, mentre il suo valore fornisce il dettaglio di quell'attributo. In parole povere, un dizionario serve per rappresentare schematicamente un oggetto, di varia natura, con tutte le sue caratteristiche. In un dizionario ogni chiave è univoca e viene utilizzata per identificare il valore associato.

A differenza delle liste, che servono per elencare elementi uno dopo l'altro, i dizionari sono usati per fornire dettagli su ciascun elemento, organizzandoli per attributi. Ogni chiave di un dizionario può contenere valori di varia natura: stringhe, interi, decimali, liste, oggetti, ecc. Ecco un esempio per chiarire:

cibi:
  pane:
    categoria: "forno"
    quantità: 2
    tipo: "integrale"
    descrizione: "Pane fresco da forno"
  pasta:
    categoria: "pasta secca"
    quantità: 1
    tipo: "spaghetti"
    descrizione: "Pasta di semola di grano duro"
  pomodori:
    categoria: "verdura"
    quantità: 5
    tipo: "ciliegino"
    descrizione: "Pomodori freschi e maturi"

In questo esempio:

• "cibi" è la chiave principale che contiene al suo interno un oggetto (o dizionario) come valore. L'oggetto contenuto all'intero di "cibi" è rappresentato da 3 chiavi: pane, pasta e pomodori
• "pane", "pasta", e "pomodori" sono, pertanto, chiavi/parametri contenute all'interno dell'oggetto "cibi".
• Ognuna delle chiavi dell'oggetto "cibi" ( "pane", "pasta", e "pomodori") contiene un ulteriore dizionario, con le rispettive chiavi e valore, che definisce le caratteristiche del rispettivo elemento.
  • categoria contiene un valore di tipo stringa
  • quantità contiene un valore di tipo intero
  • tipo contiene un valore di tipo stringa
  • descrizione contiene un valore di tipo stringa
• Non c'è bisogno di trattini perché non si tratta di una lista ma di un oggetto, dove ogni chiave descrive una proprietà con un valore.

Ricalcando l'esempio di prima di una lista di oggetti, un oggetto può essere semplicemente rappresentato nel seguente modo, ed essere un elemento di una lista

nome: "pane"
categoria: "forno"
quantità: 2
unità: "pezzi"
descrizione: "Pane fresco da forno"

Quando utilizzare i dizionari:

• Quando si desidera identificare ciascun elemento con una chiave unica (es. il nome di un dispositivo).
• Quando l'ordine degli elementi non è importante, ma è importante l'accesso diretto tramite il nome della chiave.
• Ideale per strutturare informazioni dove ogni elemento è un oggetto unico con attributi specifici, come configurazioni di dispositivi o impostazioni.

Questo tipo di struttura è molto comune in YAML, specialmente nei file di configurazione di Home Assistant, dove spesso hai bisogno di descrivere dettagliatamente più dispositivi o automazioni.

Altri Tipi di Dati in YAML

Oltre a liste e dizionari, YAML può rappresentare diversi tipi di dati:

• Scalari (Valori Semplici): come stringhe, numeri, booleani (true/false) e valori null (o ~).
  YAML Copia

  abilitato: true
  temperatura: 22.5
  valore_nullo: ~

• Blocco di Testo Multilinea: per scrivere stringhe su più righe. Si può usare | per mantenere i ritorni a capo, oppure > per unirli in una singola riga.
  YAML Copia

  descrizione: |
    Questo è un testo lungo
    che si estende su più righe.

• Date e Orari: formattati secondo lo standard ISO 8601.
  YAML Copia

  data: 2024-10-21
  orario: 18:30:00

• Ancora e Alias: YAML permette di riutilizzare blocchi di configurazione con l'uso di ancore (&) e alias (*).
  YAML Copia

  impostazioni_generali: &default
    tema: scuro
    lingua: italiano

Perché YAML è Così Usato?

YAML è amato soprattutto per la sua leggibilità. Spesso viene utilizzato per creare file di configurazione per software e applicazioni, come Docker, Kubernetes, Home Assistant, e molti altri strumenti per sviluppatori e amministratori di sistema. Il motivo principale è che YAML è molto facile da capire a colpo d'occhio, anche per chi non ha esperienza tecnica.

In particolare, per Home Assistant, YAML è essenziale per definire le automazioni, i dispositivi, e le integrazioni. Questo significa che anche se non hai mai programmato prima, puoi configurare il tuo sistema di automazione domestica semplicemente scrivendo poche righe di YAML.

Rispetto a formati come JSON o XML, YAML è meno "verboso". Non ci sono parentesi graffe {} o virgolette ""ovunque, il che lo rende molto più pulito e semplice da leggere. Ecco un confronto tra un semplice esempio in JSON e in YAML:

JSON:

{
  "cena": [
    {
      "nome": "pane",
      "quantità": 2,
      "tipo": "integrale"
    },
    {
      "nome": "pasta",
      "quantità": 1,
      "tipo": "spaghetti"
    },
    {
      "nome": "pomodori",
      "quantità": 5,
      "tipo": "ciliegino"
    }
  ]
}

YAML:

cena:
  - nome: pane
    quantità: 2
    tipo: integrale
  - nome: pasta
    quantità: 1
    tipo: spaghetti
  - nome: pomodori
    quantità: 5
    tipo: ciliegino

Come puoi vedere, YAML è meno ingombrante e più facile da leggere, soprattutto quando la struttura dei dati diventa complessa.

Esempi di Utilizzo di YAML

Vediamo qualche esempio pratico di come YAML viene utilizzato nel mondo reale, soprattutto nel contesto di una SmartHome:

• Home Assistant: YAML è molto utilizzato per configurare Home Assistant, una piattaforma di automazione domestica. In Home Assistant, YAML è usato per definire le regole di automazione. Ad esempio, potresti scrivere una regola per accendere una luce al tramonto:In questo esempio, YAML è utilizzato per definire le azioni che devono essere intraprese al tramonto. Ogni parte dell'automazione è definita in modo leggibile e chiaro, con una struttura a rientri che mostra la relazione tra il trigger (tramonto) e l'azione (accendere la luce).
  YAML Copia

  automation:
    - alias: Accendi la luce al tramonto
      trigger:
        platform: sun
        event: sunset
      action:
        service: light.turn_on
        entity_id: light.soggiorno

• Docker Compose: YAML è anche utilizzato per configurare Docker Compose, uno strumento che consente di definire e gestire container Docker. Ecco un esempio di come potrebbe apparire un file di Docker Compose:In questo file, YAML è utilizzato per descrivere i servizi da eseguire (web e db), con i rispettivi attributi. La chiarezza di YAML permette di capire rapidamente cosa fa ogni servizio e come sono collegati tra loro.
  YAML Copia

  services:
    home_assistant:
      container_name: home-assistant
      image: ghcr.io/home-assistant/home-assistant:stable
      volumes:
      - /home/pi/homeassistant_hub/homeassistant/config:/config
      - /home/pi/homeassistant_hub/homeassistant/media:/media
      - /run/dbus:/run/dbus:ro
      environment:
      - TZ=Europe/Rome
      - DISABLE_JEMALLOC=true
      network_mode: host
      restart: always
      privileged: true

Come Imparare YAML Facilmente?

YAML è uno strumento molto semplice da imparare, soprattutto se hai già familiarità con le liste o i dizionari. Se vuoi iniziare a sperimentare con YAML, puoi farlo anche semplicemente usando un editor di testo come Notepad su Windows o TextEdit su macOS. Scrivi una struttura semplice come quella degli esempi che abbiamo visto e prova a capire la logica dei rientri.

Ecco alcuni consigli utili per iniziare:

• Rientranze: YAML si basa sulle rientranze per determinare la gerarchia. Non usare tabulazioni (Tab), ma solo spazi. Di solito si utilizzano 2 spazi per ogni livello di rientranza.
• Chiarezza: YAML è progettato per essere leggibile. Usa nomi di attributi chiari e significativi per descrivere ogni elemento.
• Validazione: Se hai dubbi sulla validità del tuo file YAML, puoi utilizzare strumenti online come YAML Lint per verificare che il file sia formattato correttamente.

Per chi vuole fare pratica, ci sono anche molte risorse online e documentazione ufficiale di strumenti che utilizzano YAML. Approfondire la lettura e scrivere i propri file di configurazione è il modo migliore per diventare abili con YAML.

Conclusione

YAML è uno strumento potente e semplice per rappresentare dati in modo strutturato. La sua semplicità e leggibilità lo rendono ideale per configurazioni che devono essere facilmente comprensibili da persone e computer. Che tu stia configurando una piattaforma di automazione domestica come Home Assistant o definendo i container per una tua applicazione, YAML è il modo giusto per farlo.

Se hai mai avuto paura dei file di configurazione, spero che questo articolo ti abbia fatto vedere YAML come uno strumento accessibile, anche se non sei un esperto di programmazione. Puoi pensare a YAML come a un blocco note per il tuo software: semplice, chiaro e immediato. YAML è una parte fondamentale del mondo SmartHome e con un po' di pratica, sarà facile per te creare e modificare le configurazioni per rendere la tua casa sempre più intelligente e automatizzata.

Con YAML, hai la possibilità di prendere il controllo di molti aspetti della tua casa automatica, senza dover imparare linguaggi di programmazione complessi. Spero che queste spiegazioni ti abbiano aiutato a vedere YAML sotto una nuova luce, e che tu possa usarlo per realizzare tutte le tue idee di automazione, rendendo la tua SmartHome più funzionale, personalizzata e, soprattutto, sotto il tuo controllo totale.