YahueV2 (Yet another Hue app, using Hue API v2)

[jgab 2,647]

This is a new version of Yahue. We can't upgrade the old to this as some devices have changed types.
Install and upgrade with

Please login or register to see this link.

 

Please login or register to see this attachment.

 

 

Yahue — User Documentation

Yahue is a Fibaro HC3 QuickApp that bridges the Philips Hue v2 API. It discovers all Hue devices and rooms on your bridge and lets you selectively expose them as native HC3 child devices — sensors, lights, switches, and room controllers — that work seamlessly with scenes, automations, and the Fibaro mobile app.

---

Installation

Prerequisites

• Fibaro HC3 with firmware supporting QuickApp child devices
• Philips Hue Bridge (v2, firmware ≥ 1.60)

Installing the QuickApp

The recommended way to install and keep Yahue up to date is the 

Please login or register to see this link.

 QuickApp. It can install Yahue directly from the GitHub releases and notify you of new versions.

Manual install:

1. Download dist/Yahue.fqa from the 

   Please login or register to see this link.

2. On your HC3 go to Settings → QuickApps → Add QuickApp and upload the .fqa file
3. Open the newly created QuickApp and set the Hue_IP QuickApp Variable to the IP address of your Hue bridge (e.g. 192.168.1.50)
4. Save and restart the QuickApp

On startup, if no application key is stored yet, the info label will show:

Set Hue_User, or press 'Pair with bridge'

Option A — Pair from the QuickApp panel (recommended)

This is the easiest method and requires no tools.

1. Make sure Hue_IP is set correctly and the QuickApp has been restarted
2. Press Pair with bridge in the QuickApp panel
3. The info label changes to "Press the button on your Hue bridge now…"
4. Walk to your Hue bridge and press the physical link button within 30 seconds
5. Yahue fetches the application key automatically, saves it to the Hue_User variable, and restarts itself

Option B — Enter an existing key manually

If you already have a Hue application key (e.g. from another app or from using the Hue developer debug tool):

1. Open the QuickApp settings and set the Hue_User QuickApp Variable to your key
2. Save and restart the QuickApp

On startup the QuickApp connects to the bridge, discovers all devices and rooms, and populates the device selector.

---

Selecting devices

The QuickApp panel shows a multi-select list of every Hue resource that can be exposed as an HC3 child device. Each entry shows the device name and its type abbreviation in brackets.

1. Tick the devices and rooms you want to create child devices for
2. Press Apply selection
3. The QuickApp restarts and creates (or removes) child devices to match your selection

Child devices are persistent — they survive QuickApp restarts. You only need to use the selector when you want to add or remove devices.

---

Device type mapping

Yahue automatically picks the appropriate HC3 device type based on the Hue resource's capabilities.

Sensors

Hue capability	HC3 type	Notes
Temperature service	com.fibaro.temperatureSensor	Reports °C
Light / illuminance service	com.fibaro.lightSensor	Reports lux
Motion service	com.fibaro.motionSensor	value = true when motion detected
Contact report service	com.fibaro.doorSensor	value = true when open. Remappable — see below
Button service	com.fibaro.remoteController	Emits centralSceneEvents (keys 1–4)
Relative rotary service	com.fibaro.multilevelSensor	Accumulates rotation into 0–100
Motion area configuration	com.fibaro.motionSensor	OR-logic across all sensors in the area

Lights

Hue light capabilities	HC3 type	Notes
On/off only	com.fibaro.binarySwitch
On + dimming	com.fibaro.multilevelSwitch
On + dimming + color temperature	com.fibaro.colorController
On + dimming + color (xy)	com.fibaro.colorController	Full RGB + color temperature

Rooms and zones

Yahue inspects each room/zone group and picks the most appropriate HC3 type based on the capabilities of the lights it contains:

Group capabilities	HC3 type	Class	Notes
Any light supports color (RGB)	com.fibaro.colorController	RoomZoneQA	Full RGB + CT + scenes
No color, any light supports color temperature	com.fibaro.colorController	RoomZoneQA	CT-only colour controller + scenes
No color/CT, any light is dimmable	com.fibaro.multilevelSwitch	RoomZoneDimQA	Dim + scenes (e.g. plain white-dim entrance lights)
On/off only	com.fibaro.binarySwitch	RoomZoneSwitchQA	On/off + scenes

