Template Cover

The template cover platform allows you to create simple covers out of just a few actions and a value lambda. Once defined, it will automatically appear in Home Assistant as a cover and can be controlled through the frontend.

../../_images/cover-ui.png
# Example configuration entry
cover:
  - platform: template
    name: "Template Cover"
    lambda: |-
      if (id(top_end_stop).state) {
        return cover::COVER_OPEN;
      } else {
        return cover::COVER_CLOSED;
      }
    open_action:
      - switch.turn_on: open_cover_switch
    close_action:
      - switch.turn_on: close_cover_switch
    stop_action:
      - switch.turn_on: stop_cover_switch
    optimistic: true

Possible return values for the optional lambda:

  • return cover::COVER_OPEN; if the cover should be reported as OPEN.
  • return cover::COVER_CLOSED; if the cover should be reported as CLOSED.
  • return {}; if the last state should be repeated.

Configuration variables:

  • name (Required, string): The name of the cover.
  • lambda (Optional, lambda): Lambda to be evaluated repeatedly to get the current state of the cover.
  • open_action (Optional, Action): The action that should be performed when the remote (like Home Assistant’s frontend) requests the cover to be opened.
  • close_action (Optional, Action): The action that should be performed when the remote requests the cover to be closed.
  • stop_action (Optional, Action):
  • optimistic (Optional, boolean): Whether to operate in optimistic mode - when in this mode, any command sent to the template cover will immediately update the reported state and no lambda needs to be used. Defaults to false.
  • assumed_state (Optional, boolean): Whether the true state of the cover is not known. This will make the Home Assistant frontend show buttons for both OPEN and CLOSE actions, instead of hiding one of them. Defaults to false.
  • id (Optional, ID): Manually specify the ID used for code generation.

Advanced options:

  • internal (Optional, boolean): Mark this component as internal. Internal components will not be exposed to the frontend (like Home Assistant). Only specifying an id without a name will implicitly set this to true.
  • If MQTT enabled, all other options from MQTT Component.

cover.template.publish Action

You can also publish a state to a template cover from elsewhere in your YAML file with the cover.template.publish action.

# Example configuration entry
cover:
  - platform: template
    name: "Template Cover"
    id: template_cov

# in some trigger
on_...:
  - cover.template.publish:
      id: template_cov
      state: OPEN

  # Templated
  - cover.template.publish:
      id: template_cov
      state: !lambda 'return cover::COVER_OPEN;'

Configuration options:

  • id (Required, ID): The ID of the template cover.
  • state (Required, templatable): The state to publish. One of OPEN, CLOSED.

Note

This action can also be written in lambdas:

id(template_cov).publish_state(cover::COVER_OPEN);