Simple Microservice to control 433Mhz wireless sockets over HTTP, e.g. on a RaspberryPi

Last update: Jan 09, 2022

Overview

REST-light is a simple microservice to control 433Mhz wireless sockets over HTTP, e.g. on a RaspberryPi. The main usage is an easy integration of 433Mhz wireless sockets in SmartHome Tools like openHAB or ioBroker.

The project is an API-Wrapper around the famous 443Utils project.

How to Use

The setup is very simple. There is nothing to configure, except running the container. For the app to be able to persist the API-Key, ensure the mounted volume is writeable for UID/GID 33.

Install Docker on your RaspberryPi
Attach a 433Mhz transmitter to WiringPi Pin 2 of your RaspberryPi
Run REST-light and receive the generated API-Key from docker logs on first startup.
Try your first request! For an example, see section "curl request example"

GPIO access

For the app to be able to use the Pi's GPIO-PINs, they need to be exposed to the container. There are multiple options to do this, as explained here.

From the ones available, i had the best experience using the "device-approach" as stated below.

docker run

docker run -d --device /dev/gpiomem -v <your-path>/rest-light:/etc/rest-light -p 4242:4242 uupascal/rest-light:DEV-latest

docker-compose

version: "3.8"

services:
  rest-light:
    container_name: REST-light
    image: "uupascal/rest-light:latest"
    restart: unless-stopped
    volumes:
        - "<your-path>/rest-light:/etc/rest-light"
    devices:
        - /dev/gpiomem
    ports:
        - 4242

curl request example

curl http://127.0.0.1:4242/send \
    --data-urlencode "api_key=<key from docker logs>" \
    --data-urlencode "system_code=10000" \
    --data-urlencode "unit_code=2" \
    --data-urlencode "state=0" 

curl http://127.0.0.1:4242/codesend \
    --data-urlencode "api_key=<key from docker logs>" \
    --data-urlencode "decimalcode=500000"

Security considerations

Although this project was developed with current security best-practices in mind, it is still built around software which was not updated for at least 6 years. I would therefor strongly encourage you to only use this container on private & trusted networks and to never expose it to the internet. As the license implies, this software is provided without warranty of any kind.

Versioning & docker tags

Use the docker tag latest to always get the latest stable image.

The images are also tagged with the current timestamp, so to pin to a static version, you can for example use the tag 2022.01.09-1746.

Unstable/Development versions are prefixed with DEV- and should only be used for testing purposes.

Contribution

We love your input! For details see CONTRIBUTING.md

Credits

The project relies on 443Utils.

A script for performing OTA update over BLE on ESP32

18 Dec 15, 2022

Python code written to utilize the Korlan usb2can hardware to send and receive data over the can-bus on a 2008 Nissan 350z

nissan_ecu_hacking Python code written to utilize the Korlan usb2can hardware to send and receive data over the can-bus on a 2008 Nissan 350z My goal

11 Sep 24, 2022

Ingeniamotion is a library that works over ingenialink and aims to simplify the interaction with Ingenia's drives.

Ingeniamotion Ingeniamotion is a library that works over ingenialink and aims to simplify the interaction with Ingenia's drives. Requirements Python 3

7 Dec 15, 2022

ESP32 recording button presses, and serving webpage that graphs the numbers over time.

ESP32-IoT-button-graph-test ESP32 recording button presses, and serving webpage via webSockets in order to graph the responses. The objective was to t

1 Nov 30, 2021

Iec62056-21-mqtt - Publish DSMR P1 telegrams acquired over IEC62056-21 to MQTT

IEC 62056-21 Publish DSMR P1 telegrams acquired over IEC62056-21 to MQTT. -21 is

1 Jun 5, 2022

Quasi-static control of the centroid of quadruped robot

Quasi-static control of quadruped robot 　　This is a demo of the quasi-static controller for the centroid of the quadruped robot. The Quadratic Program

21 Dec 12, 2022

raspberry pi servo control using pca9685

RPi_servo-control_pca9685 raspberry pi 180° servo control using pca9685 Requirements Requires you to have the adafruit servokit library installed You

1 Jan 10, 2022

I made this so I can control my Tapo L510 light bulb and Govee H6159 light strip using the PyP100 module and the Govee public API