All three variants share the same scene dropdown and Static/Dynamic toggle (see 

Please login or register to see this link.

).

The choice is made when the child device is first created. If you later add an RGB bulb to a previously dim-only group, remove and re-add the room from the device selector to have it re-typed.

---

Configuring type overrides

By default, Hue contact sensors become com.fibaro.doorSensor. If you have window sensors or garage door sensors you can remap them individually.

Open the UserConfig file inside the QuickApp (or edit userconfig.lua locally before uploading). Add entries to the HUE.typeOverrides table:

Please login or register to see this code.

The key is the Hue device UUID — it is the part after the class prefix in the device dropdown value. For example, if the dropdown shows DoorSensor:a1b2c3d4-..., the key is a1b2c3d4-....

Note: The override only takes effect when the child device is first created. To change the type of an existing child:

1. Deselect it in the selector and press Apply
2. Add the override entry to userconfig.lua
3. Re-select it and press Apply

The UserConfig file is never overwritten by auto-update.

---

Per-child QuickApp variables

Some child device behaviours can be tuned by setting a QuickApp Variable directly on the child device. These are read once at initialisation (when the child is loaded after a restart).

Variable	Applies to	Type	Default	Description
dimdelay	ColorLight, RoomZoneQA	number (ms)	8000	Total duration of a smooth brightness ramp triggered by startLevelIncrease or startLevelDecrease. The actual ramp time is scaled proportionally to the current brightness level, so the ramp always takes at most this many milliseconds to travel the full 0–100 range.

How to set it: Open the child device in the HC3 UI, go to Advanced → QuickApp Variables, add a variable named dimdelay with a numeric value in milliseconds (e.g. 4000 for a 4-second ramp). Restart the parent QuickApp for the change to take effect.

---

Room / Zone controller

Room and zone devices give you full control over a Hue group. Yahue creates one of three variants depending on the group's capabilities (see 

Please login or register to see this link.

).

Scene support

Each Room/Zone child has a Scene dropdown and a Static/Dynamic toggle button in its panel.

• Scene dropdown — lists every Hue scene defined for that room/zone. Selecting a scene immediately recalls it on the Hue bridge. The selection is persisted in the QA variable lastSceneId and is restored in the dropdown on the next restart.
• Static/Dynamic button — toggles how scenes are recalled:
  • Static — recalls the scene as defined (default).
  • Dynamic — recalls the scene's dynamic palette (cycling colours on lights that support it).
    The choice is persisted in the QA variable sceneMode.

You can also store and recall scenes programmatically:

Please login or register to see this code.

Colour / CT changes also turn the group on

For RoomZoneQA (colour or CT-only), calling setColor, setColorComponents or setColorTemperature now sends on=true together with the colour change, so the group turns on if it was off — you always see the result of the action.

Brightness aggregation

The group's displayed brightness (value) is computed as the average of the on-members' brightness, updated live as each member reports a new dimming level. This keeps the QA in sync with Hue scenes that set per-light brightness without emitting a group-level dimming event.

---

Available Lua methods per device type

These methods can be called from scenes, automations, and other QuickApps via fibaro.call(deviceId, "methodName", ...).

---

All sensor types

Sensors are read-only. Their value property is updated automatically from Hue SSE events.

Method	Description
(none)	No callable methods — use property triggers in scenes

Battery: Devices with a battery (Hue sensors) automatically report batteryLevel and dead status.

---

BinarySwitch — com.fibaro.binarySwitch

Method	Arguments	Description
turnOn	—	Turns the light on
turnOff	—	Turns the light off

---

DimLight — com.fibaro.multilevelSwitch

Method	Arguments	Description
turnOn	—	Turns on at last brightness
turnOff	—	Turns off
setValue	level (0–100)	Sets brightness
startLevelIncrease	—	Smooth ramp to 100%
startLevelDecrease	—	Smooth ramp to 0%
stopLevelChange	—	Stops any active ramp

---

TempLight — com.fibaro.colorController

White-ambiance lights (tunable white, no colour).

Method	Arguments	Description
turnOn	—	Turns on
turnOff	—	Turns off
setValue	level (0–100)	Sets brightness
setColorTemperature	kelvin (2000–6500) or mirek (153–500)	Sets colour temperature. HC3's standard setColorTemperature action passes Kelvin; values ≤ 1000 are treated as already-mirek for backward compatibility

