The Home Automation System API allows you to interact with a Beoremote Halo.
Requires Beoremote Halo version 1.4.759
Copyright 2021 Bang & Olufsen a/s
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
WebSocket
Home Automation system to Beoremote Halo.
Accepts one of the following messages:
Page layout configuration
The configuration contains the complete setup of the page(s) and button(s) Halo will present on the home automation screen. This can be used as a standalone setup or used together with a product.
{
"configuration": {
"version": "1.0.1",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"pages": [
{
"title": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"buttons": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"subtitle": "string",
"value": 100,
"state": "active",
"content": {
"text": "string"
},
"default": true
}
]
}
]
}
}
Updates from Home Automation System which should be reflected on Halo
The Home Automation System is able to request different updates like a page update change, button update change or notification update which will be displayed on Halo until it is dismissed.
{
"update": {
"type": "button",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"subtitle": "string",
"value": 100,
"state": "active",
"content": {
"text": "string"
}
}
}
Beoremote Halo to Home Automation system.
Accepts the following message:
Events from Halo to Home Automation System
Halo will send status events when updates are received from the Home Automation System. System changes are sent when Halo switches power state. Power events are sent when the Halo battery charge state has changed. Button and wheel events are sent when operated. Errors messages are sent upon malformed configuration or update.
{
"event": {
"type": "status",
"state": "ok",
"message": "string"
}
}
Page layout configuration
The configuration contains the complete setup of the page(s) and button(s) Halo will present on the home automation screen. This can be used as a standalone setup or used together with a product.
Updates from Home Automation System which should be reflected on Halo
The Home Automation System is able to request different updates like a page update change, button update change or notification update which will be displayed on Halo until it is dismissed.
Events from Halo to Home Automation System
Halo will send status events when updates are received from the Home Automation System. System changes are sent when Halo switches power state. Power events are sent when the Halo battery charge state has changed. Button and wheel events are sent when operated. Errors messages are sent upon malformed configuration or update.