ZBOS MQTT API 2.2.0

API for communication with ZBOS by Zora Robotics.

Contact email: info@zorarobotics.be

Servers

127.0.0.1 mqtt

This is the local robot broker.

port:
ENUM: 1883, 9001 DEFAULT: 1883
zbos-mqtt.zoracloud.com mqtt

This is the cloud broker.

port:
ENUM: 1883, 1884, 9001, 9002

Operations

Pub zbos/motion/animation/run

Fires specific animation ID

Accepts the following message:

AnimationOptions

Payload
object
requestId
string
type
string
animationId
string

Additional properties are allowed.

motion

Examples

AnimationOptions
Payload
Example #1
{
  "requestId": "string",
  "type": "string",
  "animationId": "string"
}

Pub zbos/motion/animation/stop

Stops all animations

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

motion

Examples

EmptyMessage
Payload
{}
This example has been generated automatically.

Pub zbos/motion/animation/get

Get available animations

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

motion

Examples

KeyResult
Payload
Example #1
{
  "key": "ABCxyz"
}

Sub zbos/motion/animation/response/{key}

response: Get available animations

Parameters
key
required
string

Accepts the following message:

Array<AvailableAnimation>

Payload
array<object>

Items:

0
object
id
string
name
string
animation
string
type
string

Additional properties are allowed.

Additional items are allowed.

motion

Examples

Array<AvailableAnimation>
Payload
Example #1
{
  "id": "string",
  "name": "string",
  "animation": "string",
  "type": "string"
}

Pub zbos/motion/dance/start

Starts dance

Accepts the following message:

DanceOptions

Payload
object
requestId
string
danceId
string

Additional properties are allowed.

motion

Examples

DanceOptions
Payload
Example #1
{
  "requestId": "string",
  "danceId": "string"
}

Pub zbos/motion/dance/stop

Stops dance

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

motion

Examples

EmptyMessage
Payload
{}
This example has been generated automatically.

Pub zbos/motion/dance/get

Get available dances

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

motion

Examples

KeyResult
Payload
Example #1
{
  "key": "ABCxyz"
}

Sub zbos/motion/dance/response/{key}

response: Get available dances

Parameters
key
required
string

Accepts the following message:

Array<AvailableDance>

Payload
array<object>

Items:

0
object
id
string
name
string
animation
string
song
string

Additional properties are allowed.

Additional items are allowed.

motion

Examples

Array<AvailableDance>
Payload
Example #1
{
  "id": "string",
  "name": "string",
  "animation": "string",
  "song": "string"
}

Pub zbos/motion/control/head

Get available animations

Accepts the following message:

MobilityActionOptions

Payload
object
requestId
string
yaw
number
pitch
number
degree
number
force
number
distance
number

In meters

relativeRotation
number