https://github.com/cblomart/go-hue-bridge
https://github.com/cblomart/go-hue-bridge
domoticz home-assistant home-automation hue-api hue-bridge
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cblomart/go-hue-bridge
- Owner: cblomart
- License: mit
- Created: 2022-02-04T21:18:56.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-19T12:32:50.000Z (about 2 years ago)
- Last Synced: 2024-11-15T21:33:09.158Z (over 1 year ago)
- Topics: domoticz, home-assistant, home-automation, hue-api, hue-bridge
- Language: Go
- Homepage:
- Size: 49.8 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Golang Hue Bridge
The goal of this project is to build a simple golang hue brige implementing basic hue APIs.
It would mainly translate calls to the hue hub v1 api to calls to swith lights on or off.
It will support only on off: no colors or gradations.
## Hue Hub API
I don't have a fully docummented HUB API. It has been implemented by many other projects but sometimes fails with Alexa.
Discovery is done over SSDP responding to SSDP calls
```http
HTTP/1.1 200 OK
CACHE-CONTROL: max-age=100
EXT:
LOCATION: http://192.168.0.21:80/description.xml
SERVER: FreeRTOS/6.0.5, UPnP/1.0, IpBridge/0.1
ST: upnp:rootdevice
USN: uuid:2fa00080-d000-11e1-9b23-001f80007bbe::upnp:rootdevice
```
The discovery will provide a ```/discovery.xml``` url with details of the hub.
Request:
```http
GET /discovery.xml
```
Response:
```xml
1
0
http://{ip}:{port}/
urn:schemas-upnp-org:device:Basic:1
Philips hue ({ip})
Royal Philips Electronics
http://www.philips.com
Philips hue Personal Wireless Lighting
Philips hue bridge 2015
BSB002
http://www.meethue.com
{serial}
uuid:{uuid}
```
Once Alexa has discovered the hub information it will use Hue API (v1) to discover lights.
The first thing Alexa will do is call the ``/api`` endpoint to associate with the hub and recieve a username.
The username will be leveraged in the uri of subsequent api calls to identify the hub.
The username is a random hex string of 16bytes.
Request:
```http
GET /api
```
Response:
```json
[
{
"success": {
"username": "{username}"
}
}
]
```
Once Alexa is associated to the hub it will query the lights endpoint to list all lights:
There i had to find the necessary attributes that needed to be presented. I chose to present OSRAM switches because these where the only on/off switches i could find on.
I started by adding all the attributes listed on ``Philips`` website but discovery didn't work. Alexa requested the lights endpoint ~10 times and failed to discover anything.
I found that some emulation softawre added the ``pointsymbol`` attribute. By adding it discovery did work.
Luckily i created a way to generate unique ids as described on ``Philips`` website as it turns out reverting to simple ids break the discovery too.
> *TODO*: check if exposing a specific device type is alright rather than copying existing ones
Request:
```http
GET /api/{username}/lights
```
Response:
```json
{
"20": {
"name":"Cave",
"manufacturername":"OSRAM",
"modelid":"Plug 01",
"swversion":"v1.04.12",
"type":"On/off light",
"uniqueid":"00:7d:e8:a0:eb:37:00:f8-a4",
"state": {
"on":false,
"reachable":true
},
"pointsymbol":{}
},
"21": {
"name":"Cave - escalier",
"manufacturername":"OSRAM",
"modelid":"Plug 01",
"swversion":"v1.04.12",
"type":"On/off light",
"uniqueid":"00:b5:64:46:fb:57:38:28-80",
"state": {
"on":false,
"reachable":true
},
"pointsymbol":{}
}
}
```
Once Alexa have discovered the lights list it will poll to each light to have their status.
Request:
```http
GET /api/{username}/lights/{id}
```
Response:
```json
{
"name":"Cave",
"manufacturername":"OSRAM",
"modelid":"Plug 01",
"swversion":"v1.04.12",
"type":"On/off light",
"uniqueid":"00:7d:e8:a0:eb:37:00:f8-a4",
"state": {
"on":false,
"reachable":true
},
"pointsymbol":{}
}
```
To change the state of a light Alexa will send a state request to a light with a put method
Request:
```http
PUT /api/{username}/lights/{id}/state
```
Request content:
```json
{
"on":true
}
```
Response:
```json
[
{
"success": {
"/lights/20/state/on": true
}
}
]
```