Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Matzefication/MMM-Hello-Mirror
Voice-Control for the MagicMirror based in Google Speech Recognizer (annyang)
https://github.com/Matzefication/MMM-Hello-Mirror
Last synced: 23 days ago
JSON representation
Voice-Control for the MagicMirror based in Google Speech Recognizer (annyang)
- Host: GitHub
- URL: https://github.com/Matzefication/MMM-Hello-Mirror
- Owner: Matzefication
- License: mit
- Created: 2017-02-27T12:29:32.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-02T08:05:07.000Z (almost 8 years ago)
- Last Synced: 2024-08-04T10:03:19.682Z (4 months ago)
- Language: JavaScript
- Size: 42 KB
- Stars: 25
- Watchers: 5
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mmm - **MMM-Hello-Mirror**
README
# MMM-Hello-Mirror
Voice-Control for the MagicMirror based on Google Speech Recognizer (annyang)
This an extension for the [MagicMirror](https://github.com/MichMich/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:
```javascript
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)