apm1007 / MMM-Hello-Mirror

Voice-Control for the MagicMirror based in Google Speech Recognizer (annyang)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MMM-Hello-Mirror

Voice-Control for the MagicMirror based on Google Speech Recognizer (annyang)

This an extension for the MagicMirror to send notifications to other modules on voice commands.

Installation

  1. Navigate into your MagicMirror's modules folder
  2. Execute git clone https://github.com/Matzefication/MMM-Hello-Mirror.git
  3. No npm install is needed
  4. (Re)start magic mirror (e.g. with pm2 restart mm)

Using the module

To use this module, add it to the modules array in the config/config.js file:

modules: [
    {
        module: 'MMM-Hello-Mirror',
        position: 'lower_third',
        config: {
            // See 'Configuration options' for more information.
        }
    }
]

Configuration Options

The following properties can be configured:

Option Description
language The language used.

Valid values:
en
de

Default value: de
voice The voice used.

Valid values:
UK English Female
UK English Male
US English Female
Deutsch Female

Default value: Deutsch Female
animationSpeed Time in milliseconds to show and hide messages.

Default value: 2000

Working with voice commands

A voice command has to start with the wakeUp sentence depending on the selected language (by default Hallo (magischer) Spiegel for german, otherwise Hi (magic) mirror for all other languages) following your individual command. After recognizing a command, a notification will be send to all modules with the following params:

  • notification identifier: VOICE_COMMAND
  • notification payload: the spoken command (without the wakeUp sentence)

About

Voice-Control for the MagicMirror based in Google Speech Recognizer (annyang)

License:MIT License


Languages

Language:JavaScript 98.1%Language:CSS 1.9%