Przewodnik po DSL na Androida na potrzeby złożonych automatyzacji

Za pomocą języka DSL automatyzacji można tworzyć automatyzacje bardziej złożone niż te omówione w przewodniku po języku DSL – podstawowe automatyzacje na Androidzie.

Sekwencyjne z wieloma działaniami

Automatyzacja może wykonywać więcej niż 1 czynność. Na przykład zamiast pojedynczego węzła action możesz mieć wiele węzłów action, które działają w kolejności sekwencyjnej:

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

Sekwencyjne z wieloma działaniami równoległymi

Jeśli umieścisz kilka węzłów action w węźle parallel, działania będą wykonywane jednocześnie.

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

Jeśli w węźle sequential znajdują się węzły action, które występują po węźle parallel, czekają one na wykonanie, dopóki nie zostaną wykonane wszystkie węzły w węźle parallel.

Wykonywanie warunkowe

Domyślnie automatyzacja wykonuje węzły sekwencyjnie lub równolegle. Jeśli potrzebujesz logiki rozgałęziania warunkowego, która wykonuje różne działania lub ścieżki na podstawie warunków środowiska wykonawczego, użyj instrukcji if-then-else, które są tworzone za pomocą bloków DSL warunkowego przepływu sterowania: ifThen, elseIf i orElse.

Standardowy węzeł condition blokuje całą automatyzację (jeśli warunek ma wartość false, automatyzacja natychmiast kończy działanie), natomiast bloki ifThen umożliwiają rozgałęzianie przepływu sterowania:

• Węzeł condition: zatrzymuje wykonywanie całej automatyzacji (lub bieżącej ścieżki wykonywania), jeśli wyrażenie ma wartość false.
• ifThen / elseIf / orElse: ocenia warunki w kolejności. Jeśli warunek jest false, wykonanie przechodzi do następnej gałęzi elseIf, gałęzi zastępczej orElse lub do kolejnych węzłów w automatyzacji, jeśli żaden warunek nie jest spełniony.

Wykonywanie działania na podstawie warunku

Blok ifThen ocenia wyrażenie warunkowe. Jeśli wyrażenie ma wartość true, działania lub węzły DSL zagnieżdżone w bloku są wykonywane. Jeśli wynik to false, działania są pomijane, a automatyzacja przechodzi do kolejnych węzłów w sekwencji.

Możesz użyć samodzielnego bloku ifThen, gdy chcesz wykonać działanie warunkowo bez blokowania lub kończenia kolejnych węzłów w automatyzacji:

// 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."))
    }
  }
}

Wykonywanie różnych działań na podstawie warunku

Aby wykonać jeden zestaw działań, gdy warunek jest spełniony, i alternatywny zestaw działań, gdy warunek nie jest spełniony, połącz opcjonalny blok .orElse { ... } po 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!"))
      }
    }
  }
}

Łączenie wielu warunków w sekwencję

Możesz połączyć co najmniej 1 opcjonalny blok .elseIf(...) { ... }, aby ocenić kilka warunków po kolei. Wykonywana jest pierwsza gałąź, której warunek ma wartość true, a wszystkie pozostałe gałęzie są pomijane. Jeśli żaden z warunków nie ma wartości true, wykonywany jest opcjonalny blok .orElse { ... } (jeśli został podany):

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

Zagnieżdżone automatyzacje warunkowe

Bloki warunkowe można zagnieżdżać w innych blokach ifThen, elseIf lub orElse, a także łączyć z węzłami parallel, delayFor i stateReader.

Bloki ifThen, elseIf i orElse wykonują swoją zawartość jako sekwencyjne przepływy. W każdej gałęzi możesz umieścić dowolne węzły sekwencyjne, w tym bloki action, stateReader, parallel, delayFor i zagnieżdżone bloki ifThen.

Opóźnienia

Możesz wprowadzić przerwy w automatyzacjach, używając słowa kluczowego delayFor, które przyjmuje argument java.time.Duration określający, jak długo ma trwać przerwa przed kontynuowaniem wykonywania. Czas wstrzymania może wynosić od 5 sekund do 24 godzin.

Aby na przykład przełączyć światło 4 razy z 5-sekundową przerwą między każdym przełączeniem:

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

Pomijanie aktywatora

Blokowanie aktywacji to funkcja, która pozwala automatyzacji ignorować starter przez określony czas po początkowym zdarzeniu aktywującym. Jeśli na przykład automatyzacja ma starter, który jest aktywowany przez wykrycie ruchu, i określisz czas blokowania aktywacji na 5 minut, to po aktywowaniu starter nie zostanie on ponownie aktywowany przez kolejne 5 minut. Zapobiega to wielokrotnemu uruchamianiu automatyzacji w krótkim czasie.

Aby zastosować blokowanie aktywacji w automatyzacji, użyj słowa kluczowego suppressFor z argumentem java.time.Duration, który określa, jak długo należy czekać przed reagowaniem na kolejne aktywacje. Czas wyciszenia może wynosić od 5 sekund do 24 godzin.

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

Pamiętaj, że pominięcie reguły wpływa na wszystkie starters w automatyzacji, które poprzedzają suppressFor.

Ograniczanie liczby uruchomień

Możesz ograniczyć liczbę uruchomień automatyzacji.

Możesz na przykład skonfigurować jednorazową automatyzację, która uruchomi odkurzacz, gdy nie będzie Cię w domu.

Aby to zrobić, ustaw pole metadanych maxExecutionCount automatyzacji. Poniższy przykład przedstawia automatyzację, która może zostać wykonana tylko raz:

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

Automatyzacja zostanie natychmiast usunięta po ostatnim uruchomieniu i osiągnięciu wartości maxExecutionCount. Wpis dotyczący historii automatyzacji pozostanie na karcie Google Home app (GHA) Aktywność, w tym automation_id.

Ustawianie atrybutów cech w działaniu

Aby ustawić wartość atrybutu cechy:

1. Utwórz węzeł update w węźle action, podając odpowiednią cechę jako argument węzła update:

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

2. W węźle update dla każdego atrybutu, który ma zostać zmodyfikowany, użyj funkcji mutatora i przekaż jej nową wartość. Aby utworzyć nazwę funkcji mutatora:
   1. Zapisuj nazwę atrybutu wielką literą.
   2. Dodaj przed nim słowo set.
   Na przykład aby zaktualizować atrybut o nazwie defaultMoveRate, użyj funkcji mutatora o nazwie setDefaultMoveRate.

Pamiętaj, że węzeł update może mieć wiele funkcji mutatora. Oto przykład, w którym aktualizowane są 2 atrybuty:

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