מדריך ל-Android DSL לפעולות אוטומציה מורכבות

אפשר להשתמש ב-DSL לאוטומציה כדי ליצור אוטומציות מורכבות יותר מאלה שמוסברות במדריך ל-DSL – אוטומציות בסיסיות ב-Android.

רציף עם כמה פעולות

פעולה אוטומטית יכולה לבצע יותר מפעולה אחת. לדוגמה, במקום צומת action יחיד, יכולים להיות כמה צמתי action שפועלים בסדר רציף:

automation {
  sequential {
    starter<_>(...)
    condition {...}
    action {...}
    action {...}
    action {...}
    }
}

רצף עם כמה פעולות מקבילות

אם מציבים כמה צמתי action בצומת parallel, הפעולות יתבצעו במקביל.

automation {
  sequential {
    starter<_>(...)
    condition {...}
    parallel {
      action {...}
      action {...}
      action {...}
    }
  }
}

אם יש action צמתים בצומת sequential שמגיעים אחרי הצומת parallel, הם ימתינו להפעלה עד שכל הצמתים בצומת parallel יסיימו את ההפעלה.

ביצוע מותנה

כברירת מחדל, אוטומציה מפעילה צמתים ברצף או במקביל. אם אתם צריכים לוגיקה של הסתעפות מותנית – ביצוע של פעולות או נתיבים שונים על סמך תנאים בזמן הריצה – אתם יכולים להשתמש בהצהרות if-then-else, שנבנות באמצעות בלוקים של DSL לזרימת בקרה מותנית: ifThen, elseIf, ו- orElse.

בזמן שצומת רגיל של condition חוסם את כל האוטומציה (אם התנאי מוערך כ-false, ביצוע האוטומציה מסתיים באופן מיידי), צומתי ifThen מאפשרים פיצול של זרימת הבקרה:

• ‫condition node: עצירה של הביצוע של כל האוטומציה (או של נתיב הביצוע הנוכחי) אם הביטוי הוא false.
• ‫ifThen / elseIf / orElse: הערכת התנאים לפי הסדר. אם התנאי הוא false, הביצוע עובר לענף הבא של elseIf, לענף של orElse או ממשיך לצמתים הבאים באוטומציה אם אף תנאי לא מתקיים.

ביצוע פעולה על סמך תנאי

הבלוק ifThen מעריך ביטוי מותנה. אם הערך של הביטוי הוא true, הפעולות או הצמתים של ה-DSL שמוטמעים בתוך הבלוק מבוצעים. אם התוצאה היא false, המערכת מדלגת על הפעולות והאוטומציה ממשיכה לצמתים הבאים ברצף.

אפשר להשתמש בבלוק ifThen עצמאי כשרוצים לבצע פעולה רק אם מתקיים תנאי מסוים, בלי לחסום או להפסיק את הצמתים הבאים באוטומציה:

// When a door opens, turn on the light only if it is off,
// and always broadcast an announcement.
automation {
  sequential {
    val contactState = starter<_>(
      contactSensor,
      ContactSensorDevice,
      BooleanState,
    )
    val lightState = stateReader<_>(
      light,
      DimmableLightDevice,
      OnOff,
    )

    condition {
      // Door opened (contact sensor open)
      expression = contactState.stateValue equals false
    }

    // Conditionally turn on the light if it's off
    ifThen(lightState.onOff equals false) {
      action(light, DimmableLightDevice) { command(OnOff.on()) }
    }

    // Continue executing subsequent actions in the sequential flow
    action(structure) {
      command(AssistantBroadcast.broadcast("The door was opened."))
    }
  }
}

ביצוע פעולות שונות על סמך תנאי

כדי להפעיל קבוצה אחת של פעולות כשתנאי מסוים מתקיים וקבוצה חלופית של פעולות כשהתנאי לא מתקיים, צריך לשרשר את הבלוק האופציונלי .orElse { ... } אחרי ifThen(...) { ... }:

// When the door is unlocked, turn on the entryway light if it is off;
// otherwise, broadcast a welcome message.
automation {
  sequential {
    val doorLockEvent = starter<_>(
      doorLock,
      DoorLockDevice,
      LockOperationEvent,
    )
    val lightState = stateReader<_>(
      light,
      DimmableLightDevice,
      OnOff,
    )

    condition {
      expression =
        doorLockEvent.lockOperationType equals LockOperationTypeEnum.Unlock
    }

    ifThen(lightState.onOff equals false) {
      action(light, DimmableLightDevice) { command(OnOff.on()) }
    }.orElse {
      action(structure) {
        command(AssistantBroadcast.broadcast("Welcome home!"))
      }
    }
  }
}

שרשור של כמה תנאים ברצף

אפשר לשרשר בלוק .elseIf(...) { ... } אופציונלי אחד או יותר כדי להעריך כמה תנאים ברצף. הענף הראשון שהתנאי שלו מקבל את הערך true מופעל, וכל הענפים הנותרים מדלגים. אם אף אחד מהתנאים לא מחזיר את הערך true, יופעל בלוק .orElse { ... } אופציונלי (אם הוא צוין):

// Adjust climate controls based on room temperature changes.
automation {
  sequential {
    val tempStarter = starter<_>(
      tempSensor,
      TemperatureSensorDevice,
      TemperatureMeasurement,
    )

    // If temperature is high (>= 28°C / 2800 mC), switch thermostat to Cool mode
    ifThen(tempStarter.measuredValue greaterThanOrEquals 2800) {
      action(thermostat, ThermostatDevice) {
        command(
          SimplifiedThermostat.setSystemMode(
            SimplifiedThermostatSystemModeEnum.Cool
          )
        )
      }
    }.elseIf(tempStarter.measuredValue lessThan 1800) {
      // If temperature is low (< 18°C / 1800 mC), switch to Heat mode
      action(thermostat, ThermostatDevice) {
        command(
          SimplifiedThermostat.setSystemMode(
            SimplifiedThermostatSystemModeEnum.Heat
          )
        )
      }
    }.orElse {
      // Otherwise, turn on the fan
      action(fan, FanDevice) {
        command(OnOff.on())
      }
    }
  }
}

