Guia de DSL para iOS

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 Swift 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 GoogleHomeSDK
import GoogleHomeTypes

automation (
...
) {
  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,
  Matter.TemperatureSensorDeviceType.self,
  Matter.TemperatureMeasurementTrait.self
)

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 FanDeviceType e um HeatingCoolingUnitDeviceType, ambos contendo o traço OnOffTrait. 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,
  Google.GoogleDoorbellDeviceType.self,
  Google.DoorbellPressTrait.DoorbellPressedEvent
)

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 TimeTraitScheduledEvent para ativar a automação às 7h:

typealias TimeTrait = Google.TimeTrait

let earlyMorning = starter(
  structure,
  TimeTrait.ScheduledEvent.self
) {
  TimeTrait.ScheduledEvent.clockTime(TimeOfDay(hours: 7, minutes: 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,
    Matter.TemperatureSensorDeviceType.self,
    Matter.TemperatureMeasurementTrait.self
  )
}

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:

import GoogleHomeSDK
import GoogleHomeTypes

automation (
...
) {

  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:

typealias TimeTrait = Google.TimeTrait

let time = stateReader(structure, TimeTrait.self)
time
let currTime = time.currentTime

Com um starter:

typealias LaundryWasherDeviceType = Matter.LaundryWasherDeviceType
typealias OnOffTrait = Google.OnOffTrait

let starterNode = starter(device1, LaundryWasherDeviceType.self, OnOffTrait.self)
starterNode
condition {
  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 Swift 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 {
  let exp1 = starterNode.lockState.equals(.unlocked)
  let exp2 = stateReaderNode.lockState.equals(true)
  let exp3 = occupancySensingDevice.occupied.notEquals(0)
  (exp1.and(exp2)).or(exp3)
}

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

typealias OnOffTrait = Matter.OnOffTrait

let starterNode = starter(device, OnOffTrait.self)
starterNode
condition {
  starterNode.onOff.equals(true)
}
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:

typealias ActivatedCarbonFilterMonitoringTrait = Matter.ActivatedCarbonFilterMonitoringTrait

let filterMonitoringState = stateReader(structure, ActivatedCarbonFilterMonitoringTrait.self)

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

condition {
filterMonitoringState.changeIndication.equals(.warning)
}

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

typealias ArmDisarm = Google.ArmDisarmTrait
typealias DoorLockDevice = Matter.DoorLockDeviceType
typealias DoorLock = Matter.DoorLockTrait

let armState = stateReader(doorLock, DoorLockDevice.self, ArmDisarm )
let doorLockState = stateReader(doorLock, DoorLockDevice.self, DoorLock)
armState
doorLockState
condition {
  let exp1 = armState.armState
  let exp2 = doorLockState.lockState
  exp1.and(exp2)
}

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(for: .seconds(600)) {
lightStateReader.onOff.equals(true)
}

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 AssistantBroadcastTrait:

action(speaker, SpeakerDeviceType.self) {
  Google.AssistantBroadcastTrait.broadcast(msg: "Oven Cycle Complete")
}