Variables

API for communication with ZBOS by Zora Robotics.

Channels

zbos/variables/get

PUB Get all variables

see zbos/variables/response/\{key} for response

Channel tags

  • Variables

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

zbos/variables/response/\{key}

SUB response: Get all variables

Channel tags

  • Variables

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. default

boolean

True if this is a default system variable and cannot be deleted

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",
      "default": true
    }
  ],
  "status": true,
  "message": "string"
}

zbos/variables/set

PUB Set variables

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

Channel tags

  • Variables

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. default

boolean

True if this is a default system variable and cannot be deleted

Any

variables. id

string

Any

variables. state

string

Any

status

boolean

Will be present when status is false (error message)

Any

message

string

Any
Example of payload (generated)
{
  "variables": [
    {
      "name": "string",
      "value": "string",
      "default": true,
      "id": "string",
      "state": "string"
    }
  ],
  "status": true,
  "message": "string"
}

zbos/variables/set/response/\{key}

SUB response: indicates if the save was successful or not

Channel tags

  • Variables

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. default

boolean

True if this is a default system variable and cannot be deleted

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/value

PUB Set variable value

Channel tags

  • Variables

SetValueRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

variable

object

Any

variable. name

string

Any

variable. value

string

Any

variable. default

boolean

True if this is a default system variable and cannot be deleted

Any

variable. id

string

Any

variable. state

string

Any
Examples of payload
{
  "key": "test",
  "variable": {
    "name": "variableName",
    "value": "newValue"
  }
}

zbos/variables/set/value/response/\{key}

SUB response: Set variable value

Channel tags

  • Variables

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}