ioBroker Philips Hue Bridge Adapter

This adapter uses the service Sentry.io to automatically report exceptions and code errors and new device schemas to me as the developer. More details see below!

What is Sentry.io and what is reported to the servers of that company?

Sentry.io is a service for developers to get an overview about errors from their applications. Exactly this is implemented in this adapter.

When the adapter crashes or another Code error happens, this error message that also appears in the ioBroker log is submitted to Sentry. When you have allowed ioBroker GmbH to collect diagnostic data, then also your installation ID (this is just a unique ID without any additional infos about you, email, name or such) is included. This allows Sentry to group errors and show how many unique users are affected by such an error. All of these helps me to provide error-free adapters that basically never crash.

English 🇬🇧

This adapter connects your Philips Hue Bridges with ioBroker to control Philips Hue LED bulbs, Friends of Hue LED lamps, stripes, plugs like from Osram, and other SmartLink capable devices (like LivingWhites and some LivingColors).

Setup

Once you have installed this adapter within ioBroker, create an adapter instance accordingly. Next, you need to connect your Hue bridge with ioBroker within the adapter settings:

If you are using another bridge than v2, configure port to 80 (non-https), else 443 (https) should be the way to go.
Click on "Find Bridge" button to get the IP address of your bridge. This will search for all bridges in your environment. Then select the bridge to which you want to connect. The field "Bridge Address" will be populated with the IP address of your chosen Hue bridge.
Next, click on "Create User" button in the settings and then walk to your Hue bridge device, so your hardware, to push its round button. You'll be going to have 30 seconds to proceed. Once you pushed the button, the field "Bridge User" should be populated with a generated string.
Modify any other options in the adapter settings and then select "save and close".
Finally, you should be all set: The adapter will generate all objects to control your Hue devices accordingly.

Please note: Adapter settings button "Find Bridge" will be inactive if field "Bridge Address" is populated, and button "Create User" will be inactive if field "Bridge User" is populated.

Settings

Name	Description
Bridge address	IP address of your Hue bridge, you can try to detect it by pressing `Find Bridge` button.
Port	Port of your Hue bridge, normally 443 (SSL) and 80 (non-SSL).
SSL	If checked, connection is secured via SSL, port will automatically change to 443 (it is strongly recommended to use SSL).
User	Username of your bridge user. You can create it, by pressing `Create User` button and following the screen instructions.
Ignore scenes	If checked, scenes will not be shown/controlled by the adapter.
Ignore groups	If checked, groups will not be shown/controlled by the adapter.
"Legacy" structure	To support backwards compatibility, it is possible to hold an old object structure in ioBroker. This old structure is `hue.<instance_number>.<bridge_name_channel>.<light_or_group_channel>.<state>`. The new structure removes `<bridge_name_channel>` and thus makes it necessary to adapt old scripts, etc. If an existing old structure is detected by the adapter, the structure will be used without checking the checkbox. However, if migration from old to new structure is desired, delete the whole `hue.<instance_number>` namespace once.
Native turn off/on behaviour	If checked, the adapter will turn on/off lights in the same fashion as the native Hue app does. Otherwise, lamps will be set to a level of 100 % when switched on. Additionally when a group is already turned on, setting the brightness level will affect only the already turned on lamps and will not turn the lamps on, which are currently turned off.
Sync software sensors	Also sync software sensors. These are virtual sensors, e.g. created by Hue Labs scenes. By controlling the `status` datapoint of such a sensor you can start/stop scenes which follow this logic. In most cases `0` turns scene off and `1` turns it on.
Turn on with others	Turn on lights also with ct state, color state, ... Set to `false` and turn on only with power and brightness state.
Polling	If checked, the adapter will poll state changes, otherwise it can only be used to control lamps, not to show their status.
Polling interval	Defines how often the states will be polled, and thus updated in ioBroker. Low polling intervals can cause performance issues in some settings. Hence, the minimum allowed polling interval is 2 seconds. If polling interval is set to less than 2 seconds it will be set to 2 seconds during runtime.

Commands

