คู่มือ DSL - การทำงานอัตโนมัติขั้นพื้นฐาน

ใช้คําแนะนําต่อไปนี้เพื่อทำความเข้าใจว่าโหนด Automation DSL ต่างๆ อาจนําไปใช้สร้างการทำงานอัตโนมัติได้อย่างไร

DSL การทำงานอัตโนมัติทั้งหมดจะอยู่ในโหนด automation โหนดเดียว โหนด automation จะกำหนดขอบเขตระหว่างบริบทภาษา Kotlin ด้านนอกกับบริบท 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

โหนดเงื่อนไขเริ่มต้นจะกำหนดสถานการณ์เริ่มต้นที่เปิดใช้งานการทำงานอัตโนมัติ เช่น การเปลี่ยนแปลงสถานะหรือค่า การทำงานอัตโนมัติต้องมีเงื่อนไขเริ่มต้นอย่างน้อย 1 รายการ มิเช่นนั้นระบบจะตรวจสอบไม่ผ่าน หากต้องการเพิ่มเงื่อนไขเริ่มต้นมากกว่า 1 รายการในการทำงานอัตโนมัติ คุณต้องใช้โหนดแบบเลือก

เงื่อนไขเริ่มต้นตามแอตทริบิวต์ลักษณะ

เมื่อประกาศโหนดเริ่มต้นที่อิงตามแอตทริบิวต์ลักษณะ ให้ระบุข้อมูลต่อไปนี้

• อุปกรณ์
• ประเภทอุปกรณ์ที่ลักษณะนิสัยนั้นอยู่
• ลักษณะ

starter<_>(thermostat, TemperatureSensorDevice, TemperatureMeasurement)

คุณต้องใช้พารามิเตอร์ประเภทอุปกรณ์เนื่องจากจะช่วยให้คุณระบุประเภทอุปกรณ์ภายในอุปกรณ์ที่ระบบอัตโนมัติจะดำเนินการ เช่น อุปกรณ์อาจประกอบด้วย FanDevice และ HeatingCoolingUnitDevice ซึ่งทั้ง 2 รายการมีคุณลักษณะ OnOff การระบุประเภทอุปกรณ์จะทำให้ไม่เกิดความสับสนว่าส่วนใดของอุปกรณ์ที่ทริกเกอร์การทำงานอัตโนมัติ

เงื่อนไขเริ่มต้นตามเหตุการณ์

เมื่อประกาศโหนดเงื่อนไขเริ่มต้นที่อิงตามเหตุการณ์ ให้ระบุข้อมูลต่อไปนี้

• อุปกรณ์
• ประเภทอุปกรณ์ที่ลักษณะนิสัยนั้นอยู่
• กิจกรรม

starter<_>(doorBell, GoogleDoorbellDevice, DoorbellPressed)

เงื่อนไขเริ่มต้นที่อิงตามโครงสร้างและเหตุการณ์พร้อมพารามิเตอร์

เหตุการณ์บางรายการอาจมีพารามิเตอร์ ดังนั้นจึงต้องรวมพารามิเตอร์เหล่านี้ไว้ในเงื่อนไขเริ่มต้นด้วย

ตัวอย่างเช่นเงื่อนไขเริ่มต้นนี้ใช้ ScheduledTimeEvent ของลักษณะ Time เพื่อเปิดใช้งานการทำงานอัตโนมัติเวลา 07:00 น.

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

เงื่อนไขเริ่มต้นด้วยตนเอง

ตัวเริ่มต้นด้วยตนเองเป็นตัวเริ่มต้นประเภทพิเศษที่ช่วยให้ผู้ใช้เรียกใช้การทำงานอัตโนมัติด้วยตนเองได้

เมื่อประกาศเงื่อนไขเริ่มต้นด้วยตนเอง

• อย่าระบุลักษณะหรือประเภทอุปกรณ์
• ระบุองค์ประกอบ UI ที่เรียกใช้ Automation.execute()

เมื่อวางเงื่อนไขเริ่มต้นด้วยตนเองในโฟลว์ 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 และอาจมีค่าพื้นฐาน เช่น ตัวเลข อักขระ สตริง และบูลีน รวมถึงค่า Enum การจัดกลุ่มนิพจน์ย่อยด้วยวงเล็บช่วยให้คุณควบคุมลําดับการประเมินนิพจน์ย่อยได้

ต่อไปนี้คือตัวอย่าง 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)

จากนั้นอ้างอิง stateReader ในโหนด condition ดังนี้

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

เมื่อใช้โอเปอเรเตอร์การเปรียบเทียบและโอเปอเรเตอร์ตรรกะ คุณจะใช้stateReadersหลายรายการในโหนด condition ได้ ดังนี้

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

ระยะเวลาของเงื่อนไข

นอกจากนิพจน์บูลีนในเงื่อนไขแล้ว คุณยังระบุกรอบเวลาได้ในระหว่างที่นิพจน์ต้องเป็นจริงจึงจะทํางานอัตโนมัติได้ เช่น คุณอาจกำหนดเงื่อนไขที่จะทริกเกอร์เฉพาะในกรณีที่ไฟเปิดอยู่นาน 10 นาที

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

ระยะเวลามีตั้งแต่ 1 ถึง 30 นาที

โหนดการดำเนินการ

นอตการดำเนินการคือที่ที่การทำงานอัตโนมัติเกิดขึ้น ในตัวอย่างนี้ การดำเนินการจะเรียกใช้คำสั่ง broadcast() ของลักษณะ AssistantBroadcast

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