No description
Find a file
Matthew Garrett c157860f0d Fix setup.py
2016-12-03 14:16:59 -08:00
broadlink Merge remote-tracking branch 'zenitraM/python3' 2016-12-03 14:16:32 -08:00
LICENSE Initial commit 2016-09-15 13:20:16 -07:00
protocol.md Update documentation to cover RF packets 2016-10-30 14:18:20 -07:00
README.md Updated SmartPlug commands - set_power() and check_power() 2016-11-18 00:19:02 +01:00
setup.py Fix setup.py 2016-12-03 14:16:59 -08:00

Python control for Broadlink RM2 IR controllers

A simple Python API for controlling IR controllers from Broadlink. 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 available devices on the local network:

import broadlink

devices = broadlink.discover(timeout=5)

Obtain the authentication key required for further communication:

devices[0].auth()

Enter learning mode:

devices[0].enter_learning()

Obtain an IR or RF packet while in learning mode:

ir_packet = devices[0].check_data()

(This will return None if the device does not have a packet to return)

Send an IR or RF 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()

Set power state on a SmartPlug SP2/SP3:

devices[0].set_power(True)

Check power state on a SmartPlug:

state = devices[0].check_power()