This Python based web server provides REST interactivity with any local Broadlink RM* type IR/RF blasters.

NOTE: To connect your RM devices to your network without downloading the Broadlink mobile app, refer to the python-broadlink Example Use instructions.

Please read the Notes section before using. Refer to the API section to learn how this server can be used.

There are three objects that this application manages:

• Blasters are the Broadlink devices on your network which can transmit IR/RF signals
• Targets are aliases for the devices you want to control using blasters
• Commands are aliases for raw IR/RF commands

The basic process to use this app is:

1. Discover all blasters on your network by making a GET request on the /discoverblasters endpoint (this is done on app initialization so it's only required if the initial discovery failed or a new device gets added to the network). This will add them to the application's database. You can assign a friendly name to each one or use MAC/IP addresses to reference them after they have been discovered.
2. Create a target for every device you want to control using your blasters by making a PUT request on the /targets/<target_name> endpoint
3. For each target, you can either use a specific blaster to learn a command by making a PUT request on the /targets/<target_name>/commands/<command_name>?blaster_attr=<blaster_attr>&blaster_value=<blaster_value> endpoint and pressing the corresponding key on your remote while pointing at the blaster specified, or you can create a command from a base64 value if you already know the raw command by making a PUT request on the /targets/<target_name>/commands/<command_name>?value=<value> endpoint
4. Repeat 2 + 3 until all targets and commands have been added to the database.
5. From now on, you can reference blasters, targets, and commands by the aliases you created.

To create and start container: docker run -d --name broadlink_rm_rest --restart unless-stopped -p 8000:8000 -v </local/path/to/data>:/app/data raman325/broadlink-rm-rest

I have tested this on my Synology Diskstation NAS and have run into problems with my network configuration that prevented python-broadlink from being able to discover blasters. To resolve this problem, I switched from bridged network mode to host network mode by changing -p 8000:8000 in the above command to --network host.

1. Clone this repo.
2. cd broadlink-rm-rest/
3. Install dependencies via pip: pip3 install -r requirements.txt
4. cd app/
5. gunicorn -b 0.0.0.0:8000 app:app

Your databases will be available in the app/data folder.

To override the default values, add -e <NAME>=<VALUE> for each corresponding parameter name and value.

In the docker run command listed above, the DB files (commands.db and blasters.db) will be persisted in /local/path/to/data on your host server.

• An HTTP 200 OK will be returned if the call was successful.
• An HTTP 400 BAD REQUEST will be returned if a request was malformed or if a given resource was not found.
• An HTTP 409 CONFLICT will be returned if a request attempted to create/update a resource that conflicts with an existing resource.
• All responses are in JSON format.

1. The blasters and target/commands databases, blasters.db and commands.db, are independent files because they are completely unrelated. As long as you are using Broadlink RM* blasters, you can use the same commands.db for every instance of the application.
2. The database files are in SQLite3 format and can be hand edited if needed. I use SQLiteStudio.
3. To reset all settings/data, simply stop the container/app, delete the two .db files, and restart.
4. This was tested on an RM3 Mini but should theoretically support any RM device that python-broadlink does.

1. @mjg59 for python-broadlink
2. @falconry for falcon. This is my first REST app and falcon made it a breeze.
3. @coleifer for peewee which made persisting the data simple.
4. My wife for putting up with my late night/weekend experimentation.

1. Test cases
2. Authentication
3. Mechanism to export/import commands
4. Mechanism to share commands