---

ColorLight — com.fibaro.colorController

Full-colour lights.

Method	Arguments	Description
turnOn	—	Turns on
turnOff	—	Turns off
setValue	level (0–100)	Sets brightness
setColor	"RRGGBB"	Sets colour from hex string, e.g. "FF0000" for red
setColorComponents	{red,green,blue,warmWhite}	Sets colour by component (0–255 each). RGB triggers colour mode; warmWhite alone triggers colour temperature mode
setColorTemperature	kelvin (2000–6500) or mirek (153–500)	Sets colour temperature (HC3 passes Kelvin)
startLevelIncrease	—	Smooth ramp to 100% (duration controlled by dimdelay QA variable, default 8 s)
startLevelDecrease	—	Smooth ramp to 0% (duration controlled by dimdelay QA variable, default 8 s)
stopLevelChange	—	Stops any active ramp
signal	sig, duration_ms, colors	Signalling effect (see below)
setEffect	effect	Looping light effect (see below)
setTimedEffect	effect, duration_ms	One-shot timed effect (see below)

---

RoomZoneQA / RoomZoneDimQA / RoomZoneSwitchQA

Controls all lights in a Hue room or zone simultaneously. The exact HC3 type depends on the group's light capabilities (see 

Please login or register to see this link.

). Methods below are exposed only when supported by the underlying group:

Method	Available on	Arguments	Description
turnOn	all	(optional scene name)	Turns group on, optionally recalling a named scene
turnOff	all	—	Turns entire group off
setValue	Color, CT, Dim	level (0–100)	Sets group brightness
setColor	Color	"RRGGBB"	Sets group colour from hex string. Also turns the group on
setColorComponents	Color	{red,green,blue,warmWhite}	Sets group colour by component. Also turns the group on
setColorTemperature	Color, CT	kelvin (2000–6500) or mirek (153–500)	Sets group colour temperature. Also turns the group on
startLevelIncrease	Color, CT, Dim	—	Smooth group ramp to 100% (duration controlled by dimdelay QA variable, default 8 s)
startLevelDecrease	Color, CT, Dim	—	Smooth group ramp to 0% (duration controlled by dimdelay QA variable, default 8 s)
stopLevelChange	Color, CT, Dim	—	Stops group ramp
setScene	all	sceneName	Stores a scene name to recall on next turnOn
sceneChanged	all	event	UI callback for the scene dropdown — also persists lastSceneId
sceneModeToggle	all	—	UI callback for the Static/Dynamic button
signal	all	sig, duration_ms, colors	Signalling effect on all group lights (see below)

---

Light effects reference

signal — blink / alerting effects

Applies a visual signalling effect to the light or group.

Please login or register to see this code.

Parameter	Type	Description
sig	string	Effect type (see table below)
duration_ms	number	Duration 1000–65534000 ms. Default 5000
colors	table	Optional array of 1–2 RRGGBB hex strings

sig value	Colors required	Description
"on_off"	none	Blink between max brightness and off
"on_off_color"	1 color	Blink between off and the given color
"alternating"	2 colors	Alternate between two colors
"stop"	none	Cancel any active signal immediately

Examples:

Please login or register to see this code.

---

setEffect — continuous looping effect

Individual lights only (not supported on rooms/zones).

Please login or register to see this code.

effect value	Description
"candle"	Candle flicker
"fire"	Fire effect
"prism"	Prism colour cycle
"sparkle"	Random sparkle
"opal"	Opal shimmer
"glisten"	Glisten
"underwater"	Underwater wave
"cosmos"	Cosmos
"sunbeam"	Sunbeam
"enchant"	Enchant
"stop"	Cancel active effect

---

setTimedEffect — one-shot timed effect

Individual lights only (not supported on rooms/zones).

Please login or register to see this code.

effect value	Description
"sunrise"	Sunrise simulation
"sunset"	Sunset simulation
"stop"	Cancel active timed effect

---

Updating Yahue

To update to the latest version:

1. Open the QuickApp on the HC3
2. Set the QuickApp Variable update to yes
3. Save