Command states (e.g. hue.0.All.command) can be used to set multiple commands to the bridge. This allows setting a group or a light to a specific state using e.g. a transition time.

setState('hue.0.All.command', { "bri": 50, "transitiontime": 30 }, false);

For groups which contain scenes, like hue.0.Wohnzimmer.scene_hell the scenes can also be activated with a transition time. To do this, pass the scene argument to the corresponding command.

setState('hue.0.All.Wohnzimmer', { "scene": "hell", "transitiontime": 30 }, false);

Additional information

With version 3.3.0 the group states anyOn and allOn became controllable, note that they will just act like the on state, when controlled. In some cases, it may be desirable to have a controllable anyOn state in your visualization.

Deutsch 🇩🇪

Bindet Philips Hue / LivingColors / LivingWhites Lampen ein. In den Adapter-Settings muss die IP der Hue Bridge sowie ein Username konfiguriert werden. Um einen User zu aktivieren, einmal auf create user drücken und dann innerhalb von 30 Sekunden den Button an der Hue bridge drücken. Dann wird automatisch der User übergeben.

Changelog

3.12.0 (2024-07-14)

(foxriver76) level and bri states of groups are now updated via push API

3.11.0 (2024-03-26)

(seb2010) added possibility to use global light-scenes in commands (in addition to object-lightscene)
(foxriver76) dropped support of node 16 (End-Of-Life)

3.10.2 (2023-12-25)

(foxriver76) bring back short delay between setting and polling a group
(foxriver76) use adapter internal timer methods

3.10.1 (2023-10-17)

