Hướng dẫn về DSL – các thao tác tự động hoá cơ bản

Hãy sử dụng hướng dẫn sau để hiểu cách sử dụng nhiều nút DSL tự động hoá để tạo một quy trình tự động hoá.

Tất cả DSL tự động hoá được đặt trong một nút automation. Nút automation tạo thành ranh giới giữa ngữ cảnh ngôn ngữ Kotlin bên ngoài và ngữ cảnh DSL nhúng.

Luồng tuần tự

Quy trình tuần tự là loại quy trình tự động hoá mặc định.

Ví dụ về DSL tuần tự

Dưới đây là một mẫu DSL tự động hoá rất cơ bản sử dụng một luồng tuần tự bao gồm một trình khởi động, một điều kiện và một hành động:


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

Bạn có thể tinh chỉnh điều này bằng cách thêm các nút khác.

Người dùng mới

Nút khởi động xác định các trường hợp ban đầu kích hoạt một quy trình tự động hoá. Ví dụ: thay đổi trạng thái hoặc giá trị. Một quy trình tự động hoá phải có ít nhất một trình khởi động, nếu không quy trình đó sẽ không xác thực được. Để thêm nhiều trình khởi động vào một quy trình tự động, bạn phải sử dụng nút chọn.

Trình khởi động dựa trên thuộc tính đặc điểm

Khi khai báo nút khởi động dựa trên thuộc tính đặc điểm, hãy chỉ định:

  • thiết bị
  • loại thiết bị mà đặc điểm thuộc về
  • đặc điểm
starter<_>(thermostat, TemperatureSensorDevice, TemperatureMeasurement)

Bạn phải sử dụng tham số loại thiết bị vì tham số này cho phép bạn chỉ định loại thiết bị trong một thiết bị mà tính năng tự động hoá sẽ xử lý. Ví dụ: một thiết bị có thể bao gồm FanDeviceHeatingCoolingUnitDevice, cả hai đều chứa thuộc tính OnOff. Bằng cách chỉ định loại thiết bị, bạn sẽ không còn mơ hồ về việc phần nào của thiết bị kích hoạt tính năng tự động hoá.

Trình khởi động dựa trên sự kiện

Khi khai báo nút khởi động dựa trên một sự kiện, hãy chỉ định:

  • thiết bị
  • loại thiết bị mà đặc điểm thuộc về
  • sự kiện
starter<_>(doorBell, GoogleDoorbellDevice, DoorbellPressed)

Trình khởi động dựa trên cấu trúc và sự kiện, có các thông số

Một số sự kiện có thể có tham số, vì vậy, bạn cũng cần đưa các tham số này vào trình khởi động.

Ví dụ: trình khởi động này sử dụng ScheduledTimeEvent của đặc điểm Time để kích hoạt tính năng tự động hoá lúc 7:00 sáng:

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

Bộ khởi động thủ công

Trình khởi động thủ công là một loại trình khởi động đặc biệt cho phép người dùng chạy quy trình tự động hoá theo cách thủ công.

Khi khai báo trình khởi động thủ công:

  • Không chỉ định một đặc điểm hoặc loại thiết bị.
  • Cung cấp một phần tử giao diện người dùng gọi Automation.execute().

Khi đặt trình khởi động thủ công trong luồng select cùng với một trình khởi động khác, trình khởi động thủ công sẽ ghi đè trình khởi động khác:

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

Xin lưu ý rằng mọi nút condition theo sau trình khởi động thủ công sẽ được đánh giá và có thể chặn quá trình thực thi quá trình tự động hoá, tuỳ thuộc vào biểu thức condition.

Tách trình khởi động thủ công khỏi điều kiện

Một cách để định cấu trúc tính năng tự động hoá sao cho các nút condition không chặn tính năng tự động hoá được kích hoạt bằng trình khởi động thủ công là đặt trình khởi động khác vào một luồng tuần tự riêng biệt cùng với condition:

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

Tham chiếu giá trị của một thuộc tính

Để sử dụng giá trị của một thuộc tính trong biểu thức, hãy sử dụng cú pháp sau.

Với stateReader:

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

Với starter:

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

Nút điều kiện và biểu thức

Nút điều kiện đại diện cho một điểm quyết định xác định xem quá trình tự động hoá có tiếp tục hay không. Một quy trình tự động hoá có thể có nhiều nút condition. Nếu biểu thức của bất kỳ nút condition nào đánh giá thành false, thì quá trình thực thi toàn bộ quá trình tự động hoá sẽ kết thúc.

Trong một nút condition, bạn có thể kết hợp nhiều tiêu chí điều kiện bằng cách sử dụng nhiều toán tử, miễn là biểu thức đánh giá thành một giá trị boolean duy nhất. Nếu giá trị thu được là true, thì điều kiện đã được đáp ứng và quá trình tự động hoá sẽ tiếp tục thực thi nút tiếp theo. Nếu giá trị là false, thì quá trình tự động hoá sẽ ngừng thực thi tại thời điểm đó.

Biểu thức được tạo tương tự như biểu thức trong Kotlin và có thể chứa các giá trị gốc như số, ký tự, chuỗi và boolean, cũng như các giá trị Enum. Việc nhóm các biểu thức con bằng dấu ngoặc đơn cho phép bạn kiểm soát thứ tự đánh giá các biểu thức đó.

Dưới đây là ví dụ về condition kết hợp nhiều biểu thức con thành một biểu thức duy nhất:

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

Bạn có thể tham chiếu giá trị của một đặc điểm được truy cập thông qua trình khởi động:

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

stateReader

Một cách khác để tham chiếu giá trị thuộc tính đặc điểm trong nút condition là sử dụng nút stateReader.

Để làm việc này, trước tiên, hãy ghi lại giá trị thuộc tính đặc điểm trong nút stateReader. stateReader lấy structure và đặc điểm làm đối số:

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

Sau đó, tham chiếu stateReader trong nút condition:

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

Khi sử dụng toán tử so sánhtoán tử logic, bạn có thể sử dụng nhiều stateReaders trong một nút condition:

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

Thời lượng của điều kiện

Ngoài biểu thức boolean trong một điều kiện, bạn có thể chỉ định một khung thời gian trong đó biểu thức phải đúng để chạy quy trình tự động. Ví dụ: bạn có thể xác định một điều kiện chỉ kích hoạt nếu đèn đã bật trong 10 phút.

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

Thời lượng có thể từ 1 đến 30 phút.

Nút hành động

Nút hành động là nơi diễn ra công việc của quy trình tự động hoá. Trong ví dụ này, thao tác gọi lệnh broadcast() của đặc điểm AssistantBroadcast:

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

Câu lệnh nhập

Khi phát triển tính năng tự động hoá, bạn không phải lúc nào cũng biết cách nhập các phần tử khác nhau của API Home vào mã của mình.

Các thuộc tính của đặc điểm được nhập từ đối tượng Companion của đặc điểm:

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

Các cấu trúc dữ liệu do một đặc điểm xác định được nhập từ lớp đặc điểm có tên kết thúc bằng "-Trait":

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

Các lệnh thuộc tính được nhập từ đối tượng Companion của thuộc tính:

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