The QuickApp downloads dist/Yahue.fqa from GitHub, installs all files, and restarts. Your UserConfig file is never overwritten — your type overrides and any other customisations are preserved.

---

Troubleshooting

Info label shows "Set Hue_IP variable then restart"
The Hue_IP QuickApp Variable is empty or not a valid IPv4 address. Set it in the QuickApp settings and restart.

Info label shows "Set Hue_User, or press 'Pair with bridge'"
No application key is stored yet. Either press Pair with bridge and follow the prompt, or enter an existing key manually into the Hue_User QuickApp Variable.

Pairing timed out ("Timed out — press Pair and try again")
You have 30 seconds to press the physical link button on the bridge after pressing Pair with bridge. Press Pair with bridge again and try once more.

Pairing shows an error message
The bridge at Hue_IP was unreachable. Verify the IP address is correct and that your HC3 can reach the bridge on port 80.

No devices appear in the dropdown
The bridge was unreachable or returned an error. Check the HC3 log for ERROR lines from the QuickApp. Confirm the bridge IP is reachable from the HC3.

A child device shows as dead
The corresponding Hue device has gone offline (e.g. bulb removed or powered off). The dead property will clear automatically when the device reconnects.

Changing a contact sensor to windowSensor has no effect
The typeOverrides setting only applies when the child device is first created. Remove the device from the selection, apply, add the override to userconfig.lua, re-add the device, apply again.

Scene dropdown is empty on a Room/Zone device
Scenes are loaded at startup. If you added scenes to the Hue app after the QuickApp started, press Restart to reload them.

A dimmable light shows as off when set to 1 % in the Hue app
Fixed in v0.2.16+. At its lowest dim step the Hue bridge can send dimming.brightness values < 0.5 which would round to 0 and force HC3 to display the light as off. Yahue now clamps such values to 1.

HC3 setColorTemperature returns an error from the bridge (mirek > 500)
Fixed in v0.2.20+. HC3's standard setColorTemperature action passes a Kelvin value; Yahue now converts to Hue mirek (clamped to 153–500). Values ≤ 1000 are treated as already-mirek for backward compatibility.

A room/zone child created on an older Yahue version is missing the new scene/mode UI
On upgrade to v0.2.18+ Yahue compares each room/zone child's stored UI version against the current definition. If they differ, the child is recreated with the new layout (UID is preserved, but per-child QA variables such as scene, lastSceneId and sceneMode are reset). The QA restarts automatically after the recreate cycle.
 

 

Please login or register to see this attachment.

 

Examples:

Turn on a room/zone at 30min past sunset, and turn it off 60min before sunrise. (zoon/room has deviceID 1128). Set 'scene' quickVar if you want the zone/room to turnOn with a specific scene.

Conditions triggers:

Please login or register to see this code.

Actions:

Please login or register to see this code.

 

Another example.

A Hue tap switch (deviceID 1596) with 4 buttons controlling 3 scenes for a zone (deviceId 1587) (+ turnOff)

Conditions/triggers:

Please login or register to see this code.

Actions:

Please login or register to see this code.

 

 

Edited April 26 by jgab

[Sjakie 156]

Jan,

Please login or register to see this code.

 

[jgab 2,647]

36 minutes ago, Sjakie said:

Jan,

Please login or register to see this code.

 

The line number doesn't make sense... don't know what it is. Try to do an update (set QV 'update' to 'yes')

[Sankotronic 2,370]

Hi @jgab ,

 

Nice but very basic setup. When I wrote "very basic" I refer to missing HUE scenes. Setting color not so important, but having possibility to activate HUE scenes from HC3 is a must have. Also newer HUE lights support effects, e.g. Festavia is all about effects. Currently only few effects are available like "candle", "fire", "prism", "opal", "glisten", "sparkle" and "sunrise". Have you try these?

 

 

 

 

[jgab 2,647]

20 hours ago, Sankotronic said:

Hi @jgab ,

 

Nice but very basic setup. When I wrote "very basic" I refer to missing HUE scenes. Setting color not so important, but having possibility to activate HUE scenes from HC3 is a must have. Also newer HUE lights support effects, e.g. Festavia is all about effects. Currently only few effects are available like "candle", "fire", "prism", "opal", "glisten", "sparkle" and "sunrise". Have you try these?

