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.3K ·GitHub
Muse-gadget-sdk
这是什么？这是一个用于打造「Muse 小工具」的开源 SDK 和固件——基于 ESP32 开发板或树莓派/Linux 主机的 DIY 设备，可连接 Muse 应用来驱动显示屏、音频、按钮、传感器和执行器。
这是一个统一的 SDK，还是分开的工具包？它是两套独立的设备 SDK 加固件——一套面向 ESP32 开发板，一套面向 Linux/树莓派主机——而不是单一统一框架。
我怎么让一个小工具跑起来？获取 SDK token 并阅读 Gadget SDK 条款，然后按照 esp32/ 或 linux/ 目录中针对你目标设备的 README.md 操作，烧录或配对，并在开启开发者模式后通过 Settings > Devices 将它连接到 Muse 应用。
开始之前我需要准备什么？一块 ESP32 开发板或一台树莓派/Linux 主机、iOS 或 Android 上开启了开发者模式的 Muse 移动应用，以及用于配对小工具的有效 SDK token。
这对我的硬件安全吗？没有任何保证——这属于黑客级别的折腾，README 明确警告实验过程中你可能把开发板弄成砖、失去保修或引发电压骤降。
Muse 应用是什么？我的小工具怎么连接它？Muse 是 iOS 和 Android 上的配套移动应用，小工具与它配对——你在 Settings > Devices 下开启开发者模式，然后寻找带有「MuseGadget」前缀的条目。
Apache-2.0 许可覆盖仓库里的所有内容吗？不是。像 esp32/components/minimp3/include/minimp3.h 和 esp32/main/pixelfont.c 这样的文件保留其原有的 CC0-1.0 和 BSD-2-Clause 许可，而 Jollybot 头像则完全不受 Apache 许可覆盖。
AI 编程智能体能帮我打造小工具吗？能，每个 SDK 目录都附有一份面向 Muse Code 等编程智能体的 AGENTS.md，旁边还有一份给人类阅读的常规 README.md。
我在哪里能找到其他小工具制作者？有一个社区 Discord，黑客们在上面分享作品、获取灵感并互相支持。
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, embedded, hacking
Creator
facebookincubator
Size
6.3 MB
Stars
2.3K
Updated
CommitOct 16
Age
16d
Commits · 90 Days