{"repo":"unfoldedcircle/core-api","free":true,"listed":false,"github":"https://github.com/unfoldedcircle/core-api","clone":"git clone https://github.com/unfoldedcircle/core-api.git","description":"API specifications for Remote Two/3 by Unfolded Circle","language":"Shell","stars":98,"topics":["api","asyncapi","documentation"],"license":"CC-BY-SA-4.0","category":"api-integrations-sdks","readme_excerpt":"Unfolded Circle Core APIs This repository contains API specifications of Unfolded Circle Remote products. Read the Developer Guide which presents the ./doc content in a structured and searchable book format. Overview - Remote Two user interface - Bluetooth HID peripheral support API definitions: - WebSocket Integration-API defined with AsyncAPI. - WebSocket Core-API defined with AsyncAPI - REST Core-API defined with OpenAPI - WebSocket Dock-API defined with AsyncAPI Integration driver documentation: - Remote Two entities. - How to write an integration driver. - WebSocket handling: authentication, keep alive, error handling. Integration API The Remote WebSockets integration-API allows writing device integrations for the Unfolded Circle Remote devices. At the moment only user integrations running on an external host are supported. ℹ️ Beta release 1.9.0 allows to install custom integration drivers on the Remote. This is a developer preview feature to test their integrations. The integration driver acts as server and the Remote device as client. The remote connects to the integration when an integration instance is configured. Whenever the remote enters standby it may choose to disconnect and automatically reconnect again after wakeup. The goal of the integration-API is to cover not only simple static drivers, like controlling GPIOs on a Raspberry Pi, but also support to integrate existing home automation hubs like Home Assistant, Homey, openHAB etc. The focus of the integration ","default_branch":null,"files":null,"tree":[],"storefront":"/r/unfoldedcircle","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/unfoldedcircle/core-api/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}