Remote Two/3 API Documentation
Visit the core-api GitHub project site where this documentation was built from and where you can find further technical information.
Introduction
- Remote Two user interface
- Remote Two entities
- Bluetooth HID peripheral support
- Remote Two DNS-SD lookup
Core API
The Unfolded Circle Remote WebSocket & REST Core-APIs allow you to interact with the Unfolded Circle remote-core service and take full control of its features.
The focus of the Core-APIs is to provide all functionality for the UI application and the web-configurator. The APIs are specialized for certain tasks, but otherwise contain the same functionality and data models.
- The UCR REST Core-API adds:
- Custom resource handling for uploading icons, images etc.
- Installing custom remote-ui and web-configurator components.
- Installing custom integration drivers.
- User management and authentication handling.
- The UCR WS Core-API adds:
- Event subscription with asynchronous notifications.
The Core-APIs may also be used by other external systems and integration drivers, if specific configuration or interaction features are required, which are not present in the UCR Integration-API.
The API specifications are defined with OpenAPI & AsyncAPI in YAML format.
Dock API
The Remote Two/3 WebSocket Dock-API allows you to directly interact with the Unfolded Circle smart charging docks and take full control of its features.
The API specification is defined with AsyncAPI in YAML format. The WebSocket communication is using text messages with JSON payload.
- Dock AsyncAPI documentation viewer
- Dock AsyncAPI YAML definition
- View with the AsyncAPI Studio online tool.
The link will directly load the yaml definition file from GitHub and display it together with the HTML documentation in the browser.
Integration API
The Unfolded Circle WebSocket Integration-API allows writing device integration drivers for the Unfolded Circle Remotes.
The API specification is defined with AsyncAPI in YAML format. The WebSocket communication is using text messages with JSON payload.
- Integration AsyncAPI viewer
- Integration AsyncAPI YAML definition
- View with AsyncAPI Studio online tool.
The link will directly load the yaml definition file from GitHub and display it together with the HTML documentation in the browser.
Integration Driver
- How to write an integration driver
- WebSockets handling
- Driver registration
- Driver setup
- Install integration driver on the device
Contact us
There are a few different ways to reach us:
- Visit our GitHub site
- Reach out to us on X
- Visit our community forum
- Chat with us in our Discord channel
- Send us a message on our website
Contributions
Please read our contribution guidelines before opening a pull request.
License
We have published the API specifications and documentations under the CC-BY-AS-4.0
(Creative Commons Attribution-ShareAlike 4.0 International) license.
All code examples in this repository are licensed under the Apache License 2.0.
All graphics copyright © Unfolded Circle ApS 2022.