Noções básicas de idiomas

Entender o YAML

YAML é uma linguagem conhecida usada para especificar configuração do Terraform. Ele fornece uma maneira clara e legível de representar informações estruturadas. Confira algumas informações básicas sobre o YAML antes de criar sua primeira automação com script. Para saber mais sobre YAML em geral, consulte a Versão 1.1 especificação.

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 um espaço. Ambos os caracteres são obrigató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ça com um dos seguintes caracteres: [, {, ", ' ou #, ou a string contém : (dois-pontos seguidos por espaços), ele precisa ser citado.

Aspas simples e duplas são aceitas, mas as aspas finais devem ser iguais 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 multilinha, 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 denotar a estrutura. No exemplo anterior, name e description são recuadas (em dois espaços) para indicar que são os filhos. da chave metadata.

O recuo é rigoroso no YAML. Uma estrutura filha precisa ter recuo maior do que a principal, e os pares chave-valor do 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 valor será listado em uma nova linha e cada linha começa seguida por um traço e um espaço. No exemplo a seguir, duas listas:

1. Uma automação pode ter vários starters, e, portanto, o primeiro ativador começa com um traço e um espaço.
2. weekday pode ter vários valores e, portanto, cada valor é recuado e começa com um travessão e um espaço.

starters:
- type: time.schedule
  at: SUNSET
  weekday:
  - MONDAY
  - THURSDAY
  state: on

Comentários

O texto após uma # é 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" padrão ou dados chamados de structs.

Confira o struct automation, que define quatro campos:

A seção Referência fornece definições de esquema para todos os Structs disponíveis.

Os nomes das chaves são exclusivos dentro de 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 de 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 estruturas Starter.
• 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 podem ser ignoradas.
• Dependência do campo. Somente os campos opcionais têm dependências. Isso descreve verificações adicionais ao usar esse campo, como Use o Campo B apenas se o Campo A estiver set ou Quando o campo A for usado, não definir o campo B ou o C.
• Valores possíveis. Por exemplo, o conjunto de valores limitado de um tipo enumerado Um campo do tipo string ou um intervalo de números que pode ser usado em um campo do digite um número.

Estrutura tipada

Alguns structs podem representar ativações com base em um cronograma ou estado do dispositivo. mudar. 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 na Campo type, como time.schedule ou device.state.OnOff, para fornecer com funções diferentes. Os structs condition e action também são tipados.

Os campos adicionais no struct precisam seguir o struct filho (type). especificação. Por exemplo, ao usar device.state.OnOff como type, apenas as campos especificados para essa tipo são válidos em desse struct 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 de Struct ou vários valores primitivos. Mas o os valores da 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 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ção:

Cor

As cores podem ser especificadas de três maneiras: usando o 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.
• A saturação indica a intensidade da cor.
• Valor: indica a claridade ou escuridão relativa da cor.

Dinâmico

Às vezes, o tipo de dados de uma chave não é fixo. Pode ser um dos métodos 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 pertencente ao usuário, como um dispositivo ou sala.

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 um payload de dados. Na exemplo a seguir, currentVolume é o FieldPath do 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. o formato é diferente entre o inicializador e o de ação.

As inicializações usam uma notação de ponto, com o caminho inteiro no mesmo campo. Isso é feita principalmente para fins de comparação na lógica inicial. Por exemplo, para usar a temperatura de cor como inicializador, 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