Turn old pc to IoT gateway with Mozilla WebThings Gateway
11/25/2019
Add Comment
In February 6, 2018, Mozilla announced "Project Things", it is a collocation of re-usable software components to help you build your own web things, on other mean Mozilla make a framework of software and services that can bridge the communication gap between connected devices. So by this project or the tools of this project you can build your Things Gateway to control their connected devices directly from the web.
This project dived into two prates: the WebThings Gateway and WebThings Framework. I should drow a simple diagram to know the difference between these partes.
My old PC that I've used
Processor: pentium(R) Dual-core CPU ES300 @ 2.60GHz x 2
Memory (RAM): 1.8 GiB
OS: ubuntu mate 18.04
The Methode that I use to make a Gateway in this old PC
I have followed this to make a Gateway in My old pc, but see that I use Ubuntu Mate OS 18.04 if you use Windows or other flow the right codes:
Follow the directions from NodeJS to install on your platform.
Under Ubuntu/Debian Linux:
Under Ubuntu/Debian Linux:
Install OpenSSL =< 1.0.2 (normal, not light) in the same bitness as your Node.js.
See here.
Install Python 2.7 from here.
Enable "register extensions" on installing package, or associate file extension
Execute the following command as sudo (Linux) or administrator (Windows).
If you are not using VS Code, run
To compare UI with parent branch:
OS: ubuntu mate 18.04
The Methode that I use to make a Gateway in this old PC
I have followed this to make a Gateway in My old pc, but see that I use Ubuntu Mate OS 18.04 if you use Windows or other flow the right codes:
Update Package Cache (Linux only)
Under Ubuntu/Debian Linux:$ sudo apt update
Under Fedora Linux:$ sudo dnf --refresh upgrade
Install pkg-config
Under Ubuntu/Debian Linux:$ sudo apt install pkg-config
Under Fedora Linux:$ sudo dnf install pkgconfig
Under macOS:$ brew install pkg-config
Install curl (needed to install nvm)
Under Ubuntu/Debian Linux:$ sudo apt install curl
Under Fedora Linux:$ sudo dnf install curl
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.34.0/install.sh | bash
Reinitialize your terminal session.$ . ~/.bashrc
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.
Set up Bluetooth permissions (Linux only)
The following is required in order to let node and python3 use the Bluetooth adapter.$ sudo setcap cap_net_raw+eip $(eval readlink -f `which node`)
$ sudo setcap cap_net_raw+eip $(eval readlink -f `which python3`)
Install Bluetooth and BT Low Energy support libraries (Linux only)
The following are required in order to install the Python modules that support BluetoothUnder Ubuntu/Debian Linux:
$ sudo apt install libboost-python-dev libboost-thread-dev libbluetooth-dev libglib2.0-dev
Under Fedora Linux:$ sudo dnf install boost-python2-devel boost-python3-devel boost-devel bluez-libs-devel glib2-devel
Install libusb and libudev (Linux only)
Under Ubuntu/Debian Linux:$ sudo apt install libusb-1.0-0-dev libudev-dev
Under Fedora Linux:$ sudo dnf install libudev-devel libusb1-devel
Install autoconf
Under Ubuntu/Debian Linux:$ sudo apt install autoconf
Under Fedora Linux:$ sudo dnf install autoconf
Under macOS:$ brew install autoconf
Install libpng (Linux only)
Under x86-64 or x86 Ubuntu/Debian Linux:$ sudo apt install libpng16-16
Under ARM Ubuntu/Debian Linux:$ sudo apt install libpng-dev
Under Fedora Linux:$ sudo dnf install libpng-devel
Install git
You'll need git to checkout the repositories.Under Ubuntu/Debian Linux:
$ sudo apt install git
Under Fedora Linux:$ sudo dnf install git
Install gcc
Under Ubuntu/Debian Linux:$ sudo apt install build-essential
Under Fedora Linux:$ sudo dnf group install "C Development Tools and Libraries"
Install nanomsg
Linux
Under Ubuntu/Debian Linux:$ sudo apt install libnanomsg4 libnanomsg-dev
Note: you may need to use libnanomsg5 instead of libnanomsg4 (under Debian buster, for example)Windows
- Follow the directions from nanomsg to install in the same bitness as your Python 3.X.
- If you want to build for 64-bit, you need to execute cmake with
-DCMAKE_GENERATOR_PLATFORM=x64
. - Add
C:\path\to\nanomsg\bin
toPATH
.
Install OpenSSL (Windows only)
The Gateway depends onursa
, which requires OpenSSL.Install OpenSSL =< 1.0.2 (normal, not light) in the same bitness as your Node.js.
See here.
Install Python 2.7 (Windows only)
PageKite works with Python 2.7.Install Python 2.7 from here.
Enable "register extensions" on installing package, or associate file extension
.py
with python.Install Python 3.X (Optional, Windows only)
This is required in order to use Python 3 add-ons, e.g. tplink-adapter.- Install Python 3.4+ from here.
- Enable "Install launcher for all users" and "Add Python 3.X to PATH" on installing.
- Enable
python3
command using the following.
mklink "C:\path\to\python3\python3.exe" "C:\path\to\python3\python.exe"
- Install nnpy
git clone https://github.com/nanomsg/nnpy.git
cd nnpy
Add a file: site.cfg[DEFAULT]
include_dirs = C:\path\to\nanomsg\include\nanomsg
library_dirs = C:\path\to\nanomsg\lib
host_library = C:\path\to\nanomsg\bin\nanomsg.dll
Install Python Add-on Bindings (Optional)
This is required in order to use Python 3 add-ons, e.g. tplink-adapter.Execute the following command as sudo (Linux) or administrator (Windows).
python2 -m pip install git+https://github.com/mozilla-iot/gateway-addon-python#egg=gateway_addon
python3 -m pip install git+https://github.com/mozilla-iot/gateway-addon-python#egg=gateway_addon
Note: 2018-04-12: pip3
has an issue with some languages.Download and Build Gateway
-
Clone the GitHub repository (or fork it first):
$ git clone https://github.com/mozilla-iot/gateway.git
-
Change into the gateway directory:
$ cd gateway
-
If you have chosen to install nvm above, install and use an LTS version of node and then set the default version. The
.nvmrc
file will be used by nvm to determine which version of node to install.
$ nvm install $ nvm use $ nvm alias default $(node -v)
-
Verify that node and npm have been installed:
Note: these versions might differ from the LTS version installed locally.$ node --version v8.15.1 $ npm --version 6.4.1
-
Install dependencies:
$ npm install
```
$ sudo npm i --unsafe-perm
```
-
Add Firewall exceptions (Fedora Linux Only)
$ sudo firewall-cmd --zone=public --add-port=4443/tcp --permanent $ sudo firewall-cmd --zone=public --add-port=8080/tcp --permanent $ sudo firewall-cmd --zone=public --add-port=5353/udp --permanent
-
Set up domain:
- If you plan to use Mozilla's provided tunneling service to set up a
*.mozilla-iot.org
domain:-
Start the web server:
$ npm start
-
Load
http://localhost:8080
in your web browser (or use the server's IP address if loading remotely). Then follow the instructions on the web page to set up domain and register. Once this is done you can loadhttps://localhost:4443
in your web browser (or use the server's IP address if loading remotely).
-
Start the web server:
- If you plan to use your own SSL certificate:
-
The HTTPS server looks for
privatekey.pem
andcertificate.pem
in thessl
sub-directory of theuserProfile
directory specified in your config. You can use a real certificate or generate a self-signed one by following the steps below.
$ MOZIOT_HOME="${MOZIOT_HOME:=${HOME}/.mozilla-iot}" $ SSL_DIR="${MOZIOT_HOME}/ssl" $ [ ! -d "${SSL_DIR}" ] && mkdir -p "${SSL_DIR}" $ openssl genrsa -out "${SSL_DIR}/privatekey.pem" 2048 $ openssl req -new -sha256 -key "${SSL_DIR}/privatekey.pem" -out "${SSL_DIR}/csr.pem" $ openssl x509 -req -in "${SSL_DIR}/csr.pem" -signkey "${SSL_DIR}/privatekey.pem" -out "${SSL_DIR}/certificate.pem"
-
Start the webserver:
$ npm start
-
Load
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.
-
The HTTPS server looks for
- If you plan to use Mozilla's provided tunneling service to set up a
Browser Support
The Gateway only supports the following browsers, due to its use of theFetch API
and WebSocket API
:- Firefox 52+
- Chrome 43+
- Edge 14+
- Safari 10.1+
- Opera 29+
Debugging
If you are using VS Code, simply use the "launch" target. It will build the gateway in debugger mode.If you are not using VS Code, run
npm run debug
and it will build the gateway and launch it with --inspect
.Install additional dependencies for Test (Debian)
These steps are required on Debian (where python points to python 2.7)$ sudo apt install python-pip python3-pip firefox openjdk-8-jre
$ sudo python3 -m pip install git+https://github.com/mycroftai/adapt#egg=adapt-parser
Running Tests
To run the linter and all tests:$ npm test
To run a single test:$ jest src/test/{test-name}.js
(assumes you have the jest
command on your PATH
, otherwise, use ./node_modules/jest/bin/jest.js
)To compare UI with parent branch:
$ npm run screenshots
$ npm test
(if you have the screenshots in the folder ./browser-test-screenshots
, npm test
should compare UI with screenshots stored)
No comment