תהליכים מותנים מקוננים

אפשר להציב בלוקים של תנאים בתוך בלוקים אחרים של ifThen, elseIf או orElse, וגם לשלב אותם עם צמתי parallel, delayFor ו-stateReader.

הבלוקים ifThen,‏ elseIf ו-orElse מבצעים את התוכן שלהם כזרימות רציפות. אפשר להציב כל צומת רציף בתוך כל ענף, כולל action, stateReader, parallel, delayFor ובלוקים מוטמעים של ifThen.

עיכובים

אפשר להוסיף הפסקות לאוטומציות באמצעות מילת המפתח delayFor שמקבלת ארגומנט java.time.Duration שמייצג את משך ההפסקה לפני המשך הביצוע. משך ההשהיה יכול להיות קצר כמו חמש שניות או ארוך כמו 24 שעות.

לדוגמה, כדי להפעיל ולכבות את האור ארבע פעמים עם הפסקה של חמש שניות בין כל הפעלה וכיבוי:

sequential {
  action(light, OnOffLightDevice) { command(OnOff.toggle()) }
  delayFor(Duration.ofSeconds(5))
  action(light, OnOffLightDevice) { command(OnOff.toggle()) }
  delayFor(Duration.ofSeconds(5))
  action(light, OnOffLightDevice) { command(OnOff.toggle()) }
  delayFor(Duration.ofSeconds(5))
  action(light, OnOffLightDevice) { command(OnOff.toggle()) }
}

השבתת טריגר

השבתת טריגר היא יכולת שמאפשרת לאוטומציה להתעלם מstarter למשך פרק זמן מוגדר אחרי אירוע ההפעלה הראשוני. לדוגמה, אם לפעולה האוטומטית יש starter שמופעל על ידי זיהוי תנועה, ואם מציינים משך של חמש דקות לביטול הפעלה של טריגר, אז כשהstarter מופעל, הוא לא יופעל שוב במשך חמש הדקות הבאות. כך מונעים הפעלה חוזרת ונשנית של האוטומציה.

כדי להחיל השהיית טריגר על האוטומציה, משתמשים במילת המפתח suppressFor עם הארגומנט java.time.Duration שמייצג את משך הזמן שיעבור לפני שתהיה תגובה לטריגרים הבאים. משך ההסתרה יכול להיות קצר כמו חמש שניות או ארוך כמו 24 שעות.

automation {
  sequential {
    val starterNode = starter<_>(device, OccupancySensor, MotionDetection)
    suppressFor(Duration.ofMinutes(30))
    action(light, OnOffLightDevice) { command(OnOff.toggle()) }
}

חשוב לדעת שדיכוי הטריגר משפיע על כל starters באוטומציה שקודמים לsuppressFor.

הגבלת מספר ההרצות

אפשר להגביל את מספר הפעמים שמותר להפעיל אוטומציה.

לדוגמה, אפשר להגדיר פעולה אוטומטית חד-פעמית שתפעיל את השואב כשאתם לא בבית במהלך היום.

כדי לעשות זאת, מגדירים את שדה המטא-נתונים maxExecutionCount של האוטומציה. הדוגמה הבאה היא אוטומציה שאפשר להפעיל רק פעם אחת:

automation {
  // The automation can only be executed once.
  maxExecutionCount = 1
  // When the door lock state changes
  sequential {
    val doorLockEvent = starter<_>(doorLock, DoorLockDevice, LockOperationEvent)
    // if the door is unlocked
    condition() {
      expression = (doorLockEvent.lockOperationType equals LockOperationTypeEnum.Unlock)
    }
    // turn the light on
    action(light, DimmableLightDevice) { command(OnOff.on()) }
  }
}

הפעולה האוטומטית נמחקת מיד אחרי שהיא מסיימת את הביצוע בפעם האחרונה ומגיעה ל-maxExecutionCount. הערך בהיסטוריה של האוטומציה נשאר בכרטיסייה Google Home app (GHA) פעילות, כולל automation_id.

הגדרת מאפייני מאפיינים בפעולה

כדי להגדיר את הערך של מאפיין של מאפיין משותף:

1. יוצרים צומת update בתוך צומת action, כולל המאפיין הרלוונטי כארגומנט לצומת update:

   action(deviceReference, deviceType) {
     update(trait) {
   
     }
   }

2. בצומת update, לכל מאפיין שרוצים לשנות, משתמשים בפונקציית שינוי ומעבירים לה את הערך החדש. כדי ליצור את השם של פונקציית השינוי:
   1. האות הראשונה של שם המאפיין צריכה להיות גדולה
   2. מוסיפים לפניו את המילה set.
   לדוגמה, כדי לעדכן מאפיין שנקרא defaultMoveRate, משתמשים בפונקציית שינוי שנקראת setDefaultMoveRate.

חשוב לזכור שלצומת update יכולות להיות כמה פונקציות לשינוי. דוגמה לעדכון של שני מאפיינים:

action(device, Fan) {
  update(FanControl) {
    setPercentSetting(50u)
    setRockSetting(FanControlCluster.RockBitmap.rockUpDown)
  }
}