Entities

September 3, 2026 · View on GitHub

Which entities appear depends on the configured device_type (see configuration). The table notes the minimum device type that exposes each entity.

Always (all device types)

EntityPlatformPurpose
Connectionbinary_sensorWhether the HiveMind link is up.
Alive / Readybinary_sensorOVOS service liveness/readiness.
Speakingbinary_sensorWhether OVOS is currently speaking.
ReconnectbuttonRe-establish the HiveMind connection.
Reboot / ShutdownbuttonSystem power control (via PHAL).
Restart servicebuttonRestart the OVOS service.
Mic listenbuttonTrigger a listening cycle.
Stopbuttonmycroft.stop.
SSHswitchToggle SSH (PHAL system plugin).
Volume muteswitchMute/unmute output volume.
Mic muteswitchMute/unmute the microphone.
Sleep modeswitchPut OVOS to sleep / wake it.

media_player and voice_assistant

EntityPlatformPurpose
Media playermedia_playerOCP-backed playback, volume, transport controls.
NotifynotifySend text to OVOS to speak (TTS).

The media player maps Home Assistant MediaType values to OVOS OCP media types (music, video, movie, episode, TV channel, game, and others).

voice_assistant only

EntityPlatformPurpose
Listener statesensorCurrent listener/recognizer state.
Listening modeselectSwitch the listening mode.

These entities cover the microphone, VAD, and STT side that only a full voice assistant device exposes.


← Configuration · Home · Permissions →