Development

WebThings Gateway is an open source project maintained by a community of volunteers.

To get started hacking on the gateway, see the README and wiki.

As of version 2.0, the API exposed by the gateway is compliant with the W3C Web of Things 1.x family of standards.

This includes WoT Thing Description 1.1 for describing connected devices in a standardised way, WoT Discovery 1.0 for exposing a directory of devices, and WoT Profiles 1.0 (including the HTTP Basic Profile and HTTP SSE Profile) for providing interoperability guarantees.

🗒️ Note: Versions 1.0 and 1.1 of the gateway used our legacy Web Thing API. You can see an overview of differences between the two here.

Add-on Development

WebThings Gateway has a directory of community-contributed add-ons which enhance its capabilities.

To learn how to develop your own add-on or contribute to an existing one, you may want to start with the resources below:

• Introduction to Add-ons
• Creating an Add-on
• Configuring an Add-on
• Publishing an Add-on
• Examples:
  • Adapter Add-on
  • Notifier Add-on
  • Extension Add-on
• Add-on APIs
  • Node.js Add-on API
  • Python Add-on API
• Adapter Inter-process communication
• Debug Controller
• Updating add ons for WebThings Gateway 2.0