Migrate docs from the other repo
This commit is contained in:
53
docs/reference/led/unplot.md
Normal file
53
docs/reference/led/unplot.md
Normal file
@ -0,0 +1,53 @@
|
||||
# Unplot
|
||||
|
||||
Turn off a LED light on the [LED screen](/microbit/device/screen). Specify which LED using x, y coordinates. Use [plot](/microbit/reference/led/plot) to turn a LED on.
|
||||
|
||||
```sig
|
||||
led.unplot(0,0)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
* x - [Number](/microbit/reference/types/number); the *x coordinate* or horizontal position (0, 1, 2, 3, 4)
|
||||
* y - [Number](/microbit/reference/types/number); the *y coordinate* or vertical position (0, 1, 2, 3, 4)
|
||||
|
||||
If a parameter is [out of bounds](/microbit/reference/out-of-bounds) (a value other than 0-4), this function will do nothing.
|
||||
|
||||
### x, y coordinates?
|
||||
|
||||
The LED screen is made up of 25 LEDs arranged in a 5x5 grid. To figure out the ``x``, ``y`` coordinates, see [LED screen](/microbit/device/screen).
|
||||
|
||||
This code turns off centre LED:
|
||||
|
||||
```blocks
|
||||
led.unplot(2, 2)
|
||||
```
|
||||
|
||||
### Get the LED on/off state
|
||||
|
||||
Use the [point](/microbit/reference/led/point) function to find out if a LED is on or off.
|
||||
|
||||
### Example: toggle off
|
||||
|
||||
This code creates and shows an image on the micro:bit screen, and then clears the centre LED using `unplot`:
|
||||
|
||||
```blocks
|
||||
basic.showLeds(`
|
||||
. . # . .
|
||||
. . # . .
|
||||
# # # # #
|
||||
. . # . .
|
||||
. . # . .
|
||||
`)
|
||||
basic.pause(500)
|
||||
led.unplot(2, 2)
|
||||
```
|
||||
|
||||
### Lessons
|
||||
|
||||
[strobe light](/microbit/lessons/strobe-light)
|
||||
|
||||
### See also
|
||||
|
||||
[plot](/microbit/reference/led/plot), [point](/microbit/reference/led/point), [LED screen](/microbit/device/screen), [create image](/microbit/reference/images/create-image)
|
||||
|
Reference in New Issue
Block a user