TAPO-And-Govee-Controller I made this so I can control my Tapo L510 light bulb and Govee H6159 light strip using the PyP100 module and the Govee publi

0 Nov 23, 2021

Alarm Control Panel component for Zigbee Keypads using action_transaction field

hass_transaction_alarm_panel Alarm Control Panel component for Zigbee Keypads using action_transaction field. Works together with zigbee2mqtt Supporte

4 Jun 9, 2022

Comments

Missing parameters for codesend
Hello Pascal,

codesend from 433Utils uses some optional paramters which can't be passed with REST-light:

unsigned long code = strtoul(argv[1], &eptr, 10); if (argc >= 3) protocol = atoi(argv[2]); if (argc >= 4) pulseLength = atoi(argv[3]); if (argc >= 5) bitLength = atoi(argv[4]);

https://github.com/ninjablocks/433Utils/blob/master/RPi_utils/codesend.cpp

In my case a pulseLength of 150 is needed to get things working. Can you please add the optional parameters?
opened by Yordan1976 0

Releases(2022.01.16-0801)

2022.01.16-0801(Jan 16, 2022)

Automatically created release for push in main: added compatibility for JSON requests
Source code(tar.gz)
Source code(zip)
2022.01.09-1950(Jan 9, 2022)

Automatically created release for push: in main improve logging & performance
Source code(tar.gz)
Source code(zip)
2022.01.09-1810(Jan 9, 2022)

Automatically created release for pushs in main
Source code(tar.gz)
Source code(zip)
2022.01.09-1746(Jan 9, 2022)

Automatically created release for pushs in main
Source code(tar.gz)
Source code(zip)

Simple Microservice to control 433Mhz wireless sockets over HTTP, e.g. on a RaspberryPi

Related tags

Overview

How to Use

GPIO access

docker run

docker-compose

curl request example

Security considerations

Versioning & docker tags

Contribution

Credits

You might also like...

A script for performing OTA update over BLE on ESP32

Python code written to utilize the Korlan usb2can hardware to send and receive data over the can-bus on a 2008 Nissan 350z

Ingeniamotion is a library that works over ingenialink and aims to simplify the interaction with Ingenia's drives.

ESP32 recording button presses, and serving webpage that graphs the numbers over time.

Iec62056-21-mqtt - Publish DSMR P1 telegrams acquired over IEC62056-21 to MQTT

Quasi-static control of the centroid of quadruped robot

raspberry pi servo control using pca9685

I made this so I can control my Tapo L510 light bulb and Govee H6159 light strip using the PyP100 module and the Govee public API

Alarm Control Panel component for Zigbee Keypads using action_transaction field

Comments

Missing parameters for codesend

Releases(2022.01.16-0801)

2022.01.16-0801(Jan 16, 2022)

2022.01.09-1950(Jan 9, 2022)

2022.01.09-1810(Jan 9, 2022)

2022.01.09-1746(Jan 9, 2022)

Owner

Pascal Höhnel

Scapy: the Python-based interactive packet manipulation program & library. Supports Python 2 & Python 3.

Python module for controlling Broadlink RM2/3 (Pro) remote controls, A1 sensor platforms and SP2/3 smartplugs

Nordpool_diff custom integration for Home Assistant

Automate gate/garage door opening via 433.92MHz emitter with Raspberry Pi, Home Assistant and Homekit.

Python library to interact with the GCE Electronics IPX800 device

SALUS THERMOSTAT Custom component for Home-Assistant

Real-time Coastal Monitoring at the University of Hawaii at Manoa

LedFx is a network based LED effect controller with support for advanced real-time audio effects

CircuitPython Driver for Adafruit 24LC32 I2C EEPROM Breakout 32Kbit / 4 KB

Aqara Camera G3 integration for Home Assistant

Raspberry Pi Spectrometer

Pinion — Nice-looking interactive diagrams for KiCAD PCBs

Huawei Solar sensors for Home Assistant

Raspberry Pi Pico support for VS Code

A ESP32 project template with a web interface built in React

SPI driven CircuitPython driver for PCA9745B constant current LED driver.

The project is an open-source and low-cost kit to get started with underactuated robotics.

Monitor Live USB Plug In & Plug Out Events

Designed a system that can efficiently sort recyclables and transfer them to corresponding bins using Python, a Raspberry Pi, and Quanser Labs.

A raspberrypi tools for python