Things Gateway by Mozilla
Web of Things gateway.
(If you're just installing on your PC, you can skip this step).
If you're installing on a Raspberry Pi then you may need to set up the OS on the Raspberry Pi first. See here for instructions.
$ sudo apt-get install pkg-config
Install nvm (Recommended)
nvm allows you to easily install different versions of node. To install nvm:
$ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.1/install.sh | bash
Close and reopen your terminal window. Use nvm to install node and set the default version.
$ nvm install v7.7.2 $ nvm use v7.7.2 $ nvm alias default v7.7.2
Verify that node and npm have been installed:
$ npm --version 4.1.2 $ node --version v7.7.2
Install node (if you didn't use nvm)
(If you already installed node via nvm you can skip this step)
Follow the directions from NodeJS to install on your platform.
Install libusb and libudev (Linux only)
$ sudo apt-get install libusb-1.0-0-dev libudev-dev
You'll need git to checkout the repositories.
$ sudo apt-get install git
Build and Install openzwave
$ cd $ git clone https://github.com/OpenZWave/open-zwave.git $ cd open-zwave $ make && sudo make install
Note: You may need to manually add
/usr/local/lib to your
LD_LIBRARY_PATH enviroment variable by adding the following to your
(You can run this on the command line as well so it has immediate effect).
Download and Install gateway
Clone the GitHub repository (or fork it first):
$ cd $ git clone https://github.com/mozilla-iot/gateway.git
Change into the gateway directory:
$ cd gateway
yarn is preferred but npm install will also work.
Add SSL certificate:
The HTTPS server looks for privatekey.pem and certificate.pem. You can use a real certificate or generate a self-signed one by following the steps below.
$ openssl genrsa -out privatekey.pem 2048 $ openssl req -new -sha256 -key privatekey.pem -out csr.pem $ openssl x509 -req -in csr.pem -signkey privatekey.pem -out certificate.pem
Start the web server:
$ npm start
https://localhost:4443 in your web browser (or use the server's IP address if loading remotely).
Since you're using a self-signed certificate, you'll need to add a security exception in the browser.
If you are using vscode simply use the "launch" target it will build the gateway in debugger mode.
If you are not using vscode run
npm run debug and it will build the gateway and launch it with --inspect.
Source Code Structure
- /config/ - Gateway configuration
- /src/adapters/ - Adapter device drivers (e.g. ZigBee, Z-Wave)
- /src/controllers/ - App URL routes and their logic
- /src/models/ - Data model and business logic
- /src/tools/ - Helpful utilities (not part of the build)
- /src/views/ - Web app front end views
- /src/adapter-manager.js - Manages adapters (e.g. ZigBee, Z-Wave)
- /src/app.js - The main back end script
- /src/constants.js - System wide constants
- /src/db.js - Manages the SQLite3 database
- /src/package.json - npm module manifest
- /src/router.js - Routes app URLs to controllers