Time

API for communication with ZBOS by Zora Robotics.

Channels

zbos/time/info/get

PUB Get Time information, such as the accuracy

see zbos/time/info/response/\{key} for response

Channel tags

  • Time

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

zbos/time/info/response/\{key}

SUB response: Time information

Channel tags

  • Time

TimeInfo
Payload

Name

Type

Description

Accepted values

accurate

boolean

Any
Examples of payload
{
  "accurate": true
}

zbos/quiet/hours

PUB Quiet hours

Channel tags

  • Time

EmptyMessage

Empty message

zbos/scheduler/save

PUB Save schedule

Channel tags

  • Time

EmptyMessage

Empty message

zbos/scheduler/save/event

SUB event: Schedule saved

Channel tags

  • Time

SimpleScheduler
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any
Examples of payload
{
  "id": "string",
  "name": "string"
}

zbos/scheduler/load

PUB Get schedule

see zbos/scheduler/load/response/\{key} for response

Channel tags

  • Time

SimpleScheduler
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any
Examples of payload
{
  "id": "string"
}

zbos/scheduler/load/response/\{key}

SUB response: Get schedule

Channel tags

  • Time

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Example of payload (generated)
"string"

zbos/scheduler/delete

PUB Delete schedule

Channel tags

  • Time

SimpleScheduler
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any
Examples of payload
{
  "id": "string"
}

zbos/composition/delete/all

PUB Deletes all compositions

see zbos/composition/delete/response for response

Channel tags

  • Time

EmptyMessage

Empty message

zbos/scheduler/delete/event

SUB event: Schedule deleted

Channel tags

  • Time

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Example of payload (generated)
"string"

zbos/scheduler/list/get

PUB Get all schedules

see zbos/scheduler/list/response/\{key} for response

Channel tags

  • Time

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

zbos/scheduler/list/response/\{key}

SUB response: Get all schedules

Channel tags

  • Time

Array<SimpleScheduler>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. id

string

Any

Message Payload. name

string

Any
Examples of payload
{
  "id": "string",
  "name": "string"
}

zbos/scheduler/start

PUB Start schedule by name

Channel tags

  • Time

SimpleScheduler
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any
Examples of payload
{
  "name": "string"
}

zbos/scheduler/start/event

SUB event: Started schedule

Channel tags

  • Time

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Example of payload (generated)
"string"

zbos/scheduler/start/id

PUB Start schedule by id

Channel tags

  • Time

SimpleScheduler
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any
Examples of payload
{
  "id": "string"
}

zbos/scheduler/stop

PUB Stop schedule

Channel tags

  • Time

EmptyMessage

Empty message

zbos/scheduler/stop/event

SUB event: Schedule stopped

Channel tags

  • Time

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Example of payload (generated)
"string"

zbos/scheduler/current/get

PUB Get current schedule

see zbos/scheduler/current/get/response/\{key} for response

Channel tags

  • Time

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

zbos/scheduler/current/get/response/\{key}

SUB response: Get current schedule

Channel tags

  • Time

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Example of payload (generated)
"string"