mhop/ha-bridge
1
0
Fork 0
mirror of https://github.com/bwssytems/ha-bridge.git synced 2025-12-16 18:24:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Readme for clarity on upnp.config.address usage. Also, updated

Browse Source 
the 'ask alexa' section with more details.
This commit is contained in:
Admin
2015-12-29 10:14:26 -06:00
parent 2b335d6b9b
commit c8f4d89a45
2 changed files with 12 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -9,13 +9,13 @@ Otherwise, downloads are available at https://github.com/bwssytems/ha-bridge/rel
## 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
java -jar -Dupnp.config.address=A.B.C.D -Dvera.address=E.F.G.H -Dharmony.address=W.X.Y.Z -Dharmony.user=myself -Dharmony.pwd=passwd ha-bridge-W.X.Y.jar
```
## Available Arguments
### -Dupnp.config.address=`<ip address>`
The server defaults to the first available address on the host if this is not given. This default may NOT be the correct IP that is your public IP for your host on the network. It is best to set this paramter to not have discovery issues. 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.
### -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>`
@@ -54,9 +54,14 @@ 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 [##]%."
Discover | <EFBFBD>Alexa, discover my devices.<2E>
Turn On | <EFBFBD>Alexa, turn on the kitchen light.<2E>
Turn Off: <EFBFBD>Alexa, turn off the kitchen light.<2E>
Brighten | <EFBFBD>Alexa, brighten the kitchen light.<2E>
Dim | <EFBFBD>Alexa, dim the kitchen light.<2E>
Dim | "Alexa, Dim the lights to 40%."
Set | <EFBFBD>Alexa, set the kitchen light to 50%.<2E>
Set | "Alexa, Set brightness to 60%."
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: