#DevIoT RaspberryPi Starter Kit# RaspberryPi gateway service can be used to work with DevIoT, supply the DevIot capability with read sensor data, control sensor status, define sensor action

This code also can be as a sample code to show how to use the Gateway Service SDK, use it build a completed gateway service which can work with DevIot

This guide will show how to build this sample step by step

###You can try DevIot from http://www.ciscodeviot.com/ quickly

Table of contents

• What in this code
• Prerequisite
• How to use
• How to test
• Getting help

What in this code

1.the app.py: the app entry

2.setting.cfg: the custom's setting file, you can put all you setting item in this file with json format

3.setup.py file: this file will help you install some dependency lib for this kit

4.sensors folder: contain all the sensor logic model, those model map to real sensor connected to the Pi

5.logic folder: contain some custom logic, such as how to get the data from GrovePi and how to use the data update the sensor

##Prerequisite ###Hardware### 1.This kit depended on Raspberry-Pi, you can get this pi device from here

2.This kit use GrovePi+ Starter Kit, you can get this device fromhere.

3.SD card for Raspberry Pi, Power adapter(5V), USB cable, Network cable, HDMI cable, Display with HDML interface

###Software### 4.This kit code need base on Python2.7

5.GrovePi SDK

##How to Use ###Build the Hardware###

1.Prepare your RaspberryPi os environment in your SD card

• Download the OS for RaspberryPi form hereRASPBIAN JESSIE

• Format you SD card

• Use window install the OS image to the SD card. you can use Win32 Disk Manager do this

  I strongly recommend you do this use windows, i have met many issues when i installed it by mac os

• Attach the SD card to the RaspberryPi

You also can do this follow here

2.Join the GrovePi with RaspberryPi. if you correct, it should be like this

3.Connect RaspberryPi with the power and network.

4.Connect RaspberryPi with Display use the HDMI cables.

if you finished the above steps, in your display，you should look the RaspberryPi OS interface.

###Build the software environment### 5.Install the Python 2.7. Check the python version of RaspberryPi os. this sample code base on python2.7.3 or later. in most time, the RaspberryPi os have installed the python2.7.3 or later, if not, you can install the python follow here

6.Install GrovePi SDK.

• Make sure your Raspberry Pi is connected to the internet.

• Type follow command in terminal window

    sudo apt-get update
    sudo apt-get install rpi.gpio
  

*Follow this tutorial for setting up the GrovePi.

• Restart the Raspberry Pi.

Your SD card now has what it needs to start using the GrovePi! Here is info more about install GrovePi SDK

7.Install the dependency. In your workspace, run the setup.py file use follow command:

sudo python setup.py install

this script will install all dependency lib for this kit

###Configuration###

8.Connect the sensors to GrovePi and configuration.

By default, we connect one button sensor to A0 port,one sound sensor to A1 port, one light sensor to A2 port ,one led sensor to D3 port and one buzzer sensor to D4 port.

The port number with A prefix means it is readable pin port, you just can read data, the D prefix means you just can write data to this pin port.

Check the connection setting in setting.cfg, the setting.cfg file should like this:

{
    "address":"10.140.92.25:9000",                  #required, it is DevIot platform server address, format should be: ip:port
    "mqtthost":"10.140.92.25:1883",                 #required, it is the DevIot platform MQTT server address, format should be: ip:port

    "appname":"raspberry",                          #optional, the name of you gateway service app, it should not be empty, by default the value will be "arduino".
    "account":"",                                   #optional, your account of DevIot platform, most of the time,it should be a mail address, by default it will be empty, it means this gateway will be used for all DevIot users

    "sensors": {                                    #required, you need register you sensor information in here, if you don't have any sensor, keep it empty
        "button_r":                                 #required, sensor id is the identify id for the sensor, we suggest that you named a sensor as this format: kind_fix
            {
                "name":"RButton",                   #required, name is display name of sensor in DevIot platform
                "kind":"button",                    #required, kind is the a type identifier of sensor
                "pin": 0,                           #required, connect to the A0 port
                "type": "data"                      #required, it means A0 is readable
            },
            "sound_r":                              
            {
                "name":"RSound",                    
                "kind":"sound",                     
                "pin": 1,                           
                "type": "data"                      
            },
            "light_r":                             
            {
                "name":"RLight",                    
                "kind":"light",                     
                "pin": 2,                           
                "type": "data"                      
            },
            "led_r":                                
            {
                "name":"RLed",                      
                "kind":"led",                       
                "pin": 3,                           
                "type": "action"                    
            },
            "buzzer_r":                             
            {
                "name":"RBuzzer",                   
                "kind":"buzzer",                    
                "pin": 4,                           
                "type": "action"                    
            }
        }
}

Make sure the content(without the comment) in setting.cfg file is json format, you can check it in here

You can add or remove the sensor segment in "sensors" segment in setting.cfg file by your requirements.

Please do not let multiple sensors use same pin.

9. Configure the code to let the gateway auto run when RaspberryPi started.

• Open the terminal window and type follow command to open the rc.local file by nano:

    sudo nano /etc/rc.local
  

• Add follow command to rc.local file:

    sleep 5                         # wait for 5 seconds to make sure the RaspberryPi have connected the network
    cd /{your code directory}       # cd to you code root folder
    sudo python app.py &            # run it
  

Here is a sample:

• Press ctrl + o to save rc.local file then close the rc.local file.

10.Start the gateway. For this purpose, you have two choices: one is restart the RaspberryPi, once the RaspberryPi started, the gateway will run automatically, another is that: Open the terminal window and cd to workspace folder, type follow command to run it

sudo python app.py 

##How to test You can use mqtool to test you service

##Troubleshoting

• Error info contain the "config":

  1. Check the if the content(without the comments) in setting.cfg is Json format. you can check it in here
  2. Check the all the necessary section in the setting.cfg.

• Error info contain the "input/output" or "can't read" or "analogRead":

  1. Check if the GrovePi SDK installed successfully, you can check it by typing follow command in terminal window:

     python #start the python from grovepi import grovepi if there is some wrong, then type follow command:

     import grovepi grovepi.analogRead(0)

  if there is still something wrong, it means you GrovePi SDK did not installed correctly.

Getting help

If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker

Getting involved

For general instructions on how to contribute, please visit CONTRIBUTING

Open source licensing info

1. LICENSE

Credits and references

None