脚本语法

# 示例脚本集成包含脚本语法
script:
  example_script:
    sequence:
      # 这是使用脚本语法编写的
      - alias: "打开天花板灯"
        action: light.turn_on
        target:
          entity_id: light.ceiling
      - alias: "通知天花板灯已打开"
        action: notify.notify
        data:
          message: "天花板灯已打开！"

- alias: "卧室灯开启"
  action: light.turn_on
  target:
    entity_id: group.bedroom
  data:
    brightness: 100

- scene: scene.morning_living_room

- alias: "设置变量"
  variables:
    entities: 
      - light.kitchen
      - light.living_room
    brightness: 100
- alias: "控制灯光"
  action: light.turn_on
  target:
    entity_id: "{{ entities }}"
  data:
    brightness: "{{ brightness }}"

- alias: "设置一个模板变量"
  variables:
    blind_state_message: "百叶窗状态是{{ states('cover.blind') }}。"
- alias: "通知百叶窗的状态"
  action: notify.mobile_app_iphone
  data:
    message: "{{ blind_state_message }}"

sequence:
  # 将 people 变量设置为默认值
  - variables:
      people: 0
  # 尝试在 Paulus 在家时增加 people
  - if:
      - condition: state
        entity_id: device_tracker.paulus
        state: "home"
    then:
      # 在此作用域和序列的这个点，people == 0
      - variables:
          people: "{{ people + 1 }}"
      # 在此作用域，people 现在将是 1 ...
      - action: notify.notify
        data:
          message: "家里有 {{ people }} 个人" # "家里有 1 个人"
  # ... 但在此作用域它仍将是 0
  - action: notify.notify
    data:
      message: "家里有 {{ people }} 个人" # "家里有 0 个人"

# 如果 paulus 在家，继续执行下面的脚本
- alias: "检查 Paulus 是否在家"
  condition: state
  entity_id: device_tracker.paulus
  state: "home"

- alias: "检查 Paulus 是否在家 且 温度低于 20"
  conditions:
    - condition: state
      entity_id: "device_tracker.paulus"
      state: "home"
    - condition: numeric_state
      entity_id: "sensor.temperature"
      below: 20

# 秒
# 等待 5 秒
- alias: "等待 5 秒"
  delay: 5

# HH:MM
# 等待 1 小时
- delay: "01:00"

# HH:MM:SS
# 等待 1.5 分钟
- delay: "00:01:30"

# 支持毫秒、秒、分钟、小时、天
# 可以组合使用，至少需要一个
# 使用毫秒时，考虑到延迟至少为 X 毫秒。它不会非常精确。
# 等待 1 分钟
- delay:
    minutes: 1

# 等待 input_number.minute_delay 设置的分钟数
- delay: "{{ states('input_number.minute_delay') | multiply(60) | int }}"

# 等待媒体播放器停止
- alias: "等待媒体播放器停止"
  wait_template: "{{ is_state('media_player.floor', 'stop') }}"

# 等待自定义事件或灯光开启并保持开启 10 秒
- alias: "等待 MY_EVENT 或灯光开启"
  wait_for_trigger:
    - trigger: event
      event_type: MY_EVENT
    - trigger: state
      entity_id: light.LIGHT
      to: "on"
      for: 10

# 等待传感器改变为 'on'，最长等待 1 分钟，再继续执行。
- wait_template: "{{ is_state('binary_sensor.entrance', 'on') }}"
  timeout: "00:01:00"

# 等待 IFTTT 事件或在指定超时后中止。
- wait_for_trigger:
    - trigger: event
      event_type: ifttt_webhook_received
      event_data:
        action: connected_to_network
  timeout:
    minutes: "{{ timeout_minutes }}"
  continue_on_timeout: false

# 根据条件是否满足采取不同的行动。
- wait_template: "{{ is_state('binary_sensor.door', 'on') }}"
  timeout: 10
- if:
    - "{{ not wait.completed }}"
  then:
    - action: script.door_did_not_open
  else:
    - action: script.turn_on
      target:
        entity_id:
          - script.door_did_open
          - script.play_fanfare

# 等待总共 10 秒。
- wait_template: "{{ is_state('binary_sensor.door_1', 'on') }}"
  timeout: 10
  continue_on_timeout: false
- action: switch.turn_on
  target:
    entity_id: switch.some_light
- wait_for_trigger:
    - trigger: state
      entity_id: binary_sensor.door_2
      to: "on"
      for: 2
  timeout: "{{ wait.remaining }}"
  continue_on_timeout: false
- action: switch.turn_off
  target:
    entity_id: switch.some_light

- alias: "触发 LOGBOOK_ENTRY 事件"
  event: LOGBOOK_ENTRY
  event_data:
    name: Paulus
    message: 正在醒来
    entity_id: device_tracker.paulus
    domain: light

- event: MY_EVENT
  event_data:
    name: myEvent
    customData: "{{ myCustomVariable }}"

- alias: "触发事件"
  triggers:
    - trigger: state
      entity_id: switch.kitchen
      to: "on"
  actions:
    - event: event_light_state_changed
      event_data:
        state: "on"

- alias: "捕获事件"
  triggers:
    - trigger: event
      event_type: event_light_state_changed
  actions:
    - action: notify.notify
      data:
        message: "厨房灯已变为 {{ trigger.event.data.state }}"

script:
  flash_light:
    mode: restart
    sequence:
      - action: light.turn_on
        target:
          entity_id: "light.{{ light }}"
      - alias: "循环灯 'count' 次"
        repeat:
          count: "{{ count|int * 2 - 1 }}"
          sequence:
            - delay: 2
            - action: light.toggle
              target:
                entity_id: "light.{{ light }}"
  flash_hallway_light:
    sequence:
      - alias: "闪烁走廊灯 3 次"
        action: script.flash_light
        data:
          light: hallway
          count: 3

repeat:
  for_each:
    - "living_room"
    - "kitchen"
    - "office"
  sequence:
    - action: light.turn_off
      target:
        entity_id: "light.{{ repeat.item }}"

repeat:
  for_each:
    - language: English
      message: Hello World
    - language: Dutch
      message: Hallo Wereld
  sequence:
    - action: notify.phone
      data:
        title: "Message in {{ repeat.item.language }}"
        message: "{{ repeat.item.message }}!"

script:
  do_something:
    sequence:
      - action: script.get_ready_for_something
      - alias: "只要条件为真就重复序列"
        repeat:
          while:
            - condition: state
              entity_id: input_boolean.do_something
              state: "on"
            # 不要做太多次
            - condition: template
              value_template: "{{ repeat.index <= 20 }}"
          sequence:
            - action: script.something

- repeat:
    while: "{{ is_state('sensor.mode', 'Home') and repeat.index < 10 }}"
    sequence:
    - ...

automation:
  - triggers:
      - trigger: state
        entity_id: binary_sensor.xyz
        to: "on"
    conditions:
      - condition: state
        entity_id: binary_sensor.something
        state: "off"
    actions:
      - alias: "直到条件为真重复序列"
        repeat:
          sequence:
            # 运行某个原因可能不总是有效的命令
            - action: shell_command.turn_something_on
            # 给它时间完成
            - delay:
                milliseconds: 200
          until:
            # 它成功了吗？
            - condition: state
              entity_id: binary_sensor.something
              state: "on"

- repeat:
    until: "{{ is_state('device_tracker.iphone', 'home') }}"
    sequence:
    - ...

script:
  - if:
      - alias: "如果没有人在家"
        condition: state
        entity_id: zone.home
        state: 0
    then:
      - alias: "那么就开始清洁吧！"
        action: vacuum.start
        target:
          area_id: living_room
    # `else` 是完全可选的，可以省略
    else:
      - action: notify.notify
        data:
          message: "跳过清洁，有人在家！"

# 示例包括 "if"、"elif" 和 "else"
automation:
  - triggers:
      - trigger: state
        entity_id: input_boolean.simulate
        to: "on"
    mode: restart
    actions:
      - choose:
          # 如果是早上
          - conditions:
              - condition: template
                value_template: "{{ now().hour < 9 }}"
            sequence:
              - action: script.sim_morning
          # 或者是白天
          - conditions:
              - condition: template
                value_template: "{{ now().hour < 18 }}"
            sequence:
              - action: light.turn_off
                target:
                  entity_id: light.living_room
              - action: script.sim_day
        # 否则是晚上
        default:
          - action: light.turn_off
            target:
              entity_id: light.kitchen
          - delay:
              minutes: "{{ range(1, 11)|random }}"
          - action: light.turn_off
            target:
              entity_id: all

