Android DSL 指南

請參閱下列指南,瞭解如何使用各種 Automation DSL 節點建構自動化程序。

所有自動化 DSL 都會放在單一 automation 節點中。automation 節點會形成外部 Kotlin 語言情境與內嵌 DSL 情境之間的界線。

依序流程

依序流程是自動化流程的預設類型。

序列 DSL 範例

以下是相當基本的 Automation 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 {...}
  }
}

您可以新增節點來調整路徑。

Starter

啟動條件節點會定義啟動自動化動作的初始情況。例如狀態或值的變更。自動化程序必須至少有一個啟動器,否則無法通過驗證。如要在自動化巨集中新增多個啟動器,必須使用 select 節點。

根據特徵屬性建立的入門款

宣告以特徵屬性為基礎的啟動器節點時,請指定:

  • 裝置
  • 特徵所屬的裝置類型
  • 特徵
starter<_>(thermostat, TemperatureSensorDevice, TemperatureMeasurement)

裝置類型參數為必要參數,因為您可藉此指定自動化程序要處理的裝置類型。舉例來說,裝置可能由 FanDeviceHeatingCoolingUnitDevice 組成,兩者都包含 OnOff 特徵。指定裝置類型後,系統就能明確知道裝置的哪個部分會觸發自動化動作。

根據活動的起跑者

宣告以事件為基礎的啟動節點時,請指定:

  • 裝置
  • 特徵所屬的裝置類型
  • 活動
starter<_>(doorBell, GoogleDoorbellDevice, DoorbellPressed)

根據結構和事件 (含參數) 建立啟動條件

部分事件可能含有參數,因此這些參數也必須納入啟動器。

舉例來說,這個啟動條件會使用 Time 特徵的 ScheduledTimeEvent,在早上 7 點啟動自動化動作:

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

手動啟動

手動啟動條件是一種特殊的啟動條件,可讓使用者手動執行自動化動作。

宣告手動啟動器時:

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 和特徵做為引數:

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 時,自動化動作才會執行。舉例來說,您可以定義條件,只有在燈亮了十分鐘後才觸發。

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

時間長度可設定為 1 到 30 分鐘。

動作節點

自動化作業的實際工作會在動作節點中進行。 在本範例中,動作會叫用 AssistantBroadcast 特徵的 broadcast() 指令:

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

匯入陳述式

開發自動化功能時,您不一定會清楚如何將各種 Home API 元素匯入程式碼。

特徵屬性是從特徵的 Companion 物件匯入:

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

由特徵定義的資料結構會從名稱結尾為「-Trait」的特徵類別匯入:

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

特徵指令是從特徵的 Companion 物件匯入:

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