Commands

Create command definition

Create an actuator command definition on a digital device. Validation enforces mode/encoder/protocol constraints (direct = MQTT JSON payload, encoded = encoder pipeline).

Required scope: commands:write

post/api/v2/devices/{id}/commands

Request

  • Base URL: https://api.chirpwireless.io
  • URL: https://api.chirpwireless.io/api/v2/devices/{id}/commands
  • Auth: API key in header X-API-Key and API key in header X-Organization-Id

Path parameters

idstring required

Digital device ID

Request body

organizationIdstring required

Organization ID

Example request

{
  "command": {
    "name": "Set temperature",
    "fPort": 5,
    "mqttTopic": "shadow/dev/POK019/desired"
  }
}

Response

Command created (HTTP 201)

idstring
namestring
descriptionstring
mode'direct' | 'encoded'
paramsSchemaobject

Per-parameter JSON Schema subset, keyed by parameter name.

encodedParamsTemplateobject
directPayloadstring
customEncoderstring
fPortinteger
mqttTopicstring
confirmedboolean
verificationStrategy'no_verification' | 'wait_next_uplink' | 'query_after_ack'
queryCommandIdstring
convergenceTimeoutinteger
suitableAsQueryboolean
createdAtstring date-time
updatedAtstring date-time

Example response

{
  "name": "Set temperature"
}

Changes

No recorded changes to this operation across all 1 revision of this API.