# Example config for the MusicMouse backend. # # python -m musicmouse --config /media/musicmouse/config.yml # # Unknown keys are rejected rather than ignored, and every problem in the file is # reported at once, so a typo fails at startup with the path to the offending line. # Keep the real config (with credentials) off the repo - on the device only. general: # Root folder holding one subfolder per figure. Relative paths resolve against # this file's directory. Each figure plays /
, # in alphabetical order by filename. figure_folder: music # Serial port the ESP32 firmware is on. A dropped link is retried, not fatal. serial_port: "/dev/ttyUSB0" baudrate: 115200 reconnect_interval: 5.0 # ALSA output device passed to VLC, e.g. "hw:0,0". Omit for VLC's default. alsa_device: "softvol_effects" # Volume, 0..100. min/max clamp everything, including the rotary encoder. min_volume: 0 max_volume: 60 initial_volume: 40 volume_increment: 5 # per rotary-encoder click # Backlight of the prev/next buttons while a figure is playing, 0..1. button_leds_brightness: 0.5 # Which files count as music. Anything else in a figure folder is ignored. audio_extensions: [".mp3", ".ogg", ".oga", ".opus", ".flac", ".wav", ".m4a", ".aac"] # Home Assistant integration. Omit the whole section to run without MQTT. # The backend exposes three lights, a player sensor, a volume slider, transport # buttons, device triggers for every button/touch area, and a tag scanner. mqtt: server: "homeassistant.local" port: 1883 user: "musicmouse" password: "REPLACE_WITH_MQTT_PASSWORD" base_topic: "musicmouse" discovery_prefix: "homeassistant" device_id: "musicmouse" device_name: "Music Mouse" reconnect_interval: 10.0 # One entry per figurine. The key is the figure name and the subfolder name. figures: fuchs: # RFID tag id, 5 bytes as hex. Must be unique across figures. id: "04a1b2c3d4" # Exactly four colours: primary, secondary, background, accent. # Either "#rrggbb" (RGB) or "wNN" (white channel only, hex). colors: ["#ff6600", "#ffcc00", "#331100", "wff"] eule: id: "04b2c3d4e5" colors: ["#3355ff", "#66aaff", "#001133", "#ffffff"]