Skip to content

Commit 08b3fee

Browse files
jonnyairfrenck
authored andcommitted
Update switch.pilight.markdown to add variables and update links (home-assistant#4522)
* Update switch.pilight.markdown to add variables and update links The variables unitcode and programcode are missing from the variables-list, unitcode is mentioned in the text below but they should be listed as optional variables if they are in fact optional variables. furthermore the wiki-links to pilight are outdated, so i replaced the wiki.pilight.org links with manual.pilight,org links to their respective updated pages. * Update switch.pilight.markdown delete programcode * ✏️ Small improvements
1 parent b6258f5 commit 08b3fee

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

source/_components/switch.pilight.markdown

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,9 @@ ha_release: 0.26
1313
ha_iot_class: "Local Polling"
1414
---
1515

16-
1716
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.
1817

19-
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.
18+
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.
2019

2120
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.
2221

@@ -42,20 +41,21 @@ Configuration variables:
4241
- **[entry]** (*Required*): Name of the command switch. Multiple entries are possible.
4342
- **on_code** (*Required*): The code to turn the device on.
4443
- **off_code** (*Required*): The code to turn the device off.
45-
- **on_code_receive** (*Optional*): If given, this command will turn the switch on if it is received by Pilight.
46-
- **off_code_receive** (*Optional*): If given, this command will turn the switch off if it is received by Pilight.
44+
- **on_code_receive** (*Optional*): If given, this command will turn the switch on if it is received by pilight.
45+
- **off_code_receive** (*Optional*): If given, this command will turn the switch off if it is received by pilight.
4746
4847
Variables for the different codes (`on_code` and `off_code`):
4948

5049
- **protocol** (*Required*): Protocol to use, eg. `intertechno_old` or `daycom`.
5150
- **systemcode** (*Optional*): The systemcode of the device.
52-
- **unit** (*Optional*): The unit to use.
51+
- **unit** (*Optional*): The unit to use (is equivalent to `pilight-send --unit`).
52+
- **unitcode** (*Optional*): The unitcode to use (is equivalent to `pilight-send --unitcode`).
5353
- **id** (*Optional*): ID of the device
5454
- **state** (*Optional*): `'on'` or `'off'` has to be in apostrophes to be parsed correctly.
5555
- **'off'** (*Optional*): `1` or `0`
5656
- **'on'** (*Optional*): `1` or `0`
5757

58-
For possible code entries look at the [pilight API](https://www.pilight.org/development/api/). All commands allowed by [pilight-send](https://wiki.pilight.org/doku.php/psend) 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.
58+
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.
5959

6060
Variables for the different receive codes (`on_code_receive` and `off_code_receive`):
6161

0 commit comments

Comments
 (0)