Skip to content

Commit 5824285

Browse files
committed
Update broadlink docs
1 parent 61591bc commit 5824285

File tree

2 files changed

+32
-14
lines changed

2 files changed

+32
-14
lines changed

source/_components/sensor.broadlink.markdown

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,27 @@ ha_release: 0.35
1313
---
1414

1515

16-
The `broadlink` sensor platform let you monitor data from an RM2 and A1 E-air.
17-
There is currently no support for the cloud API.
16+
The `broadlink` sensor platform let you monitor data from an RM2 and A1 E-air. There is currently no support for the cloud API.
1817

18+
To enable it, add the following lines to your `configuration.yaml`:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
switch:
23+
- platform: broadlink
24+
host: IP_ADDRESS
25+
mac: 'MAC_ADDRESS'
26+
monitored_conditions:
27+
- 'temperature'
28+
```
1929
2030
Configuration options:
21-
- **name** (*Optional*): Default BL. Sensor name
22-
- **update_interval** (*Optional*): Default 300. Time in seconds to fetch data from sensors
31+
2332
- **host** (*Required*): The hostname/IP address to connect to.
2433
- **mac** (*Required*): Device mac address.
25-
- **timeout** (*Optional*): Timeout in seconds for the connection to the device
34+
- **name** (*Optional*): Default BL. Sensor name
35+
- **update_interval** (*Optional*): Time in seconds to fetch data from sensors. Default 300.
36+
- **timeout** (*Optional*): Timeout in seconds for the connection to the device.
2637
- **monitored_conditions** array (*Required*): States to monitor.
2738
- 'temperature'
2839
- 'humidity'
@@ -33,9 +44,10 @@ Configuration options:
3344
To set it up, add the following information to your `configuration.yaml` file:
3445

3546
Obtain sensor data from an A1:
47+
3648
```yaml
3749
sensor:
38-
platform: broadlink
50+
- platform: broadlink
3951
update_interval: 60
4052
host: IP_ADDRESS
4153
mac: 'MAC_ADDRESS'
@@ -48,21 +60,27 @@ sensor:
4860
```
4961

5062
Obtain temperature data from an RM2:
63+
5164
```yaml
5265
sensor:
53-
platform: broadlink
66+
- platform: broadlink
5467
update_interval: 60
5568
host: IP_ADDRESS
5669
mac: 'MAC_ADDRESS'
5770
monitored_conditions:
5871
- temperature
5972
```
6073

61-
**note**: The pycrypto library needs to be available on your platform.
62-
on a typical windows sysytem `pip install pycrypto` will fail, as a compiler needs to be installed.
74+
### {% linkable_title Microsoft Windows installation %}
6375

64-
The quickest way around this is to use a pre-built binary, e.g. from here:
65-
https://github.com/sfbahr/PyCrypto-Wheels
76+
<p class='note'>
77+
The pycrypto library needs to be available on your platform. On a typical windows sysytem `pip install pycrypto` will fail, as a compiler needs to be installed first.
78+
</p>
6679

67-
be sure to get the correct 64 or 32-bit binary for your system, the full commandline will look someting like this (64bit):
68-
`pip install --use-wheel --no-index --find-links=https://github.com/sfbahr/PyCrypto-Wheels/raw/master/pycrypto-2.6.1-cp35-none-win_amd64.whl pycrypto`
80+
The quickest way around this is to use a pre-built binary, e.g. from https://github.com/sfbahr/PyCrypto-Wheels
81+
82+
Be sure to get the correct 64 or 32-bit binary for your system, the full commandline will look something like the sample below for a 64-bit system:
83+
84+
```bash
85+
pip install --use-wheel --no-index --find-links=https://github.com/sfbahr/PyCrypto-Wheels/raw/master/pycrypto-2.6.1-cp35-none-win_amd64.whl pycrypto
86+
```

source/_components/switch.broadlink.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ switch:
2929
```
3030
3131
Configuration variables:
32+
3233
- **host** (*Required*): The hostname/IP address to connect to.
3334
- **mac** (*Required*): Device mac address.
3435
- **timeout** (*Optional*): Timeout in seconds for the connection to the device
@@ -39,7 +40,6 @@ Configuration variables:
3940
- **command_off** (*Required*): Base64 encoded packet from RM device to take for off.
4041
4142
42-
4343
How to obtain IR/RF packets?
4444
4545
Choose Call Service from the Developer Tools. Choose the service broadlink/learn_command from the list of Available services: and hit CALL SERVICE. Press the button on your remote with in 20 seconds. The packet will be printed in the log and as a persistent notification.

0 commit comments

Comments
 (0)