mirror of https://github.com/mjg59/python-broadlink.git synced 2024-11-22 07:00:12 +01:00

Python module for controlling Broadlink RM2/3 (Pro) remote controls, A1 sensor platforms and SP2/3 smartplugs

Go to file

Matthew Garrett 60afb5164e Document packet format		2016-10-12 05:38:15 -07:00
broadlink	Attempt to handle timezones	2016-10-10 01:09:06 -07:00
LICENSE	Initial commit	2016-09-15 13:20:16 -07:00
protocol.md	Document packet format	2016-10-12 05:38:15 -07:00
README.md	Initial commit	2016-09-15 13:20:16 -07:00
setup.py	Initial commit	2016-09-15 13:20:16 -07:00

README.md

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) devices are supported and only one device per network will be used. There is currently no support for the cloud API.

Example use

Discover an available device on the local network:

import broadlink

device = broadlink.rm2()
device.discover()

Obtain the authentication key required for further communication:

device.auth()

Enter learning mode:

device.enter_learning()

Obtain an IR packet while in learning mode:

ir_packet = device.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)