Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/merceaemil/MMM-Jarvis-Voice-Control
Voice control module for MagicMirror using OpenJarvis
https://github.com/merceaemil/MMM-Jarvis-Voice-Control
Last synced: 3 months ago
JSON representation
Voice control module for MagicMirror using OpenJarvis
- Host: GitHub
- URL: https://github.com/merceaemil/MMM-Jarvis-Voice-Control
- Owner: merceaemil
- Created: 2017-07-26T00:01:32.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-16T12:36:35.000Z (about 5 years ago)
- Last Synced: 2024-06-29T10:32:55.224Z (5 months ago)
- Language: JavaScript
- Size: 5.86 KB
- Stars: 5
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-mmm - **MMM-Jarvis-Voice-Control**
README
MMM-Jarvis-Voice-Control
===
## Description
Voice control & AI module for MagicMirror using OpenJarvis. You can use it just like you do with Siri, Google, Alexa etc.
It can understand all the words quite ok and is very customisable. OpenJarvis offers a nice place where you can download plugins to customise your setup even more.
This module depends on OpenJarvis & Jarvis-MagicMirror Plugin. Before proceding to installing this module please install OpenJarvis and Jarvis-MagicMirror module.
## Install dependencies
1. Install OpenJarvis.
````
Follow the tutorial at https://www.openjarvis.com/content/installation
````
2. Install Jarvis-MagicMirror Plugin.
````
Follow the tutorial at https://github.com/merceaemil/jarvis-magicmirror
````
## Setup
### Installation
Navigate into your MagicMirror's modules folder:
````
cd ~/MagicMirror/modules
````
Clone this repository:
````
git clone https://github.com/merceaemil/MMM-Jarvis-Voice-Control
````
### Configuration
To activate the module, you need to add the following data to config.js.
````javascript
{
module: 'MMM-Jarvis-Voice-Control',
position: 'bottom_center'
}
````
## USAGE
You can use this with any module by making the following two changes:
1. To add voice commands to your module you have to add the notificationReceived method (if does not exist already) inside your module main JS file.
````javascript
...
notificationReceived: function(notification, payload){
},
...
````
2. You have to define what voice commands do for your module inside the notificationReceived method:
````javascript
...
notificationReceived: function(notification, payload){
....
if (notification === "VOICE_COMMAND" && payload=="start music"){
// Do something here.
// For example: this.playMusic();
}
if (notification === "VOICE_COMMAND" && payload=="end music"){
// Do something here.
// For example: this.endMusic();
}
....
},
...
````