MMM-VoiceCommander

WHAT IS VOICECOMMANDER?

This is a module for voice controlling a lot of elements of MagicMirror. It works as an offline voice controller where the MagicMirror does not need to be connected to Internet for VoiceCommander to work. Also, if you need a HOTWORD module to activate other online modules - this is it! It can activate either Alexa and Google Assistant using specific modules already available.

WHAT CAN IT DO?

Used as hotword only to activate either Google Assistant or Amazon Alexa
Used as hotword to activate both Google Assistant and Amazon running at the same time
Control other modules that use voice commands with a single microphone
Built in Motion Detection for webcams to activate/de-activate upon motion/timout
Use hand gesture to mute/resume sound (to issue new voice commands if speaker is busy - requires webcam)
Take Selfies! (requires webcam)
Built in support for custom sound files
Hide and show pages of modules
Hide and show individual modules - No modification of other modules necessary!
Offline by default - no need for internet to issue commands
Add your own sentences and custom commands (**TODO**: Create instruction for json files)
Here you will find the webcam module

TESTED ON FOLLOWING HARDWARE PLATFORMS

Hardware Platform	Operating System	Notes
HP Elite 8300	✔ Ubuntu 18.04 LTS	-
HP Elite HPEu	✔ Ubuntu 16.04 LTS	-
HP G60 Laptop	✔ Ubuntu 18.04 LTS	-
Huawei Matebook Pro	✔ Ubuntu 16.04 LTS	-
Intel NUC Celeron	✔ Ubuntu 16.04 LTS	-
Tinker Board S	✔ TinkerOS 2.0.8	-
Raspberry Pi 3b+	✔ Debian Stretch	-
Odroid	✘	Need somebody to test on Odroid!
Windows	✘	Need somebody to test on Windows!

TESTED CAMERAS FOR MOTION DETECTION

USB Logitech C920
Several integrated laptop cams

INSTALLATION AND REQUIREMENTS

Start by doing the commands below to make the initial installation:

Perform the commands from ~/MagicMirror/modules directory

git clone https://github.com/thestigh/MMM-VoiceCommander
cd MMM-VoiceCommander
cd installers
bash dependencies.sh

After installation you need to check your audio setup, as this module also relies on arecord/aplay. From your home directory, run command:

sudo nano ~/.asoundrc

If it is empty, copy following code to the editor (values might need to be changed):

pcm.!default{
  type asym
  playback.pcm{
     type plug
     slave.pcm "hw:0,0"
  }

  capture.pcm{
    type plug
    slave.pcm "hw:0, 0"
  }
}

ctl.!default{
  type hw
  card 0
}

Do you want help to confiure or just deeper understanding arecord, click here

Then make sure you set the hw: and the card vales according to your own hardware configuration (you get the output at the end of installerscript you just ran) where hw:0,0 representt output and hw:1,0 represent input source. Or you can run the command over again to see the outputs by running cat /proc/asound/cards

Save and close nano editor

CONFIG.JS ENTRIES AND OPTIONS

{
    disabled: false,
    module: "MMM-VoiceCommander",
    position: "top_center",
    config: {
        timeout: 10,                                // timeout listening for a command/sentence
        defaultOnStartup: 'MMM-VoiceCommander',     // keep this so this module always are present on MM
        keyword: 'HELLO LUCY',                      // keyword to activate listening for a command/sentence
        debug: false,                               // get debug information in console
        standByMethod: 'DPMS',                      // 'DPMS' = anything else than RPi or 'PI'
        sounds: ["female_hi.wav"],                  // welcomesound at startup, add several for a random choice of welcome sound
        startHideAll: true,                         // if true, all modules start as hidden
        microphone: 'default',                      // Do NOT change, is read from ~/.asoundrc
        speed: 1000,                                // transition speed between show/no-show/show in milliseconds
        activateMotion: false,                      // if true, webcam will be used to activate/deactivate MM on movement
        onlyHotword: false,                         // TBA - Hotword only to activate external module by sendNotification
        onOnlyHotword: 'AMAZON',                    // If onlyHotword, what Assistant to start, 'GOOGLE' or 'AMAZON'
        timeoutSeconds: 10,                         // seconds to wait for external module to confirm control of mic
        captureIntervalTime: 1000,                  // how often should the webcam check for motion, in milliseconds
        scoreThreshold: 20,                         // threshold to assume motion/no-motion -> se console log for score
        timeoutMotion: 120000,                      // timeout with no motion until sleep monitor, in milliseconds
        muteThreshold: 2000,                        // motion level to activate mute of speaker
        muteVolumeLevel: 1,                         // what volume level to set speaker on activated mute
        muteNormalLevel: 50,                        // set normal volume level on startup
        muteTimer: 10000,                           // how long in milliseconds to mute the speaker
        mainPageModules: ["MMM-VoiceCommander"],    // default modules to show on page one/startup
        pageTwoModules: [],                         // modules to show on page two
        pageThreeModules: [],                       // modules to show on page two
        pageFourModules: [],                        // modules to show on page two
        pageFiveModules: [],                        // modules to show on page two
        pageSixModules: [],                         // modules to show on page two
        pageSevenModules: [],                       // modules to show on page two
        pageEightModules: [],                       // modules to show on page two
        pageNineModules: [],                        // modules to show on page two
        pageTenModules: []                          // modules to show on page two
    },

DEFAULT MODULES AND THEIR COMMANDS