mirror of https://github.com/bwssytems/ha-bridge.git synced 2025-12-16 18:24:36 +00:00

Go to file

Admin 3c54ccd56d Finished implementation of generic UDP handling. This will support the

LimitlessLED Bridge. Updated Readme for UDP and more on configuration
setup. Fixed issue with HueMulator handliong due to devices without
mapTypes.

Fixes #6.

2015-12-07 16:34:37 -06:00

src/main

Finished implementation of generic UDP handling. This will support the

2015-12-07 16:34:37 -06:00

.gitattributes

Populate git repository

2015-07-28 12:21:10 -05:00

.gitignore

update project synchronization settings.

2015-09-14 09:10:21 -05:00

.project

update project synchronization settings.

2015-09-14 09:10:21 -05:00

LICENSE

Populate git repository

2015-07-28 12:21:10 -05:00

pom.xml

Finished implementation of generic UDP handling. This will support the

2015-12-07 16:34:37 -06:00

README.md

Finished implementation of generic UDP handling. This will support the

2015-12-07 16:34:37 -06:00

README.md

ha-bridge

Emulates Philips Hue api to other home automation gateways such as an Amazon Echo. The Bridge handles basic commands such as "On", "Off" and "brightness" commands of the hue protocol. This bridge can control most devices that have a distinct API. In the cases of systems that require authorization and/or have API's that cannot be handled in the current method, a module may need to be built. The Harmony Hub is such a module. The Bridge has helpers to build devices for the gateway for the Logitech Harmony Hub, Vera, Vera Lite or Vera Edge. Alternatively the Bridge supports custom calls as well.

Build

To customize and build it yourself, build a new jar with maven:

mvn install

Otherwise, downloads are available at https://github.com/bwssytems/ha-bridge/releases.

Run

Then locate the jar and start the server with:

java -jar -Dvera.address=X.Y.Z.A -Dharmony.address=X.Y.Z.A -Dharmony.user=myself -Dharmony.pwd=passwd ha-bridge-0.X.Y.jar

Available Arguments

-Dvera.address=`<ip address>`

The argument for the vera address should be given as it the system does not have a way to find the address. Supply -Dvera.address=X.Y.Z.A on the command line to provide it. If a vera is not used, do not set it.

-Dupnp.config.address=`<ip address>`

The server defaults to the first available address on the host. Replace the -Dupnp.config.address=<ip address> value with the server ipv4 address you would like to use as the address that any upnp device will call after discovery.

-Dserver.port=`<port>`

The server defaults to running on port 8080. If you're already running a server (like openHAB) on 8080, -Dserver.port=<port> on the command line.

-Dupnp.device.db=`<filepath>`

The default location for the db to contain the devices as they are added is "data/devices.db". If you would like a different filename or directory, specify -Dupnp.devices.db=<directory>/<filename> or <filename> if it is the same directory.

-Dupnp.response.port=`<port>`

The upnp response port that will be used. The default is 50000.

-Dharmony.address=`<ip address>` | `<{devices:[{name:ahub,ip:x.y.w.z},{name:anotherhub,ip:a.b.c.d}]}>`

The argument for the Harmony Hub address should be given as the system does not have a way to find the address. Supply -Dharmony.address=X.Y.Z.A on the command line to provide it. If a Harmony Hub is not used, do not set it. To provide multiple harmony hubs, use the json style notation outlined above to provide the list. This argument is backwards compatible.

-Dharmony.user=`<username>`

The user name of the MyHarmony.com account for the Harmony Hub. This needs to be given if you are using the Harmony Hub Features, provide -Dharmony.user=<username> on the command line.

-Dharmony.pwd=`<password>`

The password for the user name of the MyHarmony.com account for the Harmony Hub. This needs to be given if you are using the Harmony Hub Features, provide -Dharmony.pwd=<password> on the command line.

-Dupnp.strict=`<true|false>`

Upnp has been very closed on this platform to try and respond as a hue and there is now a setting to control if it is more open or strict, Add -Dupnp.strict=<true|false> to your command line to have the emulator respond to what it thinks is an echo to a hue or any other device. The default is upnp.strict=true.

-Dtrace.upnp=`<true|false>`

Turn on tracing for upnp discovery messages. The default is false.

HA Bridge Device Configuration

