Skip to content

Commit 6d3cd93

Browse files
committed
document how to validate that wluma sees screen correctly
1 parent 1ea938b commit 6d3cd93

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,28 @@ To enable logging, set environment variable `RUST_LOG` to one of these values: `
135135

136136
For more complex selectors, see [env_logger's documentation](https://docs.rs/env_logger/latest/env_logger/#enabling-logging).
137137

138+
## Validating that wluma is able to see screen contents correctly
139+
140+
This is a useful test to validate that wluma does indeed see the screen contents correctly. This is obviously only applicable if you didn't disable `capturer` in your config.
141+
142+
1. Stop any running `wluma` instances
143+
1. Run the latest code from `main` branch (unless another branch was given to you by the maintainers): `RUST_LOG=trace cargo run`
144+
1. Open https://deadpixel.org and start the test.
145+
1. Make sure that **the entire screen** is covered with a single solid color, nothing else should be visible - not a status bar nor a notification, nothing else.
146+
1. Repeat for each of these colors: `black`, `white`, `red`, `green`, `blue`:
147+
a. Let the color be visible for a few seconds.
148+
a. Quickly go back to the running `wluma` and check the `luma` value reported for that color: `Prediction: 252 (lux: none, luma: ---> 14 <---)`
149+
1. Compare your values with the following expected results:
150+
```
151+
black: 0
152+
white: 100
153+
red: 49
154+
green: 83
155+
blue: 26
156+
```
157+
158+
If your results do not match, please open an issue and let's investigate!
159+
138160
## Known issues (help wanted!)
139161

140162
Help is wanted and much appreciated! If you want to implement some of these, feel free to open an issue and I'll provide more details and try to help you along the way.

0 commit comments

Comments
 (0)