​
px4.parameter.read

Open Platform PX4 parameter command. PX4 parameter: PARAM_REQUEST_READ Read a PX4 parameter value. The request model is ParameterReadRequest, and the terminal response is ParameterReadResponse, which normalizes PX4 PARAM_VALUE or PARAM_ERROR.

​
Request Params

​
vendor
string
required
Fixed value px4
​
device_id
string
required
Target PX4 device ID
​
command_type
string
required
Fixed value px4.parameter.read
​
idempotency_key
string
required
Idempotency key; repeated requests return the same command
​
timeout_seconds
integer
Timeout in seconds, range 0~300
​
payload
object
required
ParameterReadRequest parameter microservice payload
​
payload.param_id
string
required
ParameterReadRequest.param_id, the PX4 parameter name

​
PX4 Frame Mapping

  • MAVLink frame: PARAM_REQUEST_READ
  • Message ID: 20
  • Completion: ParameterReadResponse, carrying PARAM_VALUE / PARAM_ERROR
  • Guard: parameter reads still follow the real-downlink disabled-by-default policy.

​
Create Response

​
command_id
string
Platform command ID, used for follow-up queries
​
status
string
Acceptance status: ACCEPTED
​
accepted_at
string(datetime)
Command acceptance time (UTC)

​
Query Response

​
status
string
Execution status: ACCEPTED / DELIVERED / SUCCEEDED / FAILED / TIMED_OUT / UNMATCHED_RESPONSE
​
vendor_response
object
ParameterReadResponse summary, including the PARAM_VALUE or PARAM_ERROR result
curl -X POST "/api/v1/open/downlink/commands" \
  -H "Content-Type: application/json" \
  -H "X-Api-Id: YOUR_API_ID" \
  -H "X-Api-Timestamp: YOUR_UNIX_SECONDS" \
  -H "X-Api-Nonce: YOUR_NONCE" \
  -H "X-Api-Signature: YOUR_SIGNATURE" \
  -d "{\"vendor\":\"px4\",\"device_id\":\"px4-real-1\",\"command_type\":\"px4.parameter.read\",\"payload\":{\"param_id\":\"COM_RC_IN_MODE\"},\"idempotency_key\":\"req-read-COM_RC_IN_MODE-001\",\"timeout_seconds\":30}"

{
  "command_id": "8cdb5bf3-8902-c5f7-f9aa-dc7fa0af1de0",
  "status": "ACCEPTED",
  "accepted_at": "2026-06-15T00:00:00Z"
}