Skip to main content

AsyncAPI MQTT contract

This page is for people. The AsyncAPI YAML file is the machine-readable transport contract for developer tools and should normally be downloaded rather than opened as a styled web page.

What it contains​

  • The exact default downlink topic: /{ProductKey}/{DeviceName}/user/get.
  • The exact default uplink topic: /{ProductKey}/{DeviceName}/user/update.
  • Server-to-cabinet and cabinet-to-server operations.
  • The ASCII frame envelope and synthetic examples with valid CRC.
  • Links by convention to the complete command catalog.

What remains profile-specific​

  • The production MQTT/IoT host and port.
  • Authentication values, device secrets and certificates.
  • The actual ProductKey and DeviceName.
  • The supported command/firmware matrix for the purchased cabinet.
  • Rate, timeout and rollout limits selected for the operator.

The reserved mqtt.example.invalid server in the YAML cannot be reached and is intentionally safe. It preserves a valid tool-import shape without leaking production access.

  1. Read this guide and the frame/command map.
  2. Download the command catalog JSON.
  3. Import the AsyncAPI YAML into your documentation or event-contract tool.
  4. Use the reference code and test vectors.
  5. Replace only the authorized profile values in your server-side configuration.