Yes, that's is what scenes and rooms are for - you can recall a scene for room/zone when you turn it on.

Because zone/rooms are represented as multilevelSwitches QAs, we need to set the scene in a quickvar for the QA.

I very seldom need to set different scenes for room/zones but when needed there is a function setScene(name) for the room/QA that sets the quickvar...

Speed/transition and some other possible parameters could be added as other "quickvar parameters"...

It's a real mess creating custom UIs now for QA children, so I stayed away from that.

If you want to sparkle it can be assigned to a scene assigned to the room/zone.

Edited April 1, 2024 by jgab

[lux 14]

like it ! Thank you @jgab

[lux 14]

@jgab

Please login or register to see this link.

[jgab 2,647]

11 minutes ago, lux said:

@jgab

Please login or register to see this link.

Yes, it's supported. It's realised as 2 different child QAs. One remote (buttons) and one multilevelSensor (the dial 0-100)

[lux 14]

@jgab Ok ,Thank you, I will purchase one！

[jgab 2,647]

33 minutes ago, lux said:

@jgab Ok ,Thank you, I will purchase one！

Yes, I have one myself, so I will make my best to have it working  

[Sjakie 156]

Jan,

What's the format for setValue?

Possible to set color too?
 

[jgab 2,647]

On 4/3/2024 at 10:02 AM, Sjakie said:

Jan,

What's the format for setValue?

Possible to set color too?

No, assign scenes to rooms or zones in the Hue app. The scene can define color and effects.

You can swap scenes for a room/zone to play with different colors -see example in first post.

Then when you turn on the room or zone QA the scene assigned to the QA  is recalled.

 

setValue is the dimming value (e.g. brightness value 0-100%)

Edited April 6, 2024 by jgab

[lux 14]

@jgabIs there any example of the use of a rotary sensor for lighting or curtains? If the value of the rotary sensor is reset to 0 after a certain period of time, there may be more ways to use it. The current situation is that if the value is equal to 0, continue to rotate left without any change, and if possible, there may be negative values

Edited April 13, 2024 by lux

[jgab 2,647]

2 hours ago, lux said:

@jgabIs there any example of the use of a rotary sensor for lighting or curtains? If the value of the rotary sensor is reset to 0 after a certain period of time, there may be more ways to use it. The current situation is that if the value is equal to 0, continue to rotate left without any change, and if possible, there may be negative values

How do you want it to behave? I can make it a configurable behaviour.

min and max value, steps, and if should wrap around etc.

Actually, min and max should be 0-100 to map to a com.fibaro.multilevelSensor

but it could wrap around so 100->0 and 0 <- 100

[jgab 2,647]

Maybe also an option to map to other fibaro types. Which do you need?

[lux 14]

-

Edited May 5, 2024 by lux

[lux 14]

-

Edited May 5, 2024 by lux

[lux 14]

@jgab I update here , But the knob effect is not ideal!
                in eventrun4/5  i used like thiks : 2064 is hue knob ,2054 is my device

rule("2064:value => log('name:%s',env.event.value-env.event.old);2054:value=(2054:value)+(env.event.value-env.event.old)")

Please login or register to see this code.

 

Edited May 5, 2024 by lux

[ChristianSogaard 73]

On 3/31/2024 at 12:32 PM, jgab said:

I have started to use this QA instead of my old ChildrenOfHue QA.

My Hue integration philosophy is I use the Hue hub as the main controller as I prefer the Hue app to set&control lights + that I have other Hue integrations, like nodered.

Letting the HC3 be the zigbee controller and taking over the devices is not an option for me.

 

Please login or register to see this attachment.

v0.54 (upgradable to v0.55)

 

So, this QA imports some of the Hue resources from the Hue hub and creates QA child devices to represent them.

Please login or register to see this attachment.

 

 

It supports Hue devices/resources such as

• door/window contact sensor
  • Implemented as a com.fibaro.doorSensor
• motion sensor
  • Implemented as a com.fibaro.motionSensor
• temperature sensor
  • Implemented as a com.fibaro.temperatureSensor
• lux sensor
  • Implemented as a com.fibaro.lightSensor
• rotary sensor
  • Implemented as a com.fibaro.multilevelSensor.
    Sets the value of the sensor 0-100 when rotary is turned.
    args={div=4} will divide reported steps with 4 - gives a smoother turning.
