I have made a binding and a system integration for Unfolded Circle Remote Two and 3 (and docks). The UC Remote Binding works together with UC Remote Integration. The UC Remote Binding can be used to control Unfolded Circle Remotes and Unfolded Circle Docks (https://unfoldedcircle.com/). To control openHAB items with a Unfolded Circle Remotes UC Remote Integration is also needed.
UC Remote Binding
The UC Remote Binding is used to discover remotes and docks, get information of remotes and docks and to control settings, activities and profiles.
UC Remote Integration
The UC Remote Integration is used to expose openHAB items to the UC remotes and to controle them with the UC remotes.
Install and Configuration
openHAB
-
Download the binding and the system integration
-
Install both files (1) binding (for controlling remote settings and starting activities) and (2) system integration (for controlling openHAB items with the UC remote) in the openHAB addon folder.
-
Install UC remote(s) with the binding (discover and add them), if you want to control UC dock(s) with openHAB add them too (not necessary)
-
Enter PIN for each remote to get a API key for that remote
-
Open openHAB UC remote integration configurator in browser
<openhab IP:port>/uc/settings/ -
Click on ‘Install integration’ for each remote to install the integration on that remote.
Configuring openHAB
- Open in browser
<openhab IP:port>/uc/settings/ - Configure items as entities to make them available for UC remotes
Configuring UC Remotes
Tip: to see entities, you first have to configure them in openHAB UC remote integration configurator!
For each remote:
- Open UC configurator in a browser
<UC remote IP> - Go to Integration (topmenu) and click openHAB integration
- Select Entities for the remote
- ‘Customise your remote’: add entities to pages to control them
- Add entities to activities to use them within activities
Binding
There two types of things: remotes and docks. With the binding, settings of the remote can be controlled, activities from activity groups can be started and profiles can be switched. All Activity groups will be added as seperate channels (the activities are added command options). Profiles are can be controlled with a channel. However when a restriced profile is selected the admin pincode is needed for switching. This is only supported with the action ‘Set profile’. This action can be used with rules. Ambient light level channel is the light level detected with the sensor in the remote.
For WOL (to wake up the remote for starting activities) the broadcast address in openHAB network settings (advanced setting) is used.
For docks als settings can be controlled (brightness of the leds). When an OH stringitem is linked to ir-command channel, it possible to send (custom) IR codes with the dock (use the channel ir-command). When this OH stringitem is configured as an UC entity ir emitter, this UC ir emitter can be added to other UC remotes. After adding it will show up as possible infrared output device when configuring infrared devices (with the same infrared output port selection options).
System integration
Items and Entities
An item is used within openHAB (for controlling things: switch light on or off). Entities are used on the UC remote.
Simple Entity vs Advanced Entity
Configuring an item as a simple entity will configure an entity (like a switch). With the UC you can control the specific item (for a switch ON/OFF). This is a simple/easy way to make items available on the UC remote. But advanced configuration options are not possible.
An openHAB Groupitem can be configures as an advanced entity. Member items of that groupitem can be configured as features of the entity (understanding entity / features see UC documentation: core-api/doc/entities at main · unfoldedcircle/core-api · GitHub ).
For example a light can be powered on/off, dimmed, colored, cold/warm light.
Configuring an openHAB groupitem as an advanced entity Light. Each of these features (on/off, dim, color, cold/warm light) can be assigned to a (different) items.
Other example, configure a openHAB groupitem as a Mediaplayer entity and assign items with title, artist, image(url), album (etc) as feature ‘Media title’, ‘Media artist’, ‘Media image’ ‘Media album’. Assign a playeritem as feature to add player control to the advanced entity.
With an advanced entity you customize UC Entities to your needs.
Voice assistant
When one (or more) STT (speech-to-text) add-ins are installed, these STTs are made available to the UC remote. This integration has no logic (like HLI) for processing voice control. It only relays the audio stream to a STT.
For using voice control in openHAB see Audio & Voice | openHAB and OpenHAB voice control for home automation | Dantali0n . For configuring voice controle on the remote see https://support.unfoldedcircle.com/hc/en-us/articles/24061019101596-Using-Voice-Assistants.
Docks
The UC Remote Binding can discover UC docks and can add it as a openHAB thing. When (1) creating a openHAB stringitem, (2) linking it to the IR command channel and (3) configuring this stringitem as an IR emitter in the openHAB UC remote integration configurator. The dock can be added to other UC remotes. (you can use a UC dock with multiple UC remotes!)
Tips
- Experiment with settings! (you can always remove the metadata from an item and start over)
- HUE scenes can be controlled by configuring a select entity or as an advanced entity ‘Remote’ (see example ‘UC Remote (light)’)
- Mediaplayer showing media information can be configured with an advanced entity and add the media information as feature (see example ‘UC mediaplayer’)
Examples
The system integration offers an option ‘Show examples’ (in Add-on settings ‘UC Remote integration’ and as switch in the openHAB UC remote integration configurator) to show examples how the integration can be used. Enabling will build a tree ‘UC integration examples’ visible in Administration - Settings - Model. You can use these examples by linking channels to items (for testing and experimenting)
Background
The system integration depends on metadata stored with openHAB items to generate Entities for the UC remote. The web interface will store the correct metadata. You change metadata also manually. When doing so it is possible to misconfiguring the items. Deleting the metadata and starting over again will solve this.
Tested with:
- openHAB 5.1
- Remote Two (firmware 2.8.5)
- Remote 3 (firmware 2.8.4)
- Dock 2 (firmware 0.10.0)
- Dock 3 (firmware 0.8.1)
Not working:
- mDNS broadcast (openHAB problem?, showing multiple integrations on the remote, but none is working)
Credits
This binding and system integration are based on ideas and solutions from:
- HUE binding ( openhab-addons/bundles/org.openhab.binding.hue at main · openhab/openhab-addons · GitHub )
- NEEO binding ( openhab-addons/bundles/org.openhab.binding.neeo at main · openhab/openhab-addons · GitHub )
- NEEO service ( openhab-addons/bundles/org.openhab.io.neeo at main · openhab/openhab-addons · GitHub )
- Shelly binding ( openhab-addons/bundles/org.openhab.binding.shelly at main · openhab/openhab-addons · GitHub )