frodovdr/hyperion.ng
1
0
Fork 0
mirror of https://github.com/hyperion-project/hyperion.ng.git synced 2023-10-10 13:36:59 +02:00
Code Issues Releases Wiki Activity

docs(device): Philips Hue Entertainment API Documentation (#806)

Browse Source 
* Philips Hue Entertainment API hyperion docu

* Signal detection brightness minimum + minor changes
This commit is contained in:
SJunkies 2020-05-25 21:42:52 +02:00 committed by GitHub
parent 259becea04
commit 3f68e55d1a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 80 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
docs/docs/en/user/LedDevices.md
View File

@ -58,12 +58,92 @@ Hue bridges, nodeMCU, AtmoOrbs everything that is reachable over network.
#### philipshue
The well known [Philips Hue Bridge + Bulbs](https://www.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=philips+hue+starter+set&rh=i%3Aaps%2Ck%3Aphilips+hue+starter+set&tag=hyperionpro05-20) is supported. How to configure them with Hyperion? Checkout: Web configuration
#### Entertainment API
::: danger Photosensitive seizure warning
Certain individuals may experience discomfort when exposed to quick flashes/patterns of light.
Please refrain from using entertainment mode immediately if you feel any discomfort or have any known health conditions. Please consult a physician under those circumstances. Make sure your entertainment room is well-lit.
Hyperion cannot be held liable for any foreseeable, or unforeseeable, negative or harmful impact.
:::
##### Requirements
* Before you start, the Entertainment API requires at least one entertainment group/area with minimum one assigned lamp! Checkout: [Entertainment groups / areas](#entertainment-groups--areas)
* A normal Hue group, does NOT work with the Hue Entertainment API!
* Check the "Use Hue Entertainment API" option and use the Philips Hue Entertainment wizard at the web configuration for configuration (available at led hardware section)!
* The Entertainment API requires also a username and a suitable clientkey. Checkout: [Philips Hue Entertainment wizard](#philips-hue-entertainment-wizard)
##### Philips Hue Entertainment wizard
* In the wizard, your Hue Bridge is automatically discovered via the Philips Hue Cloud when it is registered. If not, try entering the bridge IP address and click the "retry" icon / button next to the IP entry field.
* If only the username is known or you start from scratch, create a new user with the Philips Hue Entertainment wizard and a clientkey will automatically generated.
* If no Entertainment group / area was found on the bridge you are using, the wizard switches back to the classic version and deactivates the use of the Hue Entertainment API!
* Username, clientkey and Entertainment group / area ready? Select your Entertainment group / area, you would like to use and fine-tune your preselected screen positions for each lamp.
* Don't forget to save your changes! ;)
##### Bridge requirements / limits
* To use the Philips Hue Entertainment API, the bridge must use at least API version 1.22!
* Only one Entertainment group / area can be active at one time on a single Hue Bridge!
##### Multiple and / or none orignal Hue bridges
* Automatic detection will only find the first available bridge.
* If your bridge wasn't found or was found, but not the one you want to use, manually enter the desired bridge IP address and click the "retry" icon / button next to the IP entry field.
##### Entertainment groups / areas
* Entertainment groups / areas can be created using the original Philips Hue app.
* Set also the right z-axis (Ground height, TV height and Ceiling height) for each lamp within the configuration of the Entertainment group / area. Tapping each lamp changes the height and will be recognized it in the Philips Hue Entertainment wizard to also preselect the correct screen position.
* You can connect up to 10 Philips Hue or Friends of Hue color-capable lights per Entertainment group / area.
* When a Entertainment group / area is used with the Entertainment API, you can't control any of the lamps in the Entertainment group / area, until the Entertainment API stops!
#### Advanced Settings
##### Signal detection
* The Entertainment API is a permanent stream that continuously sends color information to the bridge. That's why the signal detection came into play.
* With the `Signal detection timeout on black` option, you can control how long all lamps are set to black, before the Entertainment API stops and the previous lamp state will be recovered.
* Set the ms value higher, so longer dark scenes in movies will not stop the Entertainment API.
* The Entertainment API automatically restarts when color information other than black is available to send.
* Some grabbers do not provide real black, but rather dark gray, so black = 0 never occurs. With the option `Signal detection brightness minimum` you can set the minimum brightness which is considered black. The range can be set from 0 = 0% to 1 = 100%, e.g. 0,005 = 0.5%. If 0 doesn' work for your setup, increase this value in 0,005 steps. It's like the thresholds for USB Capture.
##### Brightness *Settings may be removed in future releases*
* Set / leave `brightness factor` back to 1 (default) - classic low brightness bug is fixed
* Set / leave `brightness minimum` to 0 (default) - you can set a minimum brightness, so the lamps will never be off
* Set / leave `brightness maximum` to 1 (default) - you can set a maximum brightness, if you don't want the whole room to light up in bright scenes
* Value range for brightness minimum / maximum are: 0 = 0% to 1 = 100%, E.g. 0,05 = 5% / 0,5 = 50%
* The brightness factor is a multiplier for the input brightness, means E.g. 50% input brightness * brightness factor (e.g. 1,5) = new 75% brightness.
* __Be warned__:
If you change the brightness factor / minimum / maximum to a value other than the default value, the color rendering will also change!!!
E.g. Dark / Black will apear as a deep dark blue, if you raise the minimum brightness, because the deepes color inside the hue light system is a deep blue, because black is not a color, it's only off.
__AND__ you can miss the entire Entertainment API experience ;)
::: warning Fast uncontrolled colors / flickering
* The colorinformation for each lamp, depends on the input signal from your grabber source, the defined screen position to use for the lamp (like any other led configuration) and the used capture framerate!
* Input signals with noise and other image disturbances can cause this effect of rapidly changing colors / flickering. For more information on how to reduce this problem, see the next tip:
:::
::: tip Activate smoothing in image processing!
This allows the extremely fast color / flicker to be controlled very well.
These values ​​work well, but decide for yourself:
Time: 80 - 120 ms
Update frequency: 35 - 40 Hz - higher values leads to faster color change / flickering again
Update delay: 0 ms
Continuous output: no - does not have to, since the last color values ​​are stored in the respective lamp
:::
##### Configuration Tips & Tricks
* Color calibration is not required, you can keep the default values.
* To enable/disable the active Entertainment group / area from Hyperion, disable Hyperion or just the led hardware component. The previous lamp state will be recovered - other solutions may come in future releases - Hint: [Signal detection](#signal-detection)
#### Classic Philips Hue usage without the Entertainment API
##### Configuration Tips & Tricks
* Use the Philips Hue wizard at the web configuration for configuration (available at led hardware section)!
* Color calibration is not required, you can keep the default values.
* If the bightness is to low for you and Hyperion is already at 100% you can higher the brightness factor at the web configuration -> LED hardware
* Brightness componsation influences the brightness across different color (Adjust at the color section)
* To enable/disable the bridge control from Hyperion, disable Hyperion or just the led hardware component. The previous lamp state will be recovered
#### atmoorb
#### tpm2net
#### udpe131