pxt-calliope/docs/reference/led/brightness.md

27 lines
616 B
Markdown
Raw Normal View History

2016-03-26 00:47:20 +01:00
# Brightness
Find how bright the [LED screen](/device/screen) is.
2016-03-26 00:47:20 +01:00
```sig
led.brightness();
```
### Returns
* a [Number](/reference/types/number) that means how bright the screen is, from `0` (darkest) to `255` (brightest). For example, the number `127` means the screen is halfway bright.
2016-03-26 00:47:20 +01:00
### Example: highest brightness
2016-03-26 00:47:20 +01:00
This program makes the screen completely bright if it is not that way already:
2016-03-26 00:47:20 +01:00
```blocks
if (led.brightness() < 255) {
led.setBrightness(255)
}
```
### See also
2016-04-13 17:27:45 +02:00
[set brightness](/reference/led/set-brightness), [fade in](/reference/led/fade-in), [fade out](/reference/led/fade-out)
2016-03-26 00:47:20 +01:00