This release is a pre-release and may not be stable for production use.
hivemind-audio-binary-protocol
Binary audio plugin for hivemind-core.
The plugin adds server-side WakeWord detection, VAD, STT, and TTS to a hivemind-core hub. Lightweight satellites, such as hivemind-mic-satellite, stream raw audio to the hub and receive transcriptions or synthesized speech. The satellites do not run those models locally.
Where it fits
hivemind-core
└── hivemind-plugin-manager (BinaryDataHandlerFactory loads plugins by entry-point)
└── hivemind-audio-binary-protocol ← this repo
├── ovos-simple-listener (WakeWord + VAD + STT pipeline)
└── OVOSTTSFactory / OVOSSTTFactory / OVOSVADFactory / OVOSWakeWordFactory
The plugin registers under the hivemind.binary.protocol entry-point group as
hivemind-audio-binary-protocol-plugin.
Install
pip install hivemind-audio-binary-protocol
You also need OVOS STT, TTS, VAD, and WakeWord plugins. Install them as you would in a standard OVOS setup:
pip install ovos-stt-plugin-server ovos-tts-plugin-piper ovos-vad-plugin-silero \
ovos-ww-plugin-precise-lite
Quickstart
Add the binary_protocol block to ~/.config/hivemind-core/server.json:
{
"binary_protocol": {
"module": "hivemind-audio-binary-protocol-plugin",
"hivemind-audio-binary-protocol-plugin": {
"stt": {
"module": "ovos-stt-plugin-server",
"ovos-stt-plugin-server": {"url": "https://stt.openvoiceos.org"}
},
"tts": {
"module": "ovos-tts-plugin-piper",
"ovos-tts-plugin-piper": {"voice": "en_US-lessac-medium"}
},
"vad": {
"module": "ovos-vad-plugin-silero"
},
"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"
}
}
}
}
}
Then start hivemind-core with the listen subcommand:
hivemind-core listen
Audio streaming modes
This plugin handles three binary audio flows:
| Mode | Client sends | Hub returns | Use case |
|---|---|---|---|
| Microphone stream | Raw PCM audio chunks | Bus messages (wakeword/utterance events) | Mic satellite. The hub runs the full pipeline. |
| STT transcription | Raw PCM audio | recognizer_loop:transcribe.response |
Client wants a transcription without triggering skills. |
| STT handle | Raw PCM audio | Triggers recognizer_loop:utterance on the bus |
Client wants the hub to handle the utterance. |
The bus triggers TTS (speak:synth or speak:b64_audio) and returns binary WAV audio
or a Base64-encoded string to the client.
Configuration reference
The plugin's config block mirrors the OVOS plugin config convention. Each sub-plugin
(stt, tts, vad) takes its standard OVOS config:
| Key | Description |
|---|---|
stt |
STT plugin config. module selects the OVOS STT plugin. |
tts |
TTS plugin config. module selects the OVOS TTS plugin. |
vad |
VAD plugin config. module selects the OVOS VAD plugin. |
wake_word |
WakeWord name (key into hotwords). |
hotwords |
Dict of wakeword configurations, keyed by wakeword name. |
utterance_transformers |
List of OVOS utterance transformer plugin names. |
dialog_transformers |
List of OVOS dialog transformer plugin names. |
metadata_transformers |
List of OVOS metadata transformer plugin names. |
audio_transformers |
List of OVOS audio transformer plugin names applied to raw audio before STT. |
tts_transformers |
List of OVOS tts transformer plugin names applied to synthesized audio after TTS. |
If the config block is omitted, the plugin falls back to reading mycroft.conf
(the standard OVOS configuration file) to select plugins.
Access control
This plugin respects hivemind-core's per-client allowed_types whitelist. Clients must
have the correct access to send binary audio or receive TTS output.
Related projects
- JarbasHiveMind/HiveMind-core — the hub this plugin extends
- JarbasHiveMind/hivemind-plugin-manager — loads this plugin by entry-point
- JarbasHiveMind/hivemind-mic-satellite — reference satellite client for the microphone stream mode
License
Apache License 2.0. See LICENSE.
Docs
- docs/audio_flow.md: detailed STT/TTS flow, FakeMicrophone, per-client listeners
- docs/configuration.md: full configuration reference
- docs/operations.md: plugin selection, satellite setup, authoring a binary plugin
Metadata
Release files for hivemind-audio-binary-protocol 2.2.3a2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| hivemind_audio_binary_protocol-2.2.3a2.tar.gz | 20.4 kB | Without provenance | Details for hivemind_audio_binary_protocol-2.2.3a2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| hivemind_audio_binary_protocol-2.2.3a2-py3-none-any.whl | Python 3 | none | any | Details for hivemind_audio_binary_protocol-2.2.3a2-py3-none-any.whl |
Total release size: 37.1 kB
Release files / hivemind_audio_binary_protocol-2.2.3a2.tar.gz
| Download URL | hivemind_audio_binary_protocol-2.2.3a2.tar.gz |
|---|---|
| Size | 20.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a03e6150dc738ae8c78e45e68f5e3695998ceeeec1235ffaaf1b9a440e9aa33f
|
|
BLAKE2b-256 checksum How to use checksums |
2c606b0430f4a12795a11969d4074e2f5891ae302577fc9472e40da3c4e27af0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / hivemind_audio_binary_protocol-2.2.3a2-py3-none-any.whl
| Download URL | hivemind_audio_binary_protocol-2.2.3a2-py3-none-any.whl |
|---|---|
| Size | 16.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c6df8f681b4095f7fd805ba2af2cdb1229ad190be3d34629102565b3aef88289
|
|
BLAKE2b-256 checksum How to use checksums |
04d367bce26e40b3f1766165ecb659df6595fc063aea7d91f1f0a2bd77b4cdfb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for hivemind-audio-binary-protocol 2.2.3a2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.