JavaScript
Switch branches/tags
Nothing to show
Clone or download
Latest commit 4389af2 Feb 26, 2017
Permalink
Failed to load latest commit information.
.codeclimate.yml add linter Feb 26, 2017
.editorconfig add linter Feb 26, 2017
.eslintrc add linter Feb 26, 2017
.mdlrc add linter Feb 26, 2017
.travis.yml add linter Feb 26, 2017
LICENSE Initial commit Aug 15, 2016
MMM-TTS.js add linter Feb 26, 2017
README.md fix trailing spaces Feb 26, 2017
node_helper.js add linter Feb 26, 2017
package.json removed dev dependencies Feb 26, 2017

README.md

MMM-TTS GitHub license Build Status Code Climate Known Vulnerabilities

Text-To-Speech Module for MagicMirror2

Dependencies

Installation

  1. Clone this repo into ~/MagicMirror/modules directory.

  2. Configure your ~/MagicMirror/config/config.js:

    {
        module: 'MMM-TTS',
        position: 'top_right',
        config: {
            ...
        }
    }
    
  3. Run command npm install in ~/MagicMirror/modules/MMM-TTS directory.

  4. Run command sudo apt-get install festival.

Config Options

Option Default Description
debug false Display text to speech.
text 'MMM-TTS' Text to display in debug mode, while there's no text to speech.
voice null If you want another voice than default you have to install it seperately and then fill in the voice name here. http://www.festvox.org/docs/manual-2.4.0/festival_24.html#Voices
speed 1.0 How fast the speech should be.

For Developers

To use MMM-TTS in your module you have to send a socket notification like this this.sendNotification('MMM-TTS', 'This is a text to read. Hello World!');.