Official SDK
A community adaptation of the official Muse Gadget SDK. The author identifies it as independent of Xteink and Meta.
muse-pocket — Muse Gadget project
viticci/muse-pocket
Short answer
Muse Pocket adapts an Xteink X4 Pro into an e-paper display for a Muse character, name, and short status messages. Display settings cover brightness, color warmth, refresh speed, orientation, and sleep; Muse supplies the updates through device commands.
What you need
Requires an Xteink X4 Pro with CrossPoint 1.6.5 installed, a microSD card, Wi-Fi, the Muse app with Developer mode enabled, a personal SDK token, and a computer running ESP-IDF 6.0.1. The standard X4 and X3 have different hardware.
How you build and install it
Compile the firmware using docs/build.md, then add the personal token to a private local image. Install through CrossPoint’s SD updater and follow docs/install.md for pairing. Keep CrossPoint in the other firmware slot for recovery; the magnetic USB adapter is unnecessary for this installation.
How it fits
License
Apache-2.0 covers the project source, with dependency exceptions documented in NOTICE. The FreeInk display drivers use MIT; the font and MP3 decoder retain their own licenses. The SDK’s excluded Jollybot artwork is absent. Muse pairing is also subject to the Gadget SDK Terms.
Activity
Last pushed 2 Oct 2026, with 22 stars and 2 forks. This is repository activity metadata, not a build or device validation.
Good to know
The README reports physical testing on SSD1677 hardware; UC8179 and UC8279 variants have not been physically verified by the project.
ASCII fonts render accents and emoji as a question mark. Sleep preserves the image but stops live updates; remote firmware updates are disabled.
Before you flash.
This summary comes from the README and public GitHub data, checked on 2026-10-03. This site has not built, flashed or paired this project.
Next steps
Source: GitHub README
README from the repository
Written by the project’s authors, not by Muse Gadgets Hub. Shown with the images and links the authors published, under the project’s Apache-2.0 license.
Muse Pocket
Turn an Xteink X4 Pro e-reader into a small e-paper companion for your Muse. It shows your Muse's character, name and short status updates, with settings for brightness, warmth, refresh speed, orientation and sleep.
This is a community project built on the Muse Gadget SDK. It is not an official Xteink or Meta product.
What you need
- An Xteink X4 Pro. The ordinary X4 and X3 use different hardware.
- CrossPoint 1.6.5 for X4 Pro already installed on the reader.
- A microSD card and a Wi-Fi network, or a way to copy files onto the card.
- The Muse app, Developer mode enabled, and your own Muse SDK token.
- A computer with ESP-IDF 6.0.1, Espressif's firmware build tools.
The installation uses CrossPoint's SD firmware updater, so it does not need the reader's magnetic USB adapter. Get CrossPoint through its official installer; select the X4 Pro build.
Start here
- Build and add your token. Building creates an uncredentialed image; a separate local step adds your token to a private copy.
- Install, pair and recover. Keep CrossPoint in the other firmware slot so you can return to it.
- Use the display and commands.
Every user supplies their own SDK token. No account, Muse name, Wi-Fi network or computer address is built into this project. A packaged firmware file contains your token: keep it private and never attach it to an issue or release. The repository contains source only; you do not need someone else's firmware file.
What appears on the screen
The top shows the Muse's name and battery level. The middle holds a 480×480 character image. Up to four lines of status text sit below it. Connection state and the settings shortcut appear at the bottom.
After pairing, the reader sends your Muse one message asking it to display its character and keep the caption current. Muse supplies these updates by calling the gadget's commands; the firmware does not independently know what Muse is doing. The original neutral display icon stays visible until an image arrives.
Show the full READMEShow less
Pairing and sending updates
Pairing in the Muse app confirms access to your Muse and lets you choose a Wi-Fi network. After connecting, ask your Muse to draw its character and update the status caption. The command guide explains the image and text commands, including what to ask if the first update is missing.
The screenshots below show the access confirmation, Wi-Fi selection and a chat request to send a character and status to the display.
Buttons
| Button | Main screen | Settings |
|---|---|---|
| Left | Confirm pairing; retry setup | SDK setup control |
| Right | Open settings | Select the next row |
| Power | Clean refresh; hold 3 seconds to sleep | Change the selected setting |
To return to the e-reader, select Return to CrossPoint and hold Power for 3 seconds. You can also hold Right during startup. See the recovery guide before updating.
Current support
The X4 Pro port has been used on a physical SSD1677 reader with successful Muse pairing, character/status display and settings. The generic public build is compiled and tested separately. UC8179 and UC8279 panel drivers are included and probed, but those variants have not been physically verified by this project.
Text currently uses an ASCII font: accented characters and emoji appear as ?.
Images are black and white with dithering. Sleep preserves the screen but stops
live updates. The character is held in memory and requested again after restart.
Remote firmware updates are disabled to preserve the CrossPoint recovery slot.
For contributors and coding agents
Read CONTRIBUTING.md and AGENTS.md. The included
muse-pocket skill covers building, troubleshooting,
token handling and safe app-only updates. Copy the skills/muse-pocket directory
to your agent's skill directory, or point your agent at its SKILL.md directly.
No personal tools or secret-manager integration are required.
License and upstream code
Source is under Apache-2.0, except the dependencies listed in NOTICE. X4 Pro display drivers come from FreeInk under MIT; the font and MP3 decoder retain their original licenses. The SDK's license-excluded Jollybot art is not included; the default display icon is original Apache-2.0 source.
Muse pairing also requires accepting the Gadget SDK Terms.
More projects
All projects
Featured
muse-r1
cameronapak/muse-r1
Native Android HOME app that turns a Rabbit r1 running LineageOS into a Muse gadget.
hackshop-mcp
msanchezgrice/hackshop-mcp
Hardware-literate AI scout for tinkerers. Idea-to-hardware mapping via MCP.