RaspberryIO - User Guide

[spud]

INSTALLATION / CONFIGURATION

System Requirements:
This plugin is for HS3 or HS3PRO.
It is designed to allow HomeSeer to configure, monitor and control the GPIO (General Purpose Input/Output) of a Raspberry Pi. It works with any version of Raspberry Pi.


Plugin Installation on your HS3 machine
Download and install from the updater ("Analog & Digital Input/Output Device" section) or download package from the Beta Testing thread and follow instructions to install.

If your HS3 machine is not a Raspberry Pi you don't need to enable the plug-in (but you still have to install it)

Plugin Installation on a Raspberry Pi which is not your HS3 machine
If you want to monitor/control GPIO of a Raspberry Pi which is not your HS3 machine, you need to run it as a remote plugin.
WARNING: if your HS3 server run on Windows you MUST run mono version 4 or above on your Raspberry Pi. Here is a Guide to update Mono to version 4 or above on Raspbian.

Here is the installation steps from the command line (tested on Raspbian)
1. create a directory where you want to install, and enter it:

mkdir RaspberryIO
cd RaspberryIO

2. download the plug-in remote install archive and unzip it. (This archive contains the plug-in files and the Homeseer libraries needed to run a plug-in remotely)

wget https://www.dropbox.com/s/dgdf63bzww3qlwb/RaspberryIO_remote_install_3-0-0-15.zip
unzip RaspberryIO_remote_install_3-0-0-15.zip

3.make the "run.sh" script executable

chmod +x run.sh

4. edit the run script

pico ./run.sh

5. replace
- <raspberryio_absolute_path> with the absolute path of the directory where you installed the plugin
- <ip_of_your_hs_machine> with the actual IP of your HS3 machine
- <instance_name> with a name for this instance of the plugin (no space or special characters).
Type Ctrl+X, then Y to save the file.

here is for example what my run.sh looks like:

#!/bin/sh
cd /home/homeseer/RaspberryIO
mono HSPI_RaspberryIO.exe server=192.168.0.2 instance=TestRemote autoreconnect=30

6. last step is to actually run the script

spud@rpi ~/RaspberryIO $ sudo ./run.sh
Plugin: RaspberryIO Instance: TestRemote starting...
Connecting to server at 192.168.0.2...
Connection attempt #1
Connected (HomeSeer API 3). Waiting to be initialized...
Sep-13 14:29:41 INFO RaspberryIO version 3.0.0.15
Sep-13 14:29:41 INFO Raspberry Pi running on Bcm2709 processor
Sep-13 14:29:41 INFO Firmware rev10620993, board model B2 (Raspberry Pi 2 Model B)

If everything is ok, you should see the init sequence like above, and in the 'PLUG-INS > Manage' page you should see your instance in the Remote Plug-Ins section like in the screenshot below:


7. (optional) If you want the plugin to be started automatically when your Raspberry Pi boot, edit the file /etc/rc.local

sudo pico /etc/rc.local

and add the following line (adapting the path of your run.sh accordingly to your system) at the end just above the "exit 0" command

sudo /home/homeseer/RaspberryIO/run.sh &
exit 0

To use the plugin with multiple Raspberry Pi, simply repeat step 1 to 7 on each RPi, making sure to use a different instance name on each one.


Plugin Configuration
Go to the config page 'PLUG-INS > RaspberryIO > Config - InstanceName', and configure the pins you want to use as Input/Output

[spud]

FEATURES

The plugin creates one device for each pin configured with a direction set as Input or Output. Devices for Output pins have On/Off, Toggle and Pulse controls. Device value for Input pins are changed accordingly to the pin state (Low = Off, High = On).



You can use Output pins to turn on/off some LEDs, use them with relay boards, etc...
You can use Input pins to integrate any kind of digital sensor (motion, water, etc...)



Event Actions
You can remotely reboot or shutdown any remote Raspberry Pi from Homeseer, using event actions: