facebookincubator / muse-gadget-sdk

# Muse Gadgets
Muse gadgets are open source devices you build yourself. Program an
off-the-shelf ESP32 board or set up a Raspberry Pi with our device SDKs, then
connect Muse to your displays, buttons, sensors, actuators, and whatever else
you've got lying on your workbench.
We open sourced the SDKs and firmware here. It's built by hackers, for hackers,
just for fun. Side effects of tinkering may include bricked boards, voided
warranties, brownouts, or bankruptcies. Proceed at your own risk!
| | |
|---|---|
| **ESP32 Device SDK** | Connect your ESP32 board to Muse through our open source SDK. Throw in a screen to show images, add audio in and out, or wire up other sensors. |
| **Linux Device SDK** | Turn that spare Raspberry Pi or Linux box into a Muse gadget. Hack in your own commands to let Muse handle sysadmin chores or your Home Assistant setup. |
Before you flash or pair a gadget, get an
SDK token and review the
Gadget SDK Terms. Every gadget needs a
token to pair.
ESP32 and Linux gadgets pair with the Muse app on iOS and Android, via
Settings > Devices. Turn on Developer mode there first, then look for devices
prefixed with "MuseGadget".
Each directory has a `README.md` to get started and an `AGENTS.md` for coding
agents like Muse Code.
For battery-input power profiling, see the porting recipe.
The opt-in diagnostic core is board-neutral; boards supply its hooks and state
matrices, and power_sweep.py drives the
USB-free sweep. The isolated diagnostic does not pair or need an SDK token;
fixture safety and explicit hardware authorization still come first, as the
PPK2 rules describe.
## Community
Meet other hackers who are building and customizing Muse gadgets in our
community Discord. Get inspired, support each
other, and share what you make.
## License
Muse Gadgets is licensed under the Apache License, Version 2.0, found in
`LICENSE`, except for these third-party files, which keep their
upstream licenses:
| Path | Upstream | License |
|---|---|---|
| `esp32/components/minimp3/include/minimp3.h` | lieff/minimp3 | CC0-1.0, see `LICENSE` |
| `esp32/components/muse/boards/ostb_echoear_display_init.h` | 78/xiaozhi-esp32 ESP-VoCat panel sequence | MIT, retained in the file header |
| `esp32/main/pixel_font.c` | Adafruit GFX `glcdfont.c` | BSD-2-Clause, in the file header |
Dependencies fetched at build time are under their own licenses: ESP-IDF
components (into `esp32/managed_components/`), and the simulator's LVGL and
SDL (listed in `esp32/simulator/THIRD_PARTY.md`).
The Apache License does not cover the Jollybot avatar.