python-broadlink

To use the command line interface, you must first install the core broadlink module via pip, then obtain the broadlink_cli and broadlink_discovery programs.

1. Install the Python module: pip3 install broadlink
2. Download the broadlink_cli and broadlink_discovery binaries/programs.

Broadlink devices support learning modes to capture remote signals.

1. Enter Learning Mode

Send a 16-byte payload with command value 0x006a:

• 0x00: 0x03
• 0x01-0x0f: 0x00

2. Read Back Captured Data

Send a 16-byte payload with command value 0x006a:

• 0x00: 0x04
• 0x01-0x0f: 0x00

Processing the Response:

• Check byte 0x22 (little-endian 16-bit error code). If 0, a code was successfully captured.
• Decrypt the response from byte 0x38 onwards using the device's encryption key.
• The captured data starts at byte 0x04 of the decrypted payload.

To configure a new Broadlink device while it is in Access Point (AP) Mode, send a 136-byte packet as a UDP broadcast to 255.255.255.255 on port 80.

Packet Structure:

Universal remotes allow you to capture and replay IR or RF signals.

Learning Codes

• IR (Console): Use --learn to capture an IR code and display it in the console.
• RF (Console): Use --rfscanlearn to capture an RF code and display it in the console.
• IR (File): Use --learnfile <FILENAME> to save a captured IR code to a file.
• RF (File): Use --rfscanlearn --learnfile <FILENAME> to save a captured RF code to a file.

Sending Codes

• Raw Data: Use --send <DATA> to send a specific code string.
• From File: Use --send @<FILENAME> to send a code stored in a file.

To replay a captured signal, send a payload with command byte 0x006a using the following structure:

Note on IR Codes:

• Pulse lengths must be paired as ON, then OFF.
• Captured IR codes typically end with a constant OFF value of 0x00 0x0d 0x05 (~102ms).

RF learning is a multi-step process involving frequency sweeping and two-stage button presses.

1. Call sweep_frequency().
2. Point the remote and long press the button.
3. Verify frequency with check_frequency().
4. Call find_rf_packet().
5. Point the remote and short press the button.
6. Retrieve the packet with check_data().

You can exit the process early using cancel_sweep_frequency().

If the device is not already configured via the Broadlink app, you must put it into AP Mode (long press reset until blue LED blinks quickly, then long press again until it blinks slowly) and connect to the BroadlinkProv SSID. Then, use broadlink.setup() to connect it to your WiFi.

Security mode options:

• 0: none
• 1: WEP
• 2: WPA1
• 3: WPA2
• 4: WPA1/2

import broadlink
# Connect to SSID with WPA2 (mode 3)
broadlink.setup('myssid', 'mynetworkpass', 3)

# Advanced: specify broadcast address if setup fails
broadlink.setup('myssid', 'mynetworkpass', 3, ip_address='192.168.0.255')

To capture an IR code, enter learning mode, point your remote at the Broadlink device, and press the button. Then, retrieve the packet using check_data().

Note: Universal remotes with product ID 0x2712 do not require frequency sweeping; simply use enter_learning() and check_data().

Use pip3 to install the latest version of the broadlink module.

pip3 install broadlink

To communicate with a device, you must first obtain an authorization key.

1. Generate an 80-byte packet. The payload must include a 15-digit value (the device IMEI) at offset 0x04-0x12, a command value of 0x0065, and a NULL-terminated ASCII device name at offset 0x30.
2. Send the packet. The response will contain an encrypted payload starting at byte 0x38.
3. Decrypt the response using the default AES key and IV.

Decrypted Authorization Payload:

Use this Device ID and Device encryption key for all subsequent command packets.