automation:
  - triggers:
      - trigger: state
        entity_id: input_select.home_mode
    actions:
      - choose:
          - conditions: >
              {{ trigger.to_state.state == 'Home' and
                 is_state('binary_sensor.all_clear', 'on') }}
            sequence:
              - action: script.arrive_home
                data:
                  ok: true
          - conditions: >
              {{ trigger.to_state.state == 'Home' and
                 is_state('binary_sensor.all_clear', 'off') }}
            sequence:
              - action: script.turn_on
                target:
                  entity_id: script.flash_lights
              - action: script.arrive_home
                data:
                  ok: false
          - conditions: "{{ trigger.to_state.state == 'Away' }}"
            sequence:
              - action: script.left_home

# 示例包含 "if" 和 "if"
automation:
  - alias: "当太阳变暗以及如果某个房间被占用时开启灯光"
      triggers:
        - trigger: numeric_state
          entity_id: sun.sun
          attribute: elevation
          below: 4
      actions:
        # 这必须始终适用
        - action: light.turn_on
          data:
            brightness: 255
            color_temp: 366
          target:
            entity_id:
              - light.porch
              - light.garden
        # 如果有实体是开启的
        - choose:
            - conditions:
                - condition: state
                  entity_id: binary_sensor.livingroom_tv
                  state: "on"
              sequence:
                - action: light.turn_on
                  data:
                    brightness: 255
                    color_temp: 366
                  target:
                    entity_id: light.livingroom
         # 如果与之前无关的另一个实体是开启的
        - choose:
            - conditions:
                - condition: state
                  entity_id: binary_sensor.studio_pc
                  state: "on"
              sequence:
                - action: light.turn_on
                  data:
                    brightness: 255
                    color_temp: 366
                  target:
                    entity_id: light.studio

automation:
  - triggers:
      - trigger: state
        entity_id: binary_sensor.motion
        to: "on"
    actions:
      - alias: "打开设备"
        sequence:
          - action: light.turn_on
            target:
              entity_id: light.ceiling
          - action: siren.turn_on
            target:
              entity_id: siren.noise_maker
      - alias: "发送通知"
        sequence:
          - action: notify.person1
            data:
              message: "运动传感器被触发！"
          - action: notify.person2
            data:
              message: "哦哦，有人触发了运动传感器..."

automation:
  - triggers:
      - trigger: state
        entity_id: binary_sensor.motion
        to: "on"
    actions:
      - parallel:
          - action: notify.person1
            data:
              message: "这些消息是同时发送的！"
          - action: notify.person2
            data:
              message: "这些消息是同时发送的！"

script:
  example_script:
    sequence:
      - parallel:
          - sequence:
              - wait_for_trigger:
                  - trigger: state
                    entity_id: binary_sensor.motion
                    to: "on"
              - action: notify.person1
                data:
                  message: "此消息在运动触发器等待"
          - action: notify.person2
            data:
              message: "我立即发送，不等待上述动作！"

- stop: "停止运行剩余序列"

- stop: "停止运行剩余序列"
  response_variable: "my_response_variable"

- stop: "好吧，那是意料之外的！"
  error: true

- alias: "如果这个失败了..."
  continue_on_error: true
  action: notify.super_unreliable_service_provider
  data:
    message: "我将会出错..."

- alias: "这个仍然会运行！"
  action: persistent_notification.create
  data:
    title: "你好！"
    message: "我很好..."

# 示例脚本包含一个禁用的动作
script:
  example_script:
    sequence:
      # 此动作不会运行，因为它被禁用。
      # 消息将不会发送。
      - enabled: false
        alias: "通知正在打开天花板灯"
        action: notify.notify
        data:
          message: "正在打开天花板灯！"

      # 此动作将运行，因为它没有被禁用
      - alias: "打开天花板灯"
        action: light.turn_on
        target:
          entity_id: light.ceiling

blueprint:
  input:
    input_boolean:
      name: 布尔值
      selector: 
        boolean:

  actions:
    - delay: 0:35
      enabled: !input input_boolean

# 模板化对话响应的示例，结果为 "测试 123"
- variables:
    my_var: "123"
- set_conversation_response: "{{ '测试 ' + my_var }}":

# 清除对话响应的示例
set_conversation_response: ~