Skip to content

Text-To-Speech Module for MagicMirror²

License

Notifications You must be signed in to change notification settings

paultranvan/MMM-TTS

 
 

Repository files navigation

MMM-NanoTTS GitHub license Build Status Code Climate Known Vulnerabilities

Text-To-Speech Module for MagicMirror2 using nanoTTS. Forked from MMM-TTS.

Installation

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

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

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

  4. Install nanoTTS

Config Options

Option Default Description
lang en-US The TTS language.
speed 1.0 The TTS speed.
pitch 1.0 The TTS pitch.
debug false Display text to speech.
text 'MMM-TTS' Text to display in debug mode, while there's no text to speech.

For Developers

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

About

Text-To-Speech Module for MagicMirror²

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 87.2%
  • Shell 12.8%