mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-01 07:46:49 +00:00
0e638d5f65
* Update to incluse MQTT configuration Details support for MQTT as of firmware 1.17 * Fixes
115 lines
3.4 KiB
Markdown
115 lines
3.4 KiB
Markdown
---
|
|
layout: page
|
|
title: "Garadget Cover"
|
|
description: "Instructions how to integrate Garadget covers within Home Assistant."
|
|
date: 2016-10-24 14:25
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: garadget.png
|
|
ha_category: Cover
|
|
ha_release: 0.32
|
|
ha_iot_class: "Cloud Polling"
|
|
---
|
|
|
|
|
|
The `garadget` cover platform lets you control [Garadget](http://www.garadget.com/) garage door futurizers through Home Assistant.
|
|
|
|
To enable Garadget Covers in your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# 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:**
|
|
<p class='img'>
|
|
<img src='{{site_root}}/images/components/garadget/cover_garadget_details.png' />
|
|
</p>
|
|
|
|
```yaml
|
|
# 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.
|
|
|
|
```yaml
|
|
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:
|
|
|
|
```yaml
|
|
cover:
|
|
- platform: mqtt
|
|
name: "Garage Door"
|
|
command_topic: "garadget/device_name/command"
|
|
state_topic: "garadget/device_name/status"
|
|
payload_open: "open"
|
|
payload_close: "close"
|
|
```
|