Homebridge GPIO WiringPi

Supports triggering General Purpose Input Output (GPIO) pins on the Raspberry Pi.

Based on homebrige-gpio Uses wiringPi as a back end to give non-root access to GPIO.

DEPRECATED

No more development on this module - consider migrating to homebridge-gpio-wpi2 instead

Requirements

• Homebridge - HomeKit support for the impatient
• wiring-pi - Node.js bindings to wiringPi

Installation

1. Install Homebridge using npm install -g homebridge
2. Install this plugin npm install -g homebridge-gpio-wpi
3. Update your configuration file - see sample-config.json in this repo

Configuration

Example config.json

{
  "accessories": [
    {
      "accessory": "GPIO",
        "name": "GPIO2",
        "pin": 27,
        "duration": 4000,
        "inverted": "false"
    }
  ]
}

Setting "inverted" to "true" reverses the behaviour of the GPIO output i.e. the switch is considered "On" if the value is 0, and "Off" is 1. This may be useful for some relay boards where the logic is reversed.

Pin Configuration

You need to configure the relevant GPIO pins using the gpio utility included with wiringPi.

$ gpio readall
 +-----+-----+---------+------+---+---Pi 2---+---+------+---------+-----+-----+
 | BCM | wPi |   Name  | Mode | V | Physical | V | Mode | Name    | wPi | BCM |
 +-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
 |     |     |    3.3v |      |   |  1 || 2  |   |      | 5v      |     |     |
 |   2 |   8 |   SDA.1 |  OUT | 0 |  3 || 4  |   |      | 5V      |     |     |
 |   3 |   9 |   SCL.1 |   IN | 1 |  5 || 6  |   |      | 0v      |     |     |
 |   4 |   7 | GPIO. 7 |   IN | 1 |  7 || 8  | 1 | ALT0 | TxD     | 15  | 14  |
 |     |     |      0v |      |   |  9 || 10 | 1 | ALT0 | RxD     | 16  | 15  |
 |  17 |   0 | GPIO. 0 |   IN | 0 | 11 || 12 | 1 | IN   | GPIO. 1 | 1   | 18  |
 |  27 |   2 | GPIO. 2 |  OUT | 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 2---+---+------+---------+-----+-----+

The pin number specified in the config.json file is the BCM pin number in this table.

When configuring the pins using GPIO, you can use the -g option to avoid confusion!

$ gpio -g mode 27 out   <-- Set OUTput mode
$ gpio -g mode 27 down  <-- Set pull-down resistor
$ gpio export 27 out    <-- Export the pin to /sys/class/gpio

The gpio tool is setuid root, so should be run as the user that runs Homebridge. See the set-gpio.sh script as an example.

Troubleshooting

Homebridge reports no errors, but nothing is switched on or off

Check the permissions in /sys/class/gpio/gpioXX. You should run the set-gpio.sh script as the homebridge user, or ensure that the user is a member of the gpio group.

 $ sudo usermod -G gpio homebridge

Licence

(The MIT License)

Copyright (c) 2016 Richard Grime [email protected]

Original Project Copyright (c) 2016 James Blanksby [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.