Guia de DSL do Android

Use o guia a seguir para entender como vários nós da DSL de automação podem ser usados para criar uma automação.

Toda a DSL de automação é colocada em um único nó automation. O nó automation forma o limite entre o contexto externo da linguagem Kotlin e o contexto da DSL incorporada.

Fluxo sequencial

O fluxo sequencial é o tipo padrão de fluxo de automação.

Confira um modelo muito básico da DSL de automação que usa um fluxo sequencial consistindo em uma ativação, uma condição e uma ação:

import com.google.home.automation.action
import com.google.home.automation.automation
import com.google.home.automation.condition
import com.google.home.automation.sequential
import com.google.home.automation.starter

...

automation {
  sequential {
    starter<_>(...)
    condition {...}
    action {...}
  }
}

Isso pode ser refinado com a adição de mais nós.

Starter

Os nós de ativação definem as circunstâncias iniciais que ativam uma automação. Por exemplo, uma mudança no estado ou no valor. Uma automação precisa ter pelo menos um início, caso contrário, a validação vai falhar. Para adicionar mais de um início a uma automação, use um nó select.

Início com base no atributo de característica

Ao declarar um nó inicializador com base em um atributo de traço, especifique:

• o dispositivo
• o tipo de dispositivo a que o traço pertence
• a característica

starter<_>(thermostat, TemperatureSensorDevice, TemperatureMeasurement)

O parâmetro de tipo de dispositivo é obrigatório porque permite especificar qual tipo de dispositivo dentro de um dispositivo a automação aborda. Por exemplo, um dispositivo pode ser composto por um FanDevice e um HeatingCoolingUnitDevice, ambos contendo o traço OnOff. Ao especificar o tipo de dispositivo, não há ambiguidade sobre qual parte do dispositivo aciona a automação.

Início com base em evento

Ao declarar um nó inicial baseado em um evento, especifique:

• o dispositivo
• o tipo de dispositivo a que o traço pertence
• o evento

starter<_>(doorBell, GoogleDoorbellDevice, DoorbellPressed)

Ativação com base em uma estrutura e um evento, com parâmetros

Alguns eventos podem ter parâmetros, que também precisam ser incluídos no starter.

Por exemplo, este iniciador usa o Time ScheduledTimeEvent para ativar a automação às 7h:

val earlyMorning = starter<_>(structure, Time.ScheduledTimeEvent) {
  parameter(Time.ScheduledTimeEvent.clockTime(
    LocalTime.of(7, 0, 0, 0)))
}

Ativação manual

Um iniciador manual é um tipo especial de iniciador que permite ao usuário executar a automação manualmente.

Ao declarar um iniciador manual:

• Não especifique uma característica ou um tipo de dispositivo.
• Forneça um elemento de interface que chame Automation.execute().

Ao colocar um inicializador manual em um fluxo select com outro inicializador, o manual substitui o outro:

select {
  manualStarter()
  starter<_>(thermostat, TemperatureSensorDevice, TemperatureMeasurement)
}

Qualquer nó condition após um iniciador manual será avaliado e poderá bloquear a execução da automação, dependendo da expressão condition.

Uma maneira de estruturar sua automação para que os nós condition não bloqueiem uma automação ativada com um gatilho manual é colocar o outro gatilho em um fluxo sequencial separado com o condition dele:

automation_graph {
  sequential {
    select {
      sequential {
        starter<_>(...)
        condition {...}
      }
      sequential {
        manualStarter()
      }
    }
    action {...}
  }
}

Referenciar o valor de um atributo

Para usar o valor de um atributo em uma expressão, use a seguinte sintaxe:

Com um stateReader:

val time = stateReader<_>(structure, Structure, Time)
val currTime = time.currentTime

Com um starter:

val starterNode = starter<_>(device1, LaundryWasherDevice, OnOff)
condition() {
  expression = starterNode.onOff equals true
}

Nós e expressões de condição

Um nó de condição representa um ponto de decisão que determina se a automação continua ou não. Uma automação pode ter vários nós condition. Se a expressão de um nó condition for avaliada como false, a execução de toda a automação será encerrada.

Em um nó condition, é possível combinar vários critérios de condição usando vários operadores, desde que a expressão seja avaliada como um único valor booleano. Se o valor resultante for true, a condição será atendida e a automação continuará a execução do próximo nó. Se for false, a automação vai parar de ser executada nesse ponto.

As expressões são formadas de maneira semelhante às expressões em Kotlin e podem conter valores primitivos, como números, caracteres, strings e booleanos, além de valores de enumeração. Agrupar subexpressões com parênteses permite controlar a ordem em que elas são avaliadas.

Confira um exemplo de condition que combina várias subexpressões em uma única expressão:

condition() {
  val expr1 = starterNode.lockState equals DlLockState.Unlocked
  val expr2 = stateReaderNode.lockState equals true

  val expr3 = occupancySensingDevice.occupied notEquals 0
  val expr4 = timeStateReaderNode
    .currentTime
    .between(
      timeStateReaderNode.sunsetTime,
      timeStateReaderNode.sunriseTime)
  expression = (expr1 and expr2) or (expr3 and expr4)
}

Você pode fazer referência ao valor de uma característica acessada por um iniciador:

val starterNode = starter<_>(device, OnOff)
condition() { expression = starterNode.onOff equals true }

stateReader

Outra maneira de referenciar valores de atributos de traços em um nó condition é com um nó stateReader.

Para fazer isso, primeiro capture o valor do atributo de traço em um nó stateReader. Um stateReader usa o structure e a característica como argumentos:

import com.google.home.automation.stateReader
...
val filterMonitoringState = stateReader<_>(structure, ActivatedCarbonFilterMonitoring)

Em seguida, faça referência ao stateReader no nó condition:

condition() {
  expression =
    filterMonitoringState.changeIndication
      .equals(ChangeIndicationEnum.Warning)
}

Usando comparação e operadores lógicos, vários stateReaders podem ser usados em um nó condition:

val armState = stateReader<_>(doorLock, DoorLockDevice, ArmDisarm )
val doorLockState = stateReader<_>(doorLock, DoorLockDevice, DoorLock)
condition() {
  expression =
    (armState.armState equals true)
    and
    (doorLockState.lockState equals true)
}

Duração da condição

Além de uma expressão booleana em uma condição, é possível especificar um período em que a expressão precisa ser verdadeira para executar a automação. Por exemplo, é possível definir uma condição que seja acionada somente se uma luz estiver acesa há dez minutos.

  condition {
    expression(lightStateReader.onOff == true)
    forDuration(Duration.ofMinutes(10))
  }

A duração pode variar de um a 30 minutos.

Nós de ação

O nó de ação é onde o trabalho da automação acontece. Neste exemplo, a ação invoca o comando broadcast() do traço AssistantBroadcast:

action(device, SpeakerDevice) {
  command(AssistantBroadcast.broadcast("Intruder detected!"))
}

Declarações de importação

Ao desenvolver automações, nem sempre é óbvio como importar vários elementos das APIs Home para seu código.

Os atributos de traço são importados do objeto Companion do traço:

import com.google.home.matter.standard.OnOff.Companion.onOff

As estruturas de dados definidas por uma característica são importadas da classe de característica cujo nome termina em "-Trait":

import com.google.home.matter.standard.MediaPlaybackTrait.PlaybackStateEnum

Os comandos de traço são importados do objeto Companion do traço:

import com.google.home.matter.standard.Thermostat.Companion.setTemperatureSetpointHold