• button dimmer/switch remote
  • Implemented as a com.fibaro.remoteControll
    Sends centralSceneEvents, "Pressed","HeldDown","Released". Experimental support for double-clicks...
• plug
  • Implemented as com.fibaro.binarySwitch
• room & zone
  • Implemented as com.fibaro.multilevelSwitch
  • turnOff turns on light group associated to room/zone
  • turnOn recalls scene for light group if quickVar 'scene' is set to scene name. Otherwise, the light group is just turned on
  • setValue sets the dimming level of the associated light group
  • At the moment, if any light is off-line the QA will set the dead property. This way scripts can react if lights are powered off/on. It may become a configurable option...
  • Support for leveChange commands. startLevelIncrease,startLevelDecrease,and stopLevelChange. args={dimdelay=10000} sets dim cycle (0-100%) to 10s.

 

Please login or register to see this attachment.

 

Some of the Hue controllers will be realised as several QAs.

Ex. the 'Hue tap dial switch' is realised both as a button/remote control and a rotary sensor QA.

The 'Hue motion sensor' is a temperature, motion, and lux sensor and can create 3 QAs.

 

It even works with the Hue secure camera providing motion and lux sensor.

 

It does not support lights directly, but it supports rooms and zones.

(to represent lights using the HC3 UI and rgb/xy issues, makes it too cumbersome, and scenes/zones gives the control I need)

 

Rooms and zones are represented as a multilevelSwitch, providing turnOn,turnOff, and set brightness/dimming

turnOn/turnOff operates on the light group associated with the room/zone.

If the room/zone's QA has the quickAppVariable 'scene' set to a scene associated with the room/zone the scene will be recalled when doing a turnOn.

If you need the to apply different scenes, update the scene variable for the room/zone QA, before turning on.

 

To  configure what child devices to create, go into the QA file "Map" and set enabled=true for the QAs/devices to create.

If you do any changes in the Hue hub, just restart the QA, the 'Map' will be updated.

 

...and it uses the Hue v2 api that should be more efficient as it streams the events and no need to periodically poll the hub.

If you have more than one hub, install additional Yahue QAs...

 

Setting the quickAppVariable 'update' to 'yes' will download the latest version from my GitHub while preserving configuration.

 

 

Examples:

Turn on a room/zone at 30min past sunset, and turn it off 60min before sunrise. (zoon/room has deviceID 1128). Set 'scene' quickVar if you want the zone/room to turnOn with a specific scene.

Conditions triggers:

Please login or register to see this code.

Actions:

Please login or register to see this code.

 

Another example.

A Hue tap switch (deviceID 1596) with 4 buttons controlling 3 scenes for a zone (deviceId 1587) (+ turnOff)

Conditions/triggers:

Please login or register to see this code.

Actions:

Please login or register to see this code.

 

There was a bug for remotes/buttons so update to v0.53 and recreate the remote/button devices (delete them)

 

Hi Jan, Thank you for sharing "yet another" great QA

I share your Hue philosophy as I also prefer the Hue app to set&control lights.

I am using the old ChildrenOfHue QA with ER5 so I am wondering if you managed to get rid of COH and how?

I see i can dump all devices and start filtering like "light:ea3c7602-66e3-412b-b688-e83df5b16129,Bryggers 4,spot_bulb" add to the MAP ?

im using EV5 rules like below, how do you recommend a migration path for single lights or in general ?

Please login or register to see this code.

 

[jgab 2,647]

2 hours ago, ChristianSogaard said:

Hi Jan, Thank you for sharing "yet another" great QA

I share your Hue philosophy as I also prefer the Hue app to set&control lights.

I am using the old ChildrenOfHue QA with ER5 so I am wondering if you managed to get rid of COH and how?

I see i can dump all devices and start filtering like "light:ea3c7602-66e3-412b-b688-e83df5b16129,Bryggers 4,spot_bulb" add to the MAP ?

im using EV5 rules like below, how do you recommend a migration path for single lights or in general ?

Please login or register to see this code.

 

I would suggest creating zones for the lights. 1026 one zone, {1026,1276,1275} another zone.

Then create scenes for the zones with the colors and effects you want.

Then you can turn on/off zones and assign them scenes to change colors.