This is an update on the Harmony API by Jon Maddox updated for use in a nonstandard enviornment.
First, install Forever using this command:
sudo npm install forever -g
You can then complete the rest of the setup using this command:
script/bootstrap
Before you first run the software, you will need to know the IP address and name for your hub. Once you have these, run: script/server
and enter the IP address and hub name when prompted.
On some distros, you might get an error when running it:
/usr/bin/node: No such file or directory
That can probably be fixed by creating a symlink:
sudo ln -s `which nodejs` /usr/bin/node
Harmony API will run on port 8282
by default. Use the PORT
environment
variable to use your own port.
To stop the server, run script/uninstall
Harmony API logs all of its requests. In production
, it logs to a file at log/logs.log
.
In development
mode, it just logs to stdout.
harmony-api can report its state changes to your MQTT broker. Just edit your
config file in config/config.json
to add your MQTT host and options.
By default harmony-api publishes topics with the namespace of: harmony-api
. This can be overriden
by setting topic_namespace
in your config file.
When the state changes on your harmony hub, state topics will be immediately broadcasted over your broker. There's quite a few topics that are broadcasted.
State topics are namespaced by your Harmony hub's name, as a slug. You can rename your hub in the Harmony app.
Here's a list:
This topic describes the current power state. Message is on
or off
.
harmony-api/hubs/family-room/state
on
This topic describes what the current activity of the hub is. The message is the slug of an activity name.
harmony-api/hubs/family-room/current_activity
watch-tv
These topics describe the state of each activity that the hub has. The message
is on
or off
. There will a topic for every activity on your hub.
harmony-api/hubs/family-room/activities/watch-tv/state
off
harmony-api/hubs/family-room/activities/watch-apple-tv/state
on
harmony-api/hubs/family-room/activities/play-xbox-one/state
off
You can also command harmony-api to change activities, and issue device and acivity commands by publishing topics. harmony-api listens to these topics and will change to the activity, or issue the command when it sees it.
Just provide the slug of the hub and activity you want to switch to and on
as
the message. Any use of this topic with the message off
will turn everything
off.
harmony-api/hubs/family-room/activities/watch-tv/command
on
Just provide the slug of the hub and the device to control with the command you want to execute.
harmony-api/hubs/family-room/devices/tv/command
volume-down
To optionally repeat the command any number of times, provide an optional repeat integer.
harmony-api/hubs/family-room/devices/tv/command
volume-down:5
Just provide the slug of the hub and the command you want to execute.
harmony-api/hubs/family-room/command
volume-down
To optionally repeat the command any number of times, provide an optional repeat integer.
harmony-api/hubs/family-room/command
volume-down:5
This is a quick overview of the HTTP service. Read app.js if you need more info.
Here's a list of resources that may be returned in a response.
The Activity resource returns all the information you really need for an Activity set up in your Harmony Hub.
{
"id": "15233552",
"slug": "watch-tv",
"label": "Watch TV",
"isAVActivity": true
}
The Device resource returns all the information you need to know about the devices set up for the hub.
{
"id": "38343689",
"slug": "tivo-premiere",
"label": "TiVo Premiere"
}
The Command resource returns all the information you really need for a Command to let you execute it.
{
"name": "ChannelDown",
"slug": "channel-down",
"label":"Channel Down"
}
The Status resource returns the current state of your Harmony Hub.
{
"off": false,
"current_activity": {
"id": "15233552",
"slug": "watch-tv",
"label": "Watch TV",
"isAVActivity": true
}
}
These are the endpoints you can hit to do things.
Use these endpoints to query the current state of your Harmony Hub.
GET /hubs => {"hubs": ["family-room", "bedroom"] }
GET /hubs/:hub_slug/status => StatusResource
GET /hubs/:hub_slug/commands => {"commands": [CommandResource, CommandResource, ...]}
GET /hubs/:hub_slug/activities => {"activities": [ActivityResource, ActivityResource, ...]}
GET /hubs/:hub_slug/activities/:activity_slug/commands => {"commands": [CommandResource, CommandResource, ...]}
GET /hubs/:hub_slug/devices => {"devices": [DeviceResource, DeviceResource, ...]}
GET /hubs/:hub_slug/devices/:device_slug/commands => {"commands": [CommandResource, CommandResource, ...]}
Use these endpoints to control your devices through your Harmony Hub.
PUT /hubs/:hub_slug/off => {message: "ok"}
POST /hubs/:hub_slug/commands/:command_slug => {message: "ok"}
POST /hubs/:hub_slug/commands/:command_slug?repeat=3 => {message: "ok"}
POST /hubs/:hub_slug/activities/:activity_slug => {message: "ok"}
POST /hubs/:hub_slug/devices/:device_slug/commands/:command_slug => {message: "ok"}
POST /hubs/:hub_slug/devices/:device_slug/commands/:command_slug?repeat=3 => {message: "ok"}
- fork
- create a feature branch
- open a Pull Request