iobroker-community-adapters / ioBroker.hue

Control Philips Hue Bridge
http://www.iobroker.org
Apache License 2.0
43 stars 29 forks source link
iobroker iot philips-hue smarthome

Logo

ioBroker Philips Hue Bridge Adapter

Number of Installations Number of Installations NPM version

Test and Release Translation status Downloads

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 :gb:

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:

  1. If you are using another bridge than v2, configure port to 80 (non-https), else 443 (https) should be the way to go.
  2. 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.
  3. 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.
  4. Modify any other options in the adapter settings and then select "save and close".
  5. 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 :de:

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.13.1 (2024-10-16)

3.13.0 (2024-10-16)

3.12.0 (2024-07-14)

3.11.0 (2024-03-26)

3.10.2 (2023-12-25)

3.10.1 (2023-10-17)

3.10.0 (2023-08-29)

3.9.6 (2023-08-16)

3.9.5 (2023-07-31)

3.9.4 (2023-07-30)

3.9.3 (2023-06-14)

3.9.2 (2023-06-13)

3.9.1 (2023-06-13)

3.9.0 (2023-06-11)

3.8.0 (2023-06-09)

3.7.1 (2022-07-12)

3.7.0 (2022-05-30)

3.6.5 (2022-01-11)

3.6.3 (2022-01-09)

3.6.1 (2022-01-09)

3.6.0 (2021-12-30)

3.5.31 (2021-11-20)

3.5.30 (2021-11-14)

3.5.29 (2021-11-14)

3.5.28 (2021-11-04)

3.5.27 (2021-11-01)

3.5.26 (2021-10-20)

3.5.25 (2021-09-15)

3.5.23 (2021-08-26)

3.5.22 (2021-08-12)

3.5.20 (2021-08-10)

3.5.19 (2021-06-02)

3.5.18 (2021-06-01)

3.5.17 (2021-05-26)

3.5.16 (2021-05-07)

3.5.15 (2021-05-05)

3.5.14 (2021-05-04)

3.5.13 (2021-05-03)

3.5.12 (2021-05-02)

3.5.11 (2021-05-02)

3.5.10 (2021-04-30)

3.5.9 (2021-04-30)

3.5.8 (2021-04-17)

3.5.5 (2021-04-07)

3.5.4 (2021-03-25)

3.5.2 (2021-02-24)

3.5.1 (2021-02-20)

3.5.0 (2021-02-18)

3.4.0 (2021-01-20)

3.3.11 (2021-01-12)

3.3.9 (2021-01-11)

3.3.8 (2020-10-11)

3.3.7 (2020-10-04)

3.3.5 (2020-06-03)

3.3.4 (2020-06-02)

3.3.3 (2020-05-31)

3.3.2 (2020-05-15)

3.3.0 (2020-05-14)

3.2.9 (2020-05-12)

3.2.8 (2020-04-26)

3.2.4 (2020-04-08)

3.2.3 (2020-02-20)

3.2.2 (2020-02-12)

3.2.1 (2020-01-26)

3.1.1 (2020-01-15)

3.1.0 (2020-01-12)

3.0.3 (2020-01-11)

3.0.1 (2020-01-10)

2.5.0 (2019-12-23)

2.4.7 (2019-12-14)

2.4.6 (2019-12-06)

2.4.4 (2019-11-27)

2.4.3 (2019-11-19)

2.4.2 (2019-11-16)

2.4.1 (2019-11-13)

2.3.1 (2019-11-02)

2.2.3 (2019-10-21)

2.1.0 (2019-10-15)

2.0.1 (2019-10-04)

2.0.0 (2019-09-23)

ATTENTION: Remove all objects once, ids have changed

1.2.4 (2019.09.18)

1.2.3 (2019.03.11//2019.07.07)

1.1.2 (2019.01.25)

1.1.1 (2018.08.17)

1.1.0 (2018.08.17)

1.0.1 (2018.08.14)

1.0.0 (2018.04.12)

0.6.9 (2017.05.18)

0.6.8 (2017.04.22)

0.6.7 (2017.04.21)

0.6.6 (2017.04.20)

0.6.0 (2016.11.30)

0.5.9 (2016.10.11)

0.5.8 (2016.06.05)

0.5.7 (2016.06.05)

0.5.6

0.5.5

0.5.4

0.5.3

0.5.2

0.5.1

0.5.0

0.4.4

0.4.3

0.4.2

0.4.1

0.4.0

0.3.2

0.3.1

0.3.0

0.2.1

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

Roadmap/Todo

License

Apache 2.0

Copyright (c) 2017-2024 Bluefox dogafox@gmail.com
Copyright (c) 2014-2016 hobbyquaker