Modificare i file di configurazione Home Assistant Core (su Raspberry Pi OS) con Visual Studio Code (VSCode)

Abstract

Come noto, l’HUB per domotica personale Home Assistant prevede la modifica, in taluni casi, dei propri file di configurazione al fine di definire alcune integrazioni, specifiche funzionalità ed altro.

Chi abbia scelto, come modalità di installazione di Raspberry, la modalità Home Assistant OS, è fortemente facilitato dalla presenza di un editor web che consente, appunto, tali modifiche direttamente dal proprio browser; chi invece abbia optato per la più leggera (e preferibile) versione “Core” si trova davanti al bivio di quali strategie adottare per la modifica di tali file.

La modalità più semplice è quella che prevede di collegarsi via SSH al proprio terminale e modificare i file manualmente con comandi come vi o nano (o altri editor); si tratta di una modalità non particolarmente comoda né consigliabile. Un’alternativa è quella di installare un editor sul proprio computer d’appoggio in modo che si colleghi remotamente (e automaticamente) al Raspberry Pi, permettendo l’editing on-line dei propri file di configurazione.

Questa guida illustra come configurare sia il sistema operativo Raspberry Pi OS (Raspbian) che il proprio computer d’appoggio al fine di ottenere lo scopo descritto. Ovviamente le tecniche descritte sono applicabili a qualsiasi sistema operativo sul quale sia in esecuzione Home Assistant Core e che consenta una connessione sicura SSH.

Si parte

• Requisiti e assunti
• Permessi
• Microsoft Visual Studio Code
• Connessione
• Apertura percorso

Requisiti e assunti

Necessario, innanzitutto, che Home Assistant Core sia installato su Raspberry Pi OS in modalità venv, ovvero come illustrato in dettaglio in questa nostra guida.

Inoltre, è necessario che su Raspberry Pi OS sia attivo il servizio SSH (e ovviamente si sia appurato che funzioni) – ma difficilmente è possibile aver installato Home Assistant Core nella modalità descritta senza il supporto SSH (salvo essersi collegati con monitor e tastiera al Raspberry Pi).

Assumeremo inoltre che l’utente col quale ci si collegherà su Raspberry Pi OS via SSH sia l’utente pi.

Permessi

L’utente pi  – di base – non dovrebbe poter accedere alla cartella /home/homeassistant, ovvero la location dove i file .yaml di configurazione sono solitamente archiviati.

Per far sì che i permessi siano correttamente impostati, aggiungiamo l’utente pi al gruppo homeassistant. |
Collegarsi via SSH a Raspberry Pi OS ed eseguire i seguenti comandi per impostare i permessi:

sudo chown -R homeassistant:homeassistant /home/homeassistant/ && sudo chmod -R 774 /home/homeassistant/
sudo usermod -a -G homeassistant pi

Microsoft Visual Studio Core

L’editor scelto è Visual Studio Core (VSC), un software gratuito di Microsoft. 
Per utilizzarlo, scaricalo dal sito di Microsoft e installarlo sul proprio computer di appoggio.

Una volta installato, il software va “arricchito” tramite l’estensione Remote SSH, essenziale per gli scopi di questo progetto. Per installarlo è sufficiente recarsi presso la voce “estensioni” di VSC (menu “Impostazioni” > “Estensioni“), cercarlo e installarlo.

Una volta installato, riavviare VSC chiudendolo e riaprendolo.

Connessione

A questo punto siamo pronti per collegarci al Raspberry Pi tramite Visual Studio Core.
Cliccare dunque sull’icona:

Cliccare poi sul “+” alla voce “Add SSH Target“:

Ora, alla voce “Enter SSH Shell Command” inserire il comando ssh, configurandolo con l’IP/porta relative al proprio host.
Se per esempio ci si collega via LAN, indicare solo l’IP del Raspberry Pi:

ssh pi@192.168.1.20

(l’IP 192.168.1.20 è di esempio, ovviamente)

oppure l’FQDN che si usa per la connessione esterna:

ssh pi@MIOINDIRIZZO:PORTA

Proseguire avanti. Alla voce “Select SSH configuration file to update” selezionare la prima voce in elenco.

Terminata la procedura, alla voce “SSH Targets” risulterà l’host appena aggiunto, per esempio:

A questo punto cliccare sull’icona accanto all’host:

per collegarsi al Raspberry. Verrà richiesta la password, ovviamente, dell’utente pi:

inserita la password, VSC si collegherà al Raspberry Pi.

Apertura percorso

A questo punto è possibile accedere al percorso contenente i file di configurazione di Home Assistant (o qualunque altro per il quale l’utente pi abbia i diritti ad accedere).

Per farlo cliccare su “Open folder…” e indicare il percorso di Home Assistant:

dopo aver cliccato su “OK“, VSC visualizzerà sulla sinistra l’alberatura del percorso:

A questo punto sarà possibile aggiungere, rimuovere, modificare tutti i file presenti facenti parte della configurazione.

Una volta stabilita la connessione, il plugin eseguirà un processo nodeJS lato server che resterà attivo per tutta la durata della connessione. Si consiglia quindi di cliccare su File > Close Remote Connection quando si termina la sessione di editing, in modo tale da evitare di lasciare appesi processi che per qualche motivo potrebbero rimanere attivi.