Express server script for a RESTful API to access the Raspberry Pi's GPIO pins.
Turn pins on and off by sending GET requests to the Raspberry Pi.
Basic frontend can be found here.
First, make sure you have node.js and npm installed.
If you don't, open a terminal and type:
sudo apt-get install nodejs npm node-semver
Now we need to allow your user to access the GPIO pins (can only be done from root by default). We are going to use GPIO Admin for that:
git clone git://github.com/juangesino/quick2wire-gpio-admin.git
cd quick2wire-gpio-admin
make
sudo make install
sudo adduser $USER gpio
Logout and login again (more info).
Now we are ready to clone the server.
git clone https://github.com/rinzler100/gpio-backend/
cd express-gpio-rest-api
npm install
To run the script:
node app.js
The server has 4 simple routes:
GET /on/:pin_number
GET /off/:pin_number
GET /blink/:pin_number/:time_in_milliseconds
GET /status/:pin_number
The first method just sets the pin HIGH.
The second method sets the pin LOW.
The third method sets the pin HIGH, waits the number of milliseconds you requested and then sets the pin LOW.
The status method reads the specified gpio pin's current status (0 or 1). If the light is not on or off this will return undefined.
The server script uses the node.js library pi-gpio. This library uses the physical pin numbering (the 'Pin#' in the image bellow) for the GPIO pins:
For more information about what pins to use please go to the pi-gpio docs.
The server runs by default on port 3000 (you can change this on the app.js file).
The requests should be done to the Raspberry Pi's IP address (e.g.: 192.168.0.10:3000).
Turn pin 12 on
GET /on/12
Turn pin 12 off
GET /off/12
Turn pin 12 on for 2 seconds, then turn off
GET /blink/12/2000
Retrieve the status of pin 12
GET /status/12
- Fork it ( https://github.com/rinzler100/gpio-backend/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
- Check for bad params.
- GET request should show the pin state and PUT should be used to change state.
- Ability to use buttons/input methods?
- RGB light controller
See MIT-LICENSE