https://github.com/juangesino/express-gpio-rest-api

Express server for a RESTful API to access the Raspberry Pi's GPIO pins.
https://github.com/juangesino/express-gpio-rest-api

express gpio-pins nodejs raspberry-pi rest-api

Last synced: about 1 month ago
JSON representation

Express server for a RESTful API to access the Raspberry Pi's GPIO pins.

• Host: GitHub
• URL: https://github.com/juangesino/express-gpio-rest-api
• Owner: juangesino
• License: mit
• Created: 2016-02-05T05:57:20.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-05T19:26:43.000Z (almost 9 years ago)
• Last Synced: 2023-08-21T16:31:11.812Z (about 1 year ago)
• Topics: express, gpio-pins, nodejs, raspberry-pi, rest-api
• Language: JavaScript
• Homepage:
• Size: 2.93 KB
• Stars: 7
• Watchers: 4
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Express GPIO RESTful API

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.

## Installation

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](https://github.com/juangesino/quick2wire-gpio-admin)).

Now we are ready to clone the server.

    git clone https://github.com/juangesino/express-gpio-rest-api.git

    cd express-gpio-rest-api

    npm install

To run the script:

    node app.js

## Usage

The server has 3 simple routes:

    GET /on/:pin_number

    GET /off/:pin_number

    GET /blink/:pin_number/:time_in_milliseconds

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 server script uses the node.js library [pi-gpio](https://www.npmjs.com/package/pi-gpio). This library uses the physical pin numbering (the '*Pin#*' in the image bellow) for the GPIO pins:

![Raspberry Pi GPIO Header](http://i0.wp.com/www.robert-drummond.com/wp-content/uploads/2015/06/gpio_pi2-pinout.png?w=956)

For more information about what pins to use please go to the [pi-gpio docs](https://www.npmjs.com/package/pi-gpio#about-the-pin-configuration).

## Examples

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

## Contributing

1. Fork it ( https://github.com/juangesino/express-gpio-rest-api/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request

## TODO

 - Read pins.

 - Check for bad params.

 - GET request should show the pin state and PUT should be used to change state.

 - Blink a given number of times.

 - Inverse blink (turn off, wait, turn on).

 - Write tests.

## License

See [MIT-LICENSE](https://github.com/juangesino/express-gpio-rest-api/blob/master/LICENSE)