home-assistant.io/source/_components/cover.garadget.markdown
Alok Saboo 1aca7b08cf Misc fixes: e.g. -> e.g., and proper case for Home Assistant (#4942)
* e.g. to e.g., and proper case for Home Assistant

* Instructions how to -> Instructions on how to
2018-03-17 20:20:37 +01:00

3.4 KiB

layout title description date sidebar comments sharing footer logo ha_category ha_release ha_iot_class
page Garadget Cover Instructions on how to integrate Garadget covers within Home Assistant. 2016-10-24 14:25 true false true true garadget.png Cover 0.32 Cloud Polling

The garadget cover platform lets you control Garadget garage door futurizers through Home Assistant.

To enable Garadget Covers in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
cover:
  - platform: garadget
    covers:
        190028001947343412342341:
          username: UseYourLogin@garadget.com
          password: abc123
      4c003f001151353432134214:
        access_token: df4cc785ff818f2b01396c44142342fccdef

Configuration variables:

  • covers array (Required): List of your doors.
    • device (Required): This is the device id from your Garadget portal.
    • Either:
      • username (Required): Your Garadget account username.
      • password (Required): Your Garadget account password.
    • Or:
      • access_token (Required): A generated access_token from your Garadget account.
    • name (Optional): Name to use in the frontend, will use name configured in Garadget otherwise.

If provided, the access_token will be used, otherwise the username and password will be used to automatically generate an access token at start time.

Example with more detail:

# Related configuration.yaml entry
cover:
  - platform: garadget
    covers:
      190028001947343412342341:
        access_token: !secret garadget_access_token
        name: Garage door

sensor:
  - platform: template
    sensors:
      garage_door_status:
        friendly_name: 'State of the door'
        value_template: {% raw %}'{{ states.cover.garage_door.state }}'{% endraw %}
      garage_door_time_in_state:
        friendly_name: 'Since'
        value_template: {% raw %}'{{ states.cover.garage_door.attributes.time_in_state }}'{% endraw %}
      garage_door_wifi_signal_strength:
        friendly_name: 'WiFi strength'
        value_template: {% raw %}'{{ states.cover.garage_door.attributes.wifi_signal_strength }}'{% endraw %}
        unit_of_measurement: 'dB'

group:
  garage_door:
    name: Garage door
    entities:
      - cover.garage_door
      - sensor.garage_door_status
      - sensor.garage_door_time_in_state
      - sensor.garage_door_wifi_signal_strength

customize:
  sensor.garage_door_time_in_state:
    icon: mdi:timer-sand
  sensor.garage_door_wifi_signal_strength:
    icon: mdi:wifi

Some of the Garadget sensors can create a lot of clutter in the logbook. Use this section of code in your configuration.yaml to exclude those entries.

logbook:
  exclude:
    entities:
      - sensor.garage_door_time_in_state
      - sensor.garage_door_wifi_signal_strength

As of firmware release 1.17 the garadget device has native support for MQTT. The options allow the end-user to configure the device in the following ways 'cloud only', 'cloud and MQTT' or 'MQTT only'.

For configuration of the garadget as a MQTT cover:

cover:
  - platform: mqtt
    name: "Garage Door"
    command_topic: "garadget/device_name/command"
    state_topic: "garadget/device_name/status"
    payload_open: "open"
    payload_close: "close"