SmartThings edge driver for Broadlink IR Remote

This is a driver for Samsung SmartThings home automation hubs, allowing a hub to find and control a Broadlink learning Infrared remote. It's a SmartThings "edge" driver (written in LUA, runs on the hub).

Limitations

⚠️ This is a very basic proof-of-concept. It was a hobby project when a firmware update stopped my TV supporting wake-on-lan reliably. It's only writen and tested with the single Broadlink device I had, and isn't particularly user-friendly.

• Only supports the Broadlink "RM mini 3" device
  Specifically, devices that report a deviceId listed in src/devicetypes.lua). Small protocol differences mean even similar-ish products such as the "RM4 mini" are unlikely to work without changes.
• Only supports discovery of a single Broadlink device on the network
• Remote codes must be entered in Broadlink's RawData format (which can be learned from a physical remote)
  Other formats you may find on the web (eg 'Pronto hex') are not accepted, and must be converted somehow if you don't learn from a real remote. The pronto2broadlink.py script can convert Pronto Hex to the Broadlink hex format.
• Probably riddled with bugs
• Unlikely to be maintained or extended
  I don't have the time or enthusiasm to add support for other devices, or get involved with fixing bugs you may find. If this works for you as you find it, or if you'd like to change and extend it, that's great.

Use

1. Install the driver to your SmartThings account. Either:
   1. Use the source here to compile your own driver
   2. Use invite url https://bestow-regional.api.smartthings.com/invite/Pw2D66Qadbj3 to add frostmar Shared Drivers channel to your hub; from the list of available drivers install driver Broadlink Remote
      ⚠️ Be aware there's no guarantee the driver from this channel will remain working for you!
2. In your SmartThings mobile app, Add a device → Scan
   A Broadlink Remote device will immediately be created (if a supported Broadlink IR remote is found on the local network)
   This is a parent device, use it's options to learn and display a remote code, and to create one or more "Virtual remote" devices to send remote codes.
3. In the app, select the new Broadlink Remote device to:
   • Use it's learn code button to put the Broadlink into learning mode, the next IR code received will be displayed
   • View the last IR code learned
     As of Dec 2023 it's not possible to copy values shown in the mobile app, so go to https://my.smartthings.com/ to copy a learned code from the device history on the web dashboard
   • Use it's NewVirtualRemoteDevice button to create a new child device. Each virtual remote device has a single momentary button, which can be configured to send a single remote code

Developers

This code is at a very basic proof-of-concept level. Please do fork/extend/improve. The Broadlink protocol is fairly similar for many different devices, with a few tweaks and testing the same approach could run different device types, as well as other remote models. See README_development for some notes.

Dependencies

Embeds encryption from the smartthings-edge branch of lua-lockbox - https://github.com/rtyle/lua-lockbox/blob/smartthings-edge/
Many thanks to Ross Tyler for the SmartThings-compatible fork of this useful libray.

Thanks to Mathew Garett for the excellent python-broadlink library and Broadlink protocol information, much of the code here is shamelessly based on it.

Thanks to Scott Kyle for the pronto2broadlink.py script to convert Pronto Hex remote codes into the Broadlink hex format.