Model Reference
Reference for all return types that partner apps most often inspect.
SdkOperationalDiagnostics
Snapshot of operational runtime health after bootstrap and session setup.
| Field | Description |
|---|---|
connectionState | MQTT/realtime transport state |
session | Current signed session, when present |
telemetryPublishTopic | Operational telemetry topic the SDK is using |
sosEventTopics | SOS event topics currently bound for the signed user |
sosRehydrationNote | Explains fallback or rehydration behavior after startup |
bridge.lastDecision | Latest bridge/runtime decision worth surfacing in diagnostics |
bridge.pendingSos | Queued SOS handoff details when an SOS is buffered |
bridge.pendingTelemetry | Queued telemetry payload details when telemetry is buffered |
DeviceStatus
High-level runtime view of the connected or remembered Eixam device.
| Field | Description |
|---|---|
deviceId | Stable device identifier used by the SDK |
lifecycleState | unpaired, paired, activating, ready, or error |
paired | Whether a device is paired |
activated | Whether the device is activated |
connected | Whether the device is currently connected |
isReadyForSafety | Most useful single readiness flag for host UI |
approximateBatteryPercentage | Approximate battery level |
signalQuality | BLE signal quality |
firmwareVersion | Device firmware version |
provisioningError | Error during provisioning, if any |
DeviceSosStatus
Device-side SOS state maintained by the runtime.
| Field | Description |
|---|---|
state | inactive, preConfirm, active, acknowledged, or resolved |
lastEvent | Most recent runtime explanation |
transitionSource | Where the current state came from |
updatedAt | Timestamp of last state update |
countdownRemainingSeconds | Useful during pre-confirm countdowns |
lastPacketAt | Last BLE SOS packet time, when relevant |
decoderNote | Runtime note when packet interpretation matters |
EmergencyContact
Backend-synced emergency contact record.
| Field | Description |
|---|---|
id | Contact record ID |
name | Contact name |
phone | Contact phone number |
email | Contact email |
priority | Priority order |
updatedAt | Last update timestamp |
SosIncident
App-originated SOS incident tracked by the SDK runtime.
| Field | Description |
|---|---|
id | Incident ID |
state | Current SOS lifecycle state |
createdAt | Incident creation timestamp |
triggerSource | What triggered the SOS |
message | SOS message |
positionSnapshot | Position at the time of the SOS, when available |
PermissionState
Aggregated permission snapshot for partner UI and gating logic.
| Field | Description |
|---|---|
location | Location permission status |
notifications | Notification permission status |
bluetooth | Bluetooth permission status |
bluetoothEnabled | Whether Bluetooth is enabled on the device |
hasLocationAccess | Computed: location permission granted |
hasNotificationAccess | Computed: notification permission granted |
canUseBluetooth | Computed: Bluetooth is permitted and enabled |
ProtectionStatus
Current Protection Mode runtime status, especially when native ownership is active.
| Field | Description |
|---|---|
modeState | Whether Protection Mode is armed, off, or degraded |
coverageLevel | Level of coverage provided |
runtimeState | Current runtime execution state |
bleOwner | Who owns BLE (Flutter or native service) |
protectedDeviceId | Device ID currently under protection |
serviceBleConnected | Whether native service BLE is connected |
serviceBleReady | Whether native service BLE is ready |
restorationConfigured | Whether restoration is configured |
reconnectAttemptCount | Number of reconnect attempts |
lastReconnectAttemptAt | Timestamp of last reconnect attempt |
degradationReason | Reason for degradation, if any |
lastCommandRoute | Route taken for the last command |
lastCommandResult | Result of the last command |
lastCommandError | Error from the last command, if any |
ProtectionDiagnostics
Detailed diagnostics for wake events, reconnects, queueing, and native command routing.
| Field | Description |
|---|---|
lastWakeReason | Reason for the last native wake event |
lastFailureReason | Most recent failure reason |
lastPlatformEvent | Last platform-level event |
lastRestorationEvent | Last state restoration event |
reconnectAttemptCount | Number of reconnect attempts |
lastReconnectAttemptAt | Timestamp of last reconnect attempt |
protectedDeviceId | Device ID under protection |
lastCommandRoute | Route taken for the last command |
lastCommandResult | Result of the last command |
lastCommandError | Error from the last command, if any |
pendingSosCount | Number of SOS events pending in the native queue |
pendingTelemetryCount | Number of telemetry events pending in the native queue |
BackendRegisteredDevice
Backend registry record for a device associated with the signed user.
| Field | Description |
|---|---|
id | Backend device record ID |
hardwareId | Canonical device hardware identifier |
firmwareVersion | Device firmware version |
hardwareModel | Device hardware model |
pairedAt | Pairing timestamp |
updatedAt | Last update timestamp |