HiveMind-voice-sat 2.1.0a1

Hivemind Voice Satellite

HiveMind Voice Satellite

The full-stack OVOS voice satellite: microphone, VAD, wakeword, STT, and TTS all run on this device. Spoken input is transcribed locally; only the resulting text utterance is sent to the hive. Responses arrive as text and are spoken locally. Requires the most compute of the satellite family, but 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	—	—	—	—	—	text in / text out
hivemind-mic-satellite	local	local	—	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, when bandwidth is limited, or when audio privacy matters.

Install

pip install HiveMind-voice-sat
# Linux — ALSA/SoundDevice microphone support
pip install HiveMind-voice-sat[linux]
# macOS
pip install HiveMind-voice-sat[mac]

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/:

• Overview & architecture spectrum
• Getting started
• Configuration reference
• Architecture (advanced)
• Deployment (systemd / Raspberry Pi)
• Troubleshooting

Related

Project	Role
HiveMind-core	The hive — install 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.