Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hobbyquaker/snowboy2mqtt
Publish MQTT Messages on Snowboy Hotword Detection 🎤
https://github.com/hobbyquaker/snowboy2mqtt
hotword mqtt smarthome speech voice
Last synced: about 2 months ago
JSON representation
Publish MQTT Messages on Snowboy Hotword Detection 🎤
- Host: GitHub
- URL: https://github.com/hobbyquaker/snowboy2mqtt
- Owner: hobbyquaker
- License: apache-2.0
- Created: 2018-10-25T16:17:48.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-25T16:55:06.000Z (about 6 years ago)
- Last Synced: 2024-11-07T03:49:33.587Z (about 2 months ago)
- Topics: hotword, mqtt, smarthome, speech, voice
- Language: JavaScript
- Homepage:
- Size: 486 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# snowboy2mqtt
[](https://github.com/mqtt-smarthome/mqtt-smarthome)
[](https://www.npmjs.com/package/snowboy2mqtt)
[](https://david-dm.org/hobbyquaker/snowboy2mqtt)
[](https://travis-ci.org/hobbyquaker/snowboy2mqtt)
[](https://github.com/sindresorhus/xo)
[](LICENSE)
> Publish MQTT Messages on [Snowboy](https://snowboy.kitt.ai/) Hotword Detection
## Install
**Prerquisites:** Debian, Raspbian, Armbian, Ubuntu; Node.js >= 8
`$ apt install sox libsox-fmt-all libatlas-base-dev build-essential`
`$ npm install -g snowboy2mqtt --unsafe-perm`
Create a model folder, e.g. `/opt/snowboy` and put the [Snowboy .umdl/.pmdl file(s)](https://snowboy.kitt.ai/dashboard)
in it.
I suggest to use [pm2](http://pm2.keymetrics.io/) to manage the snowboy2mqtt process (start on system boot, manage log
files, ...)
## Command Line Options
`$ snowboy2mqtt --help`
```
Usage: snowboy2mqtt [options]
Options:
-v, --verbosity possible values: "error", "warn", "info", "debug"
[default: "info"]
-p, --model-path path of model files [default: "/opt/snowboy2mqtt"]
-a, --activation-hotword hotword that activates listening for other hotwords
-t, --timeout timeout after activation [default: 5000]
-g, --audio-gain [default: 2]
-s model sensitivity [default: "0.5"]
-n, --name instance name. used as topic prefix
[default: "snowboy"]
-k, --insecure allow ssl connections without valid certificate
[boolean]
-u, --url mqtt broker url [default: "mqtt://127.0.0.1"]
-h, --help Show help [boolean]
--version Show version number [boolean]
```
#### MQTT Authentication and TLS
You can put credentials for authentication in the url supplied to the `--url` option: `mqtt://user:password@broker`. If
you want to use TLS for the connection to the broker use `mqtts://` as URL scheme, e.g. `mqtts://broker:8883`.
#### Activation Hotword
It's possible to define a Hotword that activates detection of other Hotwords for a configured period of time. So if you
set e.g. `--activation-hotword computer` and `--timeout 5000` only 5 seconds after someone said _Computer_ the
publishing of other Hotwords gets activated. Every detected Hotword prolongs the timeout to 5 seconds again. The
current activation status is published retained on the topic `/active`.
## License
snowboy2mqtt © 2018 Sebastian Raff, licensed under [Apache License 2.0](LICENSE)