# Protocol V1

# Changelog

14 Oct 2020:

  • Initial version of document

# Device Telemetry API

# Device Telemetry

Provides Device telemetry.

Will be published every 1 second.

telemetry/v1/{id}
Payload Field Description
timestamp Message publishing timestamp
... Device-specific fields

# Example

Topic

telemetry/v1/A0B1

Payload

{
  "timestamp": 1514320289,
  "uptime": 2
}

# Key/Value Storage API

# Set

Sets variable value.

variables/v1/set/{variable-name}
Payload Field Description
variable-name Variable name

# Example

Topic

variables/v1/set/pid_target_pressure

Payload

{
  "value": "30"
}

# Get

Receive notification on variable's value changes.

variables/v1/get/{variable-name}
Payload Field Description
variable-name Variable name

# Example

Topic

variables/v1/get/pid_target_pressure

Payload

{
  "timestamp": 1602699378,
  "value": "32"
}