Node.js API wrapper for the UC Integration API

This library simplifies writing Node.js based integrations for the Unfolded Circle Remote devices by wrapping the WebSocket Integration-API.

It's a beta release (in our eyes). Breaking changes are to be expected and missing features will be continuously added.
Since JavaScript & TypeScript are not our main languages, certain things might not be the "JS-way" ☺️ Let us know how to improve the library!

Not supported:

• Secure WebSocket
• Token based authentication

Requirements:

• For local development and writing external integration drivers:
  • Node.js v16.18.0 or newer (older versions are not tested).
  • Development dependencies require at least v18.18
  • Node.js version manager nvm can be used to switch versions.
• For writing custom integration drivers running on the Remote device:
  • The Remote Two firmware up to version 1.9.2 contains Node.js v16.18
  • Newer firmware versions contain Node.js v20.16

Installation

npm install @unfoldedcircle/integration-api

Usage

The examples directory contains some minimal examples in JavaScript on how to get started using the Node.js API wrapper.

See integration-ts-example for a simple integration driver project using TypeScript. This project can be used as a template for writing an integration driver.

We highly recommend using TypeScript for any new project using this package!
We might even move the runtime on the Remote to Deno v2. Stay tuned :-)

Environment Variables

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

Logging

Logging any kind of output is directed to the debug module. To let the UC API wrapper output anything, run your integration driver with the DEBUG environment variable set like:

DEBUG=ucapi:* node driver.js

UC API wrapper exposes the following log-levels:

• ucapi:msg: WebSocket message trace
• ucapi:debug: debugging messages
• ucapi:info: informational messages like server up and running, client connected or disconnected.
• ucapi:warn: warnings
• ucapi:error: errors

If you only want to get errors and warnings reported:

DEBUG=ucapi:warn,ucapi:error node driver.js

Combine those settings with your existing application if any of your other modules or libs also uses debug

Versioning

We use SemVer for versioning. For the versions available, see the tags and releases on this repository.

Changelog

The major changes found in each new release are listed in the changelog and under the GitHub releases.

Contributions

Please read our contribution guidelines before opening a pull request.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.