mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 17:27:19 +00:00
🚜 Merges/Redirect Pilight component pages (#8812)
* 🚜 Merges/Redirect Pilight component pages * ✏️ Tweak
This commit is contained in:
Klaas Schoute
Fabian Affolter
parent
8176b27319
commit
ea5ed13255
@ -1,85 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Pilight Binary Sensor"
|
||||
description: "Instructions on how to integrate Pilight binary sensors within Home Assistant."
|
||||
date: 2017-03-24 20:41
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: pilight.png
|
||||
ha_category: DIY
|
||||
ha_release: 0.44
|
||||
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).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable a Pilight binary sensor in your installation,
|
||||
add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
binary_sensor:
|
||||
- platform: pilight
|
||||
variable: 'state'
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
variable:
|
||||
description: The variable name in the data stream that defines the sensor value.
|
||||
required: true
|
||||
type: string
|
||||
payload:
|
||||
description: >
|
||||
Message payload identifiers.
|
||||
Only if all identifiers are matched the sensor value is set.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: Name of the sensor.
|
||||
required: false
|
||||
type: string
|
||||
payload_on:
|
||||
description: "Variable `on` value. The component will recognize this as logical '1'."
|
||||
required: false
|
||||
type: [string, float, integer]
|
||||
payload_off:
|
||||
description: "Variable `off` value. The component will recognize this as logical '0'."
|
||||
required: false
|
||||
type: [string, float, integer]
|
||||
disarm_after_trigger:
|
||||
description: Configure sensor as trigger type.
|
||||
required: false
|
||||
type: boolean
|
||||
reset_delay_sec:
|
||||
description: >
|
||||
Seconds before the sensor is disarmed if
|
||||
`disarm_after_trigger` is set to true.
|
||||
required: false
|
||||
type: integer
|
||||
default: 30
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Full example %}
|
||||
|
||||
A full configuration example could look like this:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
binary_sensor:
|
||||
- platform: pilight
|
||||
name: 'Motion'
|
||||
variable: 'state'
|
||||
payload:
|
||||
unitcode: 371399
|
||||
payload_on: 'closed'
|
||||
disarm_after_trigger: true
|
||||
reset_delay_sec: 30
|
||||
```
|
||||
@ -8,9 +8,17 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: pilight.png
|
||||
ha_category: DIY
|
||||
ha_category:
|
||||
- DIY
|
||||
- Binary Sensor
|
||||
- Sensor
|
||||
- Switch
|
||||
ha_release: 0.26
|
||||
ha_iot_class: "Local Push"
|
||||
redirect_from:
|
||||
- /components/binary_sensor.pilight/
|
||||
- /components/sensor.pilight/
|
||||
- /components/switch.pilight/
|
||||
---
|
||||
|
||||
[Pilight](https://www.pilight.org/) is a modular and open source solution to communicate with 433 MHz devices and runs on various small form factor computers. A lot of common [protocols](https://manual.pilight.org/protocols/index.html) are already available.
|
||||
@ -19,6 +27,12 @@ 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.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Binary Sensor](#binary-sensor)
|
||||
- [Sensor](#sensor)
|
||||
- [Switch](#switch)
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To integrate pilight into Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
@ -68,6 +82,237 @@ pilight:
|
||||
- 42
|
||||
```
|
||||
|
||||
## {% linkable_title Binary Sensor %}
|
||||
|
||||
The `pilight` binary sensor platform implement the [pilight hub](#configuration) 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:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
binary_sensor:
|
||||
- platform: pilight
|
||||
variable: 'state'
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
variable:
|
||||
description: The variable name in the data stream that defines the sensor value.
|
||||
required: true
|
||||
type: string
|
||||
payload:
|
||||
description: >
|
||||
Message payload identifiers.
|
||||
Only if all identifiers are matched the sensor value is set.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: Name of the sensor.
|
||||
required: false
|
||||
type: string
|
||||
payload_on:
|
||||
description: "Variable `on` value. The component will recognize this as logical '1'."
|
||||
required: false
|
||||
type: [string, float, integer]
|
||||
payload_off:
|
||||
description: "Variable `off` value. The component will recognize this as logical '0'."
|
||||
required: false
|
||||
type: [string, float, integer]
|
||||
disarm_after_trigger:
|
||||
description: Configure sensor as trigger type.
|
||||
required: false
|
||||
type: boolean
|
||||
reset_delay_sec:
|
||||
description: >
|
||||
Seconds before the sensor is disarmed if
|
||||
`disarm_after_trigger` is set to true.
|
||||
required: false
|
||||
type: integer
|
||||
default: 30
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Full example %}
|
||||
|
||||
A full configuration example could look like this:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
binary_sensor:
|
||||
- platform: pilight
|
||||
name: 'Motion'
|
||||
variable: 'state'
|
||||
payload:
|
||||
unitcode: 371399
|
||||
payload_on: 'closed'
|
||||
disarm_after_trigger: true
|
||||
reset_delay_sec: 30
|
||||
```
|
||||
|
||||
## {% linkable_title Sensor %}
|
||||
|
||||
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.
|
||||
|
||||
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
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: pilight
|
||||
variable: temperature
|
||||
payload:
|
||||
uuid: '0000-b8-27-eb-f447d3'
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
variable:
|
||||
description: The variable name in the data stream that defines the sensor value.
|
||||
required: true
|
||||
type: string
|
||||
payload:
|
||||
description: Message payload identifiers. Only if all identifiers are matched the sensor value is set.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: Name of the sensor.
|
||||
required: false
|
||||
default: Pilight Sensor
|
||||
type: string
|
||||
unit_of_measurement:
|
||||
description: Defines the units of measurement of the sensor, if any.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Example: Weather station %}
|
||||
|
||||
This section shows a real life example how to use values of a weather station.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: pilight
|
||||
name: 'Temperature'
|
||||
variable: 'temperature'
|
||||
payload:
|
||||
uuid: 0000-b8-27-eb-f1f72e
|
||||
unit_of_measurement: '°C'
|
||||
- platform: pilight
|
||||
name: 'Humidity'
|
||||
variable: 'humidity'
|
||||
payload:
|
||||
uuid: 0000-b8-27-eb-f1f72e
|
||||
unit_of_measurement: '%'
|
||||
- platform: pilight
|
||||
name: 'Battery'
|
||||
variable: 'battery'
|
||||
payload:
|
||||
uuid: 0000-b8-27-eb-f1f72e
|
||||
unit_of_measurement: '%'
|
||||
```
|
||||
|
||||
## {% linkable_title Switch %}
|
||||
|
||||
The `pilight` switch platform is issuing 433 MHz commands using [pilight](https://www.pilight.org/) to turn a 433 MHz device on or off. The Pilight Home Assistant hub has to be set up.
|
||||
|
||||
Additionally, RF commands can be defined that trigger this switch to turn on and off. This allows you to also use the remote shipped with your 433 MHz switch without mixing up the Home Assistant states. You can even define several on/off commands, thus several RF remotes to toggle this switch.
|
||||
|
||||
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 define a Pilight switch, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
- platform: pilight
|
||||
switches:
|
||||
Bed light:
|
||||
on_code:
|
||||
protocol: intertechno_old
|
||||
'on': 1
|
||||
off_code:
|
||||
protocol: intertechno_old
|
||||
'off': 1
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
switches:
|
||||
description: The list that contains all command switches.
|
||||
required: true
|
||||
type: string
|
||||
keys:
|
||||
entry:
|
||||
description: Name of the command switch. Multiple entries are possible.
|
||||
required: true
|
||||
type: list
|
||||
keys:
|
||||
on_code:
|
||||
description: The code to turn the device on.
|
||||
required: true
|
||||
type: list
|
||||
off_code:
|
||||
description: The code to turn the device off.
|
||||
required: true
|
||||
type: list
|
||||
on_code_receive:
|
||||
description: If given, this command will turn the switch on if it is received by pilight.
|
||||
required: false
|
||||
type: list
|
||||
off_code_receive:
|
||||
description: If given, this command will turn the switch off if it is received by pilight.
|
||||
required: false
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
Variables for the different codes (`on_code` and `off_code`):
|
||||
|
||||
- **protocol** (*Required*): Protocol to use, e.g., `intertechno_old` or `daycom`.
|
||||
- **systemcode** (*Optional*): The systemcode of the device.
|
||||
- **unit** (*Optional*): The unit to use (is equivalent to `pilight-send --unit`).
|
||||
- **unitcode** (*Optional*): The unitcode to use (is equivalent to `pilight-send --unitcode`).
|
||||
- **id** (*Optional*): ID of the device
|
||||
- **state** (*Optional*): `'on'` or `'off'` has to be in apostrophes to be parsed correctly.
|
||||
- **'off'** (*Optional*): `1` or `0`
|
||||
- **'on'** (*Optional*): `1` or `0`
|
||||
|
||||
For possible code entries, look at the [pilight API](https://manual.pilight.org/development/api.html). All commands allowed by [pilight-send](https://manual.pilight.org/programs/send.html) can be used. Which means that if, for a certain protocol, there are different parameters used, you should be able to replace the variables above by the proper ones required by the specific protocol. When using the `elro_800_switch` or `mumbi` protocol, for example, you will have to replace the variable `unit` with `unitcode` or there will be errors occurring.
|
||||
|
||||
Variables for the different receive codes (`on_code_receive` and `off_code_receive`):
|
||||
|
||||
- **echo** (*Optional*) Set to `true` if the on-/off-code should be sent if the given code was received.
|
||||
|
||||
This is useful if you have paired your sender directly with the receiver to prevent sending the signal twice.
|
||||
|
||||
### {% linkable_title Examples %}
|
||||
|
||||
```yaml
|
||||
switch:
|
||||
- platform: pilight
|
||||
switches:
|
||||
Bed light:
|
||||
on_code:
|
||||
protocol: intertechno_old
|
||||
unit: 3
|
||||
id: 4
|
||||
'on': 1
|
||||
off_code:
|
||||
protocol: intertechno_old
|
||||
unit: 3
|
||||
id: 4
|
||||
'off': 1
|
||||
on_code_receive:
|
||||
protocol: daycom
|
||||
systemcode: 14462
|
||||
unit: 6
|
||||
id: 34
|
||||
state: 'on'
|
||||
off_code_receive:
|
||||
protocol: daycom
|
||||
systemcode: 14462
|
||||
unit: 6
|
||||
id: 34
|
||||
state: 'off'
|
||||
```
|
||||
|
||||
## {% linkable_title Troubleshooting %}
|
||||
|
||||
- A list of tested RF transceiver hardware is available [here](https://manual.pilight.org/electronics/index.html). This might be useful before buying.
|
||||
|
||||
@ -1,76 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Pilight Sensor"
|
||||
description: "Instructions on how to integrate pilight sensors within Home Assistant."
|
||||
date: 2016-10-08 23:21
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: pilight.png
|
||||
ha_category: DIY
|
||||
ha_release: 0.31
|
||||
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.
|
||||
|
||||
## {% 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:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: pilight
|
||||
variable: temperature
|
||||
payload:
|
||||
uuid: '0000-b8-27-eb-f447d3'
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
variable:
|
||||
description: The variable name in the data stream that defines the sensor value.
|
||||
required: true
|
||||
type: string
|
||||
payload:
|
||||
description: Message payload identifiers. Only if all identifiers are matched the sensor value is set.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: Name of the sensor.
|
||||
required: false
|
||||
default: Pilight Sensor
|
||||
type: string
|
||||
unit_of_measurement:
|
||||
description: Defines the units of measurement of the sensor, if any.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Example: Weather station %}
|
||||
|
||||
This section shows a real life example how to use values of a weather station.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: pilight
|
||||
name: 'Temperature'
|
||||
variable: 'temperature'
|
||||
payload:
|
||||
uuid: 0000-b8-27-eb-f1f72e
|
||||
unit_of_measurement: '°C'
|
||||
- platform: pilight
|
||||
name: 'Humidity'
|
||||
variable: 'humidity'
|
||||
payload:
|
||||
uuid: 0000-b8-27-eb-f1f72e
|
||||
unit_of_measurement: '%'
|
||||
- platform: pilight
|
||||
name: 'Battery'
|
||||
variable: 'battery'
|
||||
payload:
|
||||
uuid: 0000-b8-27-eb-f1f72e
|
||||
unit_of_measurement: '%'
|
||||
```
|
||||
@ -1,117 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Pilight Switch"
|
||||
description: "Instructions on how to have switches using 433 MHz connected to a computer running pilight."
|
||||
date: 2015-06-10 22:41
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: pilight.png
|
||||
ha_category: DIY
|
||||
ha_release: 0.26
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `pilight` switch platform is issuing 433 MHz commands using [pilight](https://www.pilight.org/) to turn a 433 MHz device on or off. The Pilight Home Assistant hub has to be set up.
|
||||
|
||||
Additionally, RF commands can be defined that trigger this switch to turn on and off. This allows you to also use the remote shipped with your 433 MHz switch without mixing up the Home Assistant states. You can even define several on/off commands, thus several RF remotes to toggle this switch.
|
||||
|
||||
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`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
- platform: pilight
|
||||
switches:
|
||||
Bed light:
|
||||
on_code:
|
||||
protocol: intertechno_old
|
||||
'on': 1
|
||||
off_code:
|
||||
protocol: intertechno_old
|
||||
'off': 1
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
switches:
|
||||
description: The list that contains all command switches.
|
||||
required: true
|
||||
type: string
|
||||
keys:
|
||||
entry:
|
||||
description: Name of the command switch. Multiple entries are possible.
|
||||
required: true
|
||||
type: list
|
||||
keys:
|
||||
on_code:
|
||||
description: The code to turn the device on.
|
||||
required: true
|
||||
type: list
|
||||
off_code:
|
||||
description: The code to turn the device off.
|
||||
required: true
|
||||
type: list
|
||||
on_code_receive:
|
||||
description: If given, this command will turn the switch on if it is received by pilight.
|
||||
required: false
|
||||
type: list
|
||||
off_code_receive:
|
||||
description: If given, this command will turn the switch off if it is received by pilight.
|
||||
required: false
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
Variables for the different codes (`on_code` and `off_code`):
|
||||
|
||||
- **protocol** (*Required*): Protocol to use, e.g., `intertechno_old` or `daycom`.
|
||||
- **systemcode** (*Optional*): The systemcode of the device.
|
||||
- **unit** (*Optional*): The unit to use (is equivalent to `pilight-send --unit`).
|
||||
- **unitcode** (*Optional*): The unitcode to use (is equivalent to `pilight-send --unitcode`).
|
||||
- **id** (*Optional*): ID of the device
|
||||
- **state** (*Optional*): `'on'` or `'off'` has to be in apostrophes to be parsed correctly.
|
||||
- **'off'** (*Optional*): `1` or `0`
|
||||
- **'on'** (*Optional*): `1` or `0`
|
||||
|
||||
For possible code entries, look at the [pilight API](https://manual.pilight.org/development/api.html). All commands allowed by [pilight-send](https://manual.pilight.org/programs/send.html) can be used. Which means that if, for a certain protocol, there are different parameters used, you should be able to replace the variables above by the proper ones required by the specific protocol. When using the `elro_800_switch` or `mumbi` protocol, for example, you will have to replace the variable `unit` with `unitcode` or there will be errors occurring.
|
||||
|
||||
Variables for the different receive codes (`on_code_receive` and `off_code_receive`):
|
||||
|
||||
- **echo** (*Optional*) Set to `true` if the on-/off-code should be sent if the given code was received.
|
||||
|
||||
This is useful if you have paired your sender directly with the receiver to prevent sending the signal twice.
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
```yaml
|
||||
switch:
|
||||
- platform: pilight
|
||||
switches:
|
||||
Bed light:
|
||||
on_code:
|
||||
protocol: intertechno_old
|
||||
unit: 3
|
||||
id: 4
|
||||
'on': 1
|
||||
off_code:
|
||||
protocol: intertechno_old
|
||||
unit: 3
|
||||
id: 4
|
||||
'off': 1
|
||||
on_code_receive:
|
||||
protocol: daycom
|
||||
systemcode: 14462
|
||||
unit: 6
|
||||
id: 34
|
||||
state: 'on'
|
||||
off_code_receive:
|
||||
protocol: daycom
|
||||
systemcode: 14462
|
||||
unit: 6
|
||||
id: 34
|
||||
state: 'off'
|
||||
```
|
||||
Loading…
x
Reference in New Issue
Block a user