Skip to content

Commit 68411ba

Browse files
helgibbonshelgibbons
authored
Merge pull request #671 from pimoroni/docs/tidyup
some minor docs tidying
2 parents 3bc0f01 + fa275e6 commit 68411ba

File tree

3 files changed

+124
-7
lines changed

3 files changed

+124
-7
lines changed

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ We also maintain a C++/CMake boilerplate with GitHub workflows configured for te
105105
* Galactic Unicorn (dazzling 53 x 11 LED matrix) - https://shop.pimoroni.com/products/galactic-unicorn
106106
* Interstate 75 W (HUB75 matrix driver) - https://shop.pimoroni.com/products/interstate-75-w
107107
* Inky Frame 4.0" (7-colour E Ink) - https://shop.pimoroni.com/products/inky-frame-4
108+
* Badger 2040 W (E Ink badge) - https://shop.pimoroni.com/products/badger-2040-w
108109

109110
## Breakouts
110111

@@ -145,7 +146,7 @@ We also maintain a C++/CMake boilerplate with GitHub workflows configured for te
145146

146147
- :link: [Getting Started with (MicroPython on) Pico](https://learn.pimoroni.com/article/getting-started-with-pico)
147148
- :link: [Pico C/C++ Development on Windows / WSL](https://learn.pimoroni.com/article/pico-development-using-wsl)
148-
- :link: [Getting Started with Interstate 75](https://learn.pimoroni.com/article/getting-started-with-interstate-75)
149+
- :link: [Getting Started with Interstate 75 (and W)](https://learn.pimoroni.com/article/getting-started-with-interstate-75)
149150
- :link: [Getting Started with Plasma 2040](https://learn.pimoroni.com/article/plasma-2040)
150151
- :link: [Assembling Keybow 2040](https://learn.pimoroni.com/article/assembling-keybow-2040)
151152
- :link: [Getting Started with Badger 2040](https://learn.pimoroni.com/article/getting-started-with-badger-2040)
@@ -154,3 +155,4 @@ We also maintain a C++/CMake boilerplate with GitHub workflows configured for te
154155
- :link: [Getting Started with Inky Frame](https://learn.pimoroni.com/article/getting-started-with-inky-frame)
155156
- :link: [Getting Started with Automation 2040 W (and Mini)](https://learn.pimoroni.com/article/getting-started-with-automation-2040-w)
156157
- :link: [Assembling Wireless Plasma Kit](https://learn.pimoroni.com/article/assembling-wireless-plasma-kit)
158+
- :link: [Getting Started with Badger 2040 W](https://learn.pimoroni.com/article/getting-started-with-badger-2040-w)

‎micropython/examples/badger2040w/readme.md‎

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 how to use 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+
Display .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)

‎setting-up-micropython.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,16 @@ On the releases page you'll find a bunch of different .uf2 files for use on diff
1818

1919
| Board | What uf2 file to use | Notes |
2020
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
21-
| Raspberry Pi Pico and most other RP2040 boards without wireless (Plasma 2040, Interstate 75, Servo 2040, Motor 2040, Tiny 2040 2MB) | **pimoroni-pico** | |
22-
| Raspberry Pi Pico W and Pico W Aboard products (Automation 2040 W, Inventor 2040 W, Inky Frame, Plasma Stick) | **pimoroni-picow** | |
23-
| Badger 2040 | **pimoroni-badger2040** or **pimoroni-badger2040-without-badger-os** | Download **pimoroni-badger2040** for built in examples! |
24-
| Tufty 2040 | **pimoroni-tufty2040** | |
25-
| Pimoroni Pico LiPo | **pimoroni-picolipo_4mb** or **pimoroni-picolipo_8mb** | Includes support for the increased flash memory on these boards |
26-
| Tiny 2040 8MB | **pimoroni-tiny2040** | Includes support for the increased flash memory on this board |
21+
| Raspberry Pi Pico and most other RP2040 boards without wireless (Plasma 2040, Interstate 75, Servo 2040, Motor 2040, Tiny 2040 2MB) | **pimoroni-pico-vx.x.x-micropython.uf2** | |
22+
| Raspberry Pi Pico W and most Pico W Aboard products (Automation 2040 W, Inventor 2040 W, Plasma Stick, Interstate 75 W) | **pimoroni-picow-vx.x.x-micropython.uf2** | |
23+
| Badger 2040 | **pimoroni-badger2040-vx.x.x-micropython.uf2** or **pimoroni-badger2040-vx.x.x-micropython-without-badger-os.uf2** | Download **pimoroni-badger2040-vx.x.x-micropython.uf2** for built in examples! |
24+
| Tufty 2040 | **pimoroni-tufty2040-vx.x.x-micropython.uf2** | |
25+
| Pimoroni Pico LiPo | **pimoroni-picolipo_4mb-vx.x.x-micropython.uf2** or **pimoroni-picolipo_16mb-vx.x.x-micropython.uf2** | Includes support for the increased flash memory on these boards |
26+
| Tiny 2040 8MB | **pimoroni-tiny2040-vx.x.x-micropython.uf2** | Includes support for the increased flash memory on this board |
27+
| Enviro Urban, Indoor, Weather & Grow | **pimoroni-picow_enviro-vx.x.x-micropython.uf2** | For a .uf2 with examples built in, go to the [Enviro releases page](https://github.com/pimoroni/enviro/releases)! |
28+
| Galactic Unicorn | **pimoroni-picow_galactic_unicorn-vx.x.x-micropython.uf2** | |
29+
| Inky Frame | **pimoroni-picow_inky_frame-vx.x.x-micropython.uf2** | |
30+
| Badger 2040 W | **pimoroni-badger2040w-vx.x.x-micropython.uf2** or **pimoroni-badger2040w-vx.x.x-micropython-with-examples.uf2** | Download **pimoroni-badger2040w-vx.x.x-micropython-with-examples.uf2** for built in examples! |
2731

2832
## Entering DFU/bootloader mode
2933

0 commit comments

Comments
 (0)