Panduan DSL Android

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

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, TemperatureSensorDevice, TemperatureMeasurement)

Parameter jenis perangkat diperlukan karena memungkinkan Anda menentukan jenis perangkat dalam perangkat yang ditangani otomatisasi. Misalnya, perangkat mungkin terdiri dari FanDevice dan HeatingCoolingUnitDevice, yang keduanya berisi karakteristik OnOff. 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, GoogleDoorbellDevice, DoorbellPressed)

Pemicu berdasarkan struktur dan peristiwa, dengan parameter

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

Misalnya, starter ini menggunakan ScheduledTimeEvent dari trait Time untuk mengaktifkan otomatisasi pada pukul 07.00:

val earlyMorning = starter<_>(structure, Time.ScheduledTimeEvent) {
  parameter(Time.ScheduledTimeEvent.clockTime(
    LocalTime.of(7, 0, 0, 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, TemperatureSensorDevice, TemperatureMeasurement)
}

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:

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

Merujuk nilai atribut

Untuk menggunakan nilai atribut dalam ekspresi, gunakan sintaksis berikut.

Dengan stateReader:

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

Dengan starter:

val starterNode = starter<_>(device1, LaundryWasherDevice, OnOff)
condition() {
  expression = 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 melanjutkan eksekusi node berikutnya. Jika false, otomatisasi akan berhenti dieksekusi pada saat itu.

Ekspresi dibentuk mirip dengan ekspresi di Kotlin, 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() {
  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)
}

Anda dapat mereferensikan nilai sifat yang diakses melalui starter:

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:

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

Kemudian, rujuk stateReader di node condition:

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

Dengan menggunakan operator perbandingan dan operator logika, beberapa stateReaders dapat digunakan di node condition:

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

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 {
    expression(lightStateReader.onOff == true)
    forDuration(Duration.ofMinutes(10))
  }

Durasi dapat berkisar dari satu hingga 30 menit.

Node tindakan

Node tindakan adalah tempat terjadinya pekerjaan otomatisasi. Dalam contoh ini, tindakan memanggil perintah AssistantBroadcast trait broadcast():

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

Pernyataan impor

Saat mengembangkan otomatisasi, tidak selalu jelas cara mengimpor berbagai elemen Home API ke dalam kode Anda.

Atribut karakteristik diimpor dari objek Companion karakteristik:

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

Struktur data yang ditentukan oleh trait diimpor dari class trait yang namanya diakhiri dengan "-Trait":

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

Perintah trait diimpor dari objek Companion trait:

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