No description
Find a file
2018-11-25 23:58:33 +02:00
broadlink Get rf scan learning working in CLI tool (#87) 2018-01-30 07:50:51 +11:00
cli fixed --learnfile argument usage, so it works for both IR and RF 2018-11-25 23:58:33 +02:00
.gitignore Add new device support: Broadlink MP1 Smart power strip 2016-12-25 10:59:58 +00:00
LICENSE Initial commit 2016-09-15 13:20:16 -07:00
protocol.md Fix protocol description (#125) 2017-11-25 12:14:12 -08:00
README.md Experimental RF code 2017-11-25 12:38:57 -08:00
requirements.txt Create requirements.txt 2016-12-18 19:24:06 +01:00
setup.py Bump version 2017-11-25 12:21:48 -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

Setup a new device on your local wireless network:

  1. Put the device into AP Mode
  2. Long press the reset button until the blue LED is blinking quickly.
  3. Long press again until blue LED is blinking slowly.
  4. Manually connect to the WiFi SSID named BroadlinkProv.
  5. Run setup() and provide your ssid, network password (if secured), and set the security mode
  6. Security mode options are (0 = none, 1 = WEP, 2 = WPA1, 3 = WPA2, 4 = WPA1/2)
import broadlink

broadlink.setup('myssid', 'mynetworkpass', 3)

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()

Sweep RF frequencies:

devices[0].sweep_frequency()

Check whether a frequency has been found:

found = devices[0].check_frequency()

(This will return True if the RM has locked onto a frequency, False otherwise)

Attempt to learn an RF packet:

found = devices[0].find_rf_packet()

(This will return True if a packet has been found, False otherwise)

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()

Set power state for S1 on a SmartPowerStrip MP1:

devices[0].set_power(1, True)

Check power state on a SmartPowerStrip:

state = devices[0].check_power()

Learning RF packets

timeout = 10 devices[0].sweep_frequency()

Hold down the rf button

for i in range(0, timeout): found = devices[0].check_frequency() if found == True: break time.sleep(1)

Tap the rf button

for i in range(0, timeout): found = devices[0].find_rf_packet() if found == True: break time.sleep(1)

Obtain the code

code = devices[0].check_data()