Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Ask DeepWiki

HiveMind Voice Satellite

HiveMind Voice Satellite is a full-stack OVOS voice satellite. Microphone capture, VAD, wakeword detection, STT, and TTS all run on this device. The satellite transcribes speech locally and sends only the resulting text utterance to the hive. Responses arrive as text and the satellite speaks them locally. This satellite needs the most compute of the satellite family. It puts the least load on the server and works fully offline once set up.

Satellite spectrum

Satellite Mic VAD Wakeword STT TTS What crosses the wire
HiveMind-cli n/a n/a n/a n/a n/a text in / text out
hivemind-mic-satellite local local n/a remote remote raw audio stream
HiveMind-voice-relay local local local remote remote audio after wakeword
HiveMind-voice-sat ← you are here local local local local local text utterances only

Use voice-sat when the device has CPU/GPU to spare, bandwidth is limited, or audio privacy matters.

Install

pip install --pre HiveMind-voice-sat
# Linux: ALSA or SoundDevice microphone support
pip install --pre "HiveMind-voice-sat[linux]"
# macOS
pip install --pre "HiveMind-voice-sat[mac]"

HiveMind-voice-sat is published as pre-releases, so pass --pre. Without it, pip installs the last stable release, 2.0.1, with an older OVOS listener and audio stack (ovos-dinkum-listener 0.5.0, ovos-audio 1.2.0) that does not match these docs. With uv, the same install is uv pip install --prerelease=allow HiveMind-voice-sat.

60-second quickstart

1. Add a client on the hive (run this on the server):

hivemind-core add-client --name my-voice-sat
# outputs: Access Key and Password, copy them

2. Run the satellite (on this device):

hivemind-voice-sat --host <hive-host> --key <access-key> --password <password>

Say your wakeword. The satellite transcribes locally and sends the utterance to the hive.

Minimal configuration

The satellite reads ~/.config/mycroft/mycroft.conf (standard OVOS config). Override STT, TTS, VAD, and wakeword plugins there:

{
  "listener": {
    "VAD": {
      "module": "ovos-vad-plugin-silero"
    },
    "wake_word": "hey_mycroft",
    "hey_mycroft": {
      "module": "ovos-ww-plugin-vosk"
    }
  },
  "stt": {
    "module": "ovos-stt-plugin-server",
    "ovos-stt-plugin-server": { "url": "https://stt.openvoiceos.org/stt" }
  },
  "tts": {
    "module": "ovos-tts-plugin-server",
    "ovos-tts-plugin-server": { "host": "https://tts.openvoiceos.org" }
  }
}

All plugin slots are swappable via ovos-plugin-manager. See docs/configuration.md for the full reference.

CLI reference

Usage: hivemind-voice-sat [OPTIONS]
  connect to HiveMind
Options:
  --host TEXT       hivemind host (ws:// or wss://)
  --key TEXT        Access Key
  --password TEXT   Password for key derivation
  --port INTEGER    HiveMind port number (default 5678)
  --selfsigned      accept self-signed certificates
  --siteid TEXT     location identifier for message.context
  --help            Show this message and exit.

Documentation

Full zero-to-hero docs live in docs/:

Development

git clone https://github.com/JarbasHiveMind/HiveMind-voice-sat
cd HiveMind-voice-sat
pip install -e ".[test]"   # lightweight smoke deps
pytest tests/test_smoke.py
pip install -e ".[e2e]"    # full hivemind-core + 2.x stack for end-to-end
pytest tests/e2e/

pyproject.toml is the single packaging source of truth. The dependency stack now runs on ovos-bus-client 2.x (see docs/architecture.md). Prerelease dependencies are pinned as minimum versions, so pip resolves them without --pre.

Project Role
HiveMind-core The hive, install it on the server
HiveMind-cli Text-only client
hivemind-mic-satellite Thinnest audio satellite
HiveMind-voice-relay Mid-weight: local wakeword, remote STT/TTS

License

Apache-2.0. See LICENSE.

Metadata

Release files for HiveMind-voice-sat 2.2.7a2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for HiveMind-voice-sat 2.2.7a2
File Size Uploaded Provenance Actions
hivemind_voice_sat-2.2.7a2.tar.gz 17.6 kB Without provenance Details for hivemind_voice_sat-2.2.7a2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for HiveMind-voice-sat 2.2.7a2
File Interpreter ABI Platform Actions
hivemind_voice_sat-2.2.7a2-py3-none-any.whl Python 3 none any Details for hivemind_voice_sat-2.2.7a2-py3-none-any.whl

Total release size: 30.3 kB

Release files / hivemind_voice_sat-2.2.7a2.tar.gz

Download URL hivemind_voice_sat-2.2.7a2.tar.gz
Size 17.6 kB
Tags Source
SHA-256 checksum
How to use checksums
e81f597c49e04aa732e935043472f02fc333e2f2f7e9cefce68394e263abfd30
BLAKE2b-256 checksum
How to use checksums
86a6822e2a7f7eb942fe8b6a5091638c0c2fd62da12cd82497c47a71472a36ba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / hivemind_voice_sat-2.2.7a2-py3-none-any.whl

Download URL hivemind_voice_sat-2.2.7a2-py3-none-any.whl
Size 12.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
265cbc23592d7d2610d42761a64655f4d291f7562f9ff9d71bb3659e2b28abe8
BLAKE2b-256 checksum
How to use checksums
53e6ff52d79717884ff7afb11a94ed54282858c8650f4cfc0f9652741161f83f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for HiveMind-voice-sat 2.2.7a2

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.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page