muse-gadget-sdk README

The project's README from github.com/facebookincubator/muse-gadget-sdk. As one markdown file: README.md.

Muse Gadgets

Muse gadgets: a Waveshare round AMOLED, an M5Stack StickS3, Muse Home Link, a Raspberry Pi and a Seeed reTerminal e-ink display

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.

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/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.

muse-gadget-sdk (facebookincubator/muse-gadget-sdk)

Searching Database…

2.2K ·GitHub
Muse-gadget-sdk
What is this?This is an open source SDK and firmware for building 'Muse gadgets' — DIY devices on ESP32 boards or Raspberry Pi/Linux boxes that connect to the Muse app to drive displays, audio, buttons, sensors, and actuators.
Is this one unified SDK or separate kits?It's two separate device SDKs plus firmware — one for ESP32 boards and one for Linux/Raspberry Pi boxes — rather than a single unified framework.
How do I get a gadget running?Get an SDK token and review the Gadget SDK Terms, then follow the README.md in the esp32/ or linux/ directory for your target device, flash or pair it, and connect it to the Muse app via Settings > Devices with Developer mode turned on.
What do I need before I start?An ESP32 board or a Raspberry Pi/Linux box, the Muse mobile app on iOS or Android with Developer mode enabled, and a valid SDK token to pair the gadget.
Is this safe for my hardware?No guarantees — this is hacker-grade tinkering, and the README explicitly warns you can brick boards, void warranties, or cause brownouts while experimenting.
What is the Muse app, and how does my gadget connect to it?Muse is the companion mobile app on iOS and Android that gadgets pair with — you enable Developer mode under Settings > Devices and look for entries prefixed 'MuseGadget'.
Does the Apache-2.0 license cover everything in the repo?No. Files like esp32/components/minimp3/include/minimp3.h and esp32/main/pixelfont.c keep their original CC0-1.0 and BSD-2-Clause licenses, and the Jollybot avatar isn't covered by the Apache License at all.
Can AI coding agents help me build a gadget?Yes, each SDK directory ships an AGENTS.md aimed at coding agents like Muse Code, alongside a regular README.md for humans.
Where can I find other gadget builders?There's a community Discord where hackers share builds, get inspired, and support each other.
What are similar projects?hermes-gadget-sdk, Tasmota, oomwoo, espectre, RuView, esphome, mongoose, arduino-esp32
Which topics is it in?sensors, home-assistant, home-automation, microcontroller, esp32, embedded-systems, discord, firmware, iot, raspberry-pi, hacking, embedded
Creator
facebookincubator
Size
5.4 MB
Stars
2.2K
Updated
CommitOct 16
Age
15d
Commits · 90 Days