Entender o YAML
YAML é uma linguagem conhecida usada para especificar a configuração de software. Ele oferece uma maneira clara e legível de representar informações estruturadas. Aqui estão algumas coisas básicas que você precisa entender sobre o YAML antes de criar sua primeira automação com script. Para saber mais sobre YAML em geral, consulte a especificação da versão 1.1.
Pares de chave-valor
Os documentos YAML são basicamente uma coleção de pares de chave-valor. No exemplo a seguir, a chave é name e o valor é TV on lights off. A chave e o valor são delimitados por dois pontos seguidos de espaço. Os dois caracteres são necessários para YAML bem formado.
name: TV on lights off
Valores
O valor associado a uma chave pode ser tão básico quanto uma string, um número ou uma data, ou tão complexo quanto outra coleção de pares de chave-valor.
Strings
Se o valor de uma string começar com um dos seguintes caracteres: [, {, ",
' ou # ou se a string contiver : (dois-pontos seguidos por espaços), ele precisará estar
entre aspas.
Aspas simples e duplas são aceitas, mas as aspas de fechamento precisam corresponder às aspas de abertura.
Citação correta:
name: 'TV on lights off'
name: "TV on lights off"
Citação incorreta (aspas sem correspondência):
name: 'TV on lights off"
As aspas são opcionais para todos os outros tipos de strings.
Se você precisar de uma string de várias linhas, consulte a seção de especificação YAML sobre escalares multilinhas.
name: "[1] TV"
name: '{1} TV'
name: '#TV'
name: '"1" TV'
name: "'1' TV"
name: "\"1\" TV"
name: "TV: bedroom"
Pares de chave-valor aninhados
Aqui, o valor da chave metadata é uma lista de dois pares de chave-valor (name e description):
metadata:
name: TV on lights off
description: Turn off lights when TV turns on
Recuo
O YAML usa recuo para indicar a estrutura. No exemplo anterior, name e
description são recuados (por dois espaços) para indicar que eles são os filhos
da chave metadata.
O recuo é rigoroso no YAML. Uma estrutura filha precisa ter um recuo mais profundo do que a m��e, e os pares de chave-valor no mesmo nível precisam ter o mesmo recuo.
metadata:
name:
en: TV on lights off
description:
en: Turn off lights when TV turns on
Diversos valores
Se uma determinada chave tiver vários valores, cada um deles será listado em uma nova linha, e cada linha começará seguida por um traço e um espaço. No exemplo a seguir, há duas listas:
- Uma automação pode ter vários
starterse, portanto, a primeira ativação começa com um traço e um espaço. weekdaypode ter vários valores e, portanto, cada valor é recuado e começa com um traço e um espaço.
starters:
- type: time.schedule
at: SUNSET
weekday:
- MONDAY
- THURSDAY
state: on
Comentários
Qualquer texto após um # é considerado um comentário e ignorado
pelo mecanismo de automação.
Uma linha que começa com # é um comentário.
Um comentário pode aparecer na mesma linha que o conteúdo do script, mas o # precisa ser
precedido por um espaço.
# This is a comment. It will be ignored.
name: chromecast #This is a TV.
Script de automação
A especificação da sintaxe do script de automações é chamada de esquema.
O esquema "Automações" define algumas estruturas de dados:
- Um único par de chave-valor é chamado de Campo.
- Uma coleção de campos definidos pelo esquema é chamada de struct.
Struct
A linguagem de script de automação define vários "blocos" ou estruturas de dados padrão, chamados de structs.
Confira o struct automation, que define quatro campos:
| Key | Tipo | Descrição |
|---|---|---|
|
|
Opcional. Nome da automação. Essa informação não é exibida aos usuários e serve apenas para referência do desenvolvedor. |
|
|
|
[Início] |
Obrigatório. Uma lista de ativações. |
|
|
Opcional. Condição. |
|
|
|
[Ação] |
Obrigatório. Uma lista de ações. |
A seção Referência fornece definições de esquema para todos os structs disponíveis.
Os nomes das chaves são exclusivos em um determinado Struct e diferenciam maiúsculas de minúsculas.
Os tipos de valor possíveis são:
- Um tipo primitivo: booleano, número, string, hora e assim por diante.
- Um tipo Struct: uma coleção de campos.
- Uma matriz do tipo de dados. A matriz é indicada por
[]. Por exemplo,[string]é uma matriz de strings e[Starter]é uma matriz de Starter Structs. - Outros tipos especiais: Entity, FieldPath.
A descrição de cada campo contém informações importantes, incluindo:
- Obrigatório ou opcional, indicando se o campo é obrigatório ou se pode ser ignorado.
- Dependência do campo. Somente os campos opcionais têm dependências. Isso descreve as verificações adicionais ao usar esse campo, como Use o Campo B apenas se o Campo A estiver definido ou Quando o Campo A for usado, não defina o Campo B ou C.
- Valores possíveis. Por exemplo, o conjunto de valores limitado de um campo Enum do tipo string ou um intervalo de números que pode ser usado em um campo do tipo número.
Estrutura tipada
Alguns structs podem representar ativações com base em um cronograma ou em uma mudança de estado
do dispositivo. Cada tipo de starter precisa fornecer um conjunto distinto de campos.
# A time schedule starter.
starter:
type: time.schedule
at: 10:00
# A device state change starter.
starter:
type: device.state.OnOff
device: TV - Living Room
state: on
is: true
Um starter é um struct tipado, que é estendido por outros structs filhos no campo type, como time.schedule ou device.state.OnOff, para fornecer funções diferentes. Os structs condition e action também são tipados.
Os campos adicionais no Struct precisam seguir a especificação do Struct filho (type). Por exemplo, ao usar device.state.OnOff como type, apenas
os
campos
campos especificados para esse
tipo
são válidos
nessa estrutura starter.
Matriz
Em YAML, uma matriz de valores começa com - (um traço seguido por um espaço). A matriz pode conter vários valores Struct ou vários valores primitivos. No entanto, os valores na matriz precisam ser do mesmo tipo.
Quando a matriz contém um único item, é possível omitir o traço e o espaço:
# The starters field accepts an array of Starter Structs.
# This is the standard format.
starters:
- type: time.schedule
at: sunset
- type: time.schedule
at: sunrise
# The dash can be omitted if the array only has one item.
# This is also valid.
starters:
type: time.schedule
at: sunset
Matrizes multidimensionais, como [[1, 2], [3, 4]], não são compatíveis com scripts de automação. O
analisador de linguagem nivela automaticamente uma matriz multidimensional em uma
matriz de dimensão única, neste caso, [1, 2, 3, 4].
# INVALID: multi-dimensional array
- - 1
- 2
- - 3
- 4
Primário
Os seguintes tipos de dados primitivos são compatíveis com o esquema de script de automações:
|
Bool |
|
|
Número |
Número inteiro ou decimal |
|
String |
Texto simples As strings não precisam estar entre aspas, exceto em casos específicos. |
|
Data |
É o mês e o dia. O formato é MM-DD ou MM/DD.
|
|
Tempo |
Hora do dia. Pode ser hora do relógio ou hora solar.
Para hora do relógio, ele pode usar o formato AM/PM ou 24H. Os segundos são opcionais.
Para horário solar,
|
|
DateTime |
Ano, mês, dia e hora do dia. É necessário um espaço em branco entre a parte "Data" e a "Hora". O formato da data é AAAA-MM-DD ou AAAA/MM/DD. O formato de hora é o mesmo que [Time](#time). O fuso horário não é compatível.
|
|
Dia da semana |
|
|
Duração |
Um período de tempo.
|
| ColorHex |
Um código hexadecimal de seis dígitos que representa uma cor. Não há
|
| Temperatura | Dados de temperatura normal. Sempre adicione
|
| ColorTemperature |
Temperatura da cor em Kelvin.
|
Cor
As cores podem ser especificadas de três maneiras: usando os tipos primitivos ColorHex ou ColorTemperature ou o tipo composto SpectrumHSV.
SpectrumHSV
O tipo SpectrumHSV especifica uma cor usando três campos numéricos:
- Hue corresponde ao comprimento de onda da cor.
- Saturação indica a intensidade da cor.
- Valor: indica a claridade ou escuridão relativa da cor.
Dynamic
Às vezes, o tipo de dados de uma chave não é fixo. Pode ser um dos tipos primitivos, com base nos valores de outros campos.
Um exemplo de campo de tipo de dados dinâmico é is. O tipo real é determinado pelos valores dos campos type e state.
# The 'is' field accepts a number type.
type: device.state.Volume
device: My TV - Living Room
state: currentVolume
is: 1
# The 'is' field accepts a boolean type.
type: device.state.OnOff
device: My TV - Living Room
state: on
is: false
Entidade
Um formato de string especial para identificar exclusivamente uma entidade de propriedade do usuário, como dispositivo ou ambiente.
O dispositivo é a entidade mais usada em automações. O formato de string da entidade
é device name - room name.
# The device field accepts a Device Entity type.
type: device.state.Volume
device: My TV - Living Room
state: currentVolume
is: 1
FieldPath
Um formato de string especial usado para localizar um dado em uma carga útil de dados. No exemplo a seguir, currentVolume é o FieldPath para o campo state.
# The state field accepts a FieldPath type.
starters:
type: device.state.Volume
device: My TV - Living Room
state: currentVolume
is: 5
Outros FieldPaths podem exigir vários níveis para chegar ao item necessário, e o formato é diferente entre a ativação e a ação.
As inicializações usam uma notação de ponto, com o caminho inteiro no mesmo campo. Isso é
feito principalmente para fins de comparação na lógica inicial. Por exemplo, para usar
a temperatura da cor como ativação, use color.colorTemperature para o
estado:
starters:
- type: device.state.ColorSetting
device: My Device - Room Name
state: color.colorTemperature
is: 2000K
No entanto, as ações usam campos aninhados. Para mudar a cor de uma lâmpada para azul,
em vez de color.name e is: blue, faça o seguinte:
actions:
- type: device.command.ColorAbsolute
devices: My Device - Room Name
color:
name: blue