You must configure devices before you will have any thing for the Echo to receive. The easy way to get devices configures is with the web interface by going to the url for the host you are running on or localhost with port you have assigned: and use the helpers for the Vera or Harmony Hub to create devices that the Echo will find.

Another way to add a device is through the Manual Add Tab. This allows you to manually enter the name, the on and off URLs and select if there are custom handling with the type of call that can be made. This allows for control of anything that has a distinct request that can be executed so you are not limited to the Vera or the Harmony.

The format of these can be the default HTTP request which excecutes the URLs formtted as http:// as a GET. Other options to this are to select the HTTP Verb and add the data type and add a body that is passed with the request. Another option that is detected by the bridge is to use the udp://<ip_address>:/<your stuff here to send a UDP request. If your data for the UDP request is formatted as "0x00F009B9" lexical hex format, the bridge will convert the UDP data into a binary stream to send. Sed the examples inthe Configuration REST API Usage Section to get an idea.

Also, you may want to use the REST API's listed below to configure your devices.

Web Configuration Access

http://<ip address>:<port>

Ask Alexa

After this Tell Alexa: "Alexa, discover my devices". If there is an issue you can go to the Menu / Settings / Connected Home for the echo on the mobile app or your browser and have Alexa forget all devices and then do the discovery again.

Then you can say "Alexa, Turn on the office light" or whatever name you have given your configured devices.

Here is the table of items to use to tell Alexa what you want to do:

To do this...	Say this...
Turn on / off your connected home device	"Turn on/off [connected home device name]."
Set the brightness of compatible lights	"Set brightness to [##]%." OR "Dim the lights to [##]%."

To view or remove devices that Alexa knows about, you can use the mobile app Menu / Settings / Connected Home.

Configuration REST API Usage

This section will describe the REST api available for configuration. The REST body examples are all formatted for easy reading, the actual body usage should be like this:

