1
0
mirror of https://github.com/mjg59/python-broadlink.git synced 2024-09-21 04:20:36 +02:00
Python module for controlling Broadlink RM2/3 (Pro) remote controls, A1 sensor platforms and SP2/3 smartplugs
Go to file
Daniel Høyer Iversen 1d6d8d2aee
Merge pull request #234 from pommi/cli-python3
broadlink_cli: python3 support
2019-04-25 09:39:40 +02:00
broadlink Update __init__.py 2019-01-08 16:47:31 +09:00
cli broadlink_cli: python3 support 2019-01-16 09:34:20 +01: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 Add energy option to broadlink_cli 2018-04-19 23:45:50 +03:00
requirements.txt Update requirements 2018-11-02 11:57:07 +01:00
setup.py Update vulnerable pycryptodome 2018-08-28 11:01:42 +02:00

Python control for Broadlink RM2 IR controllers

A simple Python API for controlling IR controllers from Broadlink. At present, the following devices are currently supported:

  • RM Pro (referred to as RM2 in the codebase)
  • A1 sensor platform devices are supported
  • RM3 mini IR blaster

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

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

Check energy consumption on a SmartPlug:

state = devices[0].get_energy()

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