Impostare lo stato di un’entità in Home Assistant [aggiornato]

Dopo un po’ di esperienza configurando automazioni a molti insorge l’esigenza di impostare lo stato di un’entità in Home Assistant.

Può essere utile per impostare lo stato di un’entità di tipo device_tracker in base alla rete WiFi collegata allo smartphone, per forzare uno stato di un’entità da un’automazione, per creare un’entità provvisoria in cui memorizzare lo stato precedente o per simulare qualcosa.

Per qualunque fine ci serva ci scontreremo presto con il fatto che non è possibile impostare lo stato o l’attributo di un’entità in modo nativo in Home Assistant, men che meno creare una nuova entità da un’automazione o uno script. Ma fortunatamente la soluzione è piuttosto semplice.

Se ti interessa sapere come fare continue a leggere e sarai in grado di farlo!

Abilitare gli script Python

Come prima cosa dovremo abilitare la possibilità di creare degli script scritti in linguaggio Python nella nostra configurazione di Home Assistant.

Farlo è molto semplice, basta inserire la seguente riga nel nostro configuration.yaml o in un package:

python_script:

Sarà inoltre necessario creare la cartella python_scripts all’interno della nostra cartella config.
In tale cartella si potrà quindi creare un file .py per ogni script python che vorremo utilizzare.

Se poi vorremo documentare i parametri dei nostri script, come faremmo con uno script scritto in yaml (ad esempio vedi il mio script multinotify), basterà creare un file services.yaml nella cartella python_scripts appena creata, nel quale inserire la definizione di ogni script con la descrizione ed i campi, senza il corpo dello script. Fate attenzione che il nome delle definizioni nel file services.yaml devono corrispondere ai nomi dei file .py, che sono anche i nomi dei servizi da richiamare per eseguire tali script.

Per ulteriori indicazioni fare riferimento alla guida ufficiale.

Creare lo script set_state per impostare lo stato di un’entità in Home Assistant

Per creare lo script set_state scarica lo zip di seguito e scompattane il contenuto nella cartella config/python_scripts.

In alternativa puoi fare copia/incolla creando i seguenti due file sempre nella cartella config/python_scripts:

set_state.py

#==================================================================================================
#  python_scripts/set_state.py 
#  modified from - https://community.home-assistant.io/t/how-to-manually-set-state-value-of-sensor/43975/37
#==================================================================================================

#--------------------------------------------------------------------------------------------------
# Set the state or other attributes for the entity specified in the Automation Action
#--------------------------------------------------------------------------------------------------

inputEntity = data.get('entity_id')
if inputEntity is None:
    logger.warning("===== entity_id is required if you want to set something.")
else:    
    inputStateObject = hass.states.get(inputEntity)
    if inputStateObject is None and not data.get('allow_create'):
        logger.warning("===== unknown entity_id: %s", inputEntity)
    else:
        if not inputStateObject is None:
            inputState = inputStateObject.state
            inputAttributesObject = inputStateObject.attributes.copy()
        else:
            inputAttributesObject = {}
    
        for item in data:
            newAttribute = data.get(item)
            logger.debug("===== item = {0}; value = {1}".format(item,newAttribute))
            if item == 'entity_id':
                continue            # already handled
            elif item == 'allow_create':
                continue            # already handled
            elif item == 'state':
                inputState = newAttribute
            else:
                inputAttributesObject[item] = newAttribute
            
        hass.states.set(inputEntity, inputState, inputAttributesObject)

services.yaml

# set_state.py
set_state:
  description: "Imposta lo stato e/o gli attributi di una entità ai valori desiderati"
  fields:
    entity_id:
      description: "Nome completo dell'entità da aggiornare"
      example: device_tracker.mio_tracker
    state:
      description: "Nuovo valore dello stato dell'entità (opzionale)"
      example: not_home
    allow_create:
      description: "Specifica se permettere di creare nuove entità (default=false, così se si sbaglia a scrivere non vengono create entità errate)"
      example: false
    other:
      description: "Qualunque altro valore verrà impostato negli attributi dell'entità. Se l'attributo non esiste verrà creato."

Al termine riavviare il core di Home Assistant da Impostazioni -> Controlli del server -> Gestione del server -> RIAVVIARE.

Come utilizzare lo script set_state per Impostare lo stato di un’entità in Home Assistant

Home Assistant creerà un servizio per ogni file .py presente nella cartella python_scripts con nome python_script.NOME_FILE. Pertanto, per il file set_state.py, avremo il servizio python_script.set_state.

Per richiamarlo basterà utilizzare questa sintassi all’interno di una lista di azioni (automazioni o script):

- service: python_script.set_state
  data:
    entity_id: device_tracker.mio_smartphone
    state: home

Tramite il codice sopra riportato lo stato dell’entità device_tracker.mio_smartphone sarà impostato a home.

Abbiamo anche la possibilità di impostare gli attributi di un’entità, semplicemente specificando come parametri ulteriori i nomi degli attributi da impostare.

Per esempio possiamo impostare lo stato e la sorgente tramite l’attributo source_type con questo codice:

- service: python_script.set_state
  data:
    entity_id: device_tracker.mio_smartphone
    state: home
    source_type: wifi

Solo se stai usando la versione aggiornata al 10/01/2022 (il file zip si chiama …v2.zip) puoi anche creare una entità ex novo. Questo può essere estremamente utile per creare on the fly da un’automazione o uno script un backup di una entità per poter ripristinarla dopo qualcosa.

- service: python_script.set_state
  data:
    entity_id: tmp.nuova_entita
    state: {{states('sensor.sensore_da_backuppare')}}
    allow_create: true

Tramite il codice sopra verrà creata (se non esiste) o aggiornata l’entità tmp.nuova_entità impostandone lo stato al valore dell’entità sensor.sensore_da_backuppare.

Per fare delle prove ti potrebbe essere utile usare Strumenti per sviluppatori -> Servizi nel seguente modo (la descrizione dei parametri nella parte inferiore è presente grazie al file services.yaml):

Conclusione

Questa non era per niente complicata eh? Una volta tanto… Ora puoi impostare lo stato e gli attributi di entità a piacimento o creare nuove entità (che ricorda: saranno eliminate al riavvio di Home Assistant!)

Tieni in considerazione che è un po’ aggirare il sistema in quanto Home Assistant non prevede questa possibilità.

Ciononostante set_state è una possibilità molto utile e potente, usala con responsabilità… 🙂