Logitech Harmony Hub Binding

Introduction

The Harmony Hub binding is used to enable communication between openHAB and multiple Logitech Harmony Hub devices. The API exposed by the Harmony Hub is relatively limited, but it does allow for reading the current activity as well as setting the activity and sending device commands.

Installing

Add the org.openhab.binding.harmonyhub.jar, org.openhab.io.harmonyhub.jar and optionally the org.openhab.action.harmonyhub.jar to the addons folder of an openHAB runtime installation and restart.
The IO bundle is required for the action or binding bundle to work.

Usage

Configuration

November 2016: Logitech changed their authentication rendering the host/username/password configuration broken. Please use the new discoveryName to connect to your hub(s)

The following configuration items are required to be set in openhab.cfg:

    harmonyhub:discoveryName=<Name given to your hub when setup>

Example:

    harmonyhub:discoveryName=Great Room

Optionally you may add a unique qualifier to your configuration to support multiple hubs

    harmonyhub:qualifier.discoveryName=<Name given to your hub when setup>

Example:

    harmonyhub:greatroom.discoveryName=Great Room

Bindings

The Harmony binding supports both outgoing and incoming item bindings of the form:

{ harmonyhub="<direction>[<optional qualifier>:<binding> ...]" }

<direction> may be :

Incoming (IN) (read only)

<[....]

Outbound (OUT) (write only)

>[....]

Bi-Directional (BOTH) (read and write)

*[....]

and where <binding> can be:

Current activity (status)

Current Activity supports both IN(<), OUT(>) and BOTH(*) directions.

Displays the current activity:

String Harmony_Activity         "activity [%s]" { harmonyhub="<[currentActivity]" }

Displays the current activity for a named hub:

String Harmony_Activity         "activity [%s]" { harmonyhub="<[familyroom:currentActivity]" }

Optionally a string from can be sent to a current activity binding (ex: from an button).

String Harmony_Activity         "activity [%s]" { harmonyhub="*[familyroom:currentActivity]" }

And in the Sitemap.

Switch item=Harmony_Activity mappings=[PowerOff='PowerOff', Roku='Roku',TiVo='TiVo']

Start activity (command)

Start Activity supports the OUT(>) direction.

Start the specified activity (where activity can either be the activity id or label).

String HarmonyHubPowerOff       "powerOff"      { harmonyhub=">[start:PowerOff]" }
String HarmonyHubWatchTV        "watchTV"       { harmonyhub=">[start:Watch TV]" }

Start the specified activity on a named hub (where activity can either be the activity id or label).

String HarmonyHubPowerOff       "powerOff"      { harmonyhub=">[familyroom:start:PowerOff]" }
String HarmonyHubWatchTV        "watchTV"       { harmonyhub=">[familyroom:start:Watch TV]" }

Press button (command)

Start Activity supports the OUT(>) direction.

Press the specified button on the given device (where device can either be the device id or label).

String HarmonyHubMute           "mute"          { harmonyhub=">[press:Denon AV Receiver:Mute]" }

Press the specified button on the given named device (where device can either be the device id or label).

String HarmonyHubMute           "mute"          { harmonyhub=">[familyroom:press:Denon AV Receiver:Mute]" }

Actions

The following actions are supported in rules:

Press button

harmonyPressButton(<device>, <command>)
harmonyPressButton(<qualifier>, <device>, <command>)

Note that all the parameters are strings, for example:

harmonyPressButton("Lounge", "8-Track", "PowerOn")

Start activity

harmonyStartActivity(<activity>)
harmonyStartActivity(<qualifier>,<activity>)

Surround the activity name in quotes, for example:

harmonyStartActivity("PowerOff")

Other

Under debug logging the IO bundle will print the list of devices, activities and the full JSON config for each hub. This can be used to populate items.

The JSON configuration can also be obtained using the Harmony Android app by syncing with the hub (Menu-> Harmony Setup - > Sync). The configuration will be saved in home/Harmony/userConfig.json.

Shell

The harmony-java-client project on GitHub provides a simple shell for querying a Harmony Hub, and can be used to retrieve the full configuration of the hub to determine ids of available activities and devices as well as device commands (buttons).