Panduan DSL iOS

Gunakan panduan berikut untuk memahami cara berbagai node DSL Otomatisasi dapat digunakan untuk membuat otomatisasi.

Semua DSL otomatisasi ditempatkan dalam satu node automation. Node automation membentuk batas antara konteks bahasa Swift luar dan konteks DSL yang disematkan.

Alur berurutan

Alur berurutan adalah jenis alur otomatisasi default.

Berikut adalah template DSL Otomatisasi yang sangat mendasar yang menggunakan alur berurutan yang terdiri dari pemicu, kondisi, dan tindakan:

import GoogleHomeSDK
import GoogleHomeTypes

automation (
...
) {
  starter(...)
  condition {...}
  action {...}
}

Hal ini dapat disempurnakan dengan menambahkan node tambahan.

Starter

Node pemicu menentukan keadaan awal yang mengaktifkan otomatisasi. Misalnya, perubahan status atau nilai. Otomatisasi harus memiliki minimal satu pemicu, jika tidak, validasi akan gagal. Untuk menambahkan lebih dari satu pemicu ke otomatisasi, Anda harus menggunakan node select.

Starter berdasarkan atribut sifat

Saat mendeklarasikan node awal yang didasarkan pada atribut trait, tentukan:

• perangkat
• jenis perangkat yang memiliki trait
• ciri

starter(
  thermostat,
  Matter.TemperatureSensorDeviceType.self,
  Matter.TemperatureMeasurementTrait.self
)

Parameter jenis perangkat diperlukan karena memungkinkan Anda menentukan jenis perangkat dalam perangkat yang ditangani otomatisasi. Misalnya, perangkat mungkin terdiri dari FanDeviceType dan HeatingCoolingUnitDeviceType, yang keduanya berisi karakteristik OnOffTrait. Dengan menentukan jenis perangkat, tidak ada ambiguitas tentang bagian perangkat mana yang memicu otomatisasi.

Pemicu berdasarkan peristiwa

Saat mendeklarasikan node awal yang didasarkan pada peristiwa, tentukan:

• perangkat
• jenis perangkat yang memiliki trait
• acara

starter(
  doorbell,
  Google.GoogleDoorbellDeviceType.self,
  Google.DoorbellPressTrait.DoorbellPressedEvent
)

Pemicu berdasarkan struktur dan peristiwa, dengan parameter

Beberapa peristiwa dapat memiliki parameter, sehingga parameter ini juga perlu disertakan dalam starter.

Misalnya, pemicu ini menggunakan TimeTrait ScheduledEvent untuk mengaktifkan otomatisasi pada pukul 07.00:

typealias TimeTrait = Google.TimeTrait

let earlyMorning = starter(
  structure,
  TimeTrait.ScheduledEvent.self
) {
  TimeTrait.ScheduledEvent.clockTime(TimeOfDay(hours: 7, minutes: 0))
}

Starter manual

Pemicu manual adalah jenis pemicu khusus yang memungkinkan pengguna menjalankan otomatisasi secara manual.

Saat mendeklarasikan pemicu manual:

• Jangan tentukan karakteristik atau jenis perangkat.
• Menyediakan elemen UI yang memanggil Automation.execute().

Saat menempatkan pemicu manual dalam alur select bersama dengan pemicu lain, pemicu manual akan menggantikan pemicu lainnya:

select {
  manualStarter()
  starter(
    thermostat,
    Matter.TemperatureSensorDeviceType.self,
    Matter.TemperatureMeasurementTrait.self
  )
}

Perhatikan bahwa semua node condition yang mengikuti pemicu manual akan dievaluasi, dan dapat memblokir eksekusi otomatisasi, bergantung pada ekspresi condition.

Salah satu cara untuk menyusun otomatisasi agar node condition tidak memblokir otomatisasi yang diaktifkan dengan pemicu manual adalah dengan menempatkan pemicu lain dalam alur berurutan terpisah bersama dengan condition-nya:

import GoogleHomeSDK
import GoogleHomeTypes

automation (
...
) {

  select {
    sequential {
      starter(...)
      condition {...}
    }
    sequential {
      manualStarter()
    }
  }
  action {...}

}

Merujuk nilai atribut

Untuk menggunakan nilai atribut dalam ekspresi, gunakan sintaksis berikut.

Dengan stateReader:

typealias TimeTrait = Google.TimeTrait

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

Dengan starter:

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

let starterNode = starter(device1, LaundryWasherDeviceType.self, OnOffTrait.self)
starterNode
condition {
  starterNode.onOff.equals(true)
}

Node dan ekspresi kondisi

Node kondisi merepresentasikan titik keputusan yang menentukan apakah otomatisasi berlanjut atau tidak. Otomatisasi dapat memiliki beberapa node condition. Jika ekspresi node condition dievaluasi menjadi false, eksekusi seluruh otomatisasi akan berakhir.

Dalam node condition, Anda dapat menggabungkan beberapa kriteria kondisi menggunakan berbagai operator, selama ekspresi dievaluasi ke satu nilai boolean. Jika nilai yang dihasilkan adalah true, kondisi terpenuhi dan otomatisasi akan terus menjalankan node berikutnya. Jika false, otomatisasi akan berhenti dieksekusi pada saat itu.

Ekspresi dibentuk mirip dengan ekspresi di Swift, dan dapat berisi nilai primitif seperti angka, karakter, string, dan boolean, serta nilai Enum. Mengelompokkan sub-ekspresi dengan tanda kurung memungkinkan Anda mengontrol urutan evaluasinya.

Berikut contoh condition yang menggabungkan beberapa subekspresi menjadi satu ekspresi:

condition {
  let exp1 = starterNode.lockState.equals(.unlocked)
  let exp2 = stateReaderNode.lockState.equals(true)
  let exp3 = occupancySensingDevice.occupied.notEquals(0)
  (exp1.and(exp2)).or(exp3)
}

Anda dapat mereferensikan nilai sifat yang diakses melalui starter:

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

Cara lain untuk mereferensikan nilai atribut trait dalam node condition adalah dengan node stateReader.

Untuk melakukannya, pertama-tama ambil nilai atribut ciri dalam node stateReader. stateReader menggunakan structure dan trait sebagai argumen:

typealias ActivatedCarbonFilterMonitoringTrait = Matter.ActivatedCarbonFilterMonitoringTrait

let filterMonitoringState = stateReader(structure, ActivatedCarbonFilterMonitoringTrait.self)

Kemudian, rujuk stateReader di node condition:

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

Dengan menggunakan operator perbandingan dan operator logis, beberapa stateReaders dapat digunakan di node 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)
}

Durasi kondisi

Selain ekspresi boolean dalam kondisi, Anda dapat menentukan jangka waktu selama ekspresi harus bernilai benar agar otomatisasi dapat berjalan. Misalnya, Anda dapat menentukan kondisi yang hanya dipicu jika lampu sudah menyala selama sepuluh menit.

condition(for: .seconds(600)) {
lightStateReader.onOff.equals(true)
}

Durasi dapat berkisar dari satu hingga 30 menit.

Node tindakan

Node tindakan adalah tempat terjadinya pekerjaan otomatisasi. Dalam contoh ini, tindakan memanggil perintah AssistantBroadcastTrait's broadcast():

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