HiveMind Integration for Home Assistant

This is a manual install Home Assistant integration for connecting to an OpenVoiceOS instance via HiveMind

It allows Home Assistant to directly control and interact with a HiveMind device at a system level, not just sending voice commands, but also manipulating services like audio playback, volume, and system power.

---

Related Projects:

• hivemind-homeassistant (this integration) allows HiveMind to show up as a device in Home Assistant
• hivemind-player-protocol turn any device into a standalone HiveMind OCP player
• ovos-skill-music-assistant allows OVOS to search media in MA sources
• ovos-media-plugin-mass allows OVOS to control MA players

---

Manual Installation

1. Copy the hivemind folder into your Home Assistant custom_components directory:

mkdir -p /config/custom_components
cp -r custom_components/hivemind /config/custom_components/

1. Restart Home Assistant.

2. Add the HiveMind integration via the Home Assistant UI:
   Settings → Devices & Services → Add Integration → HiveMind

---

Home Assistant Setup

Once a HiveMind device is added to HomeAssistant you will have several entities available

controls

media player

notify

status sensors

Music Assistant

---

Permissions Required

Since this integration does more than just voice queries, it requires low-level permissions to inject and control bus messages directly.

The client connecting to HiveMind must have admin privileges and permission to access the following message types:

ovos-core

• mycroft.stop
• mycroft.skills.is_alive
• mycroft.skills.is_ready

ovos-dinkum-listener

• mycroft.voice.is_alive
• mycroft.voice.is_ready
• mycroft.mic.listen
• mycroft.mic.mute
• mycroft.mic.unmute
• mycroft.mic.get_status
• recognizer_loop:sleep
• recognizer_loop:wake_up
• recognizer_loop:state.get
• recognizer_loop:state.set

ovos-gui

• mycroft.gui_service.is_alive
• mycroft.gui_service.is_ready

ovos-audio

• speak
• mycroft.audio.is_alive
• mycroft.audio.is_ready
• mycroft.audio.speak.status

OCP (OpenVoiceOS Common Play)

• ovos.common_play.player.status
• ovos.common_play.track_info
• ovos.common_play.get_track_length
• ovos.common_play.get_track_position
• ovos.common_play.playlist.queue
• ovos.common_play.resume
• ovos.common_play.pause
• ovos.common_play.stop
• ovos.common_play.previous
• ovos.common_play.next
• ovos.common_play.set_track_position
• ovos.common_play.playlist.clear
• ovos.common_play.shuffle.set
• ovos.common_play.shuffle.unset
• ovos.common_play.repeat.set
• ovos.common_play.repeat.unset
• ovos.common_play.repeat.one

Audio Service

(only if enabled manually, for systems without the OCP Audio Plugin)

• mycroft.audio.service.play
• mycroft.audio.service.resume
• mycroft.audio.service.pause
• mycroft.audio.service.stop
• mycroft.audio.service.prev
• mycroft.audio.service.next
• mycroft.audio.service.set_track_position

PHAL

• mycroft.phal.is_alive
• mycroft.phal.is_ready

ovos-phal-plugin-alsa

• mycroft.volume.get
• mycroft.volume.increase
• mycroft.volume.decrease
• mycroft.volume.mute
• mycroft.volume.unmute

ovos-phal-plugin-system

• system.reboot
• system.shutdown
• system.mycroft.service.restart
• system.ssh.status

ovos-phal-plugin-camera

(work in progress)

• ovos.phal.camera.ping
• ovos.phal.camera.get
• ovos.phal.camera.open
• ovos.phal.camera.close

---