You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- **covers** array (*Required*): List of your doors.
36
+
- **device** (*Required*): This is the device id from your Garadget portal.
37
+
- Either:
38
+
- **username** (*Required*): Your Garadget account username.
39
+
- **device** (*Required*): Your Garadget account password.
40
+
- Or:
41
+
- **access_token** (*Required*): A generated access_token from your garadget account
42
+
- **name** (*Optional*): Name to use in the Frontend, will use name configured in Garadget otherwise.
43
+
44
+
45
+
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.
Copy file name to clipboardExpand all lines: source/_components/device_tracker.markdown
+4
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,8 @@ Home Assistant can get information from your wireless router or third party serv
13
13
14
14
There are also trackers available which use different technologies like [MQTT](/components/mqtt/) or [Nmap](/components/device_tracker.nmap_tracker/) to scan the network for devices.
15
15
16
+
An [event](/getting-started/automation-trigger/#event-trigger) (`device_tracker_new_device`) will be fired when a device is discovered for the first time.
17
+
16
18
# {% linkable_title Configuring a `device_tracker` platform %}
17
19
18
20
To get started add the following lines to your `configuration.yaml` (example for Netgear):
@@ -59,6 +61,7 @@ Here's an example configuration for a single device:
| `name` | Host name or "Unnamed Device" | The friendly name of the device |
71
74
| `mac` | None | The MAC address of the device. Add this if you are using a network device tracker like Nmap or SNMP |
75
+
| `icon` | None | A name of an MDI Icon. |
72
76
| `picture` | None | A picture that you can use to easily identify the person or device. You can also save the image file in a folder "www" in the same location (can be obtained from developer tools) where you have your configuration.yaml file and just use `picture: /local/favicon-192x192.png`. |
73
77
| `gravatar` | None | An email address for the device's owner. If provided, it will override `picture` |
74
78
| `track` | False | If `yes`/`on`/`true` then the device will be tracked. Otherwise its location and state will not update |
Copy file name to clipboardExpand all lines: source/_components/fan.mqtt.markdown
+51-17
Original file line number
Diff line number
Diff line change
@@ -17,43 +17,77 @@ The `mqtt` fan platform let you control your MQTT enabled fans.
17
17
18
18
In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with `RETAIN` flag, the MQTT fan will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the fan will be `false`.
19
19
20
-
When a `state_topic` is not available, the fan will work in optimistic mode. In this mode, the fan will immediately change state after every command. Otherwise, the fan will wait for state confirmation from device (message from `state_topic`).
20
+
When a `state_topic` is not available, the fan will work in optimistic mode. In this mode, the fan will immediately change state after every command. Otherwise, the fan will wait for state confirmation from the device (message from `state_topic`).
21
21
22
-
Optimistic mode can be forced, even if state topic is available. Try to enable it, if experiencing incorrect fan operation.
22
+
Optimistic mode can be forced even if a `state_topic` is available. Try to enable it if you are experiencing incorrect fan operation.
23
23
24
24
To enable MQTT fans in your installation, add the following to your `configuration.yaml` file:
25
25
26
26
```yaml
27
27
# Example configuration.yml entry
28
28
fan:
29
-
platform: mqtt
30
-
command_topic: "home/living-room/fan/set"
29
+
- platform: mqtt
30
+
command_topic: "bedroom_fan/on/set"
31
31
```
32
32
33
33
Configuration variables:
34
34
35
35
- **command_topic** (*Required*): The MQTT topic to publish commands to change the fan state.
36
36
- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates.
37
37
- **name** (*Optional*): The name of the fan. Default is 'MQTT Fan'.
38
+
- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates.
38
39
- **payload_on** (*Optional*): The payload that represents the running state. Default is "ON".
39
40
- **payload_off** (*Optional*): The payload that represents the stop state. Default is "OFF".
40
-
- **optimistic** (*Optional*): Flag that defines if lock works in optimistic mode. Default is `true` if no state topic defined, else `false`.
41
+
- **state_value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the state.
41
42
- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
43
+
- **optimistic** (*Optional*): Flag that defines if lock works in optimistic mode. Default is `true` if no state topic defined, else `false`.
42
44
- **retain** (*Optional*): If the published message should have the retain flag on or not.
43
-
- **state_value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the state.
44
-
- **speed_state_topic** (*Optional*): The MQTT topic subscribed to receive speed updates.
45
-
- **speed_command_topic** (*Optional*): The MQTT topic to publish commands to change the fan speed.
46
-
- **speed_value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the speed.
47
-
- **oscillation_state_topic** (*Optional*): The MQTT topic subscribed to receive oscillation updates.
48
-
- **oscillation_command_topic** (*Optional*): The MQTT topic to publish commands to change the fan oscillation.
45
+
- **oscillation_state_topic** (*Optional*): The MQTT topic subscribed to receive oscillation state updates.
46
+
- **oscillation_command_topic** (*Optional*): The MQTT topic to publish commands to change the oscillation state.
47
+
- **payload_oscillation_on** (*Optional*): The payload that represents the oscillation on state. Default is "oscillate_on".
48
+
- **payload_oscillation_off** (*Optional*): The payload that presents the oscillation off state. Default is "oscillate_off".
49
49
- **oscillation_value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the oscillation.
50
-
- **payload_oscillation_on** (*Optional*): The payload that represents the oscillation state. Default is "ON".
51
-
- **payload_oscillation_off** (*Optional*): The payload that represents the oscillation state. Default is "OFF".
52
-
- **payload_low_speed** (*Optional*): The payload that represents the low speed state. Default is "low".
53
-
- **payload_medium_speed** (*Optional*): The payload that represents the low speed state. Default is "med".
54
-
- **payload_high_speed** (*Optional*): The payload that represents the low speed state. Default is "high".
50
+
- **speed_state_topic** (*Optional*): The MQTT topic subscribed to receive speed state updates.
51
+
- **speed_command_topic** (*Optional*): The MQTT topic to publish commands to change speed state.
52
+
- **payload_low_speed** (*Optional*): The payload that represents the fan's low speed.
53
+
- **payload_medium_speed** (*Optional*): The payload that represents the fan's medium speed.
54
+
- **payload_high_speed** (*Optional*): The payload that represents the fan's high speed.
55
+
- **speed_value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the speed payload.
55
56
- **speeds** array (*Optional*): Valid entries for the list are `off`, `low`, `med`, and `high`.
56
57
57
58
<p class='note warning'>
58
-
Make sure that your topic match exact. `some-topic/` and `some-topic` are different topics.
59
+
Make sure that your topic is an exact match. `some-topic/` and `some-topic` are different topics.
59
60
</p>
61
+
62
+
## {% linkable_title Examples %}
63
+
64
+
In this section you find some real life examples of how to use this fan.
65
+
66
+
### {% linkable_title Full configuration %}
67
+
68
+
The example below shows a full configuration for a MQTT fan.
0 commit comments