mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
Fix typos in file name (#5330)
This commit is contained in:
parent
e1ccd79776
commit
243d1587e8
@ -15,10 +15,12 @@ ha_iot_class: "Local Push"
|
|||||||
|
|
||||||
The `modbus` binary sensor allows you to gather data from [Modbus](http://www.modbus.org/) coils.
|
The `modbus` binary sensor allows you to gather data from [Modbus](http://www.modbus.org/) coils.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To use your Modbus binary sensors in your installation, add the following to your `configuration.yaml` file:
|
To use your Modbus binary sensors in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
binary_sensor:
|
binary_sensor:
|
||||||
- platform: modbus
|
- platform: modbus
|
||||||
coils:
|
coils:
|
||||||
@ -39,7 +41,7 @@ Configuration variables:
|
|||||||
|
|
||||||
It's possible to change the default 30 seconds scan interval for the sensor updates as shown in the [Platform options](/docs/configuration/platform_options/#scan-interval) documentation.
|
It's possible to change the default 30 seconds scan interval for the sensor updates as shown in the [Platform options](/docs/configuration/platform_options/#scan-interval) documentation.
|
||||||
|
|
||||||
### {% linkable_title Full example %}
|
## {% linkable_title Full example %}
|
||||||
|
|
||||||
Example a sensor with a 10 seconds scan interval:
|
Example a sensor with a 10 seconds scan interval:
|
||||||
|
|
||||||
|
@ -133,7 +133,7 @@ The configuration will look like the example below:
|
|||||||
|
|
||||||
{% raw %}
|
{% raw %}
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
binary_sensor:
|
binary_sensor:
|
||||||
- platform: mqtt
|
- platform: mqtt
|
||||||
name: Bathroom
|
name: Bathroom
|
||||||
|
@ -15,10 +15,12 @@ ha_iot_class: "Local Polling"
|
|||||||
|
|
||||||
The `pilight` binary sensor platform implement the [pilight hub](/components/pilight/) binary sensor functionality. Two type of Pilight binary sensor configuration available. A normal sensor which send the on and off state cyclical and a trigger sensor which send only a trigger when an event happened (for example lots of cheap PIR motion detector).
|
The `pilight` binary sensor platform implement the [pilight hub](/components/pilight/) binary sensor functionality. Two type of Pilight binary sensor configuration available. A normal sensor which send the on and off state cyclical and a trigger sensor which send only a trigger when an event happened (for example lots of cheap PIR motion detector).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
To enable a Pilight binary sensor in your installation, add the following to your `configuration.yaml` file:
|
To enable a Pilight binary sensor in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
binary_sensor:
|
binary_sensor:
|
||||||
- platform: pilight
|
- platform: pilight
|
||||||
variable: 'state'
|
variable: 'state'
|
||||||
|
@ -14,20 +14,20 @@ ha_iot_class: "Local Polling"
|
|||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
The `modbus` thermostat allows you to use a sensor value (current temperature)
|
The `modbus` thermostat allows you to use a sensor value (current temperature) and target value (target temperature) from [Modbus](http://www.modbus.org/) registers.
|
||||||
and target value (target temperature) from [Modbus](http://www.modbus.org/)
|
|
||||||
registers.
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To use your Modbus thermostat in your installation, add the following to your `configuration.yaml` file:
|
To use your Modbus thermostat in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
climate:
|
climate:
|
||||||
- platform: modbus
|
- platform: modbus
|
||||||
name: Watlow F4T
|
name: Watlow F4T
|
||||||
slave: 1
|
slave: 1
|
||||||
target_temp_register: 2782
|
target_temp_register: 2782
|
||||||
current_temp_register: 27586
|
current_temp_register: 27586
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
@ -49,17 +49,18 @@ current_temp_register:
|
|||||||
type: int
|
type: int
|
||||||
data_type:
|
data_type:
|
||||||
description: Response representation (int, uint, float, custom). If float selected, value will converted to IEEE 754 floating point format.
|
description: Response representation (int, uint, float, custom). If float selected, value will converted to IEEE 754 floating point format.
|
||||||
Default float.
|
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
default: float
|
||||||
count:
|
count:
|
||||||
description: Number of registers to read.
|
description: Number of registers to read.
|
||||||
required: false
|
required: false
|
||||||
type: int
|
type: int
|
||||||
precision:
|
precision:
|
||||||
description: Number of valid decimals, default 0.
|
description: Number of valid decimals.
|
||||||
required: false
|
required: false
|
||||||
type: int
|
type: int
|
||||||
|
default: 0
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
|
||||||
|
@ -20,7 +20,7 @@ The `gogogate2` cover platform lets you control Gogogate2-Enabled garage doors t
|
|||||||
To use your Gogogate2 cover in your installation, add the following to your `configuration.yaml` file:
|
To use your Gogogate2 cover in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
cover:
|
cover:
|
||||||
- platform: gogogate2
|
- platform: gogogate2
|
||||||
username: email@email.com
|
username: email@email.com
|
||||||
|
@ -15,6 +15,8 @@ ha_release: 0.18
|
|||||||
|
|
||||||
The `mqtt` cover platform allows you to control an MQTT cover (such as blinds, a rollershutter, or a garage door).
|
The `mqtt` cover platform allows you to control an MQTT cover (such as blinds, a rollershutter, or a garage door).
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
The device state (`open` or `closed`) will be updated only after a new message is published on `state_topic` matching `state_open` or `state_closed`. If these messages are published with the `retain` flag set, the cover will receive an instant state update after subscription and Home Assistant will display the correct state on startup. Otherwise, the initial state displayed in Home Assistant will be `unknown`.
|
The device state (`open` or `closed`) will be updated only after a new message is published on `state_topic` matching `state_open` or `state_closed`. If these messages are published with the `retain` flag set, the cover will receive an instant state update after subscription and Home Assistant will display the correct state on startup. Otherwise, the initial state displayed in Home Assistant will be `unknown`.
|
||||||
|
|
||||||
There is an attribute that stores the relative position of the device, where 0 means the device is `closed` and all other intermediate positions means the device is `open`.
|
There is an attribute that stores the relative position of the device, where 0 means the device is `closed` and all other intermediate positions means the device is `open`.
|
||||||
@ -164,7 +166,7 @@ In this section you will find some real life examples of how to use this platfor
|
|||||||
The example below shows a full configuration for a cover without tilt.
|
The example below shows a full configuration for a cover without tilt.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
cover:
|
cover:
|
||||||
- platform: mqtt
|
- platform: mqtt
|
||||||
name: "MQTT Cover"
|
name: "MQTT Cover"
|
||||||
@ -188,8 +190,9 @@ cover:
|
|||||||
|
|
||||||
The example below shows a full configuration for a cover.
|
The example below shows a full configuration for a cover.
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
cover:
|
cover:
|
||||||
- platform: mqtt
|
- platform: mqtt
|
||||||
name: "MQTT Cover"
|
name: "MQTT Cover"
|
||||||
@ -206,7 +209,7 @@ cover:
|
|||||||
payload_available: "online"
|
payload_available: "online"
|
||||||
payload_not_available: "offline"
|
payload_not_available: "offline"
|
||||||
optimistic: false
|
optimistic: false
|
||||||
value_template: '{% raw %}{{ value.x }}{% endraw %}'
|
value_template: '{{ value.x }}'
|
||||||
tilt_command_topic: 'home-assistant/cover/tilt'
|
tilt_command_topic: 'home-assistant/cover/tilt'
|
||||||
tilt_status_topic: 'home-assistant/cover/tilt-state'
|
tilt_status_topic: 'home-assistant/cover/tilt-state'
|
||||||
tilt_min: 0
|
tilt_min: 0
|
||||||
@ -214,6 +217,7 @@ cover:
|
|||||||
tilt_closed_value: 70
|
tilt_closed_value: 70
|
||||||
tilt_opened_value: 180
|
tilt_opened_value: 180
|
||||||
```
|
```
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
To test, you can use the command line tool `mosquitto_pub` shipped with `mosquitto` or the `mosquitto-clients` package to send MQTT messages. This allows you to operate your cover manually:
|
To test, you can use the command line tool `mosquitto_pub` shipped with `mosquitto` or the `mosquitto-clients` package to send MQTT messages. This allows you to operate your cover manually:
|
||||||
|
|
||||||
|
@ -15,10 +15,12 @@ ha_iot_class: Cloud Polling
|
|||||||
|
|
||||||
The `myq` cover platform lets you control MyQ-Enabled garage doors through Home Assistant. Device names in Home Assistant are generated based on the names defined in your MyQ Device mobile app.
|
The `myq` cover platform lets you control MyQ-Enabled garage doors through Home Assistant. Device names in Home Assistant are generated based on the names defined in your MyQ Device mobile app.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To use your MyQ cover in your installation, add the following to your `configuration.yaml` file:
|
To use your MyQ cover in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
cover:
|
cover:
|
||||||
- platform: myq
|
- platform: myq
|
||||||
username: YOUR_USERNAME
|
username: YOUR_USERNAME
|
||||||
|
@ -15,6 +15,8 @@ ha_release: "0.10"
|
|||||||
|
|
||||||
The `fritz` platform offers presence detection by looking at connected devices to a [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) based router.
|
The `fritz` platform offers presence detection by looking at connected devices to a [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) based router.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
<p class='note warning'>
|
<p class='note warning'>
|
||||||
It might be necessary to install additional packages: <code>$ sudo apt-get install libxslt-dev libxml2-dev python3-lxml</code>
|
It might be necessary to install additional packages: <code>$ sudo apt-get install libxslt-dev libxml2-dev python3-lxml</code>
|
||||||
If you are working with the All-in-One installation, you may also need to execute also within your virtual environment the command <code> pip install lxml</code>; be patient this will take a while.</p>
|
If you are working with the All-in-One installation, you may also need to execute also within your virtual environment the command <code> pip install lxml</code>; be patient this will take a while.</p>
|
||||||
|
@ -23,7 +23,7 @@ for state in hass.states():
|
|||||||
To enable `discovery` in your installation, add the following to your `configuration.yaml` file:
|
To enable `discovery` in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
discoverable:
|
discoverable:
|
||||||
expose_password: yes
|
expose_password: yes
|
||||||
```
|
```
|
||||||
|
@ -15,6 +15,8 @@ ha_iot_class: depends
|
|||||||
|
|
||||||
The `mqtt` fan platform lets you control your MQTT enabled fans.
|
The `mqtt` fan platform lets you control your MQTT enabled fans.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT fan will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the fan will be `false` / `off`.
|
In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT fan will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the fan will be `false` / `off`.
|
||||||
|
|
||||||
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`).
|
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`).
|
||||||
@ -24,7 +26,7 @@ Optimistic mode can be forced even if a `state_topic` is available. Try to enabl
|
|||||||
To enable MQTT fans in your installation, add the following to your `configuration.yaml` file:
|
To enable MQTT fans in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
fan:
|
fan:
|
||||||
- platform: mqtt
|
- platform: mqtt
|
||||||
command_topic: "bedroom_fan/on/set"
|
command_topic: "bedroom_fan/on/set"
|
||||||
@ -155,7 +157,7 @@ In this section you find some real life examples of how to use this fan.
|
|||||||
The example below shows a full configuration for a MQTT fan.
|
The example below shows a full configuration for a MQTT fan.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
fan:
|
fan:
|
||||||
- platform: mqtt
|
- platform: mqtt
|
||||||
name: "Bedroom Fan"
|
name: "Bedroom Fan"
|
||||||
|
@ -35,21 +35,21 @@ fritzbox:
|
|||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
devices:
|
devices:
|
||||||
description: A list of Fritzbox devices.
|
description: A list of Fritzbox devices.
|
||||||
required: true
|
required: true
|
||||||
type: map
|
type: map
|
||||||
keys:
|
keys:
|
||||||
host:
|
host:
|
||||||
description: The hostname or IP address of the Fritzbox.
|
description: The hostname or IP address of the Fritzbox.
|
||||||
required: true
|
required: true
|
||||||
type: optional
|
type: optional
|
||||||
username:
|
username:
|
||||||
description: The username for Smart Home access.
|
description: The username for Smart Home access.
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
password:
|
password:
|
||||||
description: The password of the user.
|
description: The password of the user.
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
@ -15,10 +15,12 @@ ha_release: 0.47
|
|||||||
|
|
||||||
The `juicenet` sensor platform pulls data from a [JuiceNet](https://emotorwerks.com/products/juicenet/) charging station equipped with a wifi connection. It will access and make available all of the devices attached to your account.
|
The `juicenet` sensor platform pulls data from a [JuiceNet](https://emotorwerks.com/products/juicenet/) charging station equipped with a wifi connection. It will access and make available all of the devices attached to your account.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To enable the platform in your installation, add the following to your `configuration.yaml` file:
|
To enable the platform in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
juicenet:
|
juicenet:
|
||||||
access_token: ACCESS_TOKEN
|
access_token: ACCESS_TOKEN
|
||||||
```
|
```
|
||||||
|
@ -11,13 +11,14 @@ ha_category: Light
|
|||||||
ha_release: 0.51
|
ha_release: 0.51
|
||||||
---
|
---
|
||||||
|
|
||||||
The `mochad` light platform lets you control an X10 enabled dimmer/light
|
The `mochad` light platform lets you control an X10 enabled dimmer/light device.
|
||||||
device.
|
|
||||||
|
|
||||||
|
|
||||||
To enable this sensor, you first have to set up the [mochad component](/components/mochad/) and then add the following to your `configuration.yaml` file:
|
To enable this sensor, you first have to set up the [mochad component](/components/mochad/) and then add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
light:
|
light:
|
||||||
- platform: mochad
|
- platform: mochad
|
||||||
devices:
|
devices:
|
||||||
|
@ -14,6 +14,8 @@ ha_iot_class: depends
|
|||||||
|
|
||||||
The `mqtt` light platform lets you control your MQTT enabled lights. It supports setting brightness, color temperature, effects, flashing, on/off, RGB colors, transitions, XY colors and white values.
|
The `mqtt` light platform lets you control your MQTT enabled lights. It supports setting brightness, color temperature, effects, flashing, on/off, RGB colors, transitions, XY colors and white values.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the switch will be `false` / `off`.
|
In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the switch will be `false` / `off`.
|
||||||
|
|
||||||
When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from the device (message from `state_topic`).
|
When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from the device (message from `state_topic`).
|
||||||
@ -21,7 +23,7 @@ When a state topic is not available, the light will work in optimistic mode. In
|
|||||||
Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect light operation.
|
Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect light operation.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
light:
|
light:
|
||||||
- platform: mqtt
|
- platform: mqtt
|
||||||
command_topic: "office/rgb1/light/switch"
|
command_topic: "office/rgb1/light/switch"
|
||||||
@ -206,7 +208,7 @@ To enable a light with brightness and RGB support in your installation, add the
|
|||||||
|
|
||||||
{% raw %}
|
{% raw %}
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
light:
|
light:
|
||||||
- platform: mqtt
|
- platform: mqtt
|
||||||
name: "Office Light RGB"
|
name: "Office Light RGB"
|
||||||
@ -231,7 +233,7 @@ light:
|
|||||||
To enable a light with brightness (no RGB version) in your installation, add the following to your `configuration.yaml` file:
|
To enable a light with brightness (no RGB version) in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
light:
|
light:
|
||||||
- platform: mqtt
|
- platform: mqtt
|
||||||
name: "Office light"
|
name: "Office light"
|
||||||
@ -250,7 +252,7 @@ light:
|
|||||||
To enable a light that sends only brightness topics to turn it on, add the following to your `configuration.yaml` file. The `command_topic` is only used to send an off command in this case:
|
To enable a light that sends only brightness topics to turn it on, add the following to your `configuration.yaml` file. The `command_topic` is only used to send an off command in this case:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
light:
|
light:
|
||||||
- platform: mqtt
|
- platform: mqtt
|
||||||
name: "Brightness light"
|
name: "Brightness light"
|
||||||
|
@ -24,7 +24,7 @@ Optimistic mode can be forced, even if state topic is available. Try to enable i
|
|||||||
To enable MQTT locks in your installation, add the following to your `configuration.yaml` file:
|
To enable MQTT locks in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
lock:
|
lock:
|
||||||
- platform: mqtt
|
- platform: mqtt
|
||||||
command_topic: "home/frontdoor/set"
|
command_topic: "home/frontdoor/set"
|
||||||
|
@ -13,6 +13,8 @@ ha_release: 0.32
|
|||||||
|
|
||||||
The `mochad` component is the main component to integrate all X10 platforms being controlled by [mochad](https://sourceforge.net/projects/mochad/). Besides this component you will have to setup your X10 devices separately.
|
The `mochad` component is the main component to integrate all X10 platforms being controlled by [mochad](https://sourceforge.net/projects/mochad/). Besides this component you will have to setup your X10 devices separately.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To integrate your Mochad units with Home Assistant, add the following section to your `configuration.yaml` file:
|
To integrate your Mochad units with Home Assistant, add the following section to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
@ -20,10 +22,20 @@ To integrate your Mochad units with Home Assistant, add the following section to
|
|||||||
mochad:
|
mochad:
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
host:
|
||||||
|
description: The host that mochad is running on.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
default: localhost
|
||||||
|
port:
|
||||||
|
description: The port that mochad is running on.
|
||||||
|
required: false
|
||||||
|
type: int
|
||||||
|
default: 1099
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
- **host** (*Optional*): The host that mochad is running on. Defaults to `localhost`.
|
## {% linkable_title Example %}
|
||||||
- **port** (*Optional*): The port that mochad is running on. Defaults to `1099`.
|
|
||||||
|
|
||||||
A full configuration sample could look like the one below:
|
A full configuration sample could look like the one below:
|
||||||
|
|
||||||
|
@ -16,6 +16,8 @@ ha_iot_class: "Local Push"
|
|||||||
|
|
||||||
[Modbus](http://www.modbus.org/) is a serial communication protocol to control PLCs (Programmable logic controller). It currently supports sensors and switches which can be controlled over serial, TCP, and UDP connections.
|
[Modbus](http://www.modbus.org/) is a serial communication protocol to control PLCs (Programmable logic controller). It currently supports sensors and switches which can be controlled over serial, TCP, and UDP connections.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To add modbus to your installation, add the following to your `configuration.yaml` file:
|
To add modbus to your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
For a network connection:
|
For a network connection:
|
||||||
|
@ -19,6 +19,8 @@ This pilight hub connects to the [pilight-daemon](https://manual.pilight.org/pro
|
|||||||
|
|
||||||
The received and supported RF codes are put on the event bus of Home Assistant and are therefore directly usable by other components (e.g., automation). Additionally a send service is provided to send RF codes.
|
The received and supported RF codes are put on the event bus of Home Assistant and are therefore directly usable by other components (e.g., automation). Additionally a send service is provided to send RF codes.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To integrate pilight into Home Assistant, add the following section to your `configuration.yaml` file:
|
To integrate pilight into Home Assistant, add the following section to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
@ -14,10 +14,11 @@ ha_iot_class: "Local Polling"
|
|||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers
|
The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing` or `talking` with the phone numbers involved contained in the state attributes.
|
||||||
on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing`, or `talking` with the phone numbers involved contained in the state attributes.
|
|
||||||
It can also access the internal phone book of the router to look up the names corresponding to the phone numbers and store them in the state attributes.
|
It can also access the internal phone book of the router to look up the names corresponding to the phone numbers and store them in the state attributes.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To activate the call monitor on your Fritz!Box, dial #96\*5\* from any phone connected to it.
|
To activate the call monitor on your Fritz!Box, dial #96\*5\* from any phone connected to it.
|
||||||
|
|
||||||
To use the Fritz!Box call monitor in your installation, add the following to your `configuration.yaml` file:
|
To use the Fritz!Box call monitor in your installation, add the following to your `configuration.yaml` file:
|
||||||
@ -44,7 +45,7 @@ Configuration variables:
|
|||||||
The example below shows a full configuration for a call monitor with phone book support.
|
The example below shows a full configuration for a call monitor with phone book support.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
- platform: fritzbox_callmonitor
|
- platform: fritzbox_callmonitor
|
||||||
name: Phone
|
name: Phone
|
||||||
@ -61,8 +62,9 @@ sensor:
|
|||||||
|
|
||||||
This example shows how to send notifications whenever the sensor's state changes. You will get notified both when you receive a call and also when a call is placed.
|
This example shows how to send notifications whenever the sensor's state changes. You will get notified both when you receive a call and also when a call is placed.
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry.
|
# Example configuration.yaml entry.
|
||||||
automation:
|
automation:
|
||||||
- alias: "Notify about phone state"
|
- alias: "Notify about phone state"
|
||||||
trigger:
|
trigger:
|
||||||
@ -73,7 +75,7 @@ automation:
|
|||||||
data:
|
data:
|
||||||
title: "Phone"
|
title: "Phone"
|
||||||
message: >-
|
message: >-
|
||||||
{% raw %}{% if is_state("sensor.phone", "idle") %}
|
{% if is_state("sensor.phone", "idle") %}
|
||||||
Phone is idle
|
Phone is idle
|
||||||
{% elif is_state("sensor.phone", "dialing") %}
|
{% elif is_state("sensor.phone", "dialing") %}
|
||||||
Calling {{ states.sensor.phone.attributes.to_name }} ({{ states.sensor.phone.attributes.to }})
|
Calling {{ states.sensor.phone.attributes.to_name }} ({{ states.sensor.phone.attributes.to }})
|
||||||
@ -81,5 +83,6 @@ automation:
|
|||||||
Incoming call from {{ states.sensor.phone.attributes.from_name }} ({{ states.sensor.phone.attributes.from }})
|
Incoming call from {{ states.sensor.phone.attributes.from_name }} ({{ states.sensor.phone.attributes.from }})
|
||||||
{% else %}
|
{% else %}
|
||||||
Talking to {{ states.sensor.phone.attributes.with_name }} ({{ states.sensor.phone.attributes.with }})
|
Talking to {{ states.sensor.phone.attributes.with_name }} ({{ states.sensor.phone.attributes.with }})
|
||||||
{% endif %}{% endraw %}
|
{% endif %}
|
||||||
```
|
```
|
||||||
|
{% endraw %}
|
||||||
|
@ -15,19 +15,27 @@ ha_release: 0.47
|
|||||||
|
|
||||||
This `gitter` sensor allows one to monitor a [Gitter.im](https://gitter.im) chatroom for unread messages.
|
This `gitter` sensor allows one to monitor a [Gitter.im](https://gitter.im) chatroom for unread messages.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
Visit [Gitter Developer Apps](https://developer.gitter.im/apps) to retrieve your "Personal Access Token".
|
Visit [Gitter Developer Apps](https://developer.gitter.im/apps) to retrieve your "Personal Access Token".
|
||||||
|
|
||||||
To use a Gitter sensor in your installation, add the following to your `configuration.yaml` file:
|
To use a Gitter sensor in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
- platform: gitter
|
- platform: gitter
|
||||||
api_key: YOUR_API_TOKEN
|
api_key: YOUR_API_TOKEN
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
api_key:
|
||||||
- **api_key** (*Required*): Your Gitter.im API token.
|
description: Your Gitter.im API token.
|
||||||
- **room** (*Optional*): Gitter room to monitor. Defaults to `home-assistant/home-assistant`
|
required: true
|
||||||
|
type: string
|
||||||
|
room:
|
||||||
|
description: Gitter room to monitor.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
default: home-assistant/home-assistant
|
||||||
|
{% endconfiguration %}
|
||||||
|
@ -16,10 +16,12 @@ ha_iot_class: "Local Push"
|
|||||||
|
|
||||||
The `modbus` sensor allows you to gather data from [Modbus](http://www.modbus.org/) registers.
|
The `modbus` sensor allows you to gather data from [Modbus](http://www.modbus.org/) registers.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To use your Modbus sensors in your installation, add the following to your `configuration.yaml` file:
|
To use your Modbus sensors in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: modbus
|
platform: modbus
|
||||||
registers:
|
registers:
|
||||||
|
@ -16,6 +16,8 @@ ha_iot_class: depends
|
|||||||
|
|
||||||
This `mqtt` sensor platform uses the MQTT message payload as the sensor value. If messages in this `state_topic` are published with *RETAIN* flag, the sensor will receive an instant update with last known value. Otherwise, the initial state will be undefined.
|
This `mqtt` sensor platform uses the MQTT message payload as the sensor value. If messages in this `state_topic` are published with *RETAIN* flag, the sensor will receive an instant update with last known value. Otherwise, the initial state will be undefined.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To use your MQTT sensor in your installation, add the following to your `configuration.yaml` file:
|
To use your MQTT sensor in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
@ -16,6 +16,8 @@ ha_iot_class: depends
|
|||||||
|
|
||||||
The `mqtt_room` sensor platform allows you to detect the indoor location of devices using MQTT clients.
|
The `mqtt_room` sensor platform allows you to detect the indoor location of devices using MQTT clients.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
|
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
@ -16,6 +16,8 @@ ha_iot_class: "Cloud Polling"
|
|||||||
|
|
||||||
The `mvglive` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Munich public transport network. Additional details such as the line number and destination are present in the attributes.
|
The `mvglive` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Munich public transport network. Additional details such as the line number and destination are present in the attributes.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To enable this sensor, add the following lines to your `configuration.yaml` file:
|
To enable this sensor, add the following lines to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
@ -42,7 +44,7 @@ Configuration variables:
|
|||||||
The example below shows a full configuration with three sensors that showcase the various configuration options.
|
The example below shows a full configuration with three sensors that showcase the various configuration options.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
- platform: mvglive
|
- platform: mvglive
|
||||||
nextdeparture:
|
nextdeparture:
|
||||||
|
@ -16,10 +16,12 @@ ha_iot_class: "Local Polling"
|
|||||||
|
|
||||||
This `openevse` sensor platform pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based wifi connection.
|
This `openevse` sensor platform pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based wifi connection.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To enable this sensor in your installation, add the following to your `configuration.yaml` file:
|
To enable this sensor in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
- platform: openevse
|
- platform: openevse
|
||||||
host: IP_ADDRESS
|
host: IP_ADDRESS
|
||||||
|
@ -16,10 +16,12 @@ ha_iot_class: depends
|
|||||||
|
|
||||||
This `pilight` sensor platform for 433 MHz devices uses a value in the message payload as the sensor value. Unique identifiers (e.g., _uuid_) can be set to distinguish between multiple pilight devices. To use a pilight sensor the pilight Home Assistant hub has to be set up.
|
This `pilight` sensor platform for 433 MHz devices uses a value in the message payload as the sensor value. Unique identifiers (e.g., _uuid_) can be set to distinguish between multiple pilight devices. To use a pilight sensor the pilight Home Assistant hub has to be set up.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To use your sensor via pilight, make sure it is [supported](https://wiki.pilight.org/doku.php/protocols) and add the following to your `configuration.yaml` file:
|
To use your sensor via pilight, make sure it is [supported](https://wiki.pilight.org/doku.php/protocols) and add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
- platform: pilight
|
- platform: pilight
|
||||||
variable: temperature
|
variable: temperature
|
||||||
|
@ -16,10 +16,12 @@ ha_iot_class: "Local Polling"
|
|||||||
|
|
||||||
This `qnap` sensor allows getting various statistics from your [QNAP NAS](https://www.qnap.com/en-us/).
|
This `qnap` sensor allows getting various statistics from your [QNAP NAS](https://www.qnap.com/en-us/).
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To use the `qnap` sensor in your installation, add the following to your `configuration.yaml` file:
|
To use the `qnap` sensor in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
- platform: qnap
|
- platform: qnap
|
||||||
host: IP_ADDRESS_OF_QNAP_NAS
|
host: IP_ADDRESS_OF_QNAP_NAS
|
||||||
|
@ -15,10 +15,12 @@ ha_release: 0.47
|
|||||||
|
|
||||||
This `radarr` sensor platform pulls data from a given [Radarr](https://radarr.video/) instance.
|
This `radarr` sensor platform pulls data from a given [Radarr](https://radarr.video/) instance.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To use your Radarr sensor in your installation, add the following to your `configuration.yaml` file:
|
To use your Radarr sensor in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
- platform: radarr
|
- platform: radarr
|
||||||
api_key: YOUR_API_KEY
|
api_key: YOUR_API_KEY
|
||||||
|
@ -16,10 +16,12 @@ ha_iot_class: "Local Polling"
|
|||||||
|
|
||||||
This `sonarr` sensor platform pulls data from a given [Sonarr](https://sonarr.tv/) instance.
|
This `sonarr` sensor platform pulls data from a given [Sonarr](https://sonarr.tv/) instance.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To use your Sonarr sensor in your installation, add the following to your `configuration.yaml` file:
|
To use your Sonarr sensor in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
- platform: sonarr
|
- platform: sonarr
|
||||||
api_key: YOUR_API_KEY
|
api_key: YOUR_API_KEY
|
||||||
|
@ -16,10 +16,12 @@ ha_iot_class: "Local Polling"
|
|||||||
|
|
||||||
The `synologydsm` sensor platform allows getting various statistics from your [Synology NAS](https://www.synology.com).
|
The `synologydsm` sensor platform allows getting various statistics from your [Synology NAS](https://www.synology.com).
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To use the `synologydsm` sensor in your installation, add the following to your `configuration.yaml` file:
|
To use the `synologydsm` sensor in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
- platform: synologydsm
|
- platform: synologydsm
|
||||||
host: IP_ADDRESS_OF_SYNOLOGY_NAS
|
host: IP_ADDRESS_OF_SYNOLOGY_NAS
|
||||||
@ -33,7 +35,7 @@ sensor:
|
|||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
|
||||||
- **host** (*Required*): The IP address of the Synology NAS to monitor
|
- **host** (*Required*): The IP address of the Synology NAS to monitor.
|
||||||
- **port** (*Optional*): The port number on which the Synology NAS is reachable. Defaults to `5000`.
|
- **port** (*Optional*): The port number on which the Synology NAS is reachable. Defaults to `5000`.
|
||||||
- **username** (*Required*): An user to connect to the Synology NAS (a separate account is advised, see the Separate User Configuration section below for details).
|
- **username** (*Required*): An user to connect to the Synology NAS (a separate account is advised, see the Separate User Configuration section below for details).
|
||||||
- **password** (*Required*): The password of the user to connect to the Synology NAS.
|
- **password** (*Required*): The password of the user to connect to the Synology NAS.
|
||||||
|
@ -35,11 +35,21 @@ switch:
|
|||||||
password: YOUR_PASSWORD
|
password: YOUR_PASSWORD
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
username:
|
||||||
- **username** (*Required*): The username for your Fritz!Box.
|
description: The username for your Fritz!Box.
|
||||||
- **password** (*Required*): The password for your Fritz!Box.
|
required: true
|
||||||
- **host** (*Optional*): The IP address/hostname of your Fritz!Box. Defaults to `fritz.box`.
|
type: string
|
||||||
|
password:
|
||||||
|
description: The password for your Fritz!Box.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
host:
|
||||||
|
description: The IP address/hostname of your Fritz!Box.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
default: fritz.box
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
It is recommended to create a dedicated user for Home Assistant and only allow access to "Smart Home".
|
It is recommended to create a dedicated user for Home Assistant and only allow access to "Smart Home".
|
||||||
|
|
||||||
|
@ -14,10 +14,12 @@ ha_release: 0.32
|
|||||||
|
|
||||||
The `mochad` switch platform lets you control an X10 enabled switch device.
|
The `mochad` switch platform lets you control an X10 enabled switch device.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To enable this sensor, you first have to set up the [mochad component](/components/mochad/) and then add the following to your `configuration.yaml` file:
|
To enable this sensor, you first have to set up the [mochad component](/components/mochad/) and then add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
switch:
|
switch:
|
||||||
- platform: mochad
|
- platform: mochad
|
||||||
devices:
|
devices:
|
||||||
@ -31,3 +33,5 @@ Configuration variables:
|
|||||||
- **name** (*Optional*): The name of the switch. Default is: x10_switch_dev_*address*.
|
- **name** (*Optional*): The name of the switch. Default is: x10_switch_dev_*address*.
|
||||||
- **comm_type** (*Optional*): pl (powerline) or rf (radio frequency). Default is pl.
|
- **comm_type** (*Optional*): pl (powerline) or rf (radio frequency). Default is pl.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@ -16,10 +16,12 @@ ha_iot_class: "Local Push"
|
|||||||
|
|
||||||
The `modbus` switch platform allows you to control [Modbus](http://www.modbus.org/) coils or registers.
|
The `modbus` switch platform allows you to control [Modbus](http://www.modbus.org/) coils or registers.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To use your Modbus switches in your installation, add the following to your `configuration.yaml` file:
|
To use your Modbus switches in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
switch:
|
switch:
|
||||||
platform: modbus
|
platform: modbus
|
||||||
slave: 1
|
slave: 1
|
||||||
|
@ -15,6 +15,8 @@ ha_iot_class: depends
|
|||||||
|
|
||||||
The `mqtt` switch platform lets you control your MQTT enabled switches.
|
The `mqtt` switch platform lets you control your MQTT enabled switches.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT switch will receive an instant state update after subscription, and will start with the correct state. Otherwise, the initial state of the switch will be `false` / `off`.
|
In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT switch will receive an instant state update after subscription, and will start with the correct state. Otherwise, the initial state of the switch will be `false` / `off`.
|
||||||
|
|
||||||
When a `state_topic` is not available, the switch will work in optimistic mode. In this mode, the switch will immediately change state after every command. Otherwise, the switch will wait for state confirmation from the device (message from `state_topic`).
|
When a `state_topic` is not available, the switch will work in optimistic mode. In this mode, the switch will immediately change state after every command. Otherwise, the switch will wait for state confirmation from the device (message from `state_topic`).
|
||||||
@ -24,7 +26,7 @@ Optimistic mode can be forced, even if the `state_topic` is available. Try to en
|
|||||||
To enable this switch in your installation, add the following to your `configuration.yaml` file:
|
To enable this switch in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
switch:
|
switch:
|
||||||
- platform: mqtt
|
- platform: mqtt
|
||||||
command_topic: "home/bedroom/switch1/set"
|
command_topic: "home/bedroom/switch1/set"
|
||||||
@ -106,7 +108,7 @@ In this section you will find some real life examples of how to use this sensor.
|
|||||||
The example below shows a full configuration for a switch.
|
The example below shows a full configuration for a switch.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
switch:
|
switch:
|
||||||
- platform: mqtt
|
- platform: mqtt
|
||||||
name: "Bedroom Switch"
|
name: "Bedroom Switch"
|
||||||
@ -140,7 +142,7 @@ The configuration will look like the example below:
|
|||||||
|
|
||||||
{% raw %}
|
{% raw %}
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
switch:
|
switch:
|
||||||
- platform: mqtt
|
- platform: mqtt
|
||||||
name: bathroom
|
name: bathroom
|
||||||
|
@ -19,6 +19,8 @@ Additionally, RF commands can be defined that trigger this switch to turn on and
|
|||||||
|
|
||||||
To be really sure that Home Assistant knows the actual state of your device it is recommended to use the RF remote with codes unknown to any of your 433 MHz devices. Thus you use the remote to trigger this switch to send the correct RF code to the device.
|
To be really sure that Home Assistant knows the actual state of your device it is recommended to use the RF remote with codes unknown to any of your 433 MHz devices. Thus you use the remote to trigger this switch to send the correct RF code to the device.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To define a Pilight switch, add the following lines to your `configuration.yaml`:
|
To define a Pilight switch, add the following lines to your `configuration.yaml`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
@ -15,6 +15,8 @@ ha_iot_class: "Local Polling"
|
|||||||
|
|
||||||
The `wake_on_lan` (WOL) switch platform allows you to turn on a [WOL](https://en.wikipedia.org/wiki/Wake-on-LAN) enabled computer.
|
The `wake_on_lan` (WOL) switch platform allows you to turn on a [WOL](https://en.wikipedia.org/wiki/Wake-on-LAN) enabled computer.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
<p class='note warning'>
|
<p class='note warning'>
|
||||||
The WOL switch can only turn on your computer and monitor the state. There is no universal way to turn off a computer remotely. The `turn_off` variable is there to help you call a script when you have figured out how to remotely turn off your computer.
|
The WOL switch can only turn on your computer and monitor the state. There is no universal way to turn off a computer remotely. The `turn_off` variable is there to help you call a script when you have figured out how to remotely turn off your computer.
|
||||||
See below for suggestions on how to do this.
|
See below for suggestions on how to do this.
|
||||||
@ -23,7 +25,7 @@ See below for suggestions on how to do this.
|
|||||||
To enable this switch in your installation, add the following to your `configuration.yaml` file:
|
To enable this switch in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yaml entry
|
||||||
switch:
|
switch:
|
||||||
- platform: wake_on_lan
|
- platform: wake_on_lan
|
||||||
mac_address: "00-01-02-03-04-05"
|
mac_address: "00-01-02-03-04-05"
|
||||||
@ -42,7 +44,8 @@ Configuration variables:
|
|||||||
Here are some real life examples of how to use the **turn_off** variable.
|
Here are some real life examples of how to use the **turn_off** variable.
|
||||||
|
|
||||||
### {% linkable_title Suspending Linux %}
|
### {% linkable_title Suspending Linux %}
|
||||||
Suggested recipe for letting the turn_off script suspend a Linux computer (the **target**)
|
|
||||||
|
Suggested recipe for letting the `turn_off` script suspend a Linux computer (the **target**)
|
||||||
from Home Assistant running on another Linux computer (the **server**).
|
from Home Assistant running on another Linux computer (the **server**).
|
||||||
|
|
||||||
1. On the **server**, log in as the user account Home Assistant is running under. (I'm using `hass` in this example)
|
1. On the **server**, log in as the user account Home Assistant is running under. (I'm using `hass` in this example)
|
||||||
|
@ -61,12 +61,12 @@ __MQTT Sensors and Switches__
|
|||||||
[mqtt-switch]: /components/switch.mqtt/
|
[mqtt-switch]: /components/switch.mqtt/
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entr
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: mqtt
|
platform: mqtt
|
||||||
name: "MQTT Sensor"
|
name: "MQTT Sensor"
|
||||||
state_topic: "home/bedroom/temperature"
|
state_topic: "home/bedroom/temperature"
|
||||||
unit_of_measurement: "ºC"
|
unit_of_measurement: "°C"
|
||||||
|
|
||||||
switch:
|
switch:
|
||||||
platform: mqtt
|
platform: mqtt
|
||||||
|
Loading…
x
Reference in New Issue
Block a user