What a runtime actually offers its frontend. More...

#include <runtime_capabilities.h>

Public Attributes
bool	supports_runtime_threshold_updates {false}
	set_threshold_runtime() is honored.
bool	supports_runtime_motion_hits_updates {false}
	set_motion_hits_runtime() is honored; otherwise the controller refuses it.
bool	supports_runtime_detector_selection {false}
	set_detection_algorithm_runtime() is honored.
bool	supports_manual_recalibration {false}
	trigger_recalibration() is honored; otherwise the controller refuses it.
bool	supports_live_telemetry {false}
	The runtime drives IRuntimeListener::on_live_telemetry() at all.
bool	supports_extended_diagnostics {false}
	The runtime reports the extended diagnostics block used by stats payloads.
bool	supports_traffic_control {false}
	The runtime owns CSI traffic generation and can be asked to retune it.

Detailed Description

What a runtime actually offers its frontend.

Every flag defaults to false on purpose: ESPECTRE_PROTOCOL.md makes this block the contract clients read, so a capability has to be declared rather than inherited from a permissive default. Previously only the stream runtime declared anything and the sensing runtime shipped whatever the struct happened to default to.

supports_live_telemetry describes the runtime side of the surface: whether it drives the live-telemetry callback at all.

Definition at line 26 of file runtime_capabilities.h.

Member Data Documentation

◆ supports_runtime_threshold_updates

bool espectre::RuntimeCapabilities::supports_runtime_threshold_updates {false}

set_threshold_runtime() is honored.

Definition at line 28 of file runtime_capabilities.h.

◆ supports_runtime_motion_hits_updates

bool espectre::RuntimeCapabilities::supports_runtime_motion_hits_updates {false}

set_motion_hits_runtime() is honored; otherwise the controller refuses it.

Definition at line 30 of file runtime_capabilities.h.

◆ supports_runtime_detector_selection

bool espectre::RuntimeCapabilities::supports_runtime_detector_selection {false}

set_detection_algorithm_runtime() is honored.

Driven by RuntimeConfig::runtime_detector_selection_enabled, since switching detectors also means persisting and restoring the choice.

Definition at line 37 of file runtime_capabilities.h.

◆ supports_manual_recalibration

bool espectre::RuntimeCapabilities::supports_manual_recalibration {false}

trigger_recalibration() is honored; otherwise the controller refuses it.

Definition at line 39 of file runtime_capabilities.h.

◆ supports_live_telemetry

bool espectre::RuntimeCapabilities::supports_live_telemetry {false}

The runtime drives IRuntimeListener::on_live_telemetry() at all.

Native uses that callback for MQTT sensing telemetry and Home Assistant Movement Score. Transport adapters decide how to forward live sensing.

Definition at line 46 of file runtime_capabilities.h.

◆ supports_extended_diagnostics

bool espectre::RuntimeCapabilities::supports_extended_diagnostics {false}

The runtime reports the extended diagnostics block used by stats payloads.

Definition at line 48 of file runtime_capabilities.h.

◆ supports_traffic_control

bool espectre::RuntimeCapabilities::supports_traffic_control {false}

The runtime owns CSI traffic generation and can be asked to retune it.

Definition at line 50 of file runtime_capabilities.h.

The documentation for this struct was generated from the following file:

src/cpp/runtime/runtime_capabilities.h

Public Attributes