Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Psychokiller1888/snips-custom-hotword

Using Snowboy to customize the snips hotword
https://github.com/Psychokiller1888/snips-custom-hotword

Last synced: 2 months ago
JSON representation

Using Snowboy to customize the snips hotword

Awesome Lists containing this project

README 

        
# snips-custom-hotword

Using Snowboy to customize the snips hotword. This is meant to use the Snowboy engine to trigger Snips, unlike [oziee](https://github.com/oziee/hotword) that processes a sound buffer from Snips to check if the hotword is present. The main reason of this repository is to share another approach, all the needed files and a configurable way



### Install



I'm using raspbian stretch light



We need a few dependencies first:



```sudo apt-get install python-pip python-pyaudio python3-pyaudio sox libatlas-base-dev```



```sudo pip install pyaudio```



```sudo pip install pytoml```



```sudo pip install paho_mqtt```



Now, I perfectly know that *libatlas-base-dev* might be in conflict with Snips. That is why I do install it **before** Snips!



[Install Snips](https://github.com/snipsco/snips-platform-documentation/wiki/1.-Setup-the-Snips-Voice-Platform)



Once you sorted that out, you can download this project



```git clone https://github.com/Psychokiller1888/snips-custom-hotword.git```



### Checking your mic ###



In a console type

```sudo nano /etc/asound.conf```



Check that the part "capture" is set as type "dsnoop"



Here an exemple of a working configuration, so the mic can be shared between applications:



```

pcm.!default {

    type asym

    playback.pcm {

        type plug

        slave.pcm "hw:0,0"

    }

    capture.pcm "multi"

}



pcm.multi {

    type plug

    slave.pcm "multiapps"

}



pcm.multiapps {

    type dsnoop

    slave.pcm "hw:1,0"

    ipc_key 666666

}

```



### Creating a custom hotword



* Head to [Snowboy](https://snowboy.kitt.ai/dashboard), create an account if you don't yet own one and login.

* Create or download a hotword of your choice

* Place the downloaded **.pmdl** file into *snips-custom-hotword*



You're good to go!



```sudo python customHotword.py YOUR MODEL NAME SENSITIVITY```



Whaaat? Ok, calm down, here's an exemple:



```sudo python customHotword.py Alice 0.45```



Given that you downloaded the model Alice.pmdl and you want a sensitivity of 0.45 for it. (Sensitivity from 0 - not hearing you and 1 - full blast)



### Disabling Snips hotword



By this line of this little guide, your Snips instance still listens to both your custom hotword and your Snips hotword. Wanna disable the Snips hotword?



```sudo systemctl stop snips-hotword```



```sudo systemctl disable snips-hotword```



### Starting the custom hotword at Raspberry boot



* Edit the *snipsCustomHotword.service* file

* Change the model name and the sensitivity on line 7

* In case you downloaded the script at a different place, make sure the line 8 points correctly to where customHotword.py is located

* Move the file to *systemd* ```sudo mv /home/pi/snips-custom-hotword/snipsCustomHotword.service /etc/systemd/system/```

* Start the service ```sudo systemctl start snipsCustomHotword```

* Enable it on boot ```sudo systemctl enable snipsCustomHotword```



### But but but.... Nothing happens!



Ok, the aim of this is to change your hotword by a custom one, I didn't include any script... If you want to check that it actually works, make sure to have the service started, you could use ```sudo systemctl status snipsCustomHotword``` to make sure, then use ```snips-watch -v``` and try to wake your assistant by telling your hotword. If it hears you, you'll get informations on screen



### Proof

Yes, it works!

[Screen capture](https://puu.sh/zwS0X.png)

[Video](https://www.youtube.com/watch?v=SqWoNj4HUos)



### Todo



I'm open to any suggestions. Here a little TODO list for this simple project:

* Hook Piwho, but not force it, passed as an argument



### I wanna go back!!!

```sudo systemctl stop snipsCustomHotword```



```sudo systemctl disable snipsCustomHotword```



```sudo systemctl start snips-hotword```



```sudo systemctl enable snips-hotword```



```sudo rm /etc/systemd/system/snipsCustomHotword.service```



```sudo rm -rf /home/pi/snips-custom-hotword```



## Special thanks

* Snips: https://snips.ai

* The base: https://github.com/oziee/hotword

* Snowboy: http://docs.kitt.ai/snowboy/

* Systemd services: https://www.raspberrypi.org/documentation/linux/usage/systemd.md

* [@Algram](https://github.com/Algram) as well as @mathieu from @Snips for trying as a cobaye to fix dsnoop and snowboy install after Snips