Skip to content

Technical

Capabilities

The contracts between modules – what a module promises when it announces a capability.

Principle

A capability is a contract. A module announces it in its description, the integration passes it on in the partner list, and other modules use it only if the partner announces it – never by the module’s name.

Overview

CapabilityWhoWhat it promises
navigationGoOffline navigation; destination, arrival, distance remaining as entities
radioBeatFM/DAB+ radio as a media player
ansage.einmischenBeatAnnouncements are mixed into the running radio
mobilfunkRouterCountry, roaming, operator, signal as entities
mobilfunk.sim_wechselRouterSwitch SIM 1/2 via an action
kameraVisionCameras as entities, select channel via an action
sprache.eingabeSatelliteMicrophone for the voice assistant
sprache.ausgabeSatelliteSpeaker as a media player
  • Actions: yapaia.go_ziel_setzen (ziel as text or ort with coordinates), yapaia.go_navigation_pausieren, …_fortsetzen, …_beenden, yapaia.go_profil_waehlen (wert), yapaia.go_befehl (text; answer as antwort in the result).
  • States: ankunft, restweg, ziel, zustand, tempo, tempolimit, standort.
  • Events: ziel_erreicht, zu_schnell, gps_verloren, neuberechnung_fehlgeschlagen.

radio

  • Call: Home Assistant action yapaia.beat_befehl (text; answer as antwort in the result) – a German sentence such as „Spiel SWR3“ (play SWR3), „Radio aus“ (radio off) or „Nächster Sender“ (next station).
  • Alongside: Beat’s entities and actions (media_player.yapaia_beat, yapaia.beat_abspielen …).

ansage.einmischen

  • Call: Home Assistant action yapaia.beat_ansage – through Home Assistant, because that is where the voice (TTS) is generated.
  • Fields: message (required), priority (info, hinweis, navigation), optional engine and language.
  • Response: {"ok": true, "weg": "gemischt" | "lautsprecher"} or {"ok": false, "error": "…"}. With ok: false, the caller speaks itself.

mobilfunk.sim_wechsel

  • Call: yapaia.router_sim_waehlen with sim: 1 | 2.
  • Result: via the events sim_gewechselt or sim_wechsel_fehlgeschlagen.

kamera

  • Entities: camera.yapaia_vision_kamera_<n> per channel (still image and MJPEG live stream), plus select.yapaia_vision_kanal when channels share a grabber.
  • Call: yapaia.vision_kanal_waehlen (kanal: a name like “Rückfahrkamera” or a number). When channels share a grabber, only the selected one is live; the others show their last picture.

sprache.ausgabe

  • Call: tts.speak with the media_player from the partner list.