This library simplifies writing Node.js based integrations for the Unfolded Circle Remote devices by wrapping the WebSocket Integration API.
It's an alpha release (in our eyes). Breaking changes are to be expected and missing features will be continuously added.
Not supported:
- Secure WebSocket
- Token based authentication
Requirements:
- Node.js v16.18.0 or newer (older versions are not tested)
Certain features can be configured by environment variables:
| Variable | Values | Description |
|---|---|---|
| UC_CONFIG_HOME | directory path | Configuration directory to save the user configuration from the driver setup. Default: $HOME or current directory |
| UC_INTEGRATION_INTERFACE | address | Listening interface for WebSocket server. Default: 0.0.0.0 |
| UC_INTEGRATION_HTTP_PORT | number | WebSocket listening port. Default: port field in driver metadata json file, if not specified: 9090 |
| UC_DISABLE_MDNS_PUBLISH | true / false |
Disables mDNS service advertisement. Default: false |
Look into examples for some pointers.
We use SemVer for versioning. For the versions available, see the tags and releases on this repository.
The major changes found in each new release are listed in the changelog and under the GitHub releases.
Please read our contribution guidelines before opening a pull request.
This project is licensed under the Apache License 2.0. See the LICENSE file for details.