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…

Что это?Это опенсорсный SDK и прошивка для создания «гаджетов Muse» — самодельных устройств на платах ESP32 или машинах с Raspberry Pi/Linux, которые подключаются к приложению Muse и управляют дисплеями, звуком, кнопками, сенсорами и актуаторами.
Это один единый SDK или отдельные наборы?Это два отдельных SDK для устройств плюс прошивка — один для плат ESP32, другой для машин с Linux/Raspberry Pi, — а не единый унифицированный фреймворк.
Как запустить гаджет?Получите SDK-токен и ознакомьтесь с Gadget SDK Terms, затем следуйте README.md в каталоге esp32/ или linux/ для своего целевого устройства, прошейте или сопрягите его и подключите к приложению Muse через Settings > Devices с включённым Developer mode.
Что мне нужно перед началом?Плата ESP32 или машина с Raspberry Pi/Linux, мобильное приложение Muse на iOS или Android с включённым Developer mode и действующий SDK-токен для сопряжения гаджета.
Это безопасно для моего железа?Никаких гарантий — это эксперименты уровня хакеров, и README прямо предупреждает, что в процессе можно окирпичить плату, лишиться гарантии или вызвать просадки питания.
Что такое приложение Muse и как мой гаджет к нему подключается?Muse — компаньон-приложение для iOS и Android, с которым сопрягаются гаджеты: вы включаете Developer mode в Settings > Devices и ищете записи с префиксом «MuseGadget».
Лицензия Apache-2.0 покрывает всё содержимое репозитория?Нет. Файлы вроде esp32/components/minimp3/include/minimp3.h и esp32/main/pixelfont.c сохраняют исходные лицензии CC0-1.0 и BSD-2-Clause, а аватар Jollybot вовсе не покрыт Apache License.
Могут ли AI-кодинг-агенты помочь мне собрать гаджет?Да, в каждом каталоге SDK лежит AGENTS.md, ориентированный на кодинг-агентов вроде Muse Code, рядом с обычным README.md для людей.
Где найти других создателей гаджетов?Есть сообщество в Discord, где энтузиасты делятся сборками, черпают вдохновение и поддерживают друг друга.
Size
5.4 MB
Stars
2.2K
Updated
CommitOct 16
Age
15d
Commits · 90 Days