Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JarbasAl authored Dec 29, 2024
1 parent b962d22 commit e3572ff
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,29 @@ Extends [hivemind-core](https://github.com/JarbasHiveMind/hivemind-core) and int
pip install hivemind-audio-binary-protocol
```

## Configuration

In your hivemind `server.json` set `"binary_protocol"` module to `"hivemind-audio-binary-protocol-plugin"` and configure the plugins to be used like you would in OVOS

```json
"binary_protocol": {"module": "hivemind-audio-binary-protocol-plugin",
"hivemind-audio-binary-protocol-plugin": {
"stt": {"module": "XXX-plugin", "XXX-plugin":{}},
"tts": {"module": "XXX-plugin", "XXX-plugin":{}},
"vad": {"module": "XXX-plugin", "XXX-plugin":{}},
"wake_word": "hey_mycroft",
"hotwords": {
"hey_mycroft": {
"module": "ovos-ww-plugin-precise-lite",
"model": "https://github.com/OpenVoiceOS/precise-lite-models/raw/master/wakewords/en/hey_mycroft.tflite"
}
}
}},
```

If installed and configured correctly the audio binary protocol will be used when you run `hivemind-core listen`


---

## 🌐 Example Use Cases
Expand All @@ -51,4 +74,4 @@ We welcome contributions!

## ⚖️ License

HiveMind Listener is open-source software, licensed under the [Apache 2.0 License](LICENSE).
HiveMind Listener is open-source software, licensed under the [Apache 2.0 License](LICENSE).

0 comments on commit e3572ff

Please sign in to comment.