Skip to content

Commit

Permalink
document how to validate that wluma sees screen correctly
Browse files Browse the repository at this point in the history
  • Loading branch information
maximbaz committed Feb 26, 2025
1 parent 1ea938b commit 441ffec
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,28 @@ To enable logging, set environment variable `RUST_LOG` to one of these values: `

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

## Validating that wluma is able to see screen contents correctly

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.

1. Stop any running `wluma` instances
1. Run the latest code from `main` branch (unless another branch was given to you by the maintainers): `RUST_LOG=trace cargo run`
1. Open https://deadpixel.org and start the test.
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.
1. Repeat for each of these colors: `black`, `white`, `red`, `green`, `blue`:
1. Let the color be visible for a few seconds.
1. Quickly go back to the running `wluma` and check the `luma` value reported for that color: `Prediction: 252 (lux: none, luma: ---> 14 <---)`
1. Compare your values with the following expected results:
```
black: 0
white: 100
red: 49
green: 83
blue: 26
```

If your results do not match, please open an issue and let's investigate!

## Known issues (help wanted!)

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.
Expand Down

0 comments on commit 441ffec

Please sign in to comment.