maurice/snix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add support for multiple devices and update documentation

Browse source 
Add support for discovering more than one device on the network, and update
the documentation to describe that.
This commit is contained in:
Matthew Garrett 2016-10-30 14:16:40 -07:00
parent 69afd4ce52
commit 989009e21f
2 changed files with 109 additions and 70 deletions
Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -1,36 +1,45 @@
Python control for Broadlink RM2 IR controllers
===============================================
A simple Python API for controlling IR controllers from [Broadlink](http://www.ibroadlink.com/rm/). At present, only RM Pro (referred to as RM2 in the codebase) devices are supported and only one device per network will be used. There is currently no support for the cloud API.
A simple Python API for controlling IR controllers from [Broadlink](http://www.ibroadlink.com/rm/). At present, only RM Pro (referred to as RM2 in the codebase) and A1 sensor platform devices are supported. There is currently no support for the cloud API.
Example use
-----------
Discover an available device on the local network:
Discover available devices on the local network:
```
import broadlink
device = broadlink.rm2()
device.discover()
devices = broadlink.discover(timeout=5)
```
Obtain the authentication key required for further communication:
```
device.auth()
devices[0].auth()
```
Enter learning mode:
```
device.enter_learning()
devices[0].enter_learning()
```
Obtain an IR packet while in learning mode:
```
ir_packet = device.check_data()
ir_packet = devices[0].check_data()
```
(This will return None if the device does not have a packet to return)
Send an IR packet:
```
device.send_data(ir_packet)
devices[0].send_data(ir_packet)
```
Obtain temperature data from an RM2:
```
devices[0].check_temperature()
```
Obtain sensor data from an A1:
```
data = devices[0].check_sensors()
```