Diagnostics

API for communication with ZBOS by Zora Robotics.

Channels

zbos/diagnostics/chassis/get

PUB Get diagnostics for chassis

see zbos/diagnostics/chassis/response/\{key} for response

Channel tags

  • Diagnostics

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any
Examples of payload
{
  "key": "ABCxyz"
}

zbos/diagnostics/chassis/event

SUB event: Chassis state changed

An event will be published when there is a problem detected with a motor or motor controller.

Channel tags

  • Diagnostics

DiagnosticState
Payload

Name

Type

Description

Accepted values

partId

string

Name of the part

Any

partType

string

Type of the part

* MOTOR * MOTOR_CONTROLLER * SERVO * SERVO_CONTROLLER * CPU * MEMORY * LIDAR * POWER_BOARD * BATTERY

info

object

Any

info. translationKey

string

status code

Any

info. message

string

status message

Any

temperature

string

optional, depending on robot

Any
Examples of payload
{}

zbos/diagnostics/chassis/response/\{key}

SUB response: Diagnostics chassis

Channel tags

  • Diagnostics

Array<DiagnosticState>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. partId

string

Name of the part

Any

Message Payload. partType

string

Type of the part

* MOTOR * MOTOR_CONTROLLER * SERVO * SERVO_CONTROLLER * CPU * MEMORY * LIDAR * POWER_BOARD * BATTERY

Message Payload. info

object

Any

Message Payload.info. translationKey

string

status code

Any

Message Payload.info. message

string

status message

Any

Message Payload. temperature

string

optional, depending on robot

Any
Examples of payload
{}

zbos/diagnostics/servos/get

PUB Get diagnostics for servos

see zbos/diagnostics/servos/response/\{key} for response

Channel tags

  • Diagnostics

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any
Examples of payload
{
  "key": "ABCxyz"
}

zbos/diagnostics/servos/event

SUB event: Servo state changed

An event will be published when there is a problem detected with a servo.

Channel tags

  • Diagnostics

DiagnosticState
Payload

Name

Type

Description

Accepted values

partId

string

Name of the part

Any

partType

string

Type of the part

* MOTOR * MOTOR_CONTROLLER * SERVO * SERVO_CONTROLLER * CPU * MEMORY * LIDAR * POWER_BOARD * BATTERY

info

object

Any

info. translationKey

string

status code

Any

info. message

string

status message

Any

temperature

string

optional, depending on robot

Any
Examples of payload
{}

zbos/diagnostics/servos/response/\{key}

SUB response: Diagnostics servos

Channel tags

  • Diagnostics

Array<DiagnosticState>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. partId

string

Name of the part

Any

Message Payload. partType

string

Type of the part

* MOTOR * MOTOR_CONTROLLER * SERVO * SERVO_CONTROLLER * CPU * MEMORY * LIDAR * POWER_BOARD * BATTERY

Message Payload. info

object

Any

Message Payload.info. translationKey

string

status code

Any

Message Payload.info. message

string

status message

Any

Message Payload. temperature

string

optional, depending on robot

Any
Examples of payload
{}