Skip to content

Commit dc121aa

Browse files
committed
add badger w examples readme
1 parent ed02166 commit dc121aa

File tree

1 file changed

+111
-0
lines changed

1 file changed

+111
-0
lines changed
Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# Badger 2040 W MicroPython Examples <!-- omit in toc -->
2+
3+
- [About Badger 2040 W](#about-badger-2040-w)
4+
- [Badger 2040 W and PicoGraphics](#badger-2040-w-and-picographics)
5+
- [Examples](#examples)
6+
- [Badge](#badge)
7+
- [Clock](#clock)
8+
- [Ebook](#ebook)
9+
- [Fonts](#fonts)
10+
- [Help](#help)
11+
- [Image](#image)
12+
- [Info](#info)
13+
- [List](#list)
14+
- [Net Info](#net-info)
15+
- [News](#news)
16+
- [Qrgen](#qrgen)
17+
- [Weather](#weather)
18+
- [Other Resources](#other-resources)
19+
20+
21+
## About Badger 2040 W
22+
23+
Badger 2040 W is a programmable E Paper/eInk/EPD badge with 2.4GHz wireless connectivity, powered by Raspberry Pi Pico W. It can go into a deep sleep mode between updates to preserve battery.
24+
25+
- :link: [Badger 2040 W store page](https://shop.pimoroni.com/products/badger-2040-w)
26+
27+
Badger 2040 W ships with MicroPython firmware pre-loaded, but you can download the most recent version at the link below (you'll want the `pimoroni-badger2040w` .uf2). If you download the `-with-examples` file, it will come with examples built in.
28+
29+
- [MicroPython releases](https://github.com/pimoroni/pimoroni-pico/releases)
30+
- [Installing MicroPython](../../../setting-up-micropython.md)
31+
32+
## Badger 2040 W and PicoGraphics
33+
34+
The easiest way to start displaying cool stuff on Badger is by using our `badger2040w` module (which contains helpful functions for interacting with the board hardware) and our PicoGraphics library (which contains a bunch of functions for drawing on the E Ink display).
35+
36+
- [Badger 2040 W function reference](../../modules/badger2040w/README.md)
37+
- [PicoGraphics function reference](../../modules/picographics/README.md)
38+
39+
## Examples
40+
41+
Find out more about these examples in our Learn guide!
42+
43+
- [Getting Started with Badger 2040 W](https://learn.pimoroni.com/article/getting-started-with-badger-2040-w)
44+
45+
### Badge
46+
[badge.py](examples/badge.py)
47+
48+
Customisable name badge example.
49+
50+
### Clock
51+
[clock.py](examples/clock.py)
52+
53+
Clock example with (optional) NTP synchronization and partial screen updates.
54+
55+
### Ebook
56+
[ebook.py](examples/ebook.py)
57+
58+
View text files on Badger.
59+
60+
### Fonts
61+
[fonts.py](examples/fonts.py)
62+
63+
View all the built in fonts.
64+
65+
### Help
66+
[help.py](examples/help.py)
67+
68+
How to navigate the launcher.
69+
70+
### Image
71+
[image.py](examples/image.py)
72+
73+
View (non-progressive) .jpegs on Badger.
74+
75+
### Info
76+
[info.py](examples/info.py)
77+
78+
Info about Badger 2040 W.
79+
80+
### List
81+
[list.py](examples/list.py)
82+
83+
A checklist to keep track of to-dos or shopping.
84+
85+
### Net Info
86+
[net_info.py](examples/net_info.py)
87+
88+
Show IP address and other wireless connection details.
89+
90+
### News
91+
[news.py](examples/news.py)
92+
93+
View BBC news headlines.
94+
95+
### Qrgen
96+
[qrgen.py](examples/qrgen.py)
97+
98+
Display QR codes and associated text.
99+
100+
### Weather
101+
[weather.py](examples/weather.py)
102+
103+
Display current weather data from the [Open-Meteo weather API](https://open-meteo.com/)
104+
105+
## Other Resources
106+
107+
Here are some cool Badger 2040 W community projects and resources that you might find useful / inspirational! Note that code at the links below has not been tested by us and we're not able to offer support with it.
108+
109+
- :link: [Send messages to Badger via webform](https://github.com/techcree/Badger2040W/tree/main/webform)
110+
- :link: [3D printed Badger 2040 W enclosure](https://kaenner.de/badger2040w)
111+
- :link: [Badger Pixel Client for a Raspberry Pi Pixel Server](https://github.com/penguintutor/badger-pixel-client)

0 commit comments

Comments
 (0)