Variables

API for communication with ZBOS by Zora Robotics.

Channels

zbos/variables/get

publish

Get all variables

Channel tags
  • Variables

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

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

zbos/variables/response/{key}

subscribe

response: Get all variables

Channel tags
  • Variables

Message GlobalVariables
Payload

Name

Type

Description

Accepted values

variables

array(object)

A list of all variables, not present when status is false.

Any

variables.name

string

Any

variables.value

string

Any

variables.id

string

Any

variables.state

string

Any

status

boolean

Will be present when status is false (error message)

Any

message

string

Any

Examples of payload
{
  "variables": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "status": true,
  "message": "string"
}

zbos/variables/set

publish

Set variables

Saving the global variables on the robot.see zbos/variables/set/response/{key} for response

Channel tags
  • Variables

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

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

zbos/variables/set/response/{key}

subscribe

response: indicates if the save was successful or not

Channel tags
  • Variables

Message GlobalVariables
Payload

Name

Type

Description

Accepted values

variables

array(object)

A list of all variables, not present when status is false.

Any

variables.name

string

Any

variables.value

string

Any

variables.id

string

Any

variables.state

string

Any

status

boolean

Will be present when status is false (error message)

Any

message

string

Any

Examples of payload
{
  "variables": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "status": true,
  "message": "string"
}