Skip to content

Device Operation Reference

A user intent requested through SenHub Web or SenCLI is planned once by the shared platform service into one canonical DeviceOperationPlan. For local hardware actions, either product can provide an eligible executor implementation; they do not define separate installation or flashing semantics.

Tutorials explain how to complete a task. This Reference defines the exact values exchanged by API, Web, CLI, and executor implementations.

Executor capability matching explains how a plan is assigned to Web or SenCLI.

Intents

ValueMeaning
installResolve the target and execute the complete installation workflow selected by SenHub.
flash_firmwareWrite a firmware artifact to a compatible local target through an eligible executor.
ota_firmwareDeliver a firmware artifact through the device runtime route without a local cable.
install_applicationInstall the selected Application artifact while preserving its published identity.
install_configInstall a verified .sencfg configuration artifact and its logical snapshot identity.
install_licenseInstall a license artifact through the managed operation and verification workflow.
install_secretsCollect requested secret inputs for execution without persisting plaintext values in the intent or plan.

Plan actions

ValueMeaning
provider_operationAsk an executor provider to perform a declared local capability such as target inspection or ROM flashing.
runtime_commandSend one versioned SenCore command through the route selected by the plan.
input_command_setResolve an operation input request and execute its declared runtime command without storing the submitted value in the plan.
artifact_transferTransfer a digest-pinned artifact in chunks using commands and state transitions declared by the plan.
runtime_checkpointReacquire a runtime route, execute checkpoint commands, and evaluate response assertions.

Statuses

ValueMeaning
CREATEDCanonical statuses value.
INSPECTINGCanonical statuses value.
PLANNINGCanonical statuses value.
WAITING_FOR_EXECUTORCanonical statuses value.
WAITING_FOR_INPUTCanonical statuses value.
PREFLIGHTCanonical statuses value.
EXECUTINGCanonical statuses value.
VERIFYINGCanonical statuses value.
BLOCKEDCanonical statuses value.
SUCCEEDEDCanonical statuses value.
FAILEDCanonical statuses value.
CANCELEDCanonical statuses value.

Errors

ValueMeaning
invalid_intentCanonical errors value.
target_not_foundCanonical errors value.
target_facts_incompleteCanonical errors value.
target_facts_changedCanonical errors value.
board_mismatchCanonical errors value.
artifact_digest_mismatchCanonical errors value.
capability_unavailableCanonical errors value.
executor_disconnectedCanonical errors value.
device_busyCanonical errors value.
input_requiredCanonical errors value.
input_canceledCanonical errors value.
device_command_failedCanonical errors value.
verification_failedCanonical errors value.
operation_canceledCanonical errors value.

Contract details

FieldValue
Contractdevice_operation
Schema version1.0
Was this page helpful?

A cross-hardware capability platform for intelligent devices.