https://github.com/nebrius/nodesummit-nodebots-2017
Information for the NodeBots workshop at Node Summit 2017
https://github.com/nebrius/nodesummit-nodebots-2017
Last synced: 6 months ago
JSON representation
Information for the NodeBots workshop at Node Summit 2017
- Host: GitHub
- URL: https://github.com/nebrius/nodesummit-nodebots-2017
- Owner: nebrius
- License: mit
- Created: 2017-07-24T06:21:04.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-25T21:16:13.000Z (almost 9 years ago)
- Last Synced: 2025-02-08T08:46:58.926Z (over 1 year ago)
- Size: 41 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Node Summit 2017 NodeBots Workshop
## First run
```
sudo apt-get upgrade && sudo apt-get update -y && sudo apt-get -y install git vim && curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash - && sudo apt-get install -y nodejs && cd nodebot && npm install johnny-five raspi-io
```
## Introduction
In this workshop, we will be programming a Raspberry Pi using Node.js, [Johnny-Five](http://johnny-five.io/), and [Raspi IO](https://github.com/nebrius/raspi-io) to make Johnny-Five work on the Raspberry Pi. When using Raspi-IO, be sure to pay attention to the [pin naming scheme](https://github.com/nebrius/raspi-io/wiki/Pin-Information) as it can be a little confusing.
The Raspberry Pi's provided come with Linux, Node.js, and Johnny-Five plus Raspi IO preinstalled. Look at the top of the Raspberry Pi and note the number on it. To log in to your Raspberry Pi:
1. Connect your laptop to the `nodebots` wifi, using password `raspberry`.
1. SSH into your Raspberry Pi with `ssh pi@10.0.0.` and password `rpi`.
1. Navigate to the `/home/pi/nodebot` folder. This folder has Johnny-Five and Raspi IO preinstalled for you.
1. Create a mirror folder on your local machine called `nodebot`. This is where we'll put our code.
1. To sync your local code with your Raspberry Pi run `rsync -avz -e ssh nodebots pi@10.0.0.:/home/pi`
- Be careful when running the command that you don't use `.` as the source folder, and that you do not have a trailing slash in the source folder. Otherwise, this will cause BASH to copy the contents of the project folder into your home folder without putting it in a separate folder called ``, i.e. it gets messy :)
1. Run your project with `sudo node index.js`
If this all looks intimidating to you, don't worry! We will go through these steps together.
## Hello Raspi-IO
For the this part of the workshop, we will build the "Hello World" of hardware: getting an LED to blink! For this part of the workshop, use the following schematic:
The objective is to make the LED blink once per second. Take a look at the [Led](http://johnny-five.io/api/led/) class in Johnny-Five. Remember to check the [pin naming scheme](https://github.com/nebrius/raspi-io/wiki/Pin-Information) to see what the pin number should be!
## Distributed Environmental Sensing System
For this part of the workshop, we will build a distributed environmental sensing system. For this part of the workshop, use the following schematic:
For this part of the workshop, we will build two parts: the client and a server.
### Client
In this case, the "client" is the Raspberry Pi itself. The client needs to do the following:
1. Read the temperature, pressure, and humidity from the [BME280 sensor](http://johnny-five.io/examples/multi-BME280/) provided in the kit.
2. If the temperature gets too high or too low, then trigger an alarm
1. Set the low threshold to 3 degrees below room temperature, and the high threshold to 3 degrees above room temperature. This way, you can make it warmer or cooler by blowing on it.
1. When an alarm is triggered, flash the LED four times per second
1. Write some code so that it turns the alarm off when the [button](http://johnny-five.io/api/button/) is pressed.
3. Send the sensor data and the alarm status to the server
### Server
In this case, the "server" will be a Node.js process running on your local laptop. The server needs to do the following:
1. Listen for clients that send sensor data to it and store it in memory
1. Serve a basic web page that displays the current sensor data from all connected Raspberry Pis to the user
1. Shows when a temperature alarm is triggered
1. Provides a button in the web page for a user to turn the alarm off
I recommend using [socket.io](https://socket.io/) to handle the connection to make it easier for the server to tell the client to turn an alarm off. This can, however, be done with REST calls if you prefer.
For bonus points, team up with a neighbor and make sure that connecting two or more Raspberry Pi's to the server works.
# License
MIT License
Copyright (c) 2017 Bryan Hughes
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.