Public | Automated Build

Last pushed: a year ago
Short Description
harmony api test
Full Description

Harmony API!!

Harmony API is a simple server allowing you to query/control multiple local Harmony
Home Hubs
and their devices
over HTTP or MQTT.

With HTTP, you can simply turn on and off activities, check hub status, and send
commands to individual devices with simple HTTP requests from almost any other
project.

With MQTT, you can easily monitor the state of your devices as well as set
the current activity of your hub or send specific commands per device. This
makes it super easy to integrate into your existing home automation setup.

Features

  • Control multiple Harmony hubs.
  • List activities.
  • Get current status, including if everything is off, or what the current
    activity is.
  • Turn everything off.
  • Start a specific activity.
  • List devices.
  • List device commands.
  • Execute discrete commands for each device.

Setup

script/bootstrap

Settings

Harmony API discovers your hubs automatically. You can optionally add your MQTT
broker's host to connect to it.

{
  "mqtt_host": "mqtt://192.168.1.106",
  "mqtt_options": {
      "port": 1883,
      "username": "someuser",
      "password": "somepassword",
      "rejectUnauthorized": false
  },
  "topic_namespace": "home/harmony"
}

mqtt_options is optional, see the mqtt project for
allowed host and options values.

Running It

Get up and running immediately with script/server.

Harmony API will run on port 8282 by default. Use the PORT environment
variable to use your own port.

Forever

harmony-api has support for Forever. It uses
launchd on OS X to kick it off so that it starts on boot. There is no init.d
or other Linux support of this type. Pull requests would be welcome for this though.

Development

You can simply run it by calling script/server. This will run it in development
mode with logging to standard out.

Install as Service on OS X

script/install

Docker

Installation with Docker is straightforward. Adjust the following command so that
/path/to/your/config points to the folder where your want to store your config and run it:

$ docker run --name="harmony-api" -v /path/to/your/config:/config \
    -p 8282:8282 -d jonmaddox/harmony-api

This will launch Harmony API and serve the web interface from port 8282 on your Docker host. Hub
discovery requires host networking (--net=host). However, you can specify your Harmony Hub IP
address in config.json as hub_ip.

Logging

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.

How to Upgrade to 2.0

Simply run script/upgrade from the root of the project and Harmony API will
upgrade to the newest version.

You are then going to have to change anything you integrate with Harmony API to
reflect the change in HTTP endpoints and MQTT topics. Read the docs in this
README to see how they have changed.

Development

Launch the app via script/server to run it in the development environment.

MQTT Docs

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.

State Topics

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:

Current State

This topic describes the current power state. Message is on or off.

harmony-api/hubs/family-room/state on

Current Activity

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

Activity States

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

Command Topics

You can also command harmony-api to change activities by publishing topics.
harmony-api listens to this topic and will change to the activity 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

HTTP API Docs

This is a quick overview of the HTTP service. Read app.js if you need more
info.

Resources

Here's a list of resources that may be returned in a response.

Activity Resource

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
}

Device Resource

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"
}

Command Resource

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"
}

Status Resource

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
  }
}

Methods

These are the endpoints you can hit to do things.

Info

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/activities => {"activities": [ActivityResource, ActivityResource, ...]}
GET /hubs/:hub_slug/devices => {"devices": [DeviceResource, DeviceResource, ...]}
GET /hubs/:hub_slug/devices/:device_slug/commands => {"commands": [CommandResource, CommandResource, ...]}

Control

Use these endpoints to control your devices through your Harmony Hub.

PUT /hubs/:hub_slug/off => {message: "ok"}
POST /hubs/:hub_slug/activities/:activity_slug => {message: "ok"}
POST /hubs/:hub_slug/devices/:device_slug/commands/:command_slug => {message: "ok"}

Contributions

  • fork
  • create a feature branch
  • open a Pull Request
Docker Pull Command
Owner
nkgilley
Source Repository

Comments (0)