I am currently developing a binding to host openHAB things as WebThings (https://iot.mozilla.org/wot/#web-thing-description) so that they are accessible by other applications - mostly the Mozilla Gateway (https://iot.mozilla.org/). Furthermore, you can connect openHAB things and (Mozilla) WebThings to control each other.
Edit: It is now possible to auto-discover and manually import WebThings into openHAB and control them afterwards.
Copy the files from the dependencies folder and the binding into your addons folder
Supported Things
WebThings WebThing: Import and control a WebThing.
WebThings Server: Host your openHAB things as WebThings.
WebThings Connector: Connect openHAB things and WebThings.
Discovery
Automatically discovers:
WebThings from the Gateway based on binding configuration
WebThings from local WebThing Servers via mDNS
Binding Configuration
Configuration Parameters:
Server URL of WebThing Server: Currently only Mozilla Gateways supported. This is used for by the WebThings Connector.
Bearer token: Token for the Connector Things authorization. Can be generated in the Mozilla Gateway: Settings --> Developer --> Create local authorization
OpenHAB IP and Port: OpenHAB instance to get necessary information from. Used for REST API calls.
Match capabilities: If true the WebThing Server will try to add a @type to each WebThing to match Mozilla capabilities based on default tags - this may not always work flawlessly for all things. If set to false, all WebThings will appear as custom things.
Additional:
Background Discovery: If true all WebThings from the selected Gateway will be automatically discovered, without the need to manually start a search (may generate a lot of inbox entries if many things exist)
Operating system: Choose your installation (can be used as fallback option to import ThingUIDs for the WebThing Server)
Custom path: Set a custom path in case your operating system is not listed or you use a non-standard userdata directory
Thing Configuration
WebThings WebThing
Configuration parameters:
Link of WebThing: Link to WebThing to be imported
Security Scheme: Security method to access the respective WebThing
Security Token: Authorization token for “Bearer” authorization
Import Token: If true the security token can be left blank and will be imported from the binding configuration
WebThings Server
Configuration parameters:
Port of WebThing Server: Port to host your Webserver on. Multiple servers possible.
Linked items: Choose whether to create a property for every channel of the openHAB thing or for every item linked to it. For linked items naming convention of simple linking is currently advised
Host all things: Host all things (except things created by this binding) or only selected ones.
Selected openHAB things: Choose openHAB things to host as WebThings (only if 3. = false).
WebThings Connector
Configuration parameters:
ID of WebThing
UID of openHAB thing
Channels
Thing
channel
type
description
WebThing
Automatic
Automatic
All channels will be automacially generated based on the WebThing properties
Thing
channel
type
description
Server
Port
Number
Port of WebThing Server
Server
Hosted WebThings
Text
List of openHAB things hosted as WebThings
Thing
channel
type
description
Connector
Update
Switch
Can be used to restart the websocket (re-connect)
Connector
ID
String
ID of WebThing
Connector
UID
String
UID of openHAB thing
Example Use Cases
Easily add real world objects to openHAB using any of the existing WebThing Frameworks (Node.js, Pytho, Java, Rust, C#, Go, …) without the need for a binding
Single platform for multiple smart homes or smart home systems from one or multiple networks
Remote access
Sync openHAB instances
Authorization concept (expose different WebThing Servers with selected things via reverse proxy)
Planned Updates
Resolve known issues
Support for more items types / properties
Known Issues
Issue
Impact
Status
Workaround
Dependency incompatibility when REST API docs are installed
Binding may not start
Active
Remove docs --> install binding --> install docs
First command for switch item / OnOff property gets send but not detected by gateway
Command not properly received
Active
Send another command after initially connecting
Add webthing as internal dependency
Dependencies need to be deployed manually
Active
Add lib directory (currently not compiling)
ItemStateChangeEvents for items with delimiters are not processed correctly
Some items are not controllable
Active
Switch case for special items
WebThings can only be accessed via their index in list (e.g. localhost:8888/0)
Removal of things from a WebThing Server will change the indices of the other things
Active
Create multiple servers so that changes to one do not affect all things
WebThings WebThing label & location can not be updated
Things need to be re-created
Active
Set during creation
ConfigOptionProvider for WebThing Server may request the openHAB thing list before the API is ready
Server may not be creatable
Resolved
Try to manually restart bundle, Re-compile without WebThingsConfigOptionProvider.java
This is great, I’m using openHAB at home and at the same time I like developing Mozilla WebThings. Until now there was no simple way to connect those WebThings directly to openHAB. I’ll give this a try, thanks for putting effort into this!
I added a pre-build jar for testing. You can find it here.
Be aware that this is the barebones version of the binding, which only supports importing WebThings and not converting OH --> WoT (the reason for there being two version can be found in the issue on GitHub).
I will make a [WIP] pull request soon, so there should be an officially compiled version coming.
Thanks for publishing the jar file! I’ve tested the binding, it’s exactly the functionality I’m searching for: Controlling WebThings via openHAB. Thanks for working on this!
In my case adding the add on (and dependencies) to the addons/ folder caused my openHAB installation to become unstable. Other functionality (REST API and Paper UI) became unresponsive, throwing HTTP 503 errors in a irregular but rising basis. Nevertheless I was able to find and add one of my WebThings (an Arduino RGB-Lamp). Interface was intuitive, so looks promising. I did not figure out how to control my device, but also did not invest much time. Maybe my self-implemented API is not fully conform to the standard or they just can’t be detected automatically.
I’m limited in time, but will keep a close eye on this and test new versions when they become available. Let me know if you’re interested in logs or anything. I’ve also subscribed to the GitHub issue.
There should not be special dependencies. What are the Things that you can create with the binding - only a WebThings WebThing or also Servers/Connectors? (maybe i provided the wrong JAR).
I made the observation that the WebSocket can break, when the request is not in a specific format. I tested the connection for WebThings imported from the Mozilla Gateway and the Java, NodeJS and Python Frameworks. Interestingly, the Gateway has slighlty different syntax than the Framework, so maybe it’s the same case for you self-implemented API. In that case, you should get an error in your logs and the Thing goes offline with a communication error.
You should be able to control your WebThing with normal openHAB items. Take a look at the channels the binding automatically creates for your imported thing and add respective items. Keep in mind that actions and events are not yet supported.
Edit: If desired I can provide screenshots/a video on how to use the binding.
Are there any updates on this? Any plans to publish this binding on the marketplace or as part of the next release? I would be pleased very happy about it
Unfortunately, there seems to be no progress here. For this reason, I started a new implementation from scratch for the upcoming openHab 3. See New OpenHAB 3 WebThing binding. Feedback welcome
Thanks for your fast reply. We were not watching the forums lately, due to our decision to wait until OH3 will be released. Unfortunately, I was not subscribing to this thread or I did not notice your question. Actually I detected your thread, when I was trying to figure out how to proceed with our WIP bindings, now that OH3 is out.
Maybe we should try to combine our efforts. As far as I know, Sven (the initial main developer of the addon) got some advice how to improve the binding, i.e. offering it as a system integration instead of an addon and some more. I see the following next steps:
Figure out what kind of differences are between our approaches.
Bringing a WebThings addon into official repos.
How would you like to proceed?
Regarding our current addon approach: as far as I know, there is no other PR. Currently our addons are in a private repository, so I have no idea what kind of differences exist.
My Binding is a client-binding only. It does not support providing OpenHAB artifacts as a WebThing server. By implementing my binding I took also a look at Sven’s implementation. Especially, I improved the discovery process by supporting Multiple WebThings running on the same port as well as considering HTTPS. These have not been covered by Sven’s implementation. Furthermore, I spent a lot of effort to make the binding as stable as possible e.g. by handling unexpected error cases.
Do not get me wrong - it is great that you spend some time and effort to help openHAB.
Moreover, thanks for your explanation regarding the differences. I will have a look at the code and try to figure out how we proceed from our side. We’ll keep you posted.
