https://github.com/forslund/mycroft-porcupine-plugin

https://github.com/forslund/mycroft-porcupine-plugin

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/forslund/mycroft-porcupine-plugin
• Owner: forslund
• License: apache-2.0
• Created: 2020-12-13T21:51:43.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-01-03T07:59:38.000Z (almost 3 years ago)
• Last Synced: 2024-02-15T14:32:43.093Z (8 months ago)
• Language: Python
• Size: 11.7 KB
• Stars: 3
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ovos-plugins - mycroft-porcupine-plugin

README

        
## Picovoice Porcupine Wakeword plugin for Mycroft

This plugins allows using [Porcupine](https://github.com/Picovoice/porcupine) wakewords together with Mycroft.

## Configuration

To activate the plugin edit the mycroft config using the `mycroft-config edit user` command and add a hotword section if it doesn't already exist

```

[...]

  "hotwords": {

  }

```

Then insert a new hotword into the `hotwords` section

```

    "blueberry": {

      "module": "porcupine_wakeword_plug",

      "keyword_file_path": "~/.mycroft/blueberry_linux.ppn",

      "sensitivity": 0.5,

      "access_key": 

    }

```

Above is using the _blueberry_ model provided by picovoice stored in the location `~/.mycroft/blueberry_linux.ppn` and a sensitivity of 0.5.

## Models

Some models are available without charge from the [picovoice repo](https://github.com/Picovoice/porcupine/tree/master/resources/keyword_files), you can also generate models using the [Picovoice console](https://console.picovoice.ai/)

## Supported platforms

Porcupine ships precompiled binaries for several common platforms (x86 amd64, raspberry Pi, and several more) but may not work on your platform. Check their repo for more details.

## Credits

The original Mycroft bindings for Porcupine was written by @Tanel.Alumae, this plugin is based upon their initial work with some updates for newer Porcupine releases.

### Contributors

The following people are awesome and has helped with the development of this plugin:

- builderjer

- jarbasal