demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/openhab/openhab-addons.git synced 2025-01-10 23:22:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

[porcupineks] Enhanced documentation (#12116)

Browse Source 
Signed-off-by: Laurent Garnier <lg.hc@free.fr>
This commit is contained in:
lolodomo 2022-01-25 20:18:09 +01:00 committed by GitHub
parent 8a2d507b21
commit 56b2f47be6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
bundles/org.openhab.voice.porcupineks/README.md
View File

@ -9,12 +9,22 @@ Important: No voice data listened by this service will be uploaded to the Cloud.
The voice data is processed offline, locally on your openHAB server by Porcupine.
Once in a while, access keys are validated to stay active and this requires an Internet connection.
## How to use it
## Configuration
After installing, you will be able to access the addon options through the openHAB configuration page under the 'Other Services' section.
There you will need to provide your PicoVoice Api Key.
After installing, you will be able to access the service options through the openHAB configuration page in UI (**Settings / Other Services - Porcupine Keyword Spotter**) to edit them:
After that, you can select Porcupine as your default Keyword Spotter in your 'Voice' settings.
* **Pico Voice API Key** - API key from PicoVoice, required to use Porcupine.
* **Sensitivity** - Spot sensitivity, a higher sensitivity reduces miss rate at cost of increased false alarm rate.
In case you would like to setup the service via a text file, create a new file in `$OPENHAB_ROOT/conf/services` named `porcupineks.cfg`
Its contents should look similar to:
```
org.openhab.voice.porcupineks:apiKey=KEY
org.openhab.voice.porcupineks:sensitivity=0.5
```
## Magic Word Configuration
@ -56,3 +66,21 @@ Only the English model binary is included with the addon and will be used if the
To get the language model files, go to the [Porcupine repo](https://github.com/Picovoice/porcupine/tree/v2.0/lib/common).
Note that the keyword model you use should match the language model.
## Default Keyword Spotter and Magic Word Configuration
You can setup your preferred default keyword spotter and default magic word in the UI:
* Go to **Settings**.
* Edit **System Services - Voice**.
* Set **Porcupine Keyword Spotter** as **Default Keyword Spotter**.
* Choose your preferred **Magic Word** for your setup.
* Choose optionally your **Listening Switch** item that will be switch ON during the period when the dialog processor has spotted the keyword and is listening for commands.
In case you would like to setup these settings via a text file, you can edit the file `runtime.cfg` in `$OPENHAB_ROOT/conf/services` and set the following entries:
```
org.openhab.voice:defaultKS=porcupineks
org.openhab.voice:keyword=picovoice
org.openhab.voice:listeningItem=myItemForDialog
```