API

Sample response

{
    "io": [
        {
            "pin": 3,
            "pin_function": "IO",
            "pin_state": 1
        },
       ...],

    "power_pins": [
        {
            "pin": 1,
            "pin_function": "3V3 Power"
        },
       ...]
}

Installation

Latest release through PyPI:

$ pip install pi_gpio_api

Development version:

$ git clone git@github.com:jcapona/pi-gpio-api.git
$ cd pi-gpio-api
$ pip install -e .

CLI

The api can be run as a daemon using the gpioapi command in the Raspberry Pi shell.

$ gpioapi -h
usage: gpioapi [-h] [-H HOST] [-p PORT] command

GPIO web API controller

positional arguments:
  command               Control process: start, stop, restart, status

optional arguments:
  -h, --help            show this help message and exit
  -H HOST, --host HOST  host where the web server will be listening
  -p PORT, --port PORT  port where the web server will be listening

This way, the API can be launched through gpioapi start and stopped through gpioapi stop.

Use as a library

In a python shell:

>>> import pi_gpio_api
>>> pi_gpio_api.app.run(host='0.0.0.0', port=5000)

This will launch a server that listens requests on the given host & port.

Contribution

Feel free to open issues, report bugs or open pull requests.