Skip to content

Latest commit

 

History

History
89 lines (70 loc) · 2.46 KB

README.md

File metadata and controls

89 lines (70 loc) · 2.46 KB
Raw

Made with love License

MMM-Porcupine

MMM-Porcupine is a customizable hotword detection module to activate/notify other MagicMirror modules

The default hotwords are "porcupine", "bumblebee", "grasshopper", "terminator, and "hey edison"

See Picovoice Porcupine for info on how to train your own model

It would be great to get a model trained by the community on the "smart mirror" hotword

Installation

cd ~/MagicMirror/modules
git clone https://github.com/SikandAlex/MMM-Porcupine.git
cd MMM-Porcupine
npm install

Update

2020/04/23: v0.0.1

  • First release for testing on RPi 4 Raspbian Buster

Configuration

Basic

{
  module: 'MMM-Porcupine',
  config: {
    hotword: "porcupine"
  }
}

Advanced

{
  module: 'MMM-Porcupine',
  config: {
    debug: false,
    hotword: "porcupine",
    sensitivity: 0.7,
    onDetected: {
      notification: "ASSISTANT_ACTIVATE",
      parameters: {
        type: "MIC",
        profile: "default",
        chime: true
       }
    }
  }
}

Options

  • debug - turn on/off debug mode.

  • hotword - The hotword you wish to detect. The available hotwords are "porcupine", "bumblebee", "grasshopper", "terminator, and "hey edison"

  • sensitivity - Override default sensitivity value

    • Value could be within a range from 0.0 to 1.0.
    • Default sensitivity values is 0.7

  • notification - notification name to emit when the hotword is detected. [Preconfigured for AMk2 activation.]

  • parameters - payload to send with your notification. [Preconfigured for AMk2 activation].

Notifications

MMM-Porcupine can receive notification for start or stop listening

  • PORCUPINE_START: Start listening for hotwords
  • PORCUPINE_STOP: Stop listening for hotwords

MMM-AssistantMk2 users

  • MMM-Porcupine is preconfigured for this module
  • Just turn useA2D: true on the MMM-AssistantMk2 config file