xpui-boards-pimoroni

Pimoroni's RP2040 boards, described for xpui.

Board	Panel	Keys
Badger 2040	296 × 128 e-ink	a b c along the bottom, Up Dn stacked on the right edge
Tufty 2040	320 × 240 colour LCD	the same arrangement, in a different body
Inky Frame 5.7"	600 × 448 seven-colour e-ink	A to E along the bottom, nothing on either edge

The two badges share a key row of three — Back, Confirm, and one with no job — because the pair that walks a list sits on the edge rather than in the row a hint bar labels. The Inky Frame is the one with five in the row, and its fifth takes the job that needs no label: these frames sleep between refreshes and wake on a press.

Using it

TOML

[dependencies]
xpui-boards-pimoroni = { git = "https://github.com/XPUI-Framework/xpui-boards", branch = "main" }

Rust

use xpui_boards_pimoroni as pimoroni;

let badger = pimoroni::BADGER_2040;
assert_eq!((badger.width, badger.height), (296, 128));
assert!(!badger.touch);

// Five in the row on a frame, three on a badge — and the badge's third has
// no job, so the hint bar has two words to paint.
assert_eq!(pimoroni::INKY_FRAME.keys.len(), 5);
assert_eq!(badger.keys.len(), 3);

// Three boards, each answering to its own short name. `badger` and `tufty`
// work too, because that is what people say.
assert_eq!(pimoroni::ALL.len(), 3);
assert_eq!(pimoroni::from_slug("tufty"), Some(pimoroni::TUFTY_2040));

// This crate knows only Pimoroni. Another vendor's slug finds nothing here.
assert_eq!(pimoroni::from_slug("x4"), None);

It depends on xpui-boards-core for the vocabulary and on nothing else that paints, so taking these three costs you no Xteink and no Seeed.

Checking it

The gate is the repository's; run ./build-and-test.sh from the root.

Where next

docs/boards.md

which of the three run on hardware, and why the key labels are load-bearing