public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[rustpotterks] Upgrade to version 3 (#15556)

Browse Source 
* Upgrade to version 3
* Use ThreadPoolManager and add sleep
* Remove pool prefix, already added by thread pool manager

Signed-off-by: Miguel Álvarez <miguelwork92@gmail.com>
This commit is contained in:
GiviMAD
2023-10-01 21:15:24 +02:00
committed by GitHub
parent 5a39985420
commit 1abb8f267e
8 changed files with 337 additions and 179 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
bundles/org.openhab.voice.rustpotterks/README.md
View File

@@ -3,12 +3,15 @@
This voice service allows you to use the open source library Rustpotter as your keyword spotter in openHAB.
[Rustpotter](https://github.com/GiviMAD/rustpotter) is a free and open-source keywords spotter written in rust.
Rustpotter provides personal on-device wake word detection. You need to generate a model for your keyword using audio samples.
Rustpotter provides personal on-device wake word detection.
You need to generate a file for your keyword using audio samples.
You can test library in your browser using these web pages:
You can test the library in your browser using these web pages:
- [The spot demo](https://givimad.github.io/rustpotter-worklet-demo/), which include some example wakewords (but it's recommended to use your own).
- [The model creation demo](https://givimad.github.io/rustpotter-create-model-demo/), it allows you to record compatible wav files and generate a wakeword file that you can test on the previous page.
- [The wakeword reference creation demo](https://givimad.github.io/rustpotter-create-model-demo/), it allows you to record compatible wav files and generate a wakeword reference files that you can test on the previous page.
There is also this [command line utility](https://github.com/GiviMAD/rustpotter-cli) that allows taking records and testing the library.
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 Rustpotter.
@@ -17,12 +20,14 @@ The voice data is processed offline, locally on your openHAB server by Rustpotte
After installing, you will be able to access the service options through the openHAB configuration page in UI (**Settings / Other Services - Rustpotter Keyword Spotter**) to edit them:
- **Threshold** - Configures the detector threshold, is the min score (in range 0. to 1.) that some wake word template should obtain to trigger a detection. Defaults to 0.5.
- **Averaged Threshold** - Configures the detector averaged threshold, is the min score (in range 0. to 1.) that the audio should obtain against a combination of the wake word templates, the detection will be aborted if this is not the case. This way it can prevent to run the comparison of the current frame against each of the wake word templates which saves cpu. If set to 0 this functionality is disabled.
- **Score Mode** - Indicates how to calculate the final score.
- **Min Scores** - Minimum number of positive scores to consider a partial detection as a detection.
- **Comparator Ref** - Configures the reference for the comparator used to match the samples.
- **Comparator Band Size** - Configures the band-size for the comparator used to match the samples.
- **Threshold** - Configures the detector threshold, is the min score (in range 0. to 1.) to trigger the detection. Defaults to 0.5.
- **Averaged Threshold** - Configures the detector averaged threshold. If set to 0 this functionality is disabled.
- **Score Mode** - Indicates how to calculate the final score. (Only applies to wakeword references)
- **Min Scores** - Minimum number of positive scores required to not discard the detection.
- **Eager** - Emit detection on min partial scores.
- **VAD Mode** - Enables a basic vad detector to discard some execution.
- **Score Ref** - Configures the reference for the comparator used to match the samples.
- **Band Size** - Configures the band-size for the comparator used to match the samples. (Only applies to wakeword references)
- **Gain Normalizer** - Enables an audio filter that intent to approximate the volume of the stream to a reference level.
- **Min Gain** - Min gain applied by the gain normalizer filter.
- **Max Gain** - Max gain applied by the gain normalizer filter.
@@ -40,26 +45,23 @@ org.openhab.voice.rustpotterks:threshold=0.5
org.openhab.voice.rustpotterks:averagedthreshold=0.2
org.openhab.voice.rustpotterks:scoreMode=max
org.openhab.voice.rustpotterks:minScores=5
org.openhab.voice.rustpotterks:comparatorRef=0.22
org.openhab.voice.rustpotterks:comparatorBandSize=5
org.openhab.voice.rustpotterks:scoreRef=0.22
org.openhab.voice.rustpotterks:bandSize=5
org.openhab.voice.rustpotterks:gainNormalizer=true
org.openhab.voice.rustpotterks:minGain=0.5
org.openhab.voice.rustpotterks:maxGain=1
org.openhab.voice.rustpotterks:gainRef=
org.openhab.voice.rustpotterks:bandPass=true
org.openhab.voice.rustpotterks:lowCutoff=80
org.openhab.voice.rustpotterks:highCutoff=400
org.openhab.voice.rustpotterks:gainRef=0.004
```
## Magic Word Configuration
The magic word to spot is gathered from your 'Voice' configuration.
You can generate your own wakeword files using the [Rustpotter CLI](https://github.com/GiviMAD/rustpotter-cli).
You can generate your own wakeword files using the [command line utility](https://github.com/GiviMAD/rustpotter-cli).
You can also download the models used as examples on the [rustpotter web demo](https://givimad.github.io/rustpotter-worklet-demo/) from [this folder](https://github.com/GiviMAD/rustpotter-worklet-demo/tree/main/static).
You can also download the wakeword used as examples on the [rustpotter web demo](https://givimad.github.io/rustpotter-worklet-demo/) from [this folder](https://github.com/GiviMAD/rustpotter-worklet-demo/tree/main/static).
To use a wake word model, you should place the file under '\<openHAB userdata\>/rustpotter' and configure your magic word to match the file name replacing spaces with '_' and adding the extension '.rpw'.
To use a wake word wakeword, you should place the file under '\<openHAB userdata\>/rustpotter' and configure your magic word to match the file name replacing spaces with '_' and adding the extension '.rpw'.
As an example, the file generated for the keyword "ok openhab" will be named 'ok_openhab.rpw'.
The service will only work if it's able to find the correct rpw for your magic word configuration.