This module will play any music found on a USB Key or in defined local folder
This module is an Extented plugins for
MMM-GoogleAssistant
This module need
EXT-VLCServerplugin for playing your media
¶ Installation
Execute npm run install:EXT-MusicPlayer in the MMM-GoogleAssistant's folder.
cd ~/MagicMirror/modules/MMM-GoogleAssistant
npm run install:EXT-MusicPlayer
¶ Configuration
To display the module insert it in the config.js file.
{
module: 'MMM-GoogleAssistant/EXTs/EXT-MusicPlayer',
animateIn: "flipInX",
animateOut: "flipOutX",
position: 'top_left',
config: {
debug: false,
useUSB: false,
musicPath: "/home/pi/Music",
checkSubDirectory: false,
random: false,
autoStart: false,
minVolume: 30,
maxVolume: 100,
loop: false
}
},
¶ Details
field description type default value debug Enable debug mode or not BOOLEAN false useUSB If you prefer play file from an USB Key, set it to trueBOOLEAN false musicPath Music path for playing music from Local Files STRING "/home/pi/Music" checkSubDirectory Should this module inspect sub directory for create music list ? BOOLEAN true random Play music in random false autoStart AutoStart USB key Music at boot of MagicMirror or when USB key is plugged in BOOLEAN false minVolume Volume to set when assistant speaking NUMBER 30 maxVolume Volume to set when music playing NUMBER 100 loop Restart playlist when done BOOLEAN false Notes:
** Volume is in %
** Volume is used only withMMM-GoogleAssistant
¶ recipe for MMM-GoogleAssistant for vocal control
A prepared recipe is inclued and waiting for your use
Just add it in the config of MMM-GoogleAssistant
- sample:
recipes: [
"../EXTs/EXT-MusicPlayer/recipe/EXT-MusicPlayer.js",
],
- if you have other recipe, just add it like this:
recipes: [
"my_recipe.js",
"../EXTs/EXT-MusicPlayer/recipe/EXT-MusicPlayer.js",
],
¶ MMM-GoogleAssistant Commands:
Activate you assistant and control music module with this command:
-
EN commands:
music play: play playlist musicmusic pause: make pause
music stop: for stop it !music volume [0-100]: for controling volumemusic next: next music on the playlistmusic previous: previous music on the playlistmusic rebuild: rebuild music databasemusic switch: switch between USB Key and Local Files
-
FR commands:
musique play: Lance la lecture de la playlistmusique pause: Mets la musique en pausemusique stop: Arret de la musiquemusique volume [0-100]: Contrôle du volumemusique suivante: musique suivantemusique précédente: musique précédentemusique base de donnée: Actualise la base de donnée des titre a liremusique change source: Change la source de lecture Clé USB <=> Fichier locaux
by editing pattern field in the recipe you can make the recipe for your language
¶ EXT-TelegramBot Commands:
You can control EXT-MusicPlayer with EXT-TelegramBot
The main command is /music
- /music play: Launch music (last title)
- /music pause: Pause music
- /music stop: Stop music
- /music next: Next track
- /music previous: Previous track
- /music rebuild: Rebuild music Database
- /music volume: Volume control, it need a value 0-100
- /music switch: Switch between USB Key and Local Folder
- /music random: Switch between random playing (toggle)
** In random playing mode: previous not working properly **
¶ Developer Notes
¶ Incoming notification:
EXT_MUSIC-PLAY: Start playing musicEXT_MUSIC-STOP: Stop musicEXT_MUSIC-PAUSE: Pause musicEXT_MUSIC-NEXT: Next trackEXT_MUSIC-PREVIOUS: Previous trackEXT_MUSIC-REBUILD: Rebuild music Database- `EXT_MUSIC-SWITCH: Rebuild music Database
EXT_MUSIC-VOLUME_MIN: Set volume to min (see config)EXT_MUSIC-VOLUME_MAX: Sest volume to max (see config)EXT_MUSIC-VOLUME_SET: Volume control with payload [0-100]
¶ Outgoing notification:
EXT_MUSIC-CONNECTED: When a music is playingEXT_MUSIC-DISCONNECTED: When music player is in rest
¶ User Notes
¶ What can music module can play ?
Music module can play this format:
- mp3
- flac
- wav
- ogg
- opus
- m4a
¶ Visual
- If a cover was found inside your music file, this module will descrypt it and display it
- It will display all informations from the file
¶ Update
For updating this module, just use this command:
cd ~/MagicMirror/modules/MMM-GoogleAssistant
npm run update
¶ Uninstall
cd ~/MagicMirror/modules/MMM-GoogleAssistant
npm run remove:EXT-MusicPlayer