spotmicro

# Snowboy Hotword Detection by [KITT.AI](http://kitt.ai). [Home Page](https://snowboy.kitt.ai) [Full Documentation](http://docs.kitt.ai/snowboy) and [FAQ](http://docs.kitt.ai/snowboy#faq) [Discussion Group](https://groups.google.com/a/kitt.ai/forum/#!forum/snowboy-discussion) (or send email to snowboy-discussion@kitt.ai) [Commercial application FAQ](README_commercial.md) Version: 1.3.0 (2/19/2018) ## Alexa support Snowboy now brings hands-free experience to the [Alexa AVS sample app](https://github.com/alexa/alexa-avs-sample-app) on Raspberry Pi! See more info below regarding the performance and how you can use other hotword models. **Performance** The performance of hotword detection usually depends on the actual environment, e.g., is it used with a quality microphone, is it used on the street, in a kitchen, or is there any background noise, etc. So we feel it is best for the users to evaluate it in their real environment. For the evaluation purpose, we have prepared an Android app which can be installed and run out of box: [SnowboyAlexaDemo.apk](https://github.com/Kitt-AI/snowboy/raw/master/resources/alexa/SnowboyAlexaDemo.apk) (please uninstall any previous versions first if you have installed this app before). **Personal model** * Create your personal hotword model through our [website](https://snowboy.kitt.ai) or [hotword API](https://snowboy.kitt.ai/api/v1/train/) * Replace the hotword model in [Alexa AVS sample app](https://github.com/alexa/alexa-avs-sample-app) (after installation) with your personal model ``` # Please replace YOUR_PERSONAL_MODEL.pmdl with the personal model you just # created, and $ALEXA_AVS_SAMPLE_APP_PATH with the actual path where you # cloned the Alexa AVS sample app repository. cp YOUR_PERSONAL_MODEL.pmdl $ALEXA_AVS_SAMPLE_APP_PATH/samples/wakeWordAgent/ext/resources/alexa.umdl ``` * Set `APPLY_FRONTEND` to `false` and update `SENSITIVITY` in the [Alexa AVS sample app code](https://github.com/alexa/alexa-avs-sample-app/blob/master/samples/wakeWordAgent/src/KittAiSnowboyWakeWordEngine.cpp) and re-compile ``` # Please replace $ALEXA_AVS_SAMPLE_APP_PATH with the actual path where you # cloned the Alexa AVS sample app repository. cd $ALEXA_AVS_SAMPLE_APP_PATH/samples/wakeWordAgent/src/ # Modify KittAiSnowboyWakeWordEngine.cpp and update SENSITIVITY at line 28. # Modify KittAiSnowboyWakeWordEngine.cpp and set APPLY_FRONTEND to false at # line 30. make ``` * Run the wake word agent with engine set to `kitt_ai`! **Universal model** * Replace the hotword model in [Alexa AVS sample app](https://github.com/alexa/alexa-avs-sample-app) (after installation) with your universal model ``` # Please replace YOUR_UNIVERSAL_MODEL.umdl with the personal model you just # created, and $ALEXA_AVS_SAMPLE_APP_PATH with the actual path where you # cloned the Alexa AVS sample app repository. cp YOUR_UNIVERSAL_MODEL.umdl $ALEXA_AVS_SAMPLE_APP_PATH/samples/wakeWordAgent/ext/resources/alexa.umdl ``` * Update `SENSITIVITY` in the [Alexa AVS sample app code](https://github.com/alexa/alexa-avs-sample-app/blob/master/samples/wakeWordAgent/src/KittAiSnowboyWakeWordEngine.cpp) and re-compile ``` # Please replace $ALEXA_AVS_SAMPLE_APP_PATH with the actual path where you # cloned the Alexa AVS sample app repository. cd $ALEXA_AVS_SAMPLE_APP_PATH/samples/wakeWordAgent/src/ # Modify KittAiSnowboyWakeWordEngine.cpp and update SENSITIVITY at line 28. make ``` * Run the wake word agent with engine set to `kitt_ai`! ## Hotword as a Service Snowboy now offers **Hotword as a Service** through the ``https://snowboy.kitt.ai/api/v1/train/`` endpoint. Check out the [Full Documentation](http://docs.kitt.ai/snowboy) and example [Python/Bash script](examples/REST_API) (other language contributions are very welcome). As a quick start, ``POST`` to https://snowboy.kitt.ai/api/v1/train: { "name": "a word", "language": "en", "age_group": "10_19", "gender": "F", "microphone": "mic type", "token": "<your auth token>", "voice_samples": [ {wave: "<base64 encoded wave data>"}, {wave: "<base64 encoded wave data>"}, {wave: "<base64 encoded wave data>"} ] } then you'll get a trained personal model in return! ## Introduction Snowboy is a customizable hotword detection engine for you to create your own hotword like "OK Google" or "Alexa". It is powered by deep neural networks and has the following properties: * **highly customizable**: you can freely define your own magic phrase here – let it be “open sesame”, “garage door open”, or “hello dreamhouse”, you name it. * **always listening** but protects your privacy: Snowboy does not use Internet and does *not* stream your voice to the cloud. * light-weight and **embedded**: it even runs on a Raspberry Pi and consumes less than 10% CPU on the weakest Pi (single-core 700MHz ARMv6). * Apache licensed! Currently Snowboy supports (look into the [lib](lib) folder): * all versions of Raspberry Pi (with Raspbian based on Debian Jessie 8.0) * 64bit Mac OS X * 64bit Ubuntu 14.04 * iOS * Android * ARM64 (aarch64, Ubuntu 16.04) It ships in the form of a **C++ library** with language-dependent wrappers generated by SWIG. We welcome wrappers for new languages -- feel free to send a pull request! Currently we have built wrappers for: * C/C++ * Java/Android * Go (thanks to @brentnd and @deadprogram) * Node (thanks to @evancohen and @nekuz0r) * Perl (thanks to @iboguslavsky) * Python2/Python3 * iOS/Swift3 (thanks to @grimlockrocks) * iOS/Object-C (thanks to @patrickjquinn) If you want support on other hardware/OS, please send your request to [snowboy@kitt.ai](mailto:snowboy.kitt.ai) Note: **Snowboy does not support Windows** yet. Please build Snowboy on *nix platforms. ## Pricing for Snowboy models Hackers: free * Personal use * Community support Business: please contact us at [snowboy@kitt.ai](mailto:snowboy@kitt.ai) * Personal use * Commercial license * Technical support ## Pretrained universal models We provide pretrained universal models for testing purpose. When you test those models, bear in mind that they may not be optimized for your specific device or environment. Here is the list of the models, and the parameters that you have to use for them: * **resources/alexa/alexa-avs-sample-app/alexa.umdl**: Universal model for the hotword "Alexa" optimized for [Alexa AVS sample app](https://github.com/alexa/alexa-avs-sample-app). Set SetSensitivity to 0.6, and set ApplyFrontend to true. This is so far the best "Alexa" model we released publicly, when ApplyFrontend is set to true. * **resources/models/snowboy.umdl**: Universal model for the hotword "Snowboy". Set SetSensitivity to 0.5 and ApplyFrontend to false. * **resources/models/jarvis.umdl**: Universal model for the hotword "Jarvis" (https://snowboy.kitt.ai/hotword/29). It has two different models for the hotword Jarvis, so you have to use two sensitivites. Set sensitivities to "0.8,0.80" and ApplyFrontend to true. * **resources/models/smart_mirror.umdl**: Universal model for the hotword "Smart Mirror" (https://snowboy.kitt.ai/hotword/47). Set sensitivity to Sensitivity to 0.5, and ApplyFrontend to false. ## Precompiled node module Snowboy is available in the form of a native node module precompiled for: 64 bit Ubuntu, MacOS X, and the Raspberry Pi (Raspbian 8.0+). For quick installation run: npm install --save snowboy For sample usage see the `examples/Node` folder. You may have to install dependencies like `fs`, `wav` or `node-record-lpcm16` depending on which script you use. ## Precompiled Binaries with Python Demo * 64 bit Ubuntu [14.04](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/ubuntu1404-x86_64-1.3.0.tar.bz2) * [MacOS X](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/osx-x86_64-1.3.0.tar.bz2) * Raspberry Pi with Raspbian 8.0, all versions ([1/2/3/Zero](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/rpi-arm