You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: micropython/modules/badger2040w/README.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Badger 2040 WW<!-- omit in toc -->
1
+
# Badger 2040 W<!-- omit in toc -->
2
2
3
-
Badger 2040 WW is a Raspberry Pi Pico W powered E Ink badge.
3
+
Badger 2040 W is a Raspberry Pi Pico W powered E Ink badge.
4
4
5
5
-[Summary](#summary)
6
6
-[Differences between Badger 2040 W and Badger 2040](#differences-between-badger-2040-w-and-badger-2040)
@@ -34,7 +34,7 @@ Badger 2040 WW is a Raspberry Pi Pico W powered E Ink badge.
34
34
35
35
Badger 2040 W switches from the Badger-specific drawing library of Badger 2040, to our generic PicoGraphics library.
36
36
37
-
PicoGraphics brings some great improvements, such as JPEG support with ditering and cross-compatibility between all of our other display products.
37
+
PicoGraphics brings some great improvements, such as JPEG support with dithering and cross-compatibility between all of our other display products.
38
38
39
39
We've tried to make the transition as simple as possible, but there are a few breaking changes you'll need to be aware of:
40
40
@@ -46,7 +46,7 @@ We've tried to make the transition as simple as possible, but there are a few br
46
46
47
47
See the [PicoGraphics function reference](../picographics/README.md) for more information on how to draw to the display.
48
48
49
-
Additionally Badger 2040 W does not have a "user" button since the bootsel (which originally doubled as "user") is aboard the attached Pico W.
49
+
Additionally Badger 2040 W does not have a "user" button since the BOOTSEL button (which originally doubled as "user") is now aboard the attached Pico W.
50
50
51
51
## Getting Started
52
52
@@ -66,16 +66,20 @@ This will create a `Badger2040W` class called `badger` that will be used in the
66
66
Below is a list of other constants that have been made available, to help with the creation of more advanced programs.
67
67
68
68
### Screen Size
69
+
69
70
*`WIDTH` = `296`
70
71
*`HEIGHT` = `128`
71
72
72
73
### E Ink Pins
74
+
73
75
*`BUSY` = `26`
74
76
75
77
### Power Pins
78
+
76
79
*`ENABLE_3V3` = `10`
77
80
78
81
### Activity LED Pin
82
+
79
83
*`LED` = `22`
80
84
81
85
# Function Reference
@@ -88,7 +92,7 @@ Since Badger 2040 W is based upon PicoGraphics you should read the [PicoGraphics
88
92
89
93
There are 16 pen colours - or "shades of grey" - to choose, from 0 (black) to 15 (white).
90
94
91
-
Since Badger2040W cannot display colours other than black and white, any value from 1 to 14 will apply dithering when drawn, to simulate a shade of grey.
95
+
Since Badger 2040 W cannot display colours other than black and white, any value from 1 to 14 will apply dithering when drawn, to simulate a shade of grey.
92
96
93
97
```python
94
98
pen(
@@ -230,7 +234,6 @@ There are some useful functions to determine if Badger 2040 W has been woken by
230
234
231
235
Badger 2040 W includes a PCF85063a RTC which continues to run from battery when the Badger is off. It can be used to wake the Badger on a schedule.
232
236
233
-
234
237
## Update Speed
235
238
236
239
The E Ink display on Badger 2040 W supports several update speeds. These can be set using `set_update_speed(speed)` where `speed` is a value from `0` to `3`. For convenience these speeds have been given the following constants:
@@ -252,7 +255,6 @@ The system clock speed of the RP2040 can be controlled, allowing power to be sav
252
255
253
256
On USB, the system will not run slower than 48MHz, as that is the minimum clock speed required to keep the USB connection stable.
254
257
255
-
It is best to set the clock speed as the first thing in your program, and you must not change it after initializing any drivers for any I2C hardware connected to the qwiic port. To allow you to set the speed at the top of your program, this method is on the `badger2040w` module, rather than the `badger` instance, although we have made sure that it is safe to call it after creating a `badger` instance.
258
+
It is best to set the clock speed as the first thing in your program, and you must not change it after initializing any drivers for any I2C hardware connected to the Qwiic port. To allow you to set the speed at the top of your program, this method is on the `badger2040w` module, rather than the `badger` instance, although we have made sure that it is safe to call it after creating a `badger` instance.
256
259
257
260
Note that `SYSTEM_TURBO` overclocks the RP2040 to 250MHz, and applies a small over voltage to ensure this is stable. We've found that every RP2040 we've tested is happy to run at this speed without any issues.
0 commit comments