Android DSL 指南

请参阅以下指南,了解如何使用各种自动化 DSL 节点来构建自动化。

所有自动化 DSL 都放置在单个 automation 节点中。automation 节点构成了外部 Kotlin 语言上下文与嵌入式 DSL 上下文之间的边界。

依序流程

顺序流程是默认的自动化流程类型。

顺序 DSL 示例

下面是一个非常基本的自动化 DSL 模板,它使用由启动方式、条件和操作组成的顺序流程:


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 {...}
  }
}

您可以通过添加其他节点来优化此设置。

入门版

启动方式节点定义了激活自动化操作的初始情况。例如,状态或值的变化。自动化操作必须至少有一个启动器,否则将无法通过验证。如需向自动化操作添加多个启动方式,您必须使用 select 节点。

基于特征属性的启动器

声明基于特征属性的起始节点时,请指定:

  • 此设备
  • 特征所属的设备类型
  • trait
starter<_>(thermostat, TemperatureSensorDevice, TemperatureMeasurement)

设备类型参数是必需的,因为您可以通过它指定自动化操作针对的是设备中的哪种设备类型。例如,设备可能由 FanDevice 和 HeatingCoolingUnitDevice 组成,两者都包含 OnOff 特征。通过指定设备类型,可以明确设备的哪个部分触发了自动化操作。

基于事件的启动方式

声明基于事件的起始节点时,请指定:

  • 此设备
  • 特征所属的设备类型
  • 事件
starter<_>(doorBell, GoogleDoorbellDevice, DoorbellPressed)

基于结构和事件的启动器,带有参数

某些事件可以具有参数,因此这些参数也需要包含在 starter 中。

例如,此启动方式使用 Time 特性的 ScheduledTimeEvent 在上午 7:00 启动自动化操作:

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

基于天气的启动方式

您可以使用天气特征在启动方式中指定当前或预测的天气状况:

val weatherState = starter<_>(structure, trait = Weather)

请参阅自动化示例页面上的如果可能下雨,请关闭百叶窗。

手动启动器

手动启动方式是一种特殊类型的启动方式,可让用户手动运行自动化操作。

声明手动启动方式时:

在 select 流程中,如果手动启动方式与其他启动方式一起放置,手动启动方式会覆盖其他启动方式:

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

请注意,系统会评估手动启动方式后面的所有 condition 节点,并且可能会阻止自动化操作的执行,具体取决于 condition 表达式。

将手动启动器与条件分开

若要构建自动化操作,使 condition 节点不会阻止通过手动启动方式激活的自动化操作,一种方法是将另一个启动方式及其 condition 放在单独的顺序流程中:

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

引用属性的值

如需在表达式中使用属性的值,请使用以下语法。

使用 stateReader:

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

使用 starter:

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

条件节点和表达式

条件节点表示一个决策点,用于确定自动化操作是否继续。一个自动化操作可以有多个 condition 节点。 如果任何 condition 节点的表达式求值结果为 false,则整个自动化操作的执行将结束。

在 condition 节点中,您可以使用各种运算符组合多个条件标准,只要表达式的求值结果为单个布尔值即可。如果结果值为 true,则表示满足条件,自动化操作会继续执行下一个节点。如果为 false,自动化操作会在该点停止执行。

表达式的构成方式与 Kotlin 中的表达式类似,可能包含基元值(例如数字、字符、字符串和布尔值)以及枚举值。使用圆括号对子表达式进行分组,可让您控制其求值顺序。

以下示例展示了如何使用 condition 将多个子表达式组合成一个表达式:

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)
}

您可以引用通过启动方式访问的特征的值:

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

stateReader

在 condition 节点中引用特征属性值的另一种方法是使用 stateReader 节点。

为此,请先在 stateReader 节点中捕获特征属性值。stateReader 接受 structure 和 trait 作为参数:

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

然后在 condition 节点中引用 stateReader:

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

使用比较和逻辑运算符,可以在 condition 节点中使用多个 stateReaders:

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

条件持续时间

除了在条件中指定布尔表达式之外,您还可以指定一个时间范围,在此期间,表达式必须为 true 才能运行自动化操作。例如,您可以定义一个仅在灯亮了 10 分钟后才触发的条件。

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

时长可以介于 5 秒到 24 小时之间。

操作节点

操作节点是执行自动化操作的地方。 在此示例中,该操作会调用 AssistantBroadcast 特性的 broadcast() 命令:

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

import 语句

在开发自动化操作时,如何将 Home API 的各种元素导入代码并不总是显而易见。

特征属性是从特征的 Companion 对象导入的:

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

由 trait 定义的数据结构是从名称以“-Trait”结尾的 trait 类导入的:

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

特征命令是从特征的 Companion 对象导入的:

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