Module for IP Symcon Version 5 and higher. Enables communication with a Logitech Harmony Hub and sending commands through the Logitech Harmony Hub.
Table of Contents
With the help of the Logitech Harmony Hub devices can be operated, which are otherwise controllable via IR remote controls or even newer devices such as FireTV and AppleTV which are controlled via Bluetooth. For more information about controllable devices through the Logitech Harmony Hub, see Logitech Harmony Elite
Using the module, the devices stored in the Logitech Harmony Hub can be imported into IP-Symcon and then switched from IP-Symcon via the Logitech Harmony Hub. Harmony activities can be started from IP-Symcon. When the Harmony Hub performs an activity, the current running activity is submitted to IP-Symcon.
- Send an IR signal through the Logitech Harmony Hub to the hub known devices
- Sending commands to a FireTV
- Shows the current active Harmony Hub activity
- Starts an activity of the Harmony Hub
- IPS 5.x.
- Logitech Harmony Hub on the same network as IP Symcon
- XMPP activated in the Harmony app
Open the Harmony app and then enable XMPP under Harmony Setup -> Add and Edit Devices and Actions -> Remote Control / Keyboard and Hub -> Enable XMPP.
Open the IP Console's web console with http://{IP-Symcon IP}:3777/console/.
Then click on the module store (IP-Symcon > 5.1) icon in the upper right corner.
In the search field type
Logitech Harmony
Then select the module and click Install
Open the object tree.
Open the instance 'Modules' below core instances in the object tree of IP-Symcon (>= Ver 5.x) with a double-click and press the Plus button.
Enter the following URL in the field and confirm with OK:
https://github.com/Wolbolar/IPSymconHarmony
and confirm with OK.
Then an entry for the module appears in the list of the instance Modules
By default, the branch master is loaded, which contains current changes and adjustments. Only the master branch is kept current.
If an older version of IP-Symcon smaller than version 5.1 (min 4.3) is used, click on the gear on the right side of the list. It opens another window,
here you can switch to another branch, for older versions smaller than 5.1 (min 4.3) select Old-Version .
If scripts are to be created, they will be placed below a category. First, we create a category in the object tree right mouse button -> add object -> category, which we give an arbitrary name such as. Harmony devices. Later, all scripts for devices of the Logitech Harmony Hub will be created under this category.
Then add an instance in IP-Symcon 5.x under splitter.
Here as manufacturer enter Logitech and select Logitech Harmony Hub.
In the window that opens, first select the following items during initial installation:
1. put slider on active. This is necessary for the I / O instance to be active later.
2. Enter the IP address of the Logitech Harmony Hub
3. Email address (corresponds to login name) for MyHarmony
5. MyHarmony password
6. Then press APPLY CHANGES .
7. Select Read Configuration and wait a few seconds.
8. After the Harmony Config variable has been updated, press Setup Harmony, then the instance can be closed.
Then a configurator is created.
The configurator now offers the following options:
- category harmony scripts is the category under which scripts are created
- Harmony variables if not active only the instance is created, but scripts can still be used. Activate to switch over variables in the web front. Attention! Many devices can consume many variables. Optional If this option is selected, a variable for switching from the web front will be created for each command group of a Logitech Harmony device. CAUTION: This option should only be selected if there are still enough variables available in IP-Symcon or the number of variables is unlimited, as a large number of variables can be consumed depending on the devices learned in the Harmony Hub. Every Harmony Hub device creates a variable for switching in the web front for each Controllgroup stored in the Harmony Hub. Depending on the number of devices configured in the Harmony Hub, a large number of variables may be generated here. The option is intended for IP Symcon users who still have enough variables available and want to drop commands from the web front.
- Harmony script If this is activated, the associated scripts will be created for each already created instance with Setup Harmony. Optional This option can be chosen as an alternative or addition to variables. A subcategory with scripts is created for each Controllgroup stored in the Harmony Hub. The single script then sends the respective command (script name) to the Logitech Harmony Hub.
If something has been changed in the configuration in the Harmony Hub, press Read Configuration and press Refresh List. Individual devices can now be selected in the configurator and Create creates the device in IP-Symcon.
Mit Setup Harmony , scripts are created for each device created in IP Symcon, depending on the settings (see above), and scripts are generated for the activities.
You can then send commands via the web front or the scripts. The activity is displayed on the web front. Once a device or Harmony Remote triggers a Harmony Activity, it will also be updated in IP Symcon. The current activity is displayed in the variable Harmony Activity, which is located under the Logitech Harmony Splitter. A link under the category selected above is automatically created for this variable.
The variable names and the name of the commands are created as they are stored by the name in the Harmony Hub. For each created variable also the description field is used, here stands the actual command inside which is sent to the Harmony Hub. Therefore, the description field of the variable must not be changed. The name of the variable as well as the command names that are stored in the variable profile of the variable can be customized by the user. However, the order in the variable profile should not change
In order to be able to react to keystrokes on a Harmony Remote, an additional device must first be integrated into the Harmony Hub and then integrated into the Harmony action in which the keystroke should react. To do this, a new instance SSDP Roku must first be created in IP-Symcon under Splitter.
Then another instance Logitech Harmony Roku Emulator should be created.
Select a port and a Harmony Hub in the created instance.
Now the device can be searched for and added in the Harmony app. To do this, click in the Harmony app Harmony setup -> Add and edit devices and actions -> Devices -> Add device -> Search for WiFi devices. After a while, the Harmony app should have found devices in the WLAN and a selection of the devices found should be displayed. There should also be an entry Roku 3. If you click on the i (info symbol) you should see the name IP-Symcon (Roku Device). With Next the device is added to the devices of the Harmony Hub. The device can now either be switched individually from the app or the device is integrated into Harmony actions.
After the Roku device has been added, this is also integrated into the Harmony action in which the key presses are to be evaluated.
Then switch to the key assignment settings in MyHarmony and assign the key a command from the IP-Symcon Roku 3 device
In IP-Symcon, the Logitech Harmony Roku Emulator instance shows the last key press that was performed on the Roku Emulator device.
In the instance, a script can be assigned to the key commands per action, which is executed as soon as the key has been pressed.
Only the commands shown in IP-Symcon are transferred from the Harmony Remote to IP-Symcon. So you can e.g. when pressing Play the command Play and when pressing Pause assign the command Instant Replay in the MyHarmony app. Now the appropriate script has to be assigned, in the example picture the scripts are called Dimming up lighting and Dimming down lighting. The respective scripts now include all commands that should be executed as soon as the play button is pressed. This is usually the standard function of the device that is controlled in the Harmony action and other commands.
An example of dimming a Hue lamp on Play
<?php
IPS_RunScript(53512); // Dreambox Play
$list = ["BRIGHTNESS" => 0, "TRANSITIONTIME" => 40];// Helligkeit in (0 bis 254), transitiontime x 100ms 10 entspricht 1 s
$lightId = 33485; // Coachlampen
HUE_SetValues($lightId, $list);Any device that can be controlled from IP-Symcon can then be addressed in the script. So you can e.g. also dim KNX, LCN, Homematic, Hue etc.
The settings are to be made for each Harmony action in which key presses are to be evaluated.
So you can then integrate the device into the Harmony actions, in which you want to evaluate a keystroke of the Harmony Remote, and place it on the buttons of the Harmony. IP-Symcon then evaluates this keystroke and any device that is controlled by IP-Symcon can be switched in this way.
The Harmony Devices are to be created via the configurator A command can be sent to each device Reads out the available functions of the device and outputs them as an array
LHD_GetCommands(integer $InstanceID) Parameter $InstanceID ObjectID of the Harmony Hub device
Sends a command to the Logitech Harmony Hub
LHD_Send(integer $InstanceID, string $Command)Parameter $InstanceID ObjectID of the Harmony Hub device Parameter $Command Command to be sent, available commands are read out via LHD_GetCommands.
Activities of the Logitech Harmony Hub can be performed. The current activity of the Logitech Harmony Hub is displayed in the variable Harmony Activity and can be switched on the web front. If the activity is to be updated via functions or switched via a script, the following functions are to be used: Requests the current activity of the Logitech Harmony Hub. The value is set in the variable Harmony Activity.
HarmonyHub_getCurrentActivity(integer $InstanceID) Parameter $InstanceID ObjektID of the Harmony Hub Splitter
Reads all available activities of the Logitech Harmony Hub and returns an array.
HarmonyHub_GetAvailableAcitivities(integer $InstanceID) Parameter $InstanceID ObjektID of the Harmony Hub Splitter
Reads all available Device IDs of the Logitech Harmony Hub and returns an array.
HarmonyHub_GetHarmonyDeviceIDs(integer $InstanceID) Parameter $InstanceID of the Harmony Hub Splitter
Switches to the desired Logitech Harmony Hub activity
HarmonyHub_startActivity(integer $InstanceID, integer $activityID)Parameter $InstanceID ObjektID of the Harmony Hub Splitter Parameter $activityID ID of the Harmony Activity, available IDs can be read out via HarmonyHub_GetAvailableAcitivities
| Property | Type | Standard Value | Function |
|---|---|---|---|
| Open | boolean | true | Connect to Logitech Harmony Hub Active / Disable |
| Host | string | IP address of the Logitech Harmony Hub | |
| string | Email address to login MyHarmony | ||
| Passwort | string | Password to log in MyHarmony | |
| ImportCategoryID | integer | ObjectID of the import category | |
| HarmonyVars | boolean | Active creates variables per control group | |
| HarmonyScript | boolean | Active creates a script for each command |
| Property | Type | Standard Value | Function |
|---|---|---|---|
| Name | string | Name of the device | |
| DeviceID | integer | DeviceID of the device | |
| BluetoothDevice | boolean | false | Bluetooth Device |
GUID: {7E03C651-E5BF-4EC6-B1E8-397234992DB4}
GUID: {C45FF6B3-92E9-4930-B722-0A6193C7FFB5}
Credits: Logitech Harmony Ultimate Smart Control Hub Library Zapp