{"var1":"value1","var2":"value2","var3:"value3"}

The body should be all in one string and not separated by returns, tabs or spaces. FYI, GET items do not require a body element. If you would like to see example return of json data for full Harmony Hub configuration if configured, which includes activities and devices, take a look at the resource file config.data. If you are interested in how the json data looks for the HA bridge configuration, after creating a device, look at the data directory for the device.db. These calls can be accomplished with a REST tool using the following URLs and HTTP Verb types:

Add a device

Add a new device to the HA Bridge configuration. There is a basic examples and then three alternate examples for the add. Please note that dimming is supported as well as custom value based on the dimming number given from the echo. This is under the Dimming and Value example.

POST http://host:8080/api/devices

Body Arguments

Name	Type	Description	Required
name	string	A name for the device. This is also the utterance value that the Echo will use.	Required
deviceType	string	This identifies what type of device entry this is. It is used by the system and should be the values of "switch", "scene", "custom", "activity" or "button".	Required
onUrl	string	This is the URL that is executed for an "on" request and is used for the device types of "switch", "scene" and "custom". For "activity" or "button" it is the Json target generated by the Harmony Hub helpers.	Required
offUrl	string	This is the URL that is executed for an "off" request and is used for the device types of "switch", "scene" and "custom". For "activity" or "button" it is the Json target generated by the Harmony Hub helpers.	Required
httpVerb	string	This is used for "custom" calls that the user would like to execute. The values can only be "GET, "PUT", "POST".	Optional
contentType	string	This is an http type string such as "application/text" or "application/xml" or "application/json".	Optional
contentBody	string	This is the content body that you would like to send when executing an "on" request.	Optional
contentBodyOff	string	This is the content body that you would like to send when executing an "off" request.	Optional

Basic Example

{
"name" : "bedroom light",
"deviceType" : "switch",
  "onUrl" : "http://192.168.1.201:3480/data_request?id=action&output_format=json&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=1&DeviceNum=41",
  "offUrl" : "http://192.168.1.201:3480/data_request?id=action&output_format=json&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=0&DeviceNum=41"
}

Dimming Control Example

Dimming is also supported by using the expressions ${intensity.percent} for 0-100 or ${intensity.byte} for 0-255 for straight pass trhough of the value. e.g.

{
    "name": "entry light",
    "deviceType": "switch",
    "offUrl": "http://192.168.1.201:3480/data_request?id=action&output_format=json&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=0&DeviceNum=31",
    "onUrl": "http://192.168.1.201:3480/data_request?id=action&output_format=json&DeviceNum=31&serviceId=urn:upnp-org:serviceId:Dimming1&action=SetLoadLevelTarget&newLoadlevelTarget=${intensity.percent}"
}

See the echo's documentation for the dimming phrase.

Value Passing Control Example

You can control items that require special calculated values using ${intensity.math(<your expression using "X" as the value to operate on>)} i.e. "${intensity.math(X/4)}".
e.g.

{
    "name": "Thermostat,
    "deviceType": "custom",
    "offUrl": "http://192.168.1.201:3480/data_request?id=action&output_format=json&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=0&DeviceNum=10",
    "onUrl": "http://192.168.1.201:3480/data_request?id=action&output_format=json&DeviceNum=10&serviceId=urn:upnp-org:serviceId:Dimming1&action=SetLoadLevelTarget&newLoadlevelTarget=${intensity.math(X/4)}"
}

See the echo's documentation for the dimming phrase.

POST/PUT Support Example

This will allow control of any other application that may need more then GET.  You can also use the dimming and value control commands within the URLs as well.
e.g: 
{
    "name": "test device",
    "deviceType": "custom",
    "offUrl": "http://192.168.1.201:3480/data_request?id=action&output_format=json&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=0&DeviceNum=31",
    "onUrl": "http://192.168.1.201:3480/data_request?id=action&output_format=json&DeviceNum=31&serviceId=urn:upnp-org:serviceId:Dimming1&action=SetLoadLevelTarget&newLoadlevelTarget=${intensity.percent}",
  "httpVerb":"POST",
  "contentType" : "application/json",
  "contentBody" : "{\"fooBar\":\"baz_on\"}"
  "contentBodyOff" : "{\"fooBar\":\"baz_off\"}"
}

Custom Usage URLs Example

Anything that takes an action as a result of an HTTP request will probably work and you can also use the dimming and value control commands within the URLs as well - like putting Vera in and out of night mode:

{
  "name": "night mode",
  "deviceType": ""custom",
  "offUrl": "http://192.168.1.201:3480/data_request?id=lu_action&serviceId=urn:micasaverde-com:serviceId:HomeAutomationGateway1&action=SetHouseMode&Mode=1",
  "onUrl": "http://192.168.1.201:3480/data_request?id=lu_action&serviceId=urn:micasaverde-com:serviceId:HomeAutomationGateway1&action=SetHouseMode&Mode=3"
}

Here is a UDP example that can send binary data.

{
  "name": "UDPPacket",
  "deviceType": "custom",
  "offUrl": "udp://192.168.1.1:8899/0x460055",
  "onUrl": "udp://192.168.1.1:8899/0x450055"
}
```#### Response
Name |	Type |	Description
-----|-------|-------------
id   | number | This is the ID assigned to the device and used for lookup.
name | string | A name for the device. This is also the utterance value that the Echo will use.
deviceType | string | This identifies what type of device entry this is. It is used by the system and should be the values of "switch", "scene", "custom", "activity" or "button".
onUrl | string | This is the URL that is executed for an "on" request and is used for the device types of "switch", "scene" and "custom". For "activity" or "button" it is the Json target generated by the Harmony Hub helpers.
offUrl | string | This is the URL that is executed for an "off" request and is used for the device types of "switch", "scene" and "custom". For "activity" or "button" it is the Json target generated by the Harmony Hub helpers.
httpVerb | string | This is used for "custom" calls that the user would like to execute. The values can only be "GET, "PUT", "POST".
contentType | string | This is an http type string such as "application/text" or "application/xml" or "application/json".
contentBody | string | This is the content body that you would like to send when executing an "on" request.
contentBodyOff | string | This is the content body that you would like to send when executing an "off" request.

{ "id" : "12345", "name" : "bedroom light", "deviceType" : "switch", "onUrl" : "http://192.168.1.201:3480/data_request?id=action&output_format=json&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=1&DeviceNum=41", "offUrl" : "http://192.168.1.201:3480/data_request?id=action&output_format=json&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=0&DeviceNum=41" }

### Update a Device 
Update an existing device using it's ID that was given when the device was created and the update could contain any of the fields that are used and shown in the previous examples when adding a device.

POST http://host:8080/api/devices/

#### Body Arguments
Name |	Type |	Description | Required
-----|-------|--------------|------------
id   | number | This is the ID assigned to the device and used for lookup.
name | string | A name for the device. This is also the utterance value that the Echo will use. | Required
deviceType | string | This identifies what type of device entry this is. It is used by the system and should be the values of "switch", "scene", "custom", "activity" or "button". | Required
onUrl | string | This is the URL that is executed for an "on" request and is used for the device types of "switch", "scene" and "custom". For "activity" or "button" it is the Json target generated by the Harmony Hub helpers. | Required
offUrl | string | This is the URL that is executed for an "off" request and is used for the device types of "switch", "scene" and "custom". For "activity" or "button" it is the Json target generated by the Harmony Hub helpers. | Required
httpVerb | string | This is used for "custom" calls that the user would like to execute. The values can only be "GET, "PUT", "POST". | Optional
contentType | string | This is an http type string such as "application/text" or "application/xml" or "application/json". | Optional
contentBody | string | This is the content body that you would like to send when executing an "on" request. | Optional
contentBodyOff | string | This is the content body that you would like to send when executing an "off" request. | Optional
#### Basic Example

{ "id" : "6789", "name" : "table light", "deviceType" : "switch", "onUrl" : "http://192.168.1.201:3480/data_request?id=action&output_format=json&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=1&DeviceNum=41", "offUrl" : "http://192.168.1.201:3480/data_request?id=action&output_format=json&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=0&DeviceNum=41" }

#### Response

### Get All Devices 
Get all devices saved in the HA bridge configuration.

GET http://host:8080/api/devices

#### Response
Individual entries are the same as a single device but in json list format.

[{ "id" : "12345", "name" : "bedroom light", "deviceType" : "switch", "onUrl" : "http://192.168.1.201:3480/data_request?id=action&output_format=json&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=1&DeviceNum=41", "offUrl" : "http://192.168.1.201:3480/data_request?id=action&output_format=json&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=0&DeviceNum=41" } { "id" : "6789", "name" : "table light", "deviceType" : "switch", "onUrl" : "http://192.168.1.201:3480/data_request?id=action&output_format=json&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=1&DeviceNum=41", "offUrl" : "http://192.168.1.201:3480/data_request?id=action&output_format=json&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=0&DeviceNum=41" }]

### Get a Specific Device 
Get a device by ID assigned from creation and saved in the HA bridge configuration.

GET http://host:8080/api/devices/

#### Response
The response is the same layout as defined in the add device response.

### Delete a Specific Device 
Delete a device by ID assigned from creation and saved in the HA bridge configuration.

DELETE http://host:8080/api/devices/

#### Response
This call returns a null json "{}".
### Get HA Bridge Version 
Get current version of the HA bridge software.

GET http://host:8080/api/devices/habridge/version

#### Response
Name |	Type |	Description
-----|-------|-------------
version | string | The version returned by the software.

{"version":"1.0.7"}

### Get Vera Devices 
Get the list of devices available from the Vera, VeraLite or VeraEdge if configured. Please refer to the <a href="http://wiki.micasaverde.com/index.php/Luup_Sdata">Luup Sdata Structure</a> for the explanation of the devices list returned.

GET http://host:8080/api/devices/vera/devices

#### Response
Name |	Type |	Description
-----|-------|-------------
name | string | The name of the Vera device.
altid | string | Vera internal alternate id
id | string | Vera id for accessing device. This is used in calls to the vera url for control.
category | string | Vera category name.
subcategory | string | Vera subcategory identifier.
room | string | Room name assigned to device.
parent | string | Vera id of the parent device.
status | string | Vera status for identifying on = 1 and off = 2.
level | string | Vera device dim percentage.
state | string | Vera additional state attribute. -1 means nothing is happening. 0, 1, 5, 6 mean that the engine is working. 2 or 3 indicates an error. 4 indicates a successful operation.
comment | string | Comment configured with device. Not always present.

[{ "name":"Couch Left Lamp", "altid":"4", "id":"6", "category":"Dimmable Light", "subcategory":"0", "room":"Family Room", "parent":"1", "status":"0", "level":"0", "state":"-1", "comment":"" }, { "name":"Couch Right Lamp", "altid":"7", "id":"9", "category":"Dimmable Light", "subcategory":"0", "room":"Family Room", "parent":"1", "status":"0", "level":"0", "state":"-1", "comment":"" }]

### Get Vera Scenes 
Get the list of scenes available from the Vera, VeraLite or VeraEdge if configured.  Please refer to the <a href="http://wiki.micasaverde.com/index.php/Luup_Sdata">Luup Sdata Structure</a> for the explanation of the scenes list returned.

GET http://host:8080/api/devices/vera/scenes

#### Response
Name |	Type |	Description
-----|-------|-------------
active | string | 1 if the scene is active, 0 otherwise. 
name | string | The name of the Vera scene.
id | string | Vera id for accessing scene. This is used in calls to the vera url for control.
room | string | Room name assigned to scene.

[{ "active":"1", "name":"AccentLightsOff", "id":"27", "room":"no room" }, { "active":"0", "name":"AccentLightsOn", "id":"26", "room":"no room" }]

### Get Harmony Activities
Get the list of activities available from the Harmony Hub if configured.

GET http://host:8080/api/devices/harmony/activities

#### Response
Only listing the relevant fields that are needed for control of an activity. The example below is representative of some activities.

One caveat is that the "PowerOff" activity as id "-1" is always present and is the power off activity no matter what activity is active.

Name |	Type |	Description
-----|-------|-------------
label | string | The name of the Harmony activity.
id | integer | The id of the Harmony activity. 
#### Harmony activities data example

### Get Harmony Devices
Get the list of devices available from the Harmony Hub if configured.

GET http://host:8080/api/devices/harmony/devices

#### Response
Only listing the relevant fields that are needed for control of a device. The example below is representative of some devices.

Main device object

Name |	Type |	Description
-----|-------|-------------
id | integer | The id of the Harmony device. 
label | string | The name of the Harmony device.
controlGroup | object | The structure that contains buttons grouped by control areas. 

Control Group object

Name |	Type |	Description
-----|-------|-------------
name | string | The name of a device control area.
function | object | The structure that contains buttons grouped by function. 

Function object

Name |	Type |	Description
-----|-------|-------------
name | string | The name of a button in the device control area.
#### Harmony devices data example

### Show Harmony Current Activity
Show the Harmony Hub's current activity.

GET http://host:8080/api/devices/harmony/show

#### Response
Only listing the relevant fields that are needed for identity of an activity. TThe example below is representative of an activity.

Name |	Type |	Description
-----|-------|-------------
label | string | The name of the Harmony activity.
id | integer | The id of the Harmony activity. 
#### Harmony activity data example

## HUE REST API usage
This section will describe the REST api available for controlling the bridge based off of the HUE API. This Bridge does not support the full HUE API, only the calls that are supported with the HA Bridge are shown. The REST body examples are all formatted for easy reading, the actual body usage should be like this:

{"var1":"value1","var2":"value2","var3:"value3"}

### Get all lights
Gets a list of all lights that have been discovered by the bridge.

GET http://host:port/api//lights

#### Response
Returns a list of all lights in the system. 

If there are no lights in the system then the bridge will return an empty object, {}.

{ "1": { "state": { "on": true, "bri": 144, "alert": "none", "effect": "none", "reachable": true }, "type": "Dimmable light", "name": "Table Lamp 1", "modelid": "LWB004", "swversion": "66012040", }, "2": { "state": { "on": false, "bri": 0, "alert": "none", "effect": "none", "reachable": true }, "type": "Dimmable light", "name": "Table Lamp 2", "modelid": "LWB004", "swversion": "66012040", } }

### Get light attributes and state
Gets the attributes and state of a given light.

GET http://host:port/api//lights/

####  Response
Name |	Type |	Description
-----|-------|-------------
state |	state object |	Details the state of the light, see the state table below for more details.
type |	string |	A fixed name describing the type of light which will be "Dimmable light".
name |	string 0, 32 |	A unique, editable name given to the light.
modelid |	string 6, 6 |	The hardware model of the light which will be "LWB004".
uniqueid |	string 6, 32 |	Unique id of the device.
manufacturername |	string 6, 32 |	The manufacturer name will be "Philips".
luminaireuniqueid |	string 6, 32 |	This will be empty.
swversion |	string 8, 8 |	An identifier for the software version running on the light which will be "65003148".

The state object contains the following fields

Name |	Type |	Description
-----|-------|-------------
on |	bool |	On/Off state of the light. On=true, Off=false
bri |	uint8 |	Brightness of the light. This will be set to 254 as a default.
alert |	string |	This will be set to "none".
effect |	string |	This will be set to "none".
reachable |	bool |	Indicates if a light can be reached by the bridge and will be set to true.

{ "state": { "on": true, "effect": "none", "alert": "none", "bri": 254, "reachable": true, }, "type": "Dimmable light", "name": "Kitchen Ceiling", "modelid": "LWB004", "swversion": "66012040", }

### Set light state
Allows the user to turn the light on and off, modify the brightness.

PUT http://host:port/api//lights//state

#### Body arguments
Name |	Type |	Description	 
-----|-------|-------------
on |	bool |	On/Off state of the light. On=true, Off=false. Optional
bri |	uint8 |	The brightness value to set the light to. Brightness is a scale from 1 (the minimum the light is capable of) to 254 (the maximum). Note: a brightness of 1 is not off. e.g. "brightness": 60 will set the light to a specific brightness. Optional

{ "on": true, "bri": 200 }

#### Response
A response to a successful PUT request contains confirmation of the arguments passed in. Note: If the new value is too large to return in the response due to internal memory constraints then a value of "Updated." is returned.

[ {"success":{"/lights/1/state/bri":200}}, {"success":{"/lights/1/state/on":true}}, ]

### Create user
Emulates creating a new user. The link button state on the HA Bridge is always on for the purpose of responding to this request. No actual user is saved as this is for compatibility.

POST http://host:port/api

#### Body arguments
Name |	Type |	Description |	Required
-----|-------|--------------|-----------
devicetype |	string 0..40 | <application_name>#<devicename> application_name string 0..20, devicename string 0..19 (Example: my_hue_app#iphone peter ) | Required
username |	string 10..40 |	A username. If this is not provided, a random key will be generated and returned in the response. |	Optional

{"devicetype": "my_hue_app#iphone peter"}

#### Response
Contains a list with a single item that details whether the user was added successfully along with the username parameter.

[{"success":{"username": "83b7780291a6ceffbe0bd049104df"}}]

### Get full state (datastore)
This command is used to fetch the entire datastore from the device, including settings and state information for lights, groups, schedules and configuration.

GET http://host:port/api/

#### Response
Name |	Type |	Description
-----|-------|-------------
lights |	object |	A collection of all lights and their attributes.
groups |	object |	A collection of all groups and their attributes. This is empty.
config |	object |	All configuration settings.
schedules |	object |	A collection of all schedules and their attributes. This is not given.
scenes |	object |	A collection of all scenes and their attributes. This is empty.
sensors |	object |	A collection of all sensors and their attributes. This is not given.
rules |	object |	A collection of all rules and their attributes. This is not given.

{ "lights": { "1": { "state": { "on": false, "bri": 0, "alert": "none", "effect": "none", "reachable": true }, "type": "Dimmable light", "name": "Table Lamp 1", "modelid": "LWB004", "swversion": "66012040", }, "2": { "state": { "on": true, "bri": 254, "alert": "none", "effect": "none", "reachable": true }, "type": "Dimmable light", "name": "Table Lamp 2", "modelid": "LWB004", "swversion": "66012040", } }, "scenes":{ }, "groups":{ }, "config": { "name": "Philips hue", "mac": "00:00:88:00:bb:ee", "dhcp": true, "ipaddress": "192.168.1.74", "netmask": "255.255.255.0", "gateway": "192.168.1.254", "proxyaddress": "", "proxyport": 0, "UTC": "2012-10-29T12:00:00", "whitelist": { "1028d66426293e821ecfd9ef1a0731df": { "last use date": "2012-10-29T12:00:00", "create date": "2012-10-29T12:00:00", "name": "test user" } }, "swversion": "01003372", "swupdate": { "updatestate": 0, "url": "", "text": "", "notify": false }, "linkbutton": false, "portalservices": false }, }

## UPNP Emulation of HUE
This section will discuss the UPNP implementation of this bridge based as much as can be for the HUE.
### UPNP listening
The HA Bridge default UPNP listner is started on port 1900 on the upnp multicast address of 239.255.255.250. All ethernet interfaces that are active are bound to and the repsonse port is set to the one given on the command line above or the default of 50000.

The listener will respond to the following body packet that contain the following minimal information:

M-SEARCH * HTTP/1.1\r\n MAN: "ssdp:discover"\r\n ST: urn:schemas-upnp-org:device:basic:1\r\n OR ST: upnp:rootdevice\r\n OR ST: ssdp:all\r\n


If this criteria is met, the following response is provided to the calling application:

HTTP/1.1 200 OK\r\n CACHE-CONTROL: max-age=86400\r\n EXT:\r\n LOCATION: http://192.168.1.1:8080/description.xml\r\n SERVER: FreeRTOS/6.0.5, UPnP/1.0, IpBridge/0.1\r\n ST: urn:schemas-upnp-org:device:basic:1\r\n "USN: uuid:Socket-1_0-221438K0100073::urn:schemas-upnp-org:device:basic:1\r\n\r\n

### UPNP description service
The bridge provides the description service which is used by the calling app to interogate access details after it has decided the upnp multicast repsonse is the correct device.
#### Get Description

GET http://host:8080/description.xml

#### Response

<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n

<root xmlns="urn:schemas-upnp-org:device-1-0">\n \n 1\n 0\n \n http://192.168.1.1:8080/\n \n urn:schemas-upnp-org:device:Basic:1\n HA-Bridge (192.168.1.1)\n Royal Philips Electronics\n http://www.bwssystems.com\n Hue Emulator for HA bridge\n Philips hue bridge 2012\n 929000226503\n http://www.bwssystems.com/apps.html\n 0017880ae670\n uuid:88f6698f-2c83-4393-bd03-cd54a9f8595\n \n \n (null)\n (null)\n (null)\n (null)\n (null)\n \n \n index.html\n \n \n image/png\n 48\n 48\n 24\n hue_logo_0.png\n \n \n image/png\n 120\n 120\n 24\n hue_logo_3.png\n \n \n \n \n

## Debugging
To turn on debugging for the bridge, use the following extra parm in the command line:

-Dorg.slf4j.simpleLogger.defaultLogLevel=DEBUG

## Development Mode
To turn on development mode so that it will not need an Harmony Hub for testing, use the following extra parm in the command line and the harmony ip and login info will not be needed:

java -jar -Ddev.mode=true ha-bridge-0.X.Y.jar

Description

Home automation bridge that emulates a Philips Hue light system and can control other systems such as a Vera, Harmony Hub, Nest, MiLight bulbs or any other system that has an http/https/tcp/udp interface. This is a compact impl to run on small format computers. This is impl started from this project https://github.com/armzilla/amazon-echo-ha-bridge.

Readme Apache-2.0 15 MiB

README.md

ha-bridge

Build

Run

Available Arguments

-Dvera.address=<ip address>

-Dupnp.config.address=<ip address>

-Dserver.port=<port>

-Dupnp.device.db=<filepath>

-Dupnp.response.port=<port>

-Dharmony.address=<ip address> | <{devices:[{name:ahub,ip:x.y.w.z},{name:anotherhub,ip:a.b.c.d}]}>

-Dharmony.user=<username>

-Dharmony.pwd=<password>

-Dupnp.strict=<true|false>

-Dtrace.upnp=<true|false>

HA Bridge Device Configuration

Ask Alexa

Configuration REST API Usage

Add a device

Body Arguments

Basic Example

Dimming Control Example

Value Passing Control Example

POST/PUT Support Example

Custom Usage URLs Example

-Dvera.address=`<ip address>`

-Dupnp.config.address=`<ip address>`

-Dserver.port=`<port>`

-Dupnp.device.db=`<filepath>`

-Dupnp.response.port=`<port>`

-Dharmony.address=`<ip address>` | `<{devices:[{name:ahub,ip:x.y.w.z},{name:anotherhub,ip:a.b.c.d}]}>`

-Dharmony.user=`<username>`

-Dharmony.pwd=`<password>`

-Dupnp.strict=`<true|false>`

-Dtrace.upnp=`<true|false>`