Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pyrou/rc-restserver
RC-RESTserver is a small REST Server written in python. It is designed for Control RF Remote-controlled devices (power sockets / lamp / ..) using several protocols (Chacon / Blyss / X10)
https://github.com/pyrou/rc-restserver
Last synced: about 2 months ago
JSON representation
RC-RESTserver is a small REST Server written in python. It is designed for Control RF Remote-controlled devices (power sockets / lamp / ..) using several protocols (Chacon / Blyss / X10)
- Host: GitHub
- URL: https://github.com/pyrou/rc-restserver
- Owner: pyrou
- License: mit
- Created: 2014-10-26T19:12:27.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2019-09-01T10:55:07.000Z (over 5 years ago)
- Last Synced: 2024-10-14T10:48:50.642Z (3 months ago)
- Language: Python
- Homepage:
- Size: 21.5 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
RC-RESTserver
=============
RC-RESTserver is a small REST Server written in python. It is designed for Control RF Remote-controlled devices (power sockets / lamp / ..) using several protocols (Chacon / Otio / Blyss / X10)
## Dependencies
Submodules require wiringPi : https://projects.drogon.net/raspberry-pi/wiringpi/
**Building WiringPi**
```bash
sudo apt-get install wiringpi
```
Alternatively :
```bash
sudo apt-get install git-core
git clone git://github.com/pyrou/wiringPi
cd wiringPi
./build
```
## Installation
```bash
git clone --recursive https://github.com/pyrou/RC-RESTserver.git
wget https://bottlepy.org/bottle.py
chmod ugo+x $(pwd)/RC-RESTserver/rcserver.py
sudo ln -s $(pwd)/RC-RESTserver/rcserver.py /etc/init.d/rcserver
/etc/init.d/rcserver start
#make it boot automatically
sudo ln -s /etc/init.d/rcserver /etc/rc3.d/S98rcserver
```
**Building RCSwitch**
```bash
cd RC-RESTserver/rcswitch-pi
# edit PIN in send.cpp with appropriate wPi PIN number
# +-----+-----+---------+------+---+---Pi 3---+---+------+---------+-----+-----+
# | BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
# +-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
# | | | 3.3v | | | 1 || 2 | | | 5v | | |
# | 2 | 8 | SDA.1 | IN | 1 | 3 || 4 | | | 5v | | |
# | 3 | 9 | SCL.1 | IN | 1 | 5 || 6 | | | 0v | | |
# | 4 | 7 | GPIO. 7 | IN | 1 | 7 || 8 | 0 | OUT | TxD | 15 | 14 |
# | | | 0v | | | 9 || 10 | 1 | IN | RxD | 16 | 15 |
# | 17 | 0 | GPIO. 0 | IN | 0 | 11 || 12 | 0 | IN | GPIO. 1 | 1 | 18 |
# | 27 | 2 | GPIO. 2 | IN | 0 | 13 || 14 | | | 0v | | |
# | 22 | 3 | GPIO. 3 | IN | 0 | 15 || 16 | 0 | IN | GPIO. 4 | 4 | 23 |
# | | | 3.3v | | | 17 || 18 | 0 | IN | GPIO. 5 | 5 | 24 |
# | 10 | 12 | MOSI | IN | 0 | 19 || 20 | | | 0v | | |
# | 9 | 13 | MISO | IN | 0 | 21 || 22 | 0 | IN | GPIO. 6 | 6 | 25 |
# | 11 | 14 | SCLK | IN | 0 | 23 || 24 | 1 | IN | CE0 | 10 | 8 |
# | | | 0v | | | 25 || 26 | 1 | IN | CE1 | 11 | 7 |
# | 0 | 30 | SDA.0 | IN | 1 | 27 || 28 | 1 | IN | SCL.0 | 31 | 1 |
# | 5 | 21 | GPIO.21 | IN | 1 | 29 || 30 | | | 0v | | |
# | 6 | 22 | GPIO.22 | IN | 1 | 31 || 32 | 0 | IN | GPIO.26 | 26 | 12 |
# | 13 | 23 | GPIO.23 | IN | 0 | 33 || 34 | | | 0v | | |
# | 19 | 24 | GPIO.24 | IN | 0 | 35 || 36 | 0 | IN | GPIO.27 | 27 | 16 |
# | 26 | 25 | GPIO.25 | IN | 0 | 37 || 38 | 0 | IN | GPIO.28 | 28 | 20 |
# | | | 0v | | | 39 || 40 | 0 | IN | GPIO.29 | 29 | 21 |
# +-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
# | BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
# +-----+-----+---------+------+---+---Pi 3---+---+------+---------+-----+-----+
make
# test it with following command
./send 11111 1 1
```
## API
Once the server is running you can perform HTTP requests to control your devices.
### X10 devices
```
GET /x10/{device}/{unit}/{status}.json
```
| Param name | Description | Example |
| --- | :--- | --- |
| `device` | Called also "House code" on some devices, the de device must be a letter between `A` and `P` (case insensitive) | `C` |
| `unit` | This is the "Unit number" and must be a number between `1` and `16` | `3` |
| `status` | `on` or `off` | `on` |
**Example**
To turn on the power socket configured as house code C, unit number 3 ; perform a GET request on the following endpoint :
```
GET /x10/C/3/on.json
```
### RC Switches devices
This endpoint will use the [rcswitch-pi library](https://github.com/r10r/rcswitch-pi) to control devices with a SC5262 / SC5272, HX2262 / HX2272, PT2262 / PT2272, EV1527, RT1527, FP1527 or HS1527 chipset. Also supports Intertechno outlets.
```
GET /switch/{device}/{unit}/{status}.json
```
| Param name | Description | Example |
| --- | :--- | --- |
| `device` | 5-Bits length mask* of the switch group. | `10010` |
| `unit` | This is the "Unit number" and must be a number between `1` and `5` | `2` |
| `status` | `on` or `off` | `on` |
**Determine your bit mask and unit number**
Refer to DIP switches 1 to 5 where "1" = on and "0" = off, if all DIP switches are on, `{device}` should be `11111`. Then refer to DIP switches 6 to 10 (A..E) if switche D is on, `{unit}` is `4`.
**Example**
To turn off the power outlet socket configured as group 01001, unit B ; perform a GET request on the following endpoint :
```
GET /switch/01001/2/off.json
```
#### Tri-states commands
This endpoint will also use the [rcswitch-pi library](https://github.com/r10r/rcswitch-pi) by sending "tri-states" raw commands.
```
GET /tristate/{command}.json
```
| Param name | Description | Example |
| --- | :--- | --- |
| `command` | Command identifier defined by F, 0 or 1. | `F0FF011F0011` |
**Example**
```
GET /tristate/F0FF011F0011.json
```
### Blyss devices
```
GET /blyss/{key}/{channel}/{status}.json
```
| Param name | Description | Example |
| --- | :--- | --- |
| `key` | This is your RF key in hex format. | `0FAE24` |
| `channel` | This is the channel number to control. It must be a number between `1` and `5` | `1` |
| `status` | `on` or `off` | `on` |
**Determine your RF Key**
Determining your RF Key require additionnal components such as a 433Mhz RF Receiver. See complete instruction and code at [skyduino blog (in french)](https://skyduino.wordpress.com/2012/07/19/hack-partie-2-reverse-engineering-des-interrupteurs-domotique-blyss/)
**Example**
To turn on the power socket on channel 1; perform a GET request on the following endpoint :
```
GET /blyss/0FAE24/1/on.json
```