artnet-hue-entertainment

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

artnet-hue-entertainment

(★ 52)

Near-realtime ArtNet control over Signify/Philips Hue lights using the new Hue Entertainment API

artnet-hue-entertainment Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ArtNet Hue Entertainment

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/jeffreykog/artnet-hue-entertainment/main/LICENSE.txt)

__Note: This package is still work in progress!__

In short: an ArtNet controller for the new Hue Entertainment API,
giving near-realtime control of Hue lights.

The well-known Philips/Signify Hue API only allows for about 10 updates per second.
If you want to update multiple lights multiple times per second this approach will not scale.
To make this practical, all color transitions will need to be done inside the Hue bulb.
This complicates light programming, as Hue bulbs can not be used as any other RGB DMX light.
As this is the only well-known Hue API, this is what most other Hue ArtNet bridges use.

Since the introduction of the Hue Sync Box, a new API is available allowing up to
25 updates per second for up to 10 lights. This gives us almost real-time control over
lights, even with perfect synchronization between the lights.
This is called the Hue Entertainment API.

To accomplish this, the Hue Bridge sends the entire update packet, which contains
color information for all bulbs in the Entertainment group, to a 'Proxy' bulb.
This is a bulb that is elected by the Hue bridge to be near all other bulbs in the
Entertainment group. It will receive the full color update for all bulbs and it will
broadcast the message so all bulbs receive it. Then every individual bulb will only
take it's own color from the update message and apply it.
This accomplishes near-perfect synchronization.

Please note that only original Philips/Signify Hue color bulbs are supported.
This means Ikea Tradfri bulbs can not be used, neither can Hue white bulbs.
This is a limitation in the protocol and can not be worked around.

If you need to support non-color or non-Hue bulbs as well, you should check out
another project which talks to the normal Hue API, such as [Dmx-Hue](https://github.com/sinedied/dmx-hue).

## Setting up
To start using ArtNet-Hue-Entertainment, take the following steps:
1. First, open the Philips Hue app on your phone
   and setup a new Entertainment group.
   This can be done by navigating to `Settings > Entertainment rooms`.
2. If you don't have an entertainment group yet, create one by tapping
   the blue plus button on the top right, give the entertainment room a name
   and select some lights.
   Placement of the bulbs is not important and will be ignored.
3. Discover Hue bridges on your network by running `artnet-hue-entertainment discover`.
   This will print a list of all Hue bridges and their IP address.
4. Pair with a Hue bridge. To do so, first press the link button on the bridge.
   Then run: `artnet-hue-entertainment pair --ip <ip address of bridge>`.
5. This project really is still work in progress. More to come!

## Channel modes
DMX channel mode can be configured for every Hue light that is controlled.
The following 3 modes are supported:
1. `8bit` - 3 channels (R, G, B)
2. `8bit-dimmable` - 4 channels (Dim, R, G, B). This is the recommended mode,
   as Hue bulbs are controlled with 16 bit values. Color mixing is smooth even
   on the lowest dimmer setting.
3. `16bit` - 6 channels (R, R fine, G, G fine, B, B fine). As Hue bulbs are
   controlled with 16 bit values this gives full raw control over the bulbs.

## Protocol documentation
* Hue Entertainment: https://developers.meethue.com/develop/hue-entertainment/philips-hue-entertainment-api/
* ArtNet: https://artisticlicence.com/WebSiteMaster/User%20Guides/art-net.pdf

## Disclaimer
By using ArtNet-Hue-Entertainment you are in full control of the light that your bulbs output.
Some light combinations and/or frequencies, etc. could cause epileptic seizures, migraines etc.
to an end user, even if that person has no history of prior seizures or epilepsy etc.
By taking full control over the lights you are responsible for preventing such adverse
health effects. The maintainers of this repository are not responsible for any adverse health effects etc.

artnet-hue-entertainment

artnet-hue-entertainment Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

artnet-hue-entertainment

artnet-hue-entertainment Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README