1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
Display
*******
.. py:module:: microbit.display
This module controls the 5×5 LED display on the front of your board. It can
be used to display images, animations and even text.
.. image:: scroll-hello.gif
Functions
=========
.. py:function:: get_pixel(x, y)
Return the brightness of the LED at column ``x`` and row ``y`` as an
integer between 0 (off) and 9 (bright).
.. py:function:: set_pixel(x, y, value)
Set the brightness of the LED at column ``x`` and row ``y`` to ``value``,
which has to be an integer between 0 and 9.
.. py:function:: clear()
Set the brightness of all LEDs to 0 (off).
.. py:function:: show(image)
Display the ``image``.
.. py:function:: show(value, delay=400, \*, wait=True, loop=False, clear=False)
If ``value`` is a string, float or integer, display letters/digits in sequence.
Otherwise, if ``value`` is an iterable sequence of images, display these images in sequence.
Each letter, digit or image is shown with ``delay`` milliseconds between them.
If ``wait`` is ``True``, this function will block until the animation is
finished, otherwise the animation will happen in the background.
If ``loop`` is ``True``, the animation will repeat forever.
If ``clear`` is ``True``, the display will be cleared after the iterable has finished.
Note that the ``wait``, ``loop`` and ``clear`` arguments must be specified
using their keyword.
.. note::
If using a generator as the ``iterable``, then take care not to allocate any memory
in the generator as allocating memory in an interrupt is prohibited and will raise a
``MemoryError``.
.. py:function:: scroll(value, delay=150, \*, wait=True, loop=False, monospace=False)
Scrolls ``value`` horizontally on the display. If ``value`` is an integer or float it is
first converted to a string using ``str()``. The ``delay`` parameter controls how fast
the text is scrolling.
If ``wait`` is ``True``, this function will block until the animation is
finished, otherwise the animation will happen in the background.
If ``loop`` is ``True``, the animation will repeat forever.
If ``monospace`` is ``True``, the characters will all take up 5 pixel-columns
in width, otherwise there will be exactly 1 blank pixel-column between each
character as they scroll.
Note that the ``wait``, ``loop`` and ``monospace`` arguments must be specified
using their keyword.
.. py:function:: on()
Use on() to turn on the display.
.. py:function:: off()
Use off() to turn off the display (thus allowing you to re-use the GPIO
pins associated with the display for other purposes).
.. py:function:: is_on()
Returns ``True`` if the display is on, otherwise returns ``False``.
.. py:function:: read_light_level()
Use the display's LEDs in reverse-bias mode to sense the amount of light
falling on the display. Returns an integer between 0 and 255 representing
the light level, with larger meaning more light.
Example
=======
To continuously scroll a string across the display, and do it in the background,
you can use::
import microbit
microbit.display.scroll('Hello!', wait=False, loop=True)
|