(foxriver76) fixed frontend/backend communication (closes #481)

3.10.0 (2023-08-29)

(foxriver76) fixed problem on auto-deletion of groups
(foxriver76) implemented Hue Tap Dial (closes #368, closes #416)

3.9.6 (2023-08-16)

(foxriver76) do not set invalid states on unknown group updates
(foxriver76) only use push connection if ssl is configured

3.9.5 (2023-07-31)

(foxriver76) fixed crash case

3.9.4 (2023-07-30)

(foxriver76) fixed the edge case crash on button updates
(foxriver76) fixed crash case if uuids cannot be retrieved

3.9.3 (2023-06-14)

(foxriver76) fixed crash cases on unknown push updates (closes #417)

3.9.2 (2023-06-13)

(foxriver76) fixed sensor converting (closes #415)

3.9.1 (2023-06-13)

(foxriver76) implemented more commands of the Push API (mainly buttons)

3.9.0 (2023-06-11)

(foxriver76) implemented poll API (closes #227, #343)
(foxriver76) fixed polling not working (closes #408, #410)

3.8.0 (2023-06-09)

(Schmakus) Possibility to disable turn on lights with states other than on and brightness [#386]

3.7.1 (2022-07-12)

(Eistee82) also update state for CLIPGenericFlag sensors

3.7.0 (2022-05-30)

(foxriver76) support software sensor CLIPGenericFlag (closes #328)

3.6.5 (2022-01-11)

(foxriver76) correctly identify third party switches (closes #273)

3.6.3 (2022-01-09)

(foxriver76) added info.connection state (closes #268)

3.6.1 (2022-01-09)

(foxriver76) ct values of groups can be even lower due to third party lights

3.6.0 (2021-12-30)

(foxriver76) allow triggering scenes via command state, this allows starting a scene with transitiontime

3.5.31 (2021-11-20)

(foxriver76) ct value fixed of #234 ported for 0 (All) group

3.5.30 (2021-11-14)

(foxriver76) we fixed Sentry IOBROKER-HUE-1K, IOBROKER-HUE-A, IOBROKER-HUE-1J

3.5.29 (2021-11-14)

(bluefox) Caught SENTRY error.

3.5.28 (2021-11-04)

(foxriver76) another fixed for invalid ct values (fixes #234)

3.5.27 (2021-11-01)

(foxriver76) we fixed missing object type of some scenes (closes #255)

3.5.26 (2021-10-20)

(foxriver76) fixed an issue with the username set in Hue API (fixes 249)
(klein0r) fixed translation of search popup (fixes #247)

3.5.25 (2021-09-15)

(foxriver76) if we cannot determine the correct ct value, we won't set it (fixes #234)

3.5.23 (2021-08-26)

(Pmant) fixed for third party devices delivering wrong ct values

3.5.22 (2021-08-12)

(foxriver76) fixed several sentry issues (closes #217, closes #218, closes #219, closes #220)

3.5.20 (2021-08-10)

(foxriver76) we now define minimum ct of groups to 2000 instead of 2179 (fixes #216)

3.5.19 (2021-06-02)

(foxriver76) fixed crash case if we cannot get min/max ct values

3.5.18 (2021-06-01)

(foxriver76) get the correct min/max ct values from api for lights (closes #192)

3.5.17 (2021-05-26)

(foxriver76) prevent edge case crash (fixes #196)

3.5.16 (2021-05-07)

(foxriver76) make buttons type boolean (closes #189)

3.5.15 (2021-05-05)

(foxriver76) fixed some default type values, which produced warnings once

3.5.14 (2021-05-04)

(foxriver76) protect the user token from access by foreign adapters
(foxriver76) fixed types of default values on groups

3.5.13 (2021-05-03)

(foxriver76) we fixed some more types

3.5.12 (2021-05-02)

(foxriver76) we give skipped switches common.type 'mixed' instead of none
(foxriver76) we have corrected the min max of color temperature (empirically found)

3.5.11 (2021-05-02)

(foxriver76) we now update objects if a type has changed

3.5.10 (2021-04-30)

(foxriver76) we removed the common.max from lightlevel, was 17,000 but can be much higher
(foxriver76) we added common.type for states where the attribute was missing

3.5.9 (2021-04-30)

(foxriver76) start this adapter in TIER 2

3.5.8 (2021-04-17)

(foxriver76) minor changes

3.5.5 (2021-04-07)

(foxriver76) fixed a bug where an error on user creation crashed the adapter instance

3.5.4 (2021-03-25)

(foxriver76) fixing several edge case crashes

3.5.2 (2021-02-24)

(foxriver76) fixed crashes if wrong data type or invalid value passed for ct and hue, now logging an error
(foxriver76) fixed crashes if rgb where outside allowed range or wrong type
(foxriver76) fixed potential crashes on bridge discovery, due to unnecessary stringify/parse logic
(foxriver76) fixed a graphical issue with the label of bridge user when newly created, due to missing call of updateTextFields

3.5.1 (2021-02-20)

(foxriver76) avoid crash cases on invalid xy, setting state for non-existing device and on failing user creation

3.5.0 (2021-02-18)

(foxriver76) use official js-controller regex for replacing forbidden chars (fixes #165)
(foxriver76) use release-script
(foxriver76) sentry added

3.4.0 (2021-01-20)

(foxriver76) we now restart the adapter automatically to add new devices if they have been added to bridge

3.3.11 (2021-01-12)

(foxriver76) fixed updating anyOn and allOn if legacy structure used

3.3.9 (2021-01-11)

(foxriver76) we do not set states of non-existing states anymore

3.3.8 (2020-10-11)

(foxriver76) marked read-only states accordingly

3.3.7 (2020-10-04)

(Apollon77) do not catch undhandeledRejections anymore, because controller can handle and report now
(foxriver76) dependencies updated
(foxriver76) temperature is now correctly read-only
(foxriver76) fixed duplicate filtering on browse

3.3.5 (2020-06-03)

(foxriver76) fixed issue on frontend validation of polling intervals starting with 1

3.3.4 (2020-06-02)

(foxriver76) implemented fixed for problems with switches and handling id conflicts

3.3.3 (2020-05-31)

(foxriver76) we now handle potential id conflicts, when adding devices from a different type with same name over time

3.3.2 (2020-05-15)

(foxriver76) internal optimizations - polling after change timeout removed, was 150 ms now instant

3.3.0 (2020-05-14)

(foxriver76) introduce allOn state for groups
(foxriver76) anyOn and allOn are now controllable and act like the on state
(foxriver76) when native turn on/off behaviour is used, the brightness change of partially turned on groups will not turn the whole group on, like the hue app does, instead it will only change the brightness of the currently turned on lamps

3.2.9 (2020-05-12)

(foxriver76) fixed issues on user creation
(foxriver76) minor frontend (admin config) optimizations

3.2.8 (2020-04-26)

(foxriver76) replace dots in light/group/sensor/.. names by underscores
(foxriver76) fixed potential state update delay after state change on lights/groups containing blanks

3.2.4 (2020-04-08)

(xXBJXx) changed role of battery to value.battery and made unit %

3.2.3 (2020-02-20)

(Apollon77) minor fixed regarding handleParam called with non-existing id

3.2.2 (2020-02-12)

(foxriver76) fixed potential issues when error type is not HueError

3.2.1 (2020-01-26)

(foxriver76) if lights/groups/sensors are deleted during runtime, restart of adapter is no longer necessary
(foxriver76) if controller supports recursive deletion, device will be deleted automatically

3.1.1 (2020-01-15)

(foxriver76) added additional frontend validation of polling interval
(foxriver76) if errors are hue errors, log message instead of Error

3.1.0 (2020-01-12)

(foxriver76) added new indicators for entertainment groups (class and activeStream)
(foxriver76) added possibility to enable/disable streaming of entertainment group

3.0.3 (2020-01-11)

(foxriver76) fixed turning on/off switchs like Osram Plug

3.0.1 (2020-01-10)

(foxriver76) removed queue, because handled by dependency now
(foxriver76) improved error handling
Nodejs >= 10 required

2.5.0 (2019-12-23)

(foxriver76) implemented a mechanic to prevent regular polling of recently changed state
(foxriver76) this prevents fluctuating of buttons on low polling intervals + possible strange triggers in scripts

2.4.7 (2019-12-14)

(foxriver76) do not set default values on every adapter start
(foxriver76) this is now done only on object creation

2.4.6 (2019-12-06)

(foxriver76) log unhandeld promise rejections
(foxriver76) fixed potential issue for negative temperature values

2.4.4 (2019-11-27)

(foxriver76) only stringify huge jsons if necessary
(foxriver76) prevent possible double polling at adapter start
(foxriver76) use timeouts instead of interval
(foxriver76) improved performance

2.4.3 (2019-11-19)

(foxriver76) increased version of node-hue-api to fixed authentication for old bridge

2.4.2 (2019-11-16)

(foxriver76) we now use nupnp + upnp to discover bridges (previously only upnp)

2.4.1 (2019-11-13)

(foxriver76) added possibility to control zones and entertainment areas
(foxriver76) log queue retires on debug instead warn
(foxriver76) BETA: added possibility to control software sensors (Note: this may be handled in a more suitable fashion soon)

2.3.1 (2019-11-02)

(foxriver76) fixed controlling on state of sensors

2.2.3 (2019-10-21)

(foxriver76) migrate everything to Hue v3
(foxriver76) add possibility to turn on/off sensor
(foxriver76) add anyOn state for all group
(foxriver76) different kinds of fixes for v3 (Osram Plugs, SSL connection, etc)

2.1.0 (2019-10-15)

(foxriver76) usage and adaptions for node-hue-api v3
(foxriver76) ability to turn lights on with last settings
(foxriver76) polling interval minimum is now 2 sec

2.0.1 (2019-10-04)

(foxriver76) fixed bug, that prevented some sensor states getting updated during runtime

2.0.0 (2019-09-23)

ATTENTION: Remove all objects once, ids have changed

(foxriver76) internal optimizations
(foxriver76) usage of iobroker testing
(foxriver76) add possibility to sync scenes
(foxriver76) restart adapter when room is deleted in app
(foxriver76) fixed .hue value, user had to set 0-360° but adapter set 0-65535
(foxriver76) fixed .color.temperature
(foxriver76) remove unnecessary bridge channel, adapter namespace is the bridge
(foxriver76) add "update available" indicator for light bulbs
(foxriver76) we now poll the root endpoint instead of (|lights| + |groups| + |sensors|) endpoints every pollingInterval seconds
(foxriver76) min poll interval now 3 seconds instead of 5 seconds
(foxriver76) add new indicator state 'anyOn'

1.2.4 (2019.09.18)

(Apollon77) Make compatible with js-controller 2.0

1.2.3 (2019.03.11//2019.07.07)

(jens-maus) Refactored command queue handling to use 'bottleneck' package so that command execution are processed with minimum delay.

1.1.2 (2019.01.25)

(BasGo) Added compact mode

1.1.1 (2018.08.17)

(bluefox) Ignoring of groups was implemented

1.1.0 (2018.08.17)

(bluefox) The command queue was optimized

1.0.1 (2018.08.14)

(bluefox) Roles were adjusted
(bluefox) temperature changed from 153-cold, 500-warm to 2200-warm, 6500-cold
(bluefox) hue changed from 0-65535 to 0-360°

1.0.0 (2018.04.12)

(arteck) Enable/Disable OSRAM check from HUE Bridge
(arteck) polling ZLLSwitch and ZGPSwitch
(bluefox) admin3
(bluefox) do not send commands ofter than 10 in 10 seconds

0.6.9 (2017.05.18)

(bluefox) Enable adapter by default

0.6.8 (2017.04.22)

(bluefox) Poll groups

0.6.7 (2017.04.21)

(bluefox) Fix error with turn on the lamp on start
(bluefox) configurable port

0.6.6 (2017.04.20)

(bluefox) Use new version of npm library

0.6.0 (2016.11.30)

(pmant) support new lamps
(pmant) add light name to log

0.5.9 (2016.10.11)

(pmant) fixed error with null values

0.5.8 (2016.06.05)

(bluefox) fixed typo

0.5.7 (2016.06.05)

(soef) write back known states for group/room
(soef) Integer conversion for bri_inc command

0.5.6

(Pmant) (experimental) support for power switches

0.5.5

(Pmant) fixed error with xy state
(Pmant) support level in command state

0.5.4

(Pman) Lightset 0 fixed
(Pman) support for diffent gamuts
(Pman) support Rooms (new HUE App)

0.5.3

(soef) Default Lightset 0 added

0.5.2

(Pman) fixed jscs warnings
(Pman) improve RGB conversion
(Pman) add update rgb color

0.5.1

(Pman) fixed find bridge popup

0.5.0

(Pman) update to node-hue-api 1.2.x
(Pman) add level state (bri percentage)

0.4.4

(bluefox) fixed config edit

0.4.3

(Pmant) fixed adapter crash

0.4.2

(Pmant) add find bridge (experimental)
(Pmant) add create user (experimental)
(Pmant) fixed enable polling

0.4.1

(Pmant) calculate and write back inc values

0.4.0

(Pmant) add command state

0.3.2

(Pmant) add groups as channels (write only)
(Pmant) fixed prevent duplicate channel names

0.3.1

(Pmant) fixed another bug with spaces
(Pmant) fixed hue/sat bug
(Pmant) fixed effect bug
(Pmant) fixed xy colormode

0.3.0

(Pmant) fixed rgb states only for color lights
(Pmant) change set known state changes immediately
(Pmant) change on/off sets brightness to 254/0
(Pmant) change changing any color (hs,ct,xy) while light is off sets brightness to max
(Pmant) fixed set brightness to zero if light is off
(Pmant) change set bri to zero if lamp is not reachable
(Pmant) fixed bridges and lamps with spaces in name

0.2.1

(Pmant) add rgb states (write only)
(Pmant) fixed parent/children warnings
(Pmant) add switch light off if brightness is zero

0.1.4

(bluefox) fixed some null objects

0.1.3

(hobbyquaker) config UI
(hobbyquaker) added children

0.1.2

(hobbyquaker) fixes

0.1.1

(hobbyquaker) fixed min/max attributes
(hobbyquaker) added common.oper.read/write attributes

0.1.0

(hobbyquaker) first release

Roadmap/Todo

Automatic bridge discovery
Automatic user setup via bridge link button

License

Apache 2.0

Files

README.md

Latest commit

History