Skip to content

Commit 8c34181

Browse files
committed
Update docs
1 parent 34b7ad1 commit 8c34181

File tree

5 files changed

+22
-18
lines changed

5 files changed

+22
-18
lines changed

.devcontainer/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
homeassistant
2-
netifaces
2+
netifaces
3+
matplotlib

.github/workflows/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
homeassistant
2-
netifaces
2+
netifaces
3+
matplotlib

curves.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/beta.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ Part of the beta is to test if my documentation suffices. So head over to [the i
1717
* Rate limiting when sending DMX data from an external controller to HomeAssistant
1818
* Discovered Art-Net nodes will create new entities
1919
* Art-Net triggers will invoke HomeAssistant events
20+
* sACN has multicast support meaning it will work automatically without needing to define an IP
21+
* Transitions going through L\*U\*V\* color space
2022

2123
## What's excluded?
2224

23-
* Transitions: I'd love to support custom animations, but not yet sure how I would have you define them.
2425
* RDM: This is a HUGE standard, won't make it to the full release either.
2526

2627
## Where to report feedback?

docs/transitions.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Light Transitions with L*U*V* Color Space
1+
# Light Transitions with L\*U\*V\* Color Space
22

33
The DMX integration provides professional-grade smooth color transitions using perceptually uniform color space interpolation. This ensures that color changes appear natural and consistent to human vision.
44

@@ -36,49 +36,51 @@ data:
3636
3737
Transitions work with all fixture color modes:
3838
39-
- **RGB**: Smooth color transitions through L*U*V* color space
40-
- **RGBW**: RGB channels use L*U*V*, white channel uses linear interpolation
41-
- **RGBWW**: RGB channels use L*U*V*, white channels use linear interpolation
39+
- **RGB**: Smooth color transitions through L\*U\*V\* color space
40+
- **RGBW**: RGB channels use L\*U\*V\*, white channel uses linear interpolation
41+
- **RGBWW**: RGB channels use L\*U\*V\*, white channels use linear interpolation
4242
- **Color Temperature**: Direct brightness and temperature interpolation
4343
- **CW/WW**: Color temperature and brightness interpolation
4444
45-
## Why L*U*V* Color Space?
45+
## Why L\*U\*V\* Color Space?
4646
47-
Traditional RGB interpolation creates unnatural color transitions that don't match how humans perceive color changes. Our implementation uses **L*U*V* (L\*u\*v\*)** color space for perceptually uniform transitions.
47+
Traditional RGB interpolation creates unnatural color transitions that don't match how humans perceive color changes. Our implementation uses **L\*U\*V\* (CIELUV)** color space for perceptually uniform transitions.
4848
4949
### The Problem with RGB Interpolation
5050
5151
When transitioning from red to green in RGB space:
52+
5253
- **RGB values**: (255, 0, 0) → (0, 255, 0)
5354
- **Perceived path**: Red → Brown/Yellow → Green
5455
- **Visual result**: Unnatural, muddy intermediate colors
5556
56-
### The L*U*V* Solution
57+
### The L\*U\*V\* Solution
58+
59+
L\*U\*V\* color space is designed for perceptual uniformity:
5760
58-
L*U*V* color space is designed for perceptual uniformity:
5961
- **L\* (Lightness)**: Matches human brightness perception
6062
- **u\* and v\* (Chromaticity)**: Uniform color differences
6163
- **Interpolation result**: Smooth, natural color transitions
6264
6365
## Animation Behavior
6466
6567
### RGB Color Changes
66-
Color transitions use L*U*V* interpolation for smooth, natural color paths:
68+
Color transitions use L\*U\*V\* interpolation for smooth, natural color paths:
6769
68-
![RGB Fade Animation](/img/rgb_fade_animation.png)
70+
![RGB Fade Animation](./img/rgb_fade_animation.png)
6971
70-
*RGB transitions through L*U*V* color space create smooth color paths*
72+
*RGB transitions through L\*U\*V\* color space create smooth color paths*
7173
7274
### White Light Control
7375
Color temperature and white channel changes use direct interpolation:
7476
75-
![WW/CW Fade Animation](/img/ww_cw_fade_animation.png)
77+
![WW/CW Fade Animation](./img/ww_cw_fade_animation.png)
7678
7779
*Warm/cold white transitions interpolate temperature and brightness*
7880
7981
### Mixed RGBWW Fixtures
8082
RGB and white channels are handled separately to maintain color accuracy:
8183
82-
![RGBWW Fade Animation](/img/rgbww_fade_animation.png)
84+
![RGBWW Fade Animation](./img/rgbww_fade_animation.png)
8385
84-
*RGBWW fixtures transition RGB through L*U*V* while white channels interpolate directly*
86+
*RGBWW fixtures transition RGB through L\*U\*V\* while white channels interpolate directly*

0 commit comments

Comments
 (0)