Home

General

• Glossary of Terms
• Installing Node.js
• Setting up Raspberry Pi

WebThings Gateway

• REST & WebSocket API
  • Differences with W3C Spec
• Schemas - used in thing descriptions provided by API
• Getting Started Guide
• User Guide
• Gateway Architecture - The basic architecture of the system to help devs get started
• Supported Hardware - A list of supported gateway hardware, adapters and devices
• Logging into the Raspberry Pi - How to access the command line
• Gateway Remote Access - How secure remote access works
• Configuring GPIO - How to configure General Purpose Input/Output Ports on Raspberry Pi
• curl examples - A repository containing some example scripts which can login, get a list of things, and get or set properties.
• Fluent: Making a new translation

Build and Release

• Manually build the gateway

Raspbian

The new way

This is the process as of 0.12. You can build on either Linux or macOS. You will need the following prerequisites:

• Docker
• (On Linux) qemu
• (On Linux) qemu-user-static
• (On Linux) binfmt-support
• (On Linux) unzip
• (On Linux) kpartx
• (On Linux) you will need the loop kernel module to be loaded, e.g. sudo modprobe loop

After installing the packages above, run the following inside a cloned gateway repo.

cd <gateway>/image
./build.sh

Wait for quite a while. After the process completes, you'll be left with the 4 files required for a release:

• gateway-<version>.img.zip - the Raspbian image
• gateway-<version>.img.zip.sha256sum - sha256sum of the Raspbian image
• gateway-<checksum>.tar.gz - gateway tarball used for OTA updates
• node_modules-<checksum>.tar.gz - node_modules tarball used for OTA updates

To test the Raspbian image, just flash it to an SD card as you normally would. To test the OTA update, you'll need to upload the relevant files to a GitHub release and then follow these instructions.

The old way

The files required for this method don't exist past 0.11, but the instructions should be kept around just in case we need to switch back. It's a non-trivial process.

• Creating the base image file for the Raspberry Pi
• Creating the final image
• How To Release a Gateway OTA Update
• Testing prerelease OTA updates
• Loop mounting a Raspberry Pi image file under Linux

OpenWrt (old)

• OpenWrt
• Setting up the Turris Omnia Router
• Installing the gateway software on the Turris Omnia

Testing

• Running OAuth Locally

Add-ons

General

• HOWTO: Create an add-on
• Add-on Guidelines
• Examples:
  • Adapter
  • Notifier
  • Extension
• Add-on APIs:
  • Node.js
  • Python
• Add-on Configuration
• Add-on Packaging
• Add-on Publishing
• Adapter IPC - Inter-process communications between an add-on and the gateway
• Command Line Tool - Useful for debugging
• Using the debug controller

Z-Wave

• Installing OpenZWave
• Node for OpenZWave
• Debugging OpenZWave

Zigbee

• Debugging Zigbee
• Recording Frames sent by XCTU (Zigbee)
• Zigbee Attributes
• HOWTO: Factory reset a Cree Connected bulb
• HOWTO: Factory reset a Hue bulb
• HOWTO: Factory reset a Hue Wireless Dimmer
• HOWTO: Factory reset an IKEA bulb
• Pairing SmartThings sensors

External Links and Resources

• Mozilla Hacks - official blog
• twobraids - series of posts about the gateway itself and scripts to interact with it
• YouTube - search for "mozilla iot", "mozilla things", etc.

Environment Setup

• Setup of eslint in PyCharm - Get PyCharm to use the proper linting tool for the WebThings Gateway

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.