RASPBERRY PI GUIDE Compatible for Raspberry Pi B/2B and 3 2016/26/08-REV1
Table of Contents Preloading Cayenne to RPI... 2 Setting up an Account... 2 Setting up your Device... 2 Via a New Account... 2 Via a Previously Existing Account... 2 Option 1 Mobile Device... 3 Option 2 Web Browser... 4 Understanding the Interface... 5 Dashboard... 5 Left Panel... 6 Icon Status... 6 Adding new Devices/Triggers/Events/Projects... 6 Searching for Devices... 6 Center Panel... 7 Creating Projects... 7 Community... 7 Documentation... 7 Deleting/Renaming Projects... 7 Overview/Configuring/Remote Access... 8 Configuring GPIO... 8 Extensions... 9 Analog Converter... 9 GPIO Port... 10 PWM... 11 Sensors... 12 Temperature/Pressure... 12 Luminosity... 13 Proximity/Distance/Generic Analog Input... 14 Motion... 15 Generic Digital Input... 16 Actuators... 17 Light Switch/Relay Switch... 17 Luminosity... 18 DC Motor Switch... 19 Servo Motor Switch... 20 Valve Switch... 21 Generic DC Output... 22 Generic PWM Output... 23 1
Preloading Cayenne to RPI Setting up an Account: Step 1) Using your computer, please navigate to this web address [http://bit.ly/2agtjap]. We recommend that you open this page using a Chrome or Firefox browser with the latest updates. Step 2) Please fill in the required information asked on the webpage and ensure that you select the checkbox on the bottom to agree with MyDevices Terms and Conditions before clicking next. Congratulations, you now have an account and an email will be sent shortly to welcome you to the community. Setting up your Device: Via a new Account: Step 1) After creating an account, you will be presented with two devices; choose Raspberry Pi. Step 2) You will be given two more options; see the guide below for option 1 or option 2 on how you want to setup Cayenne to the RPI. Via a Previously Existing Account Step 1) Login in to access your Dashboard. Step 2) Once you see your Dashboard, move the cursor to the far left. On the top, there will be a green button written < Add new >. Step 3) Click it and select < Device/Widget >. Step 4) Select on the right side < Single Board Computers >. Step 5) On the farthest right, you will see < Raspberry Pi >, select it and press next. Step 6) A new window will appear with two options to setup cayenne to the RPI. Follow the guide below for option 1 or option 2. 2
Option 1 Mobile Software Step 1) Using either Android Mobile device or Apple Mobile device click and follow the link to install onto your phone. Alternatively, you can search the app on the app store or google play store and have the software installed. It is called [Cayenne]. Step 2) Insert the MicroSD card provided in the kit into the raspberry with the label facing away from the RPI. The MicroSD slot is located on the back of the RPI. Additional step is to connect a WI-FI Dongle or Ethernet cable to the RPI B/2B Model. Step 3) Insert the Micro USB cable into the RPI and connect the wall wart into the AC Socket to power up the RPI. (Note: PSU - 5v at 2.1Amps, recommended) Step 4) Open the app on the phone, you will be asked to login. After entering the username and password used for the Cayenne Dashboard the software will scan for available RPI devices. Ensure that your phone is connected to the same network as the RPI under a L.A.N. (Local Area Network). To find the IP address of the RPI, connect the HDMI Cable from the PI to the monitor. Then, on the desktop of the RPI, on the taskbar, open the computer icon with the black screen. Type [ifconfig]; on the bottom, it will be written inet that will have the ip address of the device. Once the device is found on your phone, on the right, press the [install] button. The installation process will begin and make take up to 2-5 minutes. Step 5) The app will automatically reboot the RPI and if you do not see a new window appear after the RPI has rebooted, simply close the app and reopen it. Congratulations, you now have RPI installed to the Cayenne App. You can also access the RPI on your Dashboard via the web browser by logging in. 3
Option 2 Web Browser Step 1) Insert the MicroSD card provided in the kit into the Raspberry Pi with the label facing outwards away from the RPI. The MicroSD slot is located on the back of the RPI. Additional step is to connect a WI-FI Dongle or Ethernet cable to the RPI B/2B Model. Step 2) Connect a HDMI Cable from the PI to the monitor. Step 3) Insert the Micro USB cable into the RPI and connect the DC Adapter into the AC Socket to power up the RPI. (Note: PSU - 5v at 2.1Amps, recommended) Step 4) Wait for the RPI to boot up. After the booting process, you will be presented with the desktop. Step 5) On the top taskbar, locate the computer with a black screen icon. Open this software and type in the black window the commands shown from your web browser with the dashboard waiting with the two options. Shown below in red, it has a unique ID before the end of the.sh file. Step 6) wait for the installation to be completed and allow time for the RPI to reboot. Step 7) After the system reboots, you will have access on the webpage Dashboard to the RPI. Congratulations, you now have RPI with Cayenne! 4
Understanding the Interface Cayenne Dashboard: This picture is the main page of the Cayenne Interface that is accessed from your browser. We recommend you use Google Chrome, Firefox, Opera or Spartan Browser with the latest updates. To access the Dashboard, you must first login from this webpage: [http://bit.ly/2bnz64s]. If you login and see a prompt to add your first device, please follow the guide in the manual explaining the process of adding a device with Cayenne! 5
Left panel: The Left Panel of the Dashboard offers the ability to locate the devices that have Cayenne installed and are presently connected to the internet. Icon Status If your device is in grey, this is because your device is disconnected from the internet and requires manual action to resolve this issue. If the icon is colored as shown in the image on the left, then the device is detected and you can access to add components or projects. If you see an hourglass, your device has not completed the installation process. Please click the icon and complete it. If you need help please go to [Preparing Cayenne to RPI] in this manual. If you accidently started this process and want to get rid of it, navigate to the page with two options for RPI on the webpage and press remove on the bottom right. Adding new Devices/Triggers/Events/Projects Above in Green, the menu allows you to add new Devices/Widgets, Events, Triggers and Projects. Devices/Widgets include: Single Board Computers > Raspberry Pi MicroControllers > Arduino Sensors > Temperature, Luminosity, Pressure, Proximity/Distance, Motion and Generic Digital/Analog Input Actuators > Light, Motor, Valve, Relay and Generic Digital/Analog Output Extensions > Analog Converter, GPIO Port and PWM (Extensions is reserved for RPi only!) Custom Widgets > Value, Line Chart, Gauge, 2 State, Button and Slider Events Include: Name of Event Date & Time Time zone Repetition of Event Duration Notification > E-mail or Text Message! Custom Actions Triggers are: If/Then Cases, that can notify or do an action Project are: Project (Shown in the next picture are used to organize all devices, events and triggers into a single tab) Search Devices On the bottom of the left panel you have Search Devices as your device can be renamed. You can find them faster using this menu. 6
Center Panel: The photo above is the middle section. Creating Projects On the top you have a tab named testing. This tab is designed for projects, you can add another project by pressing the + sign to create and name new projects. You use projects as a folder to add all devices/widgets, triggers and events for a specific idea. An example would be a Robotic Control System. Inside this folder, you would have an RPI with a Motor and relay that uses digital output with a timer and an event to send to your phone an alert text message when the process has started. All you have to do is drag and drop elements from the left panel into the middle. View the video in the middle of the webpage for a visual example! Community The right side has two buttons that interfaces with the Cayenne Community that allows users to create projects and share them. Use the Submit Project Button if you have a project you would like to post on the community. The link will redirect you to the page where you can share libraries with other users. The Community Button allows users to visit the community page and ask questions or download projects from other users. Documentation (Docs) You can find documentations, getting started guides and FAQ for recently and newly updated things. Below, you will find user questions about devices or custom Widgets/Projects. The User Menu button will allow you to log out manually, view your scheduling and triggers or alerts from all projects and devices. You will automatically be signed out from inactivity by default. Deleting Projects/Renaming Projects The middle blue bar changes when pressing Projects as it is highlighted in blue. It will have three options and a setting gear on the right. Overview will show basic details of all related Triggers / Events and devices connected to the RPI for your particular project. Scheduling will have details of when each event is set on a calendar. Triggers & Alerts will have details of all triggers and alerts associated with the project. The Gear icon on the right will allow you to delete the project or rename it. 7
Overview/Configuring/Remote Access This bar will show when the RPI is connected to the network and visible on your dashboard. This module has three gauges that will show the memory usage, the processor usage and the storage usage. If you press the gear icon on the right corner of each box and select settings, you can change the icon from a gauge to line chart or value. You can also change the name of each icon. These icons appear at default and cannot be removed. You also have access to commands on the right side that allows users to access the desktop of the RPI via SSH using remote access. A new window will appear when you press this option. Please make sure on the new window to select the hovering taskbar and choose the square icon to select the option to stop viewing when you are done. You can also reboot or shut down the RPI. In Configure, you can change the name of the PI, view the IP address of the PI, find the manufacturer of the PI, find the model, remove the device or enable and disable features on the left. Configuring GPIO On the light blue bar next to Overview tab is the GPIO tab. This page will show a new window that allows users to select certain pins that indicate IN for input or OUT for output. This option is available for certain pins as it is colored in grey. Enabling the OUT for a pin enables a red box that can be controlled if the pin is active low 0V or active high 3.3V. It is also used as a reference sheet to indicate the pinout. The first pin in orange box on the GPIO page is shown below with a yellow arrow. When connecting the PI Cobbler, the white cable is the first pin. The inner tab to pull will be facing inwards towards the black chip on the RPI. It should look something like this. 8
Extensions Analog Converter The RPI is a small computer that can access a desktop and run a full Linux operating system. Since the board was designed for that purpose, the cortex processor that is used is a 3.3V device. The RPI is missing a few functions compared to a popular Arduino microcontroller. One feature used commonly is the Analog to Digital converter done by the ATMEGA328p. Using this MCP3008, you can have analog ports on your RPI. You will need this IC setting installed first in order to use for analog signal based examples below. Please add this extension only once, as you will have repeated extensions if you add them multiple times. - 1x MCP3008-10x 11x Breadboard wires Note: Image is provided using Fritzing Software. In the Dashboard select < add new >, then go to < device/widgets >, then < extensions >, then < analog converter > and click on MCP3008. Make sure you select the right RPI, give the widget a proper name to identify and set the SPI chip-select to 0. Click on Add extensions. DO THIS STEP ONLY ONCE! 9
GPIO Port Unl7ike the Arduino Microcontroller family, the RPI has access to limited about of GPIOs. Arduino has different products that offer more GPIO. Due to memory limitation, they use a different microcontroller to offer more pinouts that require a different powerful IC. The RPI is using a Cortex IC that has a larger memory banks, meaning with a maximum of two SPI ports you can connect and get more GPIOs. This example uses the MCP23018 to offer 16 GPIO from a single chip. Use this example and add this extension only once if you have future projects that require access to multiple GPIOs. - 1x MCP23018-10x Breadboard wires Note: Image is provided using Fritzing Software In the Dash Board select < add new >, then go to < device/widgets >, then < extensions >, then < gpio port > and click on MCP23018. Make sure you select the right RPI, give the widget a proper name to identify and set the slave address to 0x20. Click on Add extensions. DO THIS STEP ONLY ONCE! 10
PWM The RPI is a small computer that can access a desktop and runs a full Linux operating system. Since the board was designed for that purpose the cortex processor that is used is a 3.3V device. The RPI is missing a few functions compared to a popular Arduino microcontroller. Another function the RPI is missing is PWM signals as the voltage of the pins are only 3.3V. Using the PCA9685, you can supply external power if required to drive high voltage motors using PWM generated by the PCA9685 IC. The logic supply from the chip will ensure that the RPI only talk with the device at 3.3V or less. - 1x PCA9685-6x Breadboard Wires Note: Image is provided using Fritzing Software. In the Dash Board select < add new >, then go to < device/widgets >, then < extensions >, then < PWM > and click on PCA9685. Make sure you select the right RPI, give the widget a proper name to identify and set the slave address to 0x40. Click on Add extensions. DO THIS STEP ONLY ONCE! 11
Sensors Temperature / Pressure The BMP180 is a small breakout board that allows users to get temperature, pressure and altitude. SCL and SDA are communication lines used for devices to communicate with the microcontroller. The communication protocol that uses these signal lines is called I 2 C (pronounced: I squared C). SDA stands for serial data and SCL for serial clock. A good documentation on I 2 C can be found here: [http://bit.ly/2bsvoth]. This protocol is based on addressing and each device has its own unique hex address. - 4x 6x Breadboard wires - 1x BMP180 Note: Image is provided using Fritzing Software, please make sure you connect to 3.3V not 5V. In the Dashboard, select < add new >, then go to < device/widgets >, then < sensors >, then < temperature > for temperature or < pressure > for pressure and click on BMP180. Finally, make sure you selected the right device, give the widget a proper name to identify and choose the icon. Choose the widget you want to see on your dashboard and click on Add Sensor. If the add sensor button is faded out and prevents you from clicking it, you must first wire the circuit before clicking add sensor or the settings for the BMP180 is conflicting with something already wired on that pin. You will be redirected to the dashboard where you can press the gear icon and select settings to change the widget icon. 12
Luminosity This circuit uses a 10-bit ADC (Analog to Digital Converter) chip that has 8 analog channels that will send data back using SPI communication protocol. The channels can be related to Arduino microcontroller that has 8 analog ports. The Atmel chip is designed internally to house analog converters, where the Raspberry Pi can only do digital communication. SPI requires four cables for Master to Slave communication, master being the RPI. - 13x 14x Breadboard wires - 1x MCP3008-1x 12kΩ Photoresistor - 1x 10kΩ ¼ Watt 5% tolerance resistor Note: Image is provided using Fritzing Software. View in this guide to add < Extensions Analog Converter > before proceeding to add < luminosity >. You only need to add the extension once. Then proceed to add new device and widget < add new >, then go to < device/widgets >, then < sensors >, then < luminosity > and select Photoresistor. Proceed to name the widget and select the correct RPI. Select for Connectivity the recently added MCP3008 with channel 0. Choose the widget as a value and a gauge and press add sensor. You can change the widget and icon later, by modifying the settings. 13
Proximity/Distance/Generic Analog Input This sensor is commonly used for obstacle avoidance or object detection. It uses the same principal as the voltage divider. One of the lens sends out a signal that is reflected on any object to be received into the other lens. This difference is calculated with the internal circuit on the sensor and the feedback is translated into an analog value. - 1x Pi Cobbler - 1x IR Range Finder - 13x 14x Breadboard wires - 1x MCP3008 Note: Image is provided using Fritzing Software. View in this guide to add < Extensions Analog Converter > before proceeding to add < proximity >. You only need to add the extension once. Then proceed to add new device and widget < add new >, then go to < device/widgets >, then < sensors >, then < proximity/distance > and select analog distance sensor or < generic >, then select analog input. Proceed to name the widget and select the correct RPI. Select for Connectivity the recently added MCP3008 with channel 0. Choose the widget as a value and a gauge and press add sensor. You can change the widget and icon later by modifying the settings. 14
Motion This device, unlike proximity sensor cannot tell you how far an object is travelling towards the sensor. However, if the application is a simple detector of movement, then this sensor will deliver a digital value of active high or active low. This is what would happen to the proximity sensor if it was only connected into the digital pin. You will end up losing accuracy but the wiring will be reduced. - 1x PIR Sensor - 3x Breadboard wires - 1x 100Ω ¼ watt 5% tolerance resistor Note: Image is provided using Fritzing Software. Add new device and widget < add new >, then go to < device/widgets >, then < sensors >, then < motion > and select digital motion sensor. Proceed to name the widget and select the correct RPI. Select for Connectivity Integrated GPIO with channel 17. Choose the widget as a 2-state display and a gauge and press add sensor. You can change the widget and icon later by modifying the settings. 15
Generic Digital Input Buttons are a common component used to control electronic devices. They are usually used as switches to connect or disconnect circuits. Using a multimeter, if you measure the pushbutton, you will notice the entire row is shorted. The pushbutton inside has a wire that shorts the two pins in parallel creating two rows. The top row only send voltage to the bottom row when the button is pressed. - 1x Push Button - 4x 5x Breadboard wires - 1x 10kΩ ¼ watt 5% tolerance resistor Note: Image is provided using Fritzing Software. Add new device and widget < add new >, then go to < device/widgets >, then < sensors >, then < generic > and select generic digital sensor. Proceed to name the widget and select the correct RPI. Select for Connectivity Integrated GPIO with channel 17. Choose the widget as a 2-state display and a lock icon and press add sensor. You can change the widget and icon later by modifying the settings. 16
Actuators Light Switch / Relay Switch This circuit can also be done simply adding a wire to ground and a channel to turn on or off the LED. This specific circuit can do the same job. At the same time, you can also understand and get a feeling for adding relays to your projects. - 1x 5mm LED - 1x Relay Board - 1x 220Ω ¼ watt 5% tolerance resistor - 10x Breadboard wires Note: Image is provided using Fritzing Software. Add new device and widget < add new >, then go to < device/widgets >, then < actuators >, then < light > and select light switch or < relay > and select relay switch. Proceed to name the widget and select the correct RPI. Select for Connectivity Integrated GPIO with channel 13. Choose the widget as a button and a lock icon and press add sensor. You can change the widget and icon later by modifying the settings. 17
Luminosity This basic example shows how to get up and running a basic Pulse Width Modulation code. This example allows users to interact using the Dashboard to increase or decrease the brightness of the LED. The wavy lines on the digital ports stand for PWM. Not all digital pins can do this function. This PWM function is not supplied by the RPI. Using a PCA9685 IC offers the feature of PWM for the PI. - 1x 5mm LED - 1x 220Ω ¼ watt 5% tolerance resistor - 8x Breadboard wires - 1x PCA9685 PWM Board Note: Image is provided using Fritzing Software View in this guide to add < Extensions PWM > before proceeding to add < luminosity >. You only need to the extension once. Add new device and widget < add new >, then go to < device/widgets >, then < actuators >, then < light > and select luminosity. Proceed to name the widget and select the correct RPI. Select for Connectivity PWM with channel 0. Choose the widget as a button and a lock icon and press add sensor. You can change the widget and icon later by modifying the settings. 18
DC Motor Switch Motors require additional power to rotate. The higher the voltage the higher the torque. The lower the voltage, the harder it will be for the motor to spin on a given surface. The RPI can only supply 3.3V max. Using a wall adapter, you get access to 1.5Amp of current, allowing the motor to move freely and 12V, preventing the motor from stalling. That is why relays are so important. Specifically, they allow us to interface high current and voltage devices with low voltage and current microcontrollers. - 1x DC motor + 104 capacitor pre-soldered - 1x DC to Terminal Block - 1 X PI Cobbler - 1x Relay Board - 9x Breadboard wires - Optional two diodes to force current direction Note: Image is provided using Fritzing Software. Add new device and widget < add new >, then go to < device/widgets >, then < actuators >, then < motors > and select DC Motor. Proceed to name the widget and select the correct RPI. Select for Connectivity Integrated GPIO with channel 13. Choose the widget as a button and a motor icon and press add sensor. You can change the widget and icon later by modifying the settings. 19
Servo Motor Switch Unlike a DC motor, the servo motor has an interior circuit board that acts as a PID system (proportional, Integral and Differential). Using this system, it allows the servo to correct its current position with what the user demands. The user sends a PWM, Pulse Width Modulated signal, that tells when and where the servo motor must be. The circuit inside will move the motor and the encoder will tell the exact location. This information will then be transferred to the controller to correct or leave its position. - 1x PCA9685-1x Dc to terminal block connector - 1x servo motor - 12x Breadboard wires Note: Image is provided using Fritzing Software. View in this guide to add < Extensions PWM > before proceeding to add < Servo >. You only need to the extension once. Add new device and widget < add new >, then go to < device/widgets >, then < actuators >, then < motors > and select Servo Motor. Proceed to name the widget and select the correct RPI. Select for Connectivity PWM with channel 15. Choose the widget as a slider and press add sensor. You can change the widget and icon later by modifying the settings. 20
Valve Switch Relay can be found interfaced with motors, valves and even oven switches. However, if you pay close attention, you will notice sparks as you increase for higher voltage or higher current. This sparking is a common trait from relays when the voltage meets the conditions that allow it. To fix this, we use diodes to tell the current to follow a certain direction and prevent EMI Current Kickback, high pass filter and various other filtering techniques. Sometimes, for ovens, we just leave it as it is. - 1x DC connector to terminal block - 1x 12VDC Valve - 1x Relay board - 9x Breadboard wires Note: Image is provided using Fritzing Software. Add new device and widget < add new >, then go to < device/widgets >, then < actuators >, then < valve > and select valve switch. Proceed to name the widget and select the correct RPI. Select for Connectivity Integrated GPIO with channel 13. Choose the widget as a button and a motor icon and press add sensor. You can change the widget and icon later by modifying the settings. 21
Generic Digital Output This basic example shows how to set up a simple on/off circuit using the RPI. Using this example, you can turn on or off certain devices. Digital pin only exerts 3.3V out to your device. This port can also take in digital signal. These are the most common pins used for controlling or sending signals to other devices. - 1x 5mm LED - 1x 220Ω ¼ watt 5% tolerance resistor - 2x Breadboard wires Note: Image is provided using Fritzing Software. Add new device and widget < add new >, then go to < device/widgets >, then < actuators >, then < generic > and select digital output. Proceed to name the widget and select the correct RPI. Select for Connectivity Integrated GPIO with channel 23. Choose the widget as a button and a lock icon and press add sensor. You can change the widget and icon later by modifying the settings. 22
Generic PWM Output The RPI is a small computer that can access a desktop. It runs a full Linux operating system. Since the board was designed for that purpose, the cortex processor that is used is a 3.3V device. The RPI is missing a few functions compared to a popular Arduino microcontroller. Another function the RPI is missing is PWM signals as the voltage of the pins are only 3.3V. Using the PCA9685, you can supply external power if required to drive high voltage motors using PWM generated by the PCA9685 IC. The logic supply from the chip will ensure that the RPI only communicate with the device at 3.3V or less. - 1x PCA9685-1x 5mm LED - 1x 220Ω ¼ watt 5% tolerance resistor - 8x Breadboard wires Note: Image is provided using Fritzing Software. View in this guide to add < Extensions PWM > before proceeding to add < PWM >. You only need to use the extension once. Add new device and widget < add new >, then go to < device/widgets >, then < actuators >, then < generic > and select PWM output. Proceed to name the widget and select the correct RPI. Select for Connectivity PWM with channel 0. Choose the widget as a button and a lock icon and press add sensor. You can change the widget and icon later by modifying the settings. 23