Skip to content

Commit c7b343f

Browse files
ladyadaladyada
authored
Merge pull request #44 from jposada202020/Including_examples_in_the_API
Exposing examples to the API documentation and other small changes
2 parents ed16e1b + b678f58 commit c7b343f

5 files changed

+49
-9
lines changed

‎docs/examples.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,43 @@ Ensure your device works with this simple test.
66
.. literalinclude:: ../examples/bitmap_font_simpletest.py
77
:caption: examples/bitmap_font_simpletest.py
88
:linenos:
9+
10+
Label simple test
11+
-----------------
12+
13+
This example uses ``adafruit_display_text.label`` to display text using a custom font
14+
loaded by ``adafruit_bitmap_font``
15+
16+
.. literalinclude:: ../examples/bitmap_font_label_simpletest.py
17+
:caption: examples/bitmap_font_label_simpletest.py
18+
:linenos:
19+
20+
Displayio simple test
21+
---------------------
22+
23+
This example uses ``adafruit_bitmap_font`` to load a font and fill a bitmap with
24+
pixels matching glyphs from a given String
25+
26+
.. literalinclude:: ../examples/bitmap_font_displayio_simpletest.py
27+
:caption: examples/bitmap_font_displayio_simpletest.py
28+
:linenos:
29+
30+
Label MagTag
31+
------------
32+
33+
This example uses ``adafruit_display_text.label`` to display text using a custom font
34+
loaded by ``adafruit_bitmap_font``.
35+
36+
.. literalinclude:: ../examples/bitmap_font_label_magtag.py
37+
:caption: examples/bitmap_font_label_magtag.py
38+
:linenos:
39+
40+
Fork Awesome icons
41+
------------------
42+
43+
This example uses ``adafruit_display_text.label`` to display fork awesome
44+
icons.
45+
46+
.. literalinclude:: ../examples/bitmap_font_label_forkawesome.py
47+
:caption: examples/bitmap_font_label_forkawesome.py
48+
:linenos:

‎examples/bitmap_font_displayio_simpletest.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
"""
55
This example runs on PyPortal, or any Circuit Python device
6-
with a built-in screen that is at least 320x240 pixels.
6+
with a built-in screen.
77
88
It will use adafruit_bitmap_font to load a font and fill a
99
bitmap with pixels matching glyphs from a given String
@@ -14,7 +14,7 @@
1414
import displayio
1515
from adafruit_bitmap_font import bitmap_font
1616

17-
# use built in display (PyPortal, PyGamer, PyBadge, CLUE, etc.)
17+
# use built in display (MagTag, PyPortal, PyGamer, PyBadge, CLUE, etc.)
1818
# see guide for setting up external displays (TFT / OLED breakouts, RGB matrices, etc.)
1919
# https://learn.adafruit.com/circuitpython-display-support-using-displayio/display-and-display-bus
2020
display = board.DISPLAY
@@ -25,7 +25,7 @@
2525

2626
font = bitmap_font.load_font(font_file)
2727

28-
bitmap = displayio.Bitmap(320, 240, 2)
28+
bitmap = displayio.Bitmap(display.width, display.height, 2)
2929

3030
palette = displayio.Palette(2)
3131

‎examples/bitmap_font_label_forkawesome.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# SPDX-License-Identifier: MIT
33

44
"""
5-
This example uses addfruit_display_text.label to display fork awesome
5+
This example uses adafruit_display_text.label to display fork awesome
66
icons.
77
88
More info here: https://emergent.unpythonic.net/01606790241
@@ -13,7 +13,7 @@
1313
from adafruit_display_text import label
1414
from adafruit_bitmap_font import bitmap_font
1515

16-
# use built in display (PyPortal, PyGamer, PyBadge, CLUE, etc.)
16+
# use built in display (MagTag, PyPortal, PyGamer, PyBadge, CLUE, etc.)
1717
# see guide for setting up external displays (TFT / OLED breakouts, RGB matrices, etc.)
1818
# https://learn.adafruit.com/circuitpython-display-support-using-displayio/display-and-display-bus
1919
display = board.DISPLAY

‎examples/bitmap_font_label_magtag.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# SPDX-License-Identifier: MIT
33

44
"""
5-
This example uses addfruit_display_text.label to display text using a custom font
5+
This example uses adafruit_display_text.label to display text using a custom font
66
loaded by adafruit_bitmap_font.
77
Adapted for use on MagTag
88
"""
@@ -11,7 +11,7 @@
1111
from adafruit_display_text import label
1212
from adafruit_bitmap_font import bitmap_font
1313

14-
# use built in display (PyPortal, PyGamer, PyBadge, CLUE, etc.)
14+
# use built in display (MagTag, PyPortal, PyGamer, PyBadge, CLUE, etc.)
1515
# see guide for setting up external displays (TFT / OLED breakouts, RGB matrices, etc.)
1616
# https://learn.adafruit.com/circuitpython-display-support-using-displayio/display-and-display-bus
1717
display = board.DISPLAY

‎examples/bitmap_font_label_simpletest.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
# SPDX-License-Identifier: MIT
33

44
"""
5-
This example uses addfruit_display_text.label to display text using a custom font
5+
This example uses adafruit_display_text.label to display text using a custom font
66
loaded by adafruit_bitmap_font
77
"""
88

99
import board
1010
from adafruit_display_text import label
1111
from adafruit_bitmap_font import bitmap_font
1212

13-
# use built in display (PyPortal, PyGamer, PyBadge, CLUE, etc.)
13+
# use built in display (MagTag, PyPortal, PyGamer, PyBadge, CLUE, etc.)
1414
# see guide for setting up external displays (TFT / OLED breakouts, RGB matrices, etc.)
1515
# https://learn.adafruit.com/circuitpython-display-support-using-displayio/display-and-display-bus
1616
display = board.DISPLAY

0 commit comments

Comments
 (0)