ZBOS MQTT API 2.4.2

Operations

Messages

ZBOS MQTT API 2.4.2

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/applications/categories/get

Get application categories

Get all application categories.

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Applications

Examples

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

Sub zbos/applications/categories/get/response/{key}

Response: Get application categories

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<ApplicationCategory>

Payload
array<object>
id
string
name
string

Use name for a static name, or name_key for a translatable name

name_key
string

Use name for a static name, or name_key for a translatable name

weight
integer

Additional items are allowed.

Applications

Examples

Array<ApplicationCategory>
Payload
Example #1
{
  "id": "category_1",
  "name": "Category 1",
  "weight": 10
}
Example #2
{
  "id": "category_2",
  "weight": 20,
  "name_key": "category_2_key"
}

Pub zbos/applications/apps/get

Get applications

Get all applications with optional filters.

Accepts the following message:

GetApplicationsRequest

Payload
object
key
string
limit
integer
offset
integer
filters
array<object>
field
string

Field to check on. Note that the field should be camelCase, not snake_case

value
string

Value to check on. For numbers you should use 'min' and 'max'.

min
number

Minimum value, only usable for number fields

max
number

Maximum value, only usable for number fields

direction
object

Direction to sort on. Can be 'asc' or 'desc'. The default direction is 'asc'

Enum: "ASC" "DESC"
name
string
ordinal
integer

Additional properties are allowed.

operator
object

Operator for either the child filters, or this filter object itself. Can be 'and', 'or' or 'not'. Default is 'and'. The root operator is always 'and'

Enum: "AND" "OR" "NOT"
name
string
ordinal
integer

Additional properties are allowed.

match_type
object

Match type for string values. Can be 'exact', 'contains', 'starts_with', 'ends_with'. The default match_type is 'contains'

Enum: "EXACT" "CONTAINS" "STARTS_WITH" "ENDS_WITH"
name
string
ordinal
integer

Additional properties are allowed.

filters
array<object>

Filters on which the operator will be applied. If there are no child filters, the operator will be applied to the filter object itself.

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

field_filters
array<object>

Filters to apply on the child fields of the field. Will only work if the field is an object, array/list or map.

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

Additional items are allowed.

language
string

Optional. Set the language to have all translations filled in. The language format is ISO 639-1 language code, Eg: 'en' or 'en-US'

Additional properties are allowed.

Applications

Examples

GetApplicationsRequest
Payload
Example #1
{
  "key": "abc",
  "limit": 20,
  "offset": 20,
  "filters": [
    {
      "field": "category_id",
      "value": "category_1",
      "operator": "and",
      "filters": [
        {
          "field": "category_id",
          "value": "category_1",
          "operator": "and",
          "match_type": "exact"
        }
      ],
      "match_type": "exact"
    }
  ]
}

Sub zbos/applications/apps/get/response/{key}

Response: Get applications

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<Application>

Payload
array<object>
id
string

This could be a package name, or some other defined unique ID

name
string

Use name for a static name, or name_key for a translatable name

name_key
string

Use name for a static name, or name_key for a translatable name

category_id
string
weight
integer
actions
array<object>
application_id
string
name
string

Use name for a static name, or name_key for a translatable name

name_key
string

Use name for a static name, or name_key for a translatable name

type
object

List of available actions: open: Opens an application handled by the RAILopen_control: Opens an application handled by the control settings: Opens the settings, handled by the control datasource: Edit the datasource, handled by the control other: Should be handled by the app itself

Enum: "OPEN" "OPEN_CONTROL" "SETTINGS" "DATASOURCES" "OTHER"
name
string
ordinal
integer

Additional properties are allowed.

data
object

Optional data that an action might need.

Additional properties are allowed.

Additional items are allowed.

Additional items are allowed.

Applications

Examples

Array<Application>
Payload
Example #1
{
  "id": "com.zorabots.application.one",
  "name": "Application 1",
  "weight": 10,
  "actions": [
    {
      "name": "Open",
      "type": "open",
      "data": {
        "key1": "value1"
      },
      "valid": true,
      "application_id": "com.zorabots.application.one"
    },
    {
      "name": "Settings",
      "type": "settings",
      "valid": true,
      "application_id": "com.zorabots.application.one"
    },
    {
      "name": "Datasource",
      "type": "datasources",
      "valid": true,
      "application_id": "com.zorabots.application.one"
    }
  ],
  "category_id": "category_1"
}
Example #2
{
  "id": "com.zorabots.application.two",
  "weight": 20,
  "actions": [
    {
      "type": "open",
      "data": {
        "key1": "value1"
      },
      "valid": true,
      "application_id": "com.zorabots.application.two",
      "name_key": "Open"
    },
    {
      "name": "Some other action",
      "type": "other",
      "data": {
        "key1": "value1"
      },
      "valid": true,
      "application_id": "com.zorabots.application.two"
    }
  ],
  "name_key": "application_2_key",
  "category_id": "category_1"
}

Pub zbos/applications/apps/changed/event/{app}

Application changed

Fired when an app was added or changed.

Parameters
app
required
string

ID of the app that was changed

Accepts the following message:

Application

Payload
object
id
string

This could be a package name, or some other defined unique ID

name
string

Use name for a static name, or name_key for a translatable name

name_key
string

Use name for a static name, or name_key for a translatable name

category_id
string
weight
integer
actions
array<object>
application_id
string
name
string

Use name for a static name, or name_key for a translatable name

name_key
string

Use name for a static name, or name_key for a translatable name

type
object

List of available actions: open: Opens an application handled by the RAILopen_control: Opens an application handled by the control settings: Opens the settings, handled by the control datasource: Edit the datasource, handled by the control other: Should be handled by the app itself

Enum: "OPEN" "OPEN_CONTROL" "SETTINGS" "DATASOURCES" "OTHER"
name
string
ordinal
integer

Additional properties are allowed.

data
object

Optional data that an action might need.

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

Applications

Examples

Application
Payload
Example #1
{
  "id": "com.zorabots.application.one",
  "name": "Application 1",
  "weight": 10,
  "actions": [
    {
      "name": "Open",
      "type": "open",
      "data": {
        "key1": "value1"
      },
      "valid": true,
      "application_id": "com.zorabots.application.one"
    },
    {
      "name": "Settings",
      "type": "settings",
      "valid": true,
      "application_id": "com.zorabots.application.one"
    },
    {
      "name": "Datasource",
      "type": "datasources",
      "valid": true,
      "application_id": "com.zorabots.application.one"
    }
  ],
  "category_id": "category_1"
}

Pub zbos/applications/icons/get

Get application icon

Get the application icons for the passed application ID.

Accepts the following message:

GetApplicationIconRequest

Payload
object
key
string
max_width
integer

Optional, can be used to decrease payload size

max_height
integer

Optional, can be used to decrease payload size

application_id
string

Additional properties are allowed.

Applications

Examples

GetApplicationIconRequest
Payload
Example #1
{
  "key": "abc",
  "valid": true,
  "max_width": 100,
  "max_height": 100,
  "application_id": "com.zorabots.application.one"
}

Sub zbos/applications/icons/get/response/{key}

Response: Get application icon

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

ApplicationIcon

Payload
object
application_id
string
icon
string

Base 64 encoded PNG

Additional properties are allowed.

Applications

Examples

ApplicationIcon
Payload
Example #1
{
  "icon": "{base64 encoded png}",
  "application_id": "com.zorabots.application.one"
}

Pub zbos/applications/actions/start

Start application action

Start an application action.

Accepts the following message:

ApplicationAction

Payload
object
application_id
string
name
string

Use name for a static name, or name_key for a translatable name

name_key
string

Use name for a static name, or name_key for a translatable name

type
object

List of available actions: open: Opens an application handled by the RAILopen_control: Opens an application handled by the control settings: Opens the settings, handled by the control datasource: Edit the datasource, handled by the control other: Should be handled by the app itself

Enum: "OPEN" "OPEN_CONTROL" "SETTINGS" "DATASOURCES" "OTHER"
name
string
ordinal
integer

Additional properties are allowed.

data
object

Optional data that an action might need.

Additional properties are allowed.

Additional properties are allowed.

Applications

Examples

ApplicationAction
Payload
Example #1
{
  "name": "Open",
  "type": "open",
  "data": {
    "key1": "value1"
  },
  "valid": true,
  "application_id": "com.zorabots.application.one"
}
Example #2
{
  "name": "Settings",
  "type": "settings",
  "valid": true,
  "application_id": "com.zorabots.application.one"
}
Example #3
{
  "name": "Datasource",
  "type": "datasources",
  "valid": true,
  "application_id": "com.zorabots.application.one"
}
Example #4
{
  "name": "Some other action",
  "type": "other",
  "data": {
    "key1": "value1"
  },
  "valid": true,
  "application_id": "com.zorabots.application.one"
}

Sub zbos/applications/actions/start/response/{key}

Response: Start application action

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Applications

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/applications/registration/request

Request application registrations

Request all apps to register themselves using the topics below.

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Applications

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/applications/registration/add

Add application registration

Registers an application to the applications list. Should be executed every time the application is started.

Accepts the following message:

RegisterApplicationRequest

Payload
object
key
string
application
object
id
string

This could be a package name, or some other defined unique ID

name
string

Use name for a static name, or name_key for a translatable name

name_key
string

Use name for a static name, or name_key for a translatable name

category_id
string
weight
integer
actions
array<object>
application_id
string
name
string

Use name for a static name, or name_key for a translatable name

name_key
string

Use name for a static name, or name_key for a translatable name

type
object

List of available actions: open: Opens an application handled by the RAILopen_control: Opens an application handled by the control settings: Opens the settings, handled by the control datasource: Edit the datasource, handled by the control other: Should be handled by the app itself

Enum: "OPEN" "OPEN_CONTROL" "SETTINGS" "DATASOURCES" "OTHER"
name
string
ordinal
integer

Additional properties are allowed.

data
object

Optional data that an action might need.

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

Additional properties are allowed.

Applications

Examples

RegisterApplicationRequest
Payload
Example #1
{
  "key": "abc",
  "application": {
    "id": "com.zorabots.application.one",
    "name": "Application 1",
    "weight": 10,
    "actions": [
      {
        "name": "Open",
        "type": "open",
        "data": {
          "key1": "value1"
        },
        "valid": true,
        "application_id": "com.zorabots.application.one"
      },
      {
        "name": "Settings",
        "type": "settings",
        "valid": true,
        "application_id": "com.zorabots.application.one"
      }
    ],
    "category_id": "category_1"
  },
  "valid": false
}

Pub zbos/applications/registration/add/response/{key}

Response: Add application registration

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Applications

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/applications/registration/remove

Remove application registration

Unregister an application from the applications list.

Accepts the following message:

UnregisterApplicationRequest

Payload
object
key
string
id
string

Additional properties are allowed.

Applications

Examples

UnregisterApplicationRequest
Payload
Example #1
{
  "key": "abc",
  "id": "com.zorabots.application.one",
  "valid": true
}

Pub zbos/applications/registration/remove/response/{key}

Response: Remove application registration

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Applications

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/applications/datasources/get

Get the content of a specific application datasource file

Publish on this topic to get the content of a datasource Payload is json with a key for the response topic {"key":aKey}

Accepts the following message:

DatasourceGetRequest

Payload
object
applicationName
string
datasourceId
string

Additional properties are allowed.

Applications

Examples

DatasourceGetRequest
Payload
Example #1
{
  "applicationName": "string",
  "datasourceId": "string",
  "valid": true
}

Sub zbos/applications/datasources/get/response/{key}

Response: Get datasource

Will return a JSON string with the content of the datasource data file

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
Applications

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/applications/datasources/set

Save the datasource

Publish on this topic to save the datasource data (changes) Payload is json with a key for the response topic {"key":aKey} The Payload is a JSON string of an object with following keys: application name, datasource id and datasource data

Accepts the following message:

DatasourceSetRequest

Payload
object
applicationName
string
datasourceId
string
datasourceData
string

Additional properties are allowed.

Applications

Examples

DatasourceSetRequest
Payload
Example #1
{
  "applicationName": "string",
  "datasourceId": "string",
  "datasourceData": "string",
  "valid": true
}

Sub zbos/applications/datasources/set/response/{key}

Response: Datasource saved

A message object (with key 'success') is publish on this topic when the datasource has been saved

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Applications

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/audio/player/start

Play media

Play specific media file from path

Accepts the following message:

String

Payload
string
Audio

Examples

String
Payload
Example #1
{
  "requestId": "1",
  "url": "Url"
}

Pub zbos/audio/player/stop

Stop media

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Audio

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/audio/player/ended

Media ended

Accepts the following message:

String

Payload
string
Audio

Examples

String
Payload
Example #1
{
  "requestId": "1",
  "url": "Url"
}

Pub zbos/audio/player/pause

Pause media

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Audio

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/audio/player/resume

Resume media

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Audio

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/audio/volume/set

Set volume

Accepts the following message:

Int

Payload
integer
>= 0 <= 100
Audio

Examples

Int
Payload 
""
This example has been generated automatically.

Pub zbos/audio/volume/get

Get volume

see <<zbos/audio/volume/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Audio

Examples

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

Sub zbos/audio/volume/response/{key}

response: Get volume

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Int

Payload
integer
>= 0 <= 100
Audio

Examples

Int
Payload 
""
This example has been generated automatically.

Sub zbos/audio/volume/event

event: Volume change

Notify subscribers of a volume change.

Accepts the following message:

Int

Payload
integer
>= 0 <= 100
Audio

Examples

Int
Payload 
""
This example has been generated automatically.

Pub zbos/audio/beep

Play beep

Publish to play a beep sound. Used by the robot when the hot word is recognized.

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Audio

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/camera/picture/get

Get picture

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Camera

Examples

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

Pub zbos/camera/picture/event

event: Get picture

Picture in base64 formatsee zbos/facetracking/response for response

Accepts the following message:

String

Payload
string
Face tracking

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/camera/stream/start

Start the camera stream of the selected camera.

Accepts the following message:

StreamStartRequest

Payload
object
cameraId
string

Camera id

extras
object

Additional properties are allowed.

Additional properties are allowed.

Camera

Examples

StreamStartRequest
Payload
Example #1
{
  "cameraId": "string",
  "extras": {}
}

Pub zbos/camera/stream/stop

Stop camera stream

Accepts the following message:

VideoOptions

Payload
object
requestId
string
cameraId
string

camera id

Additional properties are allowed.

Camera

Examples

VideoOptions
Payload
Example #1
{
  "requestId": "string",
  "cameraId": "string"
}

Sub zbos/camera/stream/stop/event

Camera stream has stopped

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Camera

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/camera/stream/init

Initialize camera stream

Send by the robot to start the webrtc handshake

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Camera

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/camera/stream/offer

WebRTC Session Description

Handsake offer for camera stream

Accepts the following message:

String

Payload
string
Camera

Examples

String
Payload 
"string"
This example has been generated automatically.

Sub zbos/camera/stream/answer

WebRTC Session Description

Handsake answer for camera stream

Accepts the following message:

StreamAnswer

Payload
object
type
object
Enum: "OFFER" "PRANSWER" "ANSWER"
name
string
ordinal
integer

Additional properties are allowed.

sdp
string

Additional properties are allowed.

Camera

Examples

StreamAnswer
Payload
Example #1
{
  "type": "ANSWER",
  "sdp": "string"
}

Sub zbos/camera/stream/candidate/core

WebRTC Session Description

RTC ICE Candidate Core

Accepts the following message:

Candidate

Payload
object
cameraId
string

camera id

type
string

Always returns "candidate"

label
integer

sdpMLineIndex

id
string

sdpMid

candidate
string

Additional properties are allowed.

Camera

Examples

Candidate
Payload
Example #1
{
  "cameraId": "string",
  "type": "string",
  "label": 5,
  "id": "string",
  "candidate": "string"
}

Sub zbos/camera/stream/candidate/control

RTC ICE Candidate Control

Accepts the following message:

Candidate

Payload
object
cameraId
string

camera id

type
string

Always returns "candidate"

label
integer

sdpMLineIndex

id
string

sdpMid

candidate
string

Additional properties are allowed.

Camera

Examples

Candidate
Payload
Example #1
{
  "cameraId": "string",
  "type": "string",
  "label": 5,
  "id": "string",
  "candidate": "string"
}

Pub zbos/camera/stream/twoway/request

Request two way camera stream

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Camera

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/camera/preview/resume

Resume camera preview

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Camera

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/camera/preview/pause

Pause camera preview

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Camera

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/camera/error

Camera error

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Camera

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/camera/qr/scan/start

Start QR Scanning

Start a QR code scan using the camera.

Accepts the following message:

QrScanStartRequest

Payload
object
scan_id
string

Unique ID that will be used in related topics.

scan_timeout
integer

Timeout in seconds after which the scan should automatically be stopped. Pass 0 to not have a timeout. 0 is also the default when no value was passed.

Additional properties are allowed.

Camera

Examples

QrScanStartRequest
Payload
Example #1
{
  "scan_id": "abc",
  "scan_timeout": 60
}
Example #2
{
  "scan_id": "xyz",
  "scan_timeout": 0
}

Pub zbos/camera/qr/scan/stop

Stop QR Scanning

Stop a QR code scan using the camera.

Accepts the following message:

QrScanStopRequest

Payload
object
scan_id
string

Unique ID that should be the same as the one used in the start request.

Additional properties are allowed.

Camera

Examples

QrScanStopRequest
Payload
Example #1
{
  "scan_id": "abc"
}

Sub zbos/camera/qr/scan/stopped/event

Event: Stopped QR scanning

This event is published when a QR scan has stopped, either manually or due to a timeout.

Accepts the following message:

QrScanStoppedEvent

Payload
object
scan_id
string

Unique ID that will be the same as the one used in the start request.

Additional properties are allowed.

Camera

Examples

QrScanStoppedEvent
Payload
Example #1
{
  "scan_id": "abc"
}

Sub zbos/camera/qr/result/event

QR Result Event

This event is published every time a QR code is decoded while a scan is active.

Accepts the following message:

QrResultEvent

Payload
object
content
string

Additional properties are allowed.

Camera

Examples

QrResultEvent
Payload
Example #1
{
  "content": "QR Code Content"
}

Pub zbos/cloud/login

Login to the cloud

see <<zbos/cloud/login/response>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Cloud

Examples

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

Sub zbos/cloud/login/response

response: Login to the cloud

Response indicating if login to the cloud was successful or not

Accepts the following message:

LoginResponse

Payload
object
token
string

jwt auth token

success
boolean

Additional properties are allowed.

Cloud

Examples

LoginResponse
Payload
Example #1
{
  "token": "string",
  "success": true
}

Pub zbos/cloud/config/get

Get cloud config

see <<zbos/cloud/config/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Cloud

Examples

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

Sub zbos/cloud/config/response/{key}

response: Get cloud config

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Map

Payload
object

Additional properties are allowed.

Cloud

Examples

Map
Payload 
{}
This example has been generated automatically.

Pub zbos/cloud/config/set

Set cloud config

Accepts the following message:

Map

Payload
object

Additional properties are allowed.

Cloud

Examples

Map
Payload 
{}
This example has been generated automatically.

Sub zbos/cloud/config/event

event: Config cloud

Accepts the following message:

Map

Payload
object

Additional properties are allowed.

Cloud

Examples

Map
Payload 
{}
This example has been generated automatically.

Pub zbos/media/library/resync

Resync all media libraries

see <<zbos/media/library/resync/response/{key}>> for response

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Cloud

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/media/library/resync/response/{key}

response: Resync all media libraries

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Cloud

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/media/library/file/upload

Upload file in media library

see <<zbos/media/library/file/upload/response/{key}>> for response

Accepts the following message:

FileUploadRequest

Payload
object
file
string
storageAccount
string
key
string
metadata
object

Additional properties are allowed.

Additional properties are allowed.

Cloud

Examples

FileUploadRequest
Payload
Example #1
{
  "file": "string",
  "storageAccount": "string",
  "key": "string",
  "metadata": {}
}

Sub zbos/media/library/file/upload/response/{key}

response: Upload file in media library

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

CloudResult

Payload
object
success
boolean
cloudFileId
string

Additional properties are allowed.

Cloud

Examples

CloudResult
Payload
Example #1
{
  "success": false,
  "cloudFileId": "string"
}

Pub zbos/composition/start

Start composition

Payload is composition json

Accepts the following message:

String

Payload
string
Composer

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/composition/start/id

Start composition by id

Accepts the following message:

SimpleComposition

Payload
object
id
string
name
string
type
object
Enum: "SIMPLE_COMPOSITION" "ADVANCED_COMPOSITION"
name
string
ordinal
integer

Additional properties are allowed.

settings
object
pinned
boolean
schedulerParallel
boolean

Additional properties are allowed.

Additional properties are allowed.

Composer

Examples

SimpleComposition
Payload
Example #1
{
  "id": "string",
  "name": "string",
  "type": "SIMPLE_COMPOSITION",
  "settings": {
    "pinned": false,
    "schedulerParallel": false
  }
}

Sub zbos/{source}/start/event

event: Composition started

Parameters
source
required
string

The source that this composition belongs to

Enum: "scheduler/timeline" "composition"

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Composer

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/{source}/stop

Stop composition

Parameters
source
required
string

The source that this composition belongs to

Enum: "scheduler/timeline" "composition"

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Composer

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/{source}/stop/event

event: Composition stopped

Parameters
source
required
string

The source that this composition belongs to

Enum: "scheduler/timeline" "composition"

Accepts the following message:

String

Payload
string
Composer

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/composition/pause

Pause composition

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Composer

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/composition/pause/event

event: Composition paused

Timeline ID

Accepts the following message:

String

Payload
string
Composer

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/composition/resume

Resume composition

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Composer

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/composition/resume/event

event: Composition Resumed

Accepts the following message:

String

Payload
string
Composer

Examples

String
Payload 
"string"
This example has been generated automatically.

Sub zbos/{source}/loop/event

event: Composition loop state

Parameters
source
required
string

The source that this composition belongs to

Enum: "scheduler/timeline" "composition"

Accepts the following message:

LoopProperty

Payload
object
infinite
boolean
repeatTimes
integer

Total loop count

currentRepeatTimes
integer

current loop count

Additional properties are allowed.

Composer

Examples

LoopProperty
Payload
Example #1
{
  "infinite": true,
  "currentRepeatTimes": 3
}

Pub zbos/composition/settings

Settings for a given composition

Accepts the following message:

TimelinePropertiesWrapper

Payload
object
properties
object
loop
object
infinite
boolean
repeatTimes
integer

Total loop count

currentRepeatTimes
integer

current loop count

Additional properties are allowed.

general
object
stoppable
boolean
powerManagement
object
Enum: "DEFAULT" "AWARE" "DISABLED"
name
string
ordinal
integer

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

timelineId
string

Composition ID

isScheduler
boolean
isPinned
boolean
type
object
Enum: "SIMPLE_COMPOSITION" "ADVANCED_COMPOSITION"
name
string
ordinal
integer

Additional properties are allowed.

Additional properties are allowed.

Composer

Examples

TimelinePropertiesWrapper
Payload
Example #1
{}

Pub zbos/composition/save

Save composition

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Composer

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/composition/save/multiple

Save multiple compositions

see <<zbos/composition/save/multiple/response/{key}>> for response

Accepts the following message:

SaveMultipleCompositionRequest

Payload
object
key
string

Required key

compositions
array<object>

Array of compositions

id
string
name
string
type
object
Enum: "SIMPLE_COMPOSITION" "ADVANCED_COMPOSITION"
name
string
ordinal
integer

Additional properties are allowed.

settings
object
pinned
boolean
schedulerParallel
boolean

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

Composer

Examples

SaveMultipleCompositionRequest
Payload
Example #1
{
  "compositions": [
    {
      "id": "string",
      "name": "string",
      "type": "SIMPLE_COMPOSITION",
      "settings": {
        "pinned": false,
        "schedulerParallel": false
      }
    }
  ]
}

Sub zbos/composition/save/event

event: Composition Saved

Accepts the following message:

SimpleComposition

Payload
object
id
string
name
string
type
object
Enum: "SIMPLE_COMPOSITION" "ADVANCED_COMPOSITION"
name
string
ordinal
integer

Additional properties are allowed.

settings
object
pinned
boolean
schedulerParallel
boolean

Additional properties are allowed.

Additional properties are allowed.

Composer

Examples

SimpleComposition
Payload
Example #1
{
  "id": "string"
}

Sub zbos/composition/save/multiple/response/{key}

response: Save multiple compositions

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Map

Payload
object

Additional properties are allowed.

Composer

Examples

Map
Payload 
{}
This example has been generated automatically.

Pub zbos/composition/load

Load composition

Accepts the following message:

SimpleComposition

Payload
object
id
string
name
string
type
object
Enum: "SIMPLE_COMPOSITION" "ADVANCED_COMPOSITION"
name
string
ordinal
integer

Additional properties are allowed.

settings
object
pinned
boolean
schedulerParallel
boolean

Additional properties are allowed.

Additional properties are allowed.

Composer

Examples

SimpleComposition
Payload
Example #1
{
  "id": "string"
}

Sub zbos/composition/load/event

event: Composition loaded

Accepts the following message:

String

Payload
string
Composer

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/composition/list

Get list of compositions

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Composer

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/composition/list/event

event: Get list of compositions

Accepts the following message:

Array<SimpleComposition>

Payload
array<object>
id
string
name
string
type
object
Enum: "SIMPLE_COMPOSITION" "ADVANCED_COMPOSITION"
name
string
ordinal
integer

Additional properties are allowed.

settings
object
pinned
boolean
schedulerParallel
boolean

Additional properties are allowed.

Additional items are allowed.

Composer

Examples

Array<SimpleComposition>
Payload
Example #1
{
  "id": "string",
  "name": "string",
  "type": "SIMPLE_COMPOSITION",
  "settings": {
    "pinned": false,
    "schedulerParallel": false
  }
}

Pub zbos/composition/delete

Delete composition by id

see <<zbos/composition/delete/response>> for response

Accepts the following message:

SimpleComposition

Payload
object
id
string
name
string
type
object
Enum: "SIMPLE_COMPOSITION" "ADVANCED_COMPOSITION"
name
string
ordinal
integer

Additional properties are allowed.

settings
object
pinned
boolean
schedulerParallel
boolean

Additional properties are allowed.

Additional properties are allowed.

Composer

Examples

SimpleComposition
Payload
Example #1
{
  "id": "string"
}

Pub zbos/composition/delete/all

Deletes all compositions

see <<zbos/composition/delete/response>> for response

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Composer

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/composition/delete/response

response: Delete composition

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Composer

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Sub zbos/composition/changed/event

event: Composition changed

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Composer

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/composition/audio/stop

Stop audio composition

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Composer

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/composition/video/stop

Stop video composition

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Composer

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/composition/image/stop

Stop image composition

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Composer

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/composition/error

event: Composition encountered error

List of possible error reasons: 'INVALID_ID': The block id is malformed/broken. 'INVALID_TYPE': The block type is malformed/broken. 'INVALID_BLOCK': One of the properties aside from id and type is malformed/broken.

Accepts the following message:

CompositionError

Payload
object
type
string

Block type that caused the error, 'UNKNOWN' if not known

id
string

Block ID that caused the error, 'UNKNOWN' if not known

reasons
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Composer

Examples

CompositionError
Payload
Example #1
{
  "type": "string",
  "id": "string"
}

Pub zbos/api/request

Get api

see <<zbos/api/response/{key}>> for response

Accepts the following message:

ApiRequestBlock

Payload
object
name
string
endpoint
string
body
string
params
object

Additional properties are allowed.

headers
object

Additional properties are allowed.

Additional properties are allowed.

Composer

Examples

ApiRequestBlock
Payload
Example #1
{}

Sub zbos/api/response/{key}

response: Get api

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
Composer

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/composition/default/variable/request

Get default composition variables

Payload "key" is optionalsee <<zbos/composition/default/variable/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Composer

Examples

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

Sub zbos/composition/default/variable/response/{key}

response: Get default composition variables

Payload is array of variable names

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<String>

Payload
array<string>

Items:

0
string

Additional items are allowed.

Composer

Examples

Array<String>
Payload 
[
  "string"
]
This example has been generated automatically.

Pub zbos/composition/status/get

Get composition statussee <<zbos/composition/status/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Composer

Examples

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

Sub zbos/composition/status/response/{key}

response: Composition status

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

CompositionStatus

Payload
object
id
string
state
object

Default, playing or paused

Enum: "DEFAULT" "PLAYING" "PAUSED"
name
string
ordinal
integer

Additional properties are allowed.

activeBlocks
array<string>

Items:

0
string

Additional items are allowed.

properties
object

Composition properties

loop
object
infinite
boolean
repeatTimes
integer

Total loop count

currentRepeatTimes
integer

current loop count

Additional properties are allowed.

general
object
stoppable
boolean
powerManagement
object
Enum: "DEFAULT" "AWARE" "DISABLED"
name
string
ordinal
integer

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

playCount
integer

Current repeat iteration

Additional properties are allowed.

Composer

Examples

CompositionStatus
Payload
Example #1
{
  "id": "string",
  "state": "DEFAULT",
  "activeBlocks": [
    "string"
  ],
  "properties": {
    "loop": {
      "infinite": true,
      "currentRepeatTimes": 3
    },
    "general": {
      "powerManagement": "DEFAULT"
    }
  },
  "playCount": 5
}

Pub zbos/composition/block/start

Start composition block

Accepts the following message:

Block

Payload
object
id
string

Block ID

index
integer
blocking
boolean
input
object
connectors
array<object>
id
string
connection
object
blockId
string
connectorId
string

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

output
object
connectors
array<object>
id
string
connection
object
blockId
string
connectorId
string

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

nextBlockId
string

Additional properties are allowed.

Composer

Examples

Block
Payload
Example #1
{
  "index": 5,
  "blocking": false,
  "nextBlockId": "string"
}

Sub zbos/{source}/block/start/event

event: Composition block started

Parameters
source
required
string

The source that this composition belongs to

Enum: "scheduler/timeline" "composition"

Accepts the following message:

String

Payload
string
Composer

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/composition/block/stop

Stop composition block

Block ID to stop, when key = "all", all active blocks will be stopped.

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Composer

Examples

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

Sub zbos/{source}/block/end/event

event: Composition block ended

Parameters
source
required
string

The source that this composition belongs to

Enum: "scheduler/timeline" "composition"

Accepts the following message:

String

Payload
string
Composer

Examples

String
Payload 
"string"
This example has been generated automatically.

Sub zbos/{source}/block/pause/event

event: Composition block paused

Parameters
source
required
string

The source that this composition belongs to

Enum: "scheduler/timeline" "composition"

Accepts the following message:

String

Payload
string
Composer

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/connection/status/get

Get the connection status

Requesting the connection information for the WiFi, access point and cablesee <<zbos/connection/status/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Connection

Examples

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

Sub zbos/connection/status/response/{key}

response: Get the connection status

Response with the status information for the WiFi, access point and cable

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

ConnectionStatus

Payload
object
wifi
array<object>
ssid
string
encryption
object
Enum: "UNSECURE" "SHARE" "WEP" "WPA" "WPA_PSK" "WPA_OR_WPA2" "WPA_OR_WPA2_PSK" "WPA2" "WPA2_PSK" "WPA2_EAP" "WAI_CERT" "WAI_PSK"
name
string
ordinal
integer

Additional properties are allowed.

ip4
string
ip6
string
dhcp
boolean
subnetmask
string
gateway
string
dns
object
dns1
string
dns2
string
adapterName
string

Additional properties are allowed.

serviceId
string
connectionStatus
object
Enum: "CONNECTING" "CONNECTED" "DISCONNECTED"
name
string
ordinal
integer

Additional properties are allowed.

hasInternet
boolean
adapterName
string

Additional items are allowed.

cable
array<object>
ip4
string
ip6
string
dhcp
boolean
subnetmask
string
gateway
string
dns
object
dns1
string
dns2
string
adapterName
string

Additional properties are allowed.

hasConnection
boolean
hasInternet
boolean
serviceId
string
adapterName
string

Additional items are allowed.

ap
array<object>
ssid
string
ip
string
encryption
object
Enum: "UNSECURE" "SHARE" "WEP" "WPA" "WPA_PSK" "WPA_OR_WPA2" "WPA_OR_WPA2_PSK" "WPA2" "WPA2_PSK" "WPA2_EAP" "WAI_CERT" "WAI_PSK"
name
string
ordinal
integer

Additional properties are allowed.

hasConnection
boolean
hasInternet
boolean
adapterName
string

Additional items are allowed.

Additional properties are allowed.

Connection

Examples

ConnectionStatus
Payload
Example #1
{
  "wifi": [
    {
      "ssid": "ZoraBotsNetwork",
      "encryption": "WPA2_PSK",
      "ip4": "192.168.0.5",
      "ip6": "2a02:1811:b282:ae00:5850:a744:3c37:711b",
      "dhcp": true,
      "subnetmask": "255.255.254.0",
      "gateway": "192.168.0.1",
      "dns": {
        "dns1": "8.8.8.8",
        "dns2": "8.8.4.4",
        "valid": true
      },
      "serviceId": "wifi_kdsjfqsdf5185",
      "connectionStatus": "CONNECTED",
      "hasInternet": true,
      "adapterName": "wlan0"
    }
  ],
  "cable": [
    {
      "ip4": "192.168.0.4",
      "ip6": "2a02:1811:b282:ae00:5850:a744:3c37:711a",
      "dhcp": true,
      "subnetmask": "255.255.254.0",
      "gateway": "192.168.0.1",
      "dns": {
        "dns1": "8.8.8.8",
        "dns2": "8.8.4.4",
        "valid": true
      },
      "hasConnection": true,
      "hasInternet": true,
      "adapterName": "eth0"
    }
  ],
  "ap": [
    {
      "ssid": "ZoraBotsHotspot",
      "ip": "192.168.60.1",
      "encryption": "WPA2_PSK",
      "hasConnection": true,
      "hasInternet": true,
      "adapterName": "teth0"
    }
  ]
}
Example #2
{
  "cable": [
    {
      "ip4": "192.168.0.4",
      "ip6": "2a02:1811:b282:ae00:5850:a744:3c37:711a",
      "dhcp": true,
      "subnetmask": "255.255.254.0",
      "gateway": "192.168.0.1",
      "dns": {
        "dns1": "8.8.8.8",
        "dns2": "8.8.4.4",
        "valid": true
      },
      "hasConnection": true,
      "hasInternet": true,
      "adapterName": "eth0"
    }
  ]
}
Example #3
{
  "wifi": [
    {
      "ssid": "ZoraBotsNetwork",
      "encryption": "WPA2_PSK",
      "ip4": "192.168.0.5",
      "ip6": "2a02:1811:b282:ae00:5850:a744:3c37:711b",
      "dhcp": true,
      "subnetmask": "255.255.254.0",
      "gateway": "192.168.0.1",
      "dns": {
        "dns1": "8.8.8.8",
        "dns2": "8.8.4.4",
        "valid": true
      },
      "serviceId": "wifi_kdsjfqsdf5185",
      "connectionStatus": "CONNECTED",
      "hasInternet": true,
      "adapterName": "wlan0"
    }
  ]
}
Example #4
{
  "ap": [
    {
      "ssid": "ZoraBotsHotspot",
      "ip": "192.168.60.1",
      "encryption": "WPA2_PSK",
      "hasConnection": true,
      "hasInternet": true,
      "adapterName": "teth0"
    },
    {
      "ssid": "ZoraBotsHotspot5GHz",
      "ip": "192.168.60.1",
      "encryption": "WPA2_PSK",
      "hasConnection": true,
      "hasInternet": true,
      "adapterName": "teth1"
    }
  ]
}

Sub zbos/connection/status/event

event: Connection status

Periodic status information for the WiFi, access point and cable

Accepts the following message:

ConnectionStatus

Payload
object
wifi
array<object>
ssid
string
encryption
object
Enum: "UNSECURE" "SHARE" "WEP" "WPA" "WPA_PSK" "WPA_OR_WPA2" "WPA_OR_WPA2_PSK" "WPA2" "WPA2_PSK" "WPA2_EAP" "WAI_CERT" "WAI_PSK"
name
string
ordinal
integer

Additional properties are allowed.

ip4
string
ip6
string
dhcp
boolean
subnetmask
string
gateway
string
dns
object
dns1
string
dns2
string
adapterName
string

Additional properties are allowed.

serviceId
string
connectionStatus
object
Enum: "CONNECTING" "CONNECTED" "DISCONNECTED"
name
string
ordinal
integer

Additional properties are allowed.

hasInternet
boolean
adapterName
string

Additional items are allowed.

cable
array<object>
ip4
string
ip6
string
dhcp
boolean
subnetmask
string
gateway
string
dns
object
dns1
string
dns2
string
adapterName
string

Additional properties are allowed.

hasConnection
boolean
hasInternet
boolean
serviceId
string
adapterName
string

Additional items are allowed.

ap
array<object>
ssid
string
ip
string
encryption
object
Enum: "UNSECURE" "SHARE" "WEP" "WPA" "WPA_PSK" "WPA_OR_WPA2" "WPA_OR_WPA2_PSK" "WPA2" "WPA2_PSK" "WPA2_EAP" "WAI_CERT" "WAI_PSK"
name
string
ordinal
integer

Additional properties are allowed.

hasConnection
boolean
hasInternet
boolean
adapterName
string

Additional items are allowed.

Additional properties are allowed.

Connection

Examples

ConnectionStatus
Payload
Example #1
{
  "wifi": [
    {
      "ssid": "ZoraBotsNetwork",
      "encryption": "WPA2_PSK",
      "ip4": "192.168.0.5",
      "ip6": "2a02:1811:b282:ae00:5850:a744:3c37:711b",
      "dhcp": true,
      "subnetmask": "255.255.254.0",
      "gateway": "192.168.0.1",
      "dns": {
        "dns1": "8.8.8.8",
        "dns2": "8.8.4.4",
        "valid": true
      },
      "serviceId": "wifi_kdsjfqsdf5185",
      "connectionStatus": "CONNECTED",
      "hasInternet": true,
      "adapterName": "wlan0"
    }
  ],
  "cable": [
    {
      "ip4": "192.168.0.4",
      "ip6": "2a02:1811:b282:ae00:5850:a744:3c37:711a",
      "dhcp": true,
      "subnetmask": "255.255.254.0",
      "gateway": "192.168.0.1",
      "dns": {
        "dns1": "8.8.8.8",
        "dns2": "8.8.4.4",
        "valid": true
      },
      "hasConnection": true,
      "hasInternet": true,
      "adapterName": "eth0"
    }
  ],
  "ap": [
    {
      "ssid": "ZoraBotsHotspot",
      "ip": "192.168.60.1",
      "encryption": "WPA2_PSK",
      "hasConnection": true,
      "hasInternet": true,
      "adapterName": "teth0"
    }
  ]
}
Example #2
{
  "cable": [
    {
      "ip4": "192.168.0.4",
      "ip6": "2a02:1811:b282:ae00:5850:a744:3c37:711a",
      "dhcp": true,
      "subnetmask": "255.255.254.0",
      "gateway": "192.168.0.1",
      "dns": {
        "dns1": "8.8.8.8",
        "dns2": "8.8.4.4",
        "valid": true
      },
      "hasConnection": true,
      "hasInternet": true,
      "adapterName": "eth0"
    }
  ]
}
Example #3
{
  "wifi": [
    {
      "ssid": "ZoraBotsNetwork",
      "encryption": "WPA2_PSK",
      "ip4": "192.168.0.5",
      "ip6": "2a02:1811:b282:ae00:5850:a744:3c37:711b",
      "dhcp": true,
      "subnetmask": "255.255.254.0",
      "gateway": "192.168.0.1",
      "dns": {
        "dns1": "8.8.8.8",
        "dns2": "8.8.4.4",
        "valid": true
      },
      "serviceId": "wifi_kdsjfqsdf5185",
      "connectionStatus": "CONNECTED",
      "hasInternet": true,
      "adapterName": "wlan0"
    }
  ]
}
Example #4
{
  "ap": [
    {
      "ssid": "ZoraBotsHotspot",
      "ip": "192.168.60.1",
      "encryption": "WPA2_PSK",
      "hasConnection": true,
      "hasInternet": true,
      "adapterName": "teth0"
    },
    {
      "ssid": "ZoraBotsHotspot5GHz",
      "ip": "192.168.60.1",
      "encryption": "WPA2_PSK",
      "hasConnection": true,
      "hasInternet": true,
      "adapterName": "teth1"
    }
  ]
}

Pub zbos/connection/wifi/scan

Scan for WiFi networks

Start scanning for WiFi networks

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Connection

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/connection/wifi/scan/event

response: Scan for WiFi networks

A list of all the scanned WiFi networks the robot can connect to

Accepts the following message:

Array<ScannedNetwork>

Payload
array<object>
ssid
string
encryption
object
Enum: "UNSECURE" "SHARE" "WEP" "WPA" "WPA_PSK" "WPA_OR_WPA2" "WPA_OR_WPA2_PSK" "WPA2" "WPA2_PSK" "WPA2_EAP" "WAI_CERT" "WAI_PSK"
name
string
ordinal
integer

Additional properties are allowed.

signal
number
isSaved
boolean
serviceId
string
channel
number

Additional items are allowed.

Connection

Examples

Array<ScannedNetwork>
Payload
Example #1
{
  "ssid": "ZoraBotsNetwork",
  "encryption": "WPA2_PSK",
  "signal": -60,
  "serviceId": "wifi_ksdjfsf4894",
  "saved": false
}
Example #2
{
  "ssid": "ZoraBotsNetworkEnterprise",
  "encryption": "WPA2_EAP",
  "signal": -55,
  "serviceId": "wifi_wxvze5651",
  "saved": false
}
Example #3
{
  "ssid": "ZoraBotsNetworkOpen",
  "encryption": "UNSECURE",
  "signal": -50,
  "serviceId": "wifi_wxvsezt8137",
  "saved": false
}
Example #4
{
  "ssid": "ZoraBotsNetworkWEP",
  "encryption": "WEP",
  "signal": -70,
  "serviceId": "wifi_mqlkspfaf2168751",
  "saved": false
}

Pub zbos/connection/wifi/connect

Connect to a network

Connect to a specific WiFi network

Accepts the following message:

ConnectToNetwork

Payload
object
ssid
string
encryption
object
Enum: "UNSECURE" "SHARE" "WEP" "WPA" "WPA_PSK" "WPA_OR_WPA2" "WPA_OR_WPA2_PSK" "WPA2" "WPA2_PSK" "WPA2_EAP" "WAI_CERT" "WAI_PSK"
name
string
ordinal
integer

Additional properties are allowed.

password
string
username
string
serviceId
string
isSaved
boolean
hidden
boolean
channel
number
adapterName
string

Additional properties are allowed.

Connection

Examples

ConnectToNetwork
Payload
Example #1
{
  "ssid": "ZoraNetwork1",
  "encryption": "WPA2_PSK",
  "password": "Nice_try123",
  "serviceId": "wifi_ksdjfsf4894",
  "hidden": false,
  "adapterName": "wlan0",
  "valid": true,
  "saved": false,
  "enterpriseNetwork": false
}

Sub zbos/connection/wifi/connect/event

event: Connect to a network

A (json) message is published when the connection request was successful or not

Accepts the following message:

ConnectionResponse

Payload
object
success
boolean
message
string

Additional properties are allowed.

Connection

Examples

ConnectionResponse
Payload
Example #1
{
  "success": true,
  "message": "ZoraBotsNetwork"
}
Example #2
{
  "success": true,
  "message": ""
}
Example #3
{
  "success": false,
  "message": "INVALID_CREDENTIALS"
}

Pub zbos/connection/wifi/forget

Forget a network

Forget a network. If the robot is connected to the given network, it will disconnect

Accepts the following message:

ForgetNetwork

Payload
object
ssid
string
serviceId
string
adapterName
string

Additional properties are allowed.

Connection

Examples

ForgetNetwork
Payload
Example #1
{
  "ssid": "ZoraBotsNetworkEnterprise",
  "serviceId": "wifi_wxvze5651",
  "adapterName": "wlan0",
  "valid": true
}

Sub zbos/connection/wifi/forget/event

event: Forget a network

A (json) message is published when the forget request was successful or not

Accepts the following message:

ConnectionResponse

Payload
object
success
boolean
message
string

Additional properties are allowed.

Connection

Examples

ConnectionResponse
Payload
Example #1
{
  "success": true,
  "message": "ZoraBotsNetwork"
}
Example #2
{
  "success": true,
  "message": ""
}
Example #3
{
  "success": false,
  "message": "INVALID_CREDENTIALS"
}

Pub zbos/connection/wifi/list/saved/get

Get the saved networks

Get an overview of all the networks that are saved on the robotsee <<zbos/connection/wifi/list/saved/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Connection

Examples

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

Sub zbos/connection/wifi/list/saved/response/{key}

response: Get the saved networks

A list of all the saved networks that are stored on the robot

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<SavedNetwork>

Payload
array<object>
ssid
string
encryption
object
Enum: "UNSECURE" "SHARE" "WEP" "WPA" "WPA_PSK" "WPA_OR_WPA2" "WPA_OR_WPA2_PSK" "WPA2" "WPA2_PSK" "WPA2_EAP" "WAI_CERT" "WAI_PSK"
name
string
ordinal
integer

Additional properties are allowed.

password
string
username
string
hidden
boolean
networkConfig
object
dhcp
boolean
fixedIp4
string
fixedIp6
string
subnetmask
string
gateway
string
adapterName
string

Additional properties are allowed.

dns
object
dns1
string
dns2
string
adapterName
string

Additional properties are allowed.

Additional items are allowed.

Connection

Examples

Array<SavedNetwork>
Payload
Example #1
{
  "ssid": "ZoraBotsNetwork",
  "encryption": "WPA2_PSK",
  "password": "Nice_try123",
  "hidden": false,
  "networkConfig": {
    "dhcp": false,
    "fixedIp4": "192.168.5.2",
    "subnetmask": "255.255.255.0",
    "gateway": "192.168.5.1",
    "valid": true
  },
  "dns": {
    "dns1": "8.8.8.8",
    "dns2": "8.8.4.4",
    "valid": true
  }
}
Example #2
{
  "ssid": "ZoraBotsNetworkEnterprise",
  "encryption": "WPA2_EAP",
  "password": "Nice_try123",
  "username": "let_me_see",
  "hidden": false
}
Example #3
{
  "ssid": "ZoraBotsNetworkOpen",
  "encryption": "UNSECURE",
  "hidden": false
}
Example #4
{
  "ssid": "ZoraBotsNetworkHidden",
  "encryption": "WEP",
  "password": "Nice_try123",
  "hidden": true
}

Pub zbos/connection/wifi/network/configure/set

Set network configuration

Set specific WiFi network configuration (DHCP, IPv4, IPv6, subnetmask, default gateway).see <<zbos/connection/wifi/network/configure/response/{key}>> for response

Accepts the following message:

NetworkConfig

Payload
object
dhcp
boolean
fixedIp4
string
fixedIp6
string
subnetmask
string
gateway
string
adapterName
string

Additional properties are allowed.

Connection

Examples

NetworkConfig
Payload
Example #1
{
  "dhcp": false,
  "fixedIp4": "192.168.0.101",
  "subnetmask": "255.255.254.0",
  "gateway": "192.168.0.2",
  "adapterName": "wlan0",
  "valid": true
}
Example #2
{
  "dhcp": false,
  "fixedIp4": "192.168.0.101",
  "fixedIp6": "2a02:1811:b282:ae00:5850:a744:3c37:711b",
  "subnetmask": "255.255.254.0",
  "gateway": "192.168.0.2",
  "adapterName": "wlan1",
  "valid": true
}
Example #3
{
  "dhcp": true,
  "valid": true
}

Sub zbos/connection/wifi/network/configure/response/{key}

response: Set network configuration

A (json) message is published when saving the configuration was successful or not

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

ConnectionResponse

Payload
object
success
boolean
message
string

Additional properties are allowed.

Connection

Examples

ConnectionResponse
Payload
Example #1
{
  "success": true,
  "message": "ZoraBotsNetwork"
}
Example #2
{
  "success": true,
  "message": ""
}
Example #3
{
  "success": false,
  "message": "INVALID_CREDENTIALS"
}

Pub zbos/connection/wifi/dns/get

Get DNS configuration

Get the DNS configuration of the network the robot is connected tosee <<zbos/connection/wifi/dns/get/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Connection

Examples

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

Sub zbos/connection/wifi/dns/get/response/{key}

response: Get DNS configuration

Response with the DNS configuration of the connected network

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

DNSConfig

Payload
object
dns1
string
dns2
string
adapterName
string

Additional properties are allowed.

Connection

Examples

DNSConfig
Payload
Example #1
{
  "dns1": "8.8.8.8",
  "dns2": "8.8.4.4",
  "adapterName": "wlan0",
  "valid": true
}

Pub zbos/connection/wifi/dns/set

Set DNS configuration

Set the DNS configuration of the network the robot is connected to.see <<zbos/connection/wifi/dns/set/response/{key}>> for response

Accepts the following message:

DNSConfig

Payload
object
dns1
string
dns2
string
adapterName
string

Additional properties are allowed.

Connection

Examples

DNSConfig
Payload
Example #1
{
  "dns1": "1.1.1.1",
  "dns2": "1.0.0.1",
  "adapterName": "wlan0",
  "valid": true
}

Sub zbos/connection/wifi/dns/set/response/{key}

response: Set DNS configuration

A (json) message is published when saving the DNS configuration was successful or not

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

ConnectionResponse

Payload
object
success
boolean
message
string

Additional properties are allowed.

Connection

Examples

ConnectionResponse
Payload
Example #1
{
  "success": true,
  "message": "ZoraBotsNetwork"
}
Example #2
{
  "success": true,
  "message": ""
}
Example #3
{
  "success": false,
  "message": "INVALID_CREDENTIALS"
}

Pub zbos/connection/ap/config/get

Get access point configuration

Get the access point configuration of the network that the robot is broadcastingsee <<zbos/connection/ap/config/get/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Connection

Examples

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

Sub zbos/connection/ap/config/get/response/{key}

response: Get access point configuration

Response about the access point that the robot is broadcasting

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

APConfig

Payload
object
enabled
boolean
ssid
string
password
string
adapterName
string

Additional properties are allowed.

Connection

Examples

APConfig
Payload
Example #1
{
  "enabled": true,
  "ssid": "ZoraBotsHotspot",
  "password": "hotspot_123"
}
Example #2
{
  "enabled": false,
  "ssid": "ZoraBotsHotspot",
  "password": "hotspot_123",
  "adapterName": "teth1"
}

Pub zbos/connection/ap/config/set

Set access point configuration

Set the access point configuration of the network that the robot is broadcasting.see <<zbos/connection/ap/config/set/response/{key}>> for response

Accepts the following message:

APConfig

Payload
object
enabled
boolean
ssid
string
password
string
adapterName
string

Additional properties are allowed.

Connection

Examples

APConfig
Payload
Example #1
{
  "enabled": true,
  "ssid": "ZoraBotsHotspot",
  "password": "hotspot_123"
}
Example #2
{
  "enabled": false,
  "ssid": "ZoraBotsHotspot",
  "password": "hotspot_123",
  "adapterName": "teth1"
}

Sub zbos/connection/ap/config/set/response/{key}

response: Set access point configuration

A (json) message is published when saving the access point configuration was successful or not

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

ConnectionResponse

Payload
object
success
boolean
message
string

Additional properties are allowed.

Connection

Examples

ConnectionResponse
Payload
Example #1
{
  "success": true,
  "message": "ZoraBotsNetwork"
}
Example #2
{
  "success": true,
  "message": ""
}
Example #3
{
  "success": false,
  "message": "INVALID_CREDENTIALS"
}

Sub zbos/connection/ap/enable/event

event: Access point enabled

Triggered when the access point/hotspot is turned on

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Connection

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/connection/ap/disable/event

event: Access point disabled

Triggered when the access point/hotspot is turned off

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Connection

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/connection/usb/config/start

Start connecting to a wifi config

Look for a wifi config on the robot and attempt to connect to it

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Connection

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/diagnostics/chassis/get

Get diagnostics for chassis

see <<zbos/diagnostics/chassis/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Diagnostics

Examples

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

Sub zbos/diagnostics/chassis/event

event: Chassis state changed

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

Accepts the following message:

DiagnosticState

Payload
object
partId
string

Name of the part

partType
object

Type of the part

Enum: "MOTOR" "MOTOR_CONTROLLER" "SERVO" "SERVO_CONTROLLER" "CPU" "MEMORY" "LIDAR" "POWER_BOARD" "BATTERY"
name
string
ordinal
integer

Additional properties are allowed.

info
object
translationKey
string

status code

message
string

status message

Additional properties are allowed.

temperature
string

optional, depending on robot

Additional properties are allowed.

Diagnostics

Examples

DiagnosticState
Payload
Example #1
{}

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

response: Diagnostics chassis

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<DiagnosticState>

Payload
array<object>
partId
string

Name of the part

partType
object

Type of the part

Enum: "MOTOR" "MOTOR_CONTROLLER" "SERVO" "SERVO_CONTROLLER" "CPU" "MEMORY" "LIDAR" "POWER_BOARD" "BATTERY"
name
string
ordinal
integer

Additional properties are allowed.

info
object
translationKey
string

status code

message
string

status message

Additional properties are allowed.

temperature
string

optional, depending on robot

Additional items are allowed.

Diagnostics

Examples

Array<DiagnosticState>
Payload
Example #1
{}

Pub zbos/diagnostics/servos/get

Get diagnostics for servos

see <<zbos/diagnostics/servos/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Diagnostics

Examples

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

Sub zbos/diagnostics/servos/event

event: Servo state changed

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

Accepts the following message:

DiagnosticState

Payload
object
partId
string

Name of the part

partType
object

Type of the part

Enum: "MOTOR" "MOTOR_CONTROLLER" "SERVO" "SERVO_CONTROLLER" "CPU" "MEMORY" "LIDAR" "POWER_BOARD" "BATTERY"
name
string
ordinal
integer

Additional properties are allowed.

info
object
translationKey
string

status code

message
string

status message

Additional properties are allowed.

temperature
string

optional, depending on robot

Additional properties are allowed.

Diagnostics

Examples

DiagnosticState
Payload
Example #1
{}

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

response: Diagnostics servos

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<DiagnosticState>

Payload
array<object>
partId
string

Name of the part

partType
object

Type of the part

Enum: "MOTOR" "MOTOR_CONTROLLER" "SERVO" "SERVO_CONTROLLER" "CPU" "MEMORY" "LIDAR" "POWER_BOARD" "BATTERY"
name
string
ordinal
integer

Additional properties are allowed.

info
object
translationKey
string

status code

message
string

status message

Additional properties are allowed.

temperature
string

optional, depending on robot

Additional items are allowed.

Diagnostics

Examples

Array<DiagnosticState>
Payload
Example #1
{}

Pub zbos/domotica/get/settings

Get settings

see <<zbos/domotica/get/settings/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Domotics

Examples

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

Sub zbos/domotica/get/settings/response/{key}

response: Get settings

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Settings

Payload
object
ADD
string
ADD_RESPONSE
string
CHANGED_EVENT
string
GET
string
GET_RESPONSE
string
REQUEST
string
RESET
string
RESET_RESPONSE
string
UPDATE
string
UPDATE_RESPONSE
string

Additional properties are allowed.

Domotics

Examples

Settings
Payload
Example #1
{
  "brand": "creadomotics",
  "login": "admin",
  "password": "admin",
  "ip": "192.168.0.123"
}

Pub zbos/domotica/set/setting

Set settings

Sets login, password and ip of a domotics center. Automatically replaces settings from the same brand. Settings are saved to the sd card. If no file exists, it is automatically created.

Accepts the following message:

Settings

Payload
object
ADD
string
ADD_RESPONSE
string
CHANGED_EVENT
string
GET
string
GET_RESPONSE
string
REQUEST
string
RESET
string
RESET_RESPONSE
string
UPDATE
string
UPDATE_RESPONSE
string

Additional properties are allowed.

Domotics

Examples

Settings
Payload
Example #1
{
  "brand": "creadomotics",
  "login": "admin",
  "password": "admin",
  "ip": "192.168.0.123"
}

Pub zbos/domotica/delete/settings/all

Delete all settings

Deletes all the plugin settings/configs from the device.

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Domotics

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/domotica/get/status

Get status

see <<zbos/domotica/get/status/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Domotics

Examples

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

Sub zbos/domotica/get/status/response/{key}

response: Get status

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<PluginState>

Payload
array<object>
brand
string
state
object

Can be: INITIALIZING, CONNECTING, CONNECTION_FAILED, CONNECTION_SUCCEEDED

Enum: "INITIALIZING" "CONNECTING" "CONNECTION_FAILED" "CONNECTION_SUCCEEDED" "NOT_CONFIGURED"
name
string
ordinal
integer

Additional properties are allowed.

Additional items are allowed.

Domotics

Examples

Array<PluginState>
Payload
Example #1
{
  "brand": "creadomotics",
  "state": "CONNECTION_FAILED"
}

Pub zbos/domotica/get/devices

Get devices

see <<zbos/domotica/get/devices/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Domotics

Examples

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

Sub zbos/domotica/get/devices/response/{key}

response: Get devices

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<DomoticaDevice>

Payload
array<object>
id
string
room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

type
string
brand
string

Additional items are allowed.

Domotics

Examples

Array<DomoticaDevice>
Payload
Example #1
{
  "id": "string",
  "room": "kitchen",
  "tags": [
    "string",
    "bar",
    "kitchen"
  ],
  "type": "dimmer",
  "brand": "creadomotics",
  "validDevice": true
}

Pub zbos/domotica/add/device

Add device

Automatically removes device from same brand with same id. devices are saved to the sd card. If no file exists, it is automatically created.

Accepts the following message:

DomoticaDevice

Payload
object
id
string
room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

type
string
brand
string

Additional properties are allowed.

Domotics

Examples

DomoticaDevice
Payload
Example #1
{
  "id": "string",
  "room": "kitchen",
  "tags": [
    "string",
    "bar",
    "kitchen"
  ],
  "type": "dimmer",
  "brand": "creadomotics",
  "validDevice": true
}

Pub zbos/domotica/delete/device

Delete device

Accepts the following message:

DomoticaDevice

Payload
object
id
string
room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

type
string
brand
string

Additional properties are allowed.

Domotics

Examples

DomoticaDevice
Payload
Example #1
{
  "id": "string",
  "validDevice": false
}

Pub zbos/domotica/delete/devices/all

Delete all devices

Deletes all locally configured devices.

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Domotics

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/domotica/get/rooms

Get rooms

see <<zbos/domotica/get/rooms/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Domotics

Examples

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

Sub zbos/domotica/get/rooms/response/{key}

response: Get rooms

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Room

Payload
object
key
string
devices
array<object>
id
string
room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

type
string
brand
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

Room
Payload
Example #1
{}

Pub zbos/domotica/set/notifications

Enable notifications on device state changes

To get notifications for all device types, pass "all" as a device type.

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Domotics

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/domotica/event

event: Domotica state changes

Accepts the following message:

DeviceState

Payload
object
room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

state
object
value
object

Additional properties are allowed.

optionalValue
object

Additional properties are allowed.

unit
string

Additional properties are allowed.

type
string
id
string

Additional properties are allowed.

Domotics

Examples

DeviceState
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ],
  "state": {
    "value": "ON"
  },
  "type": "motion",
  "id": "string"
}

Sub zbos/domotica/device/event

event: Domotica device

Domotica device state changes trigger this event. Has no payload, state is in the topic itself.

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Domotics

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/domotica/plugin/event

event: Domotica plugin

Plugin state changes (such as connectivity changes) trigger this event.

Accepts the following message:

PluginState

Payload
object
brand
string
state
object

Can be: INITIALIZING, CONNECTING, CONNECTION_FAILED, CONNECTION_SUCCEEDED

Enum: "INITIALIZING" "CONNECTING" "CONNECTION_FAILED" "CONNECTION_SUCCEEDED" "NOT_CONFIGURED"
name
string
ordinal
integer

Additional properties are allowed.

Additional properties are allowed.

Domotics

Examples

PluginState
Payload
Example #1
{
  "brand": "creadomotics",
  "state": "INITIALIZING"
}

Pub zbos/domotica/set/device/bool

Set device

All devices in given room of given type including all given tags will be adressed.

Accepts the following message:

DomoticaSetDeviceOptions

Payload
object
type
string

The device type. Currently supported types are: light, dimmer, switch, plug, door, shutter, speaker.

state
boolean

True for on/open/..., false for off/closed/...

room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaSetDeviceOptions
Payload
Example #1
{
  "type": "string",
  "state": true
}

Pub zbos/domotica/get/light

Get light

All lights in given room including all given tags will be adressed.

Accepts the following message:

DomoticaGetOptions

Payload
object
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaGetOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ]
}

Pub zbos/domotica/set/light

Set light

All lights in given room including all given tags will be adressed.

Accepts the following message:

DomoticaSetBooleanOptions

Payload
object
state
boolean

True for on, false for off

room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaSetBooleanOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ],
  "state": true
}

Pub zbos/domotica/get/dimmer

Get dimmer

All dimmers in given room including all given tags will be adressed.

Accepts the following message:

DomoticaGetOptions

Payload
object
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaGetOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ]
}

Pub zbos/domotica/set/dimmer

Set dimmer

All dimmers in given room including all given tags will be adressed.

Accepts the following message:

DomoticaSetIntOptions

Payload
object
value
integer

Value between 0 and 100 (percentage). To turn off, give value zero

room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaSetIntOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ],
  "value": 100
}

Pub zbos/domotica/get/switch

Get switch

All switches in given room including all given tags will be adressed.

Accepts the following message:

DomoticaGetOptions

Payload
object
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaGetOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ]
}

Pub zbos/domotica/set/switch

Set switch

All switches in given room including all given tags will be adressed.

Accepts the following message:

DomoticaSetBooleanOptions

Payload
object
state
boolean

True for on, false for off

room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaSetBooleanOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ],
  "state": true
}

Pub zbos/domotica/get/door

Get door

All doors in given room including all given tags will be adressed.

Accepts the following message:

DomoticaGetOptions

Payload
object
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaGetOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ]
}

Pub zbos/domotica/set/door

Set door

All doors in given room including all given tags will be adressed.

Accepts the following message:

DomoticaSetBooleanOptions

Payload
object
state
boolean

True for on, false for off

room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaSetBooleanOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ],
  "state": true
}

Pub zbos/domotica/get/shutter

Get Shutter

All shutters in given room including all given tags will be adressed.

Accepts the following message:

DomoticaGetOptions

Payload
object
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaGetOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ]
}

Pub zbos/domotica/set/shutter

Set shutter

All shutters in given room including all given tags will be adressed.

Accepts the following message:

DomoticaSetBooleanOptions

Payload
object
state
boolean

True for on, false for off

room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaSetBooleanOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ],
  "state": true
}

Pub zbos/domotica/get/speaker

Get speaker

All speakers in given room including all given tags will be adressed.

Accepts the following message:

DomoticaGetOptions

Payload
object
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaGetOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ]
}

Pub zbos/domotica/set/speaker

Set speaker

All speakers in given room including all given tags will be adressed.

Accepts the following message:

DomoticaSetSpeakerOptions

Payload
object
command
string

Supported commands: play, pause, mute, unmute, set volume, increase volume, decrease volume, next song, previous song

value
integer

Optional. Only used for 'set volume' command. Value between 0 and 100 (percentage)

room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaSetSpeakerOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ],
  "command": "play",
  "value": 70
}

Pub zbos/domotica/get/doorsensor

Get doorsensor

All doorsensors in given room including all given tags will be adressed.

Accepts the following message:

DomoticaGetOptions

Payload
object
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaGetOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ]
}

Pub zbos/domotica/get/motionsensor

Get motionsensor

All motionsensors in given room including all given tags will be adressed.

Accepts the following message:

DomoticaGetOptions

Payload
object
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaGetOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ]
}

Pub zbos/domotica/get/floodsensor

Get floodsensor

All floodsensors in given room including all given tags will be adressed.

Accepts the following message:

DomoticaGetOptions

Payload
object
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaGetOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ]
}

Pub zbos/domotica/get/lightsensor

Get lightsensor

All lightsensors in given room including all given tags will be adressed.

Accepts the following message:

DomoticaGetOptions

Payload
object
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaGetOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ]
}

Pub zbos/domotica/get/temperature

Get temperature

All temperature sensors in given room including all given tags will be adressed.

Accepts the following message:

DomoticaGetOptions

Payload
object
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Domotics

Examples

DomoticaGetOptions
Payload
Example #1
{
  "room": "kitchen",
  "tags": [
    "bar",
    "kitchen"
  ]
}

Pub zbos/domotica/play/scene

Set scene

All scenes in given room will be adressed. Use scene property to specify specific scene. Scene names can be found in the tags of scene objects.see <<zbos/domotica/response/{key}>> for response

Accepts the following message:

DomoticaPlaySceneOptions

Payload
object
room
string
scene
string

Optional

Additional properties are allowed.

Domotics

Examples

DomoticaPlaySceneOptions
Payload
Example #1
{
  "room": "kitchen",
  "scene": "demo scene"
}

Sub zbos/domotica/response/{key}

Domotics response

Response for the various device getters: get light, get dimmer, etc

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Any

Payload
object

Additional properties are allowed.

Domotics

Examples

Any
Payload 
{}
This example has been generated automatically.

Sub zbos/facetracking/detected/faces

event: Detected faces

Accepts the following message:

String

Payload
string
Face tracking

Examples

String
Payload 
"string"
This example has been generated automatically.

Sub zbos/facetracking/response

response: Face

Accepts the following message:

Detection

Payload
object
name
string
role
string
lastUpdated
object
fastTime
number
cdate
object
cachedYear
integer
cachedFixedDateJan1
number
cachedFixedDateNextJan1
number

Additional properties are allowed.

Additional properties are allowed.

lastSeen
object
fastTime
number
cdate
object
cachedYear
integer
cachedFixedDateJan1
number
cachedFixedDateNextJan1
number

Additional properties are allowed.

Additional properties are allowed.

seenCount
integer

Additional properties are allowed.

Face tracking

Examples

Detection
Payload
Example #1
{
  "name": "string",
  "role": "string",
  "lastUpdated": 1616061846645,
  "lastSeen": 1616061846645,
  "seenCount": 5
}

Pub zbos/facetracking/add_request

Add face

see <<zbos/facetracking/add_response>> for response

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Face tracking

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/facetracking/add_response

response: Add face

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Face tracking

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/facetracking/update_request

Update face

see <<zbos/facetracking/update_response>> for response

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Face tracking

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/facetracking/update_response

response: Update face

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Face tracking

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/facetracking/update_person_request

Update person

see <<zbos/facetracking/update_person_response>> for response

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Face tracking

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/facetracking/update_person_response

response: Update person

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Face tracking

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/facetracking/delete_request

Delete face

see <<zbos/facetracking/delete_response>> for response

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Face tracking

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/facetracking/delete_response

response: Delete face

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Face tracking

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/facetracking/name_request

Request name

see <<zbos/facetracking/name_response>> for response

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Face tracking

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/facetracking/name_response

response: Request name

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Face tracking

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/facetracking/persondata_request

Request data from person

see <<zbos/facetracking/persondata_response>> for response

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Face tracking

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/facetracking/persondata_response

response: Request data from person

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Face tracking

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/kiosk/resume/event

event: Kiosk is active

Fired when kiosk is active after being moved to the background

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Kiosk

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/remote/kiosk/apps/home

Open home screen

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Kiosk

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/remote/kiosk/apps/start

Start application remotely on Kiosk

Accepts the following message:

ApplicationStartRequest

Payload
object
appName
string
extras
object

Additional properties are allowed.

Additional properties are allowed.

Kiosk

Examples

ApplicationStartRequest
Payload
Example #1
{}

Pub zbos/remote/kiosk/apps/get

Get installed applications on Kiosk

Request a list of all installed & listed applications from the Kiosksee <<zbos/remote/kiosk/apps/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Kiosk

Examples

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

Sub zbos/remote/kiosk/apps/response/{key}

response: Get installed applications on Kiosk

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<SimpleApplicationNodeDto>

Payload
array<object>
app_name
string
package_name
string
image_base64
string

Additional items are allowed.

Kiosk

Examples

Array<SimpleApplicationNodeDto>
Payload
Example #1
{
  "app_name": "string",
  "package_name": "string",
  "image_base64": "string"
}

Pub zbos/remote/kiosk/apps/all/get

Get installed applications on Kiosk

Request a list of all installed & listed applications from the Kiosksee <<zbos/remote/kiosk/apps/all/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Kiosk

Examples

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

Sub zbos/remote/kiosk/apps/all/response/{key}

response: Get installed applications on Kiosk

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<SimpleApplicationNodeDto>

Payload
array<object>
app_name
string
package_name
string
image_base64
string

Additional items are allowed.

Kiosk

Examples

Array<SimpleApplicationNodeDto>
Payload
Example #1
{
  "app_name": "string",
  "package_name": "string",
  "image_base64": "string"
}

Pub zbos/remote/kiosk/multimedia/{type}/show

Show multimedia

see <<zbos/remote/kiosk/multimedia/{type}/show/response/{key}>> for response

Parameters
type
required
string

Type of multimedia

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Kiosk

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/remote/kiosk/multimedia/{type}/show/response/{key}

response: Show multimedia

Parameters
type
required
string

Type of multimedia

key
required
string

Request key to create a unique subscription topic

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Kiosk

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/remote/kiosk/input/show

Show input prompt

see <<zbos/remote/kiosk/input/show/response/{key}>> for response

Accepts the following message:

InputBlock

Payload
object
question
string
textType
string
confirmText
string

Additional properties are allowed.

Kiosk

Examples

InputBlock
Payload
Example #1
{
  "question": "string"
}

Sub zbos/remote/kiosk/input/show/response/{key}

response: Show input prompt

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

InputResponse

Payload
object
input
string

Additional properties are allowed.

Kiosk

Examples

InputResponse
Payload
Example #1
{
  "input": "input"
}

Pub zbos/remote/kiosk/microphone/show

Show microphone in composition

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Kiosk

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/remote/kiosk/multimedia/image/show

Show image

see <<zbos/remote/kiosk/multimedia/image/show/response/{key}>> for response

Accepts the following message:

Image

Payload
object
id
string
path
string
extension
string
fileName
string
style
object
backgroundColor
string

Additional properties are allowed.

url
string

Additional properties are allowed.

Kiosk

Examples

Image
Payload
Example #1
{
  "id": "string",
  "style": {
    "backgroundColor": "string"
  },
  "url": "string"
}

Sub zbos/remote/kiosk/multimedia/image/show/response/{key}

response: Show image

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Image

Payload
object
id
string
path
string
extension
string
fileName
string
style
object
backgroundColor
string

Additional properties are allowed.

url
string

Additional properties are allowed.

Kiosk

Examples

Image
Payload
Example #1
{
  "id": "string",
  "style": {
    "backgroundColor": "string"
  },
  "url": "string"
}

Pub zbos/remote/kiosk/multimedia/image/stop

Stop showing image

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Kiosk

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/remote/kiosk/multimedia/image/{filename}/end

event: Image ended

Parameters
filename
required
string

Name of the file

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Kiosk

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/remote/kiosk/multimedia/video/show

Show video

see <<zbos/remote/kiosk/multimedia/video/show/response/{key}>> for response

Accepts the following message:

Video

Payload
object
id
string
url
string
repeat
boolean
audioUrl
string
videoOnly
boolean
showControls
boolean

Additional properties are allowed.

Kiosk

Examples

Video
Payload
Example #1
{
  "id": "string",
  "url": "string",
  "repeat": true,
  "audioUrl": "string",
  "videoOnly": false,
  "showControls": true,
  "remoteVideo": false
}

Sub zbos/remote/kiosk/multimedia/video/show/response/{key}

response: Show video

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Video

Payload
object
id
string
url
string
repeat
boolean
audioUrl
string
videoOnly
boolean
showControls
boolean

Additional properties are allowed.

Kiosk

Examples

Video
Payload
Example #1
{
  "id": "string",
  "url": "string",
  "repeat": true,
  "audioUrl": "string",
  "videoOnly": false,
  "showControls": true,
  "remoteVideo": false
}

Pub zbos/remote/kiosk/multimedia/video/stop

Stop video

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Kiosk

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/remote/kiosk/multimedia/video/{filename}/end

event: Video ended

Parameters
filename
required
string

Name of the file

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Kiosk

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/remote/kiosk/multimedia/page/show

Show page in kiosk

see <<zbos/remote/kiosk/multimedia/page/show/response/{key}>> for response

Accepts the following message:

OpenBrowserBlock

Payload
object
blocking
boolean
id
string
index
integer
url
string

Additional properties are allowed.

Kiosk

Examples

OpenBrowserBlock
Payload
Example #1
{}

Sub zbos/remote/kiosk/multimedia/page/show/response/{key}

response: Show page in kiosk

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

OpenBrowserBlock

Payload
object
blocking
boolean
id
string
index
integer
url
string

Additional properties are allowed.

Kiosk

Examples

OpenBrowserBlock
Payload
Example #1
{}

Pub zbos/remote/kiosk/action/start

Start action

Accepts the following message:

Action

Payload
object

Additional properties are allowed.

Kiosk

Examples

Action
Payload 
{}
This example has been generated automatically.

Pub zbos/remote/kiosk/settings/lock/state/get

Get current lockstate

see <<zbos/remote/kiosk/settings/lock/state/response>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Kiosk

Examples

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

Sub zbos/remote/kiosk/settings/lock/state/response

response: Get current lockstate

Accepts the following message:

LockStatus

Payload
object
isLocked
boolean
isPincodeSet
boolean

Additional properties are allowed.

Kiosk

Examples

LockStatus
Payload
Example #1
{
  "pincodeSet": false,
  "locked": true
}

Pub zbos/remote/kiosk/settings/unlock

Unlock settings page

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Kiosk

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/remote/kiosk/settings/lock

Lock settings page

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Kiosk

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/remote/kiosk/settings/lock/event

response: Lock settings page

Accepts the following message:

LockResponse

Payload
object
response
string
success
boolean

Additional properties are allowed.

Kiosk

Examples

LockResponse
Payload
Example #1
{}

Sub zbos/remote/kiosk/settings/unlock/event

response: Unlock settings page

Accepts the following message:

LockResponse

Payload
object
response
string
success
boolean

Additional properties are allowed.

Kiosk

Examples

LockResponse
Payload
Example #1
{}

Sub zbos/remote/kiosk/settings/pincode/change/event

response: Change current pincode

Accepts the following message:

LockResponse

Payload
object
response
string
success
boolean

Additional properties are allowed.

Kiosk

Examples

LockResponse
Payload
Example #1
{}

Pub zbos/remote/kiosk/settings/pincode/remove

Remove current pincode

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Kiosk

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/remote/kiosk/settings/pincode/remove/event

response: Remove current pincode

Accepts the following message:

LockResponse

Payload
object
response
string
success
boolean

Additional properties are allowed.

Kiosk

Examples

LockResponse
Payload
Example #1
{}

Pub zbos/kiosk/datasource/get/all

Get all datasources

see <<zbos/kiosk/datasource/get/all/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Kiosk

Examples

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

Sub zbos/kiosk/datasource/get/all/response/{key}

response: Get all datasources

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<SimpleDataSource>

Payload
array<object>
id
string
name
string

Additional items are allowed.

Kiosk

Examples

Array<SimpleDataSource>
Payload
Example #1
{
  "id": "string",
  "name": "string"
}

Pub zbos/kiosk/datasource/get

Get specific datasources

see <<zbos/kiosk/datasource/get/response/{key}>> for response

Accepts the following message:

SimpleDataSource

Payload
object
id
string
name
string

Additional properties are allowed.

Kiosk

Examples

SimpleDataSource
Payload
Example #1
{
  "id": "string",
  "name": "string"
}

Sub zbos/kiosk/datasource/get/response/{key}

response: Get specific datasources

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
Kiosk

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/kiosk/datasource/current/get

Get active datasources

see <<zbos/kiosk/datasource/current/get/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Kiosk

Examples

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

Sub zbos/kiosk/datasource/current/get/response/{key}

response: Get active datasources

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
Kiosk

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/kiosk/datasource/set

Set current Kiosk datasources

Accepts the following message:

ChangeDatasourceRequest

Payload
object
id
string

Additional properties are allowed.

Kiosk

Examples

ChangeDatasourceRequest
Payload
Example #1
{
  "id": "string"
}

Pub zbos/kiosk/datasource/save

Save or add a datasource

see <<zbos/kiosk/datasource/save/event/{kiosk_id}>> for response

Accepts the following message:

SimpleDataSource

Payload
object
id
string
name
string

Additional properties are allowed.

Kiosk

Examples

SimpleDataSource
Payload
Example #1
{
  "id": "string",
  "name": "String"
}

Sub zbos/kiosk/datasource/save/event/{kiosk_id}

response: Get active datasources

Parameters
kiosk_id
required
string

ID of kiosk

Accepts the following message:

String

Payload
string
Kiosk

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/kiosk/datasource/delete

Delete a datasource

see <<zbos/kiosk/datasource/delete/event/{kiosk_id}>> for response

Accepts the following message:

SimpleDataSource

Payload
object
id
string
name
string

Additional properties are allowed.

Kiosk

Examples

SimpleDataSource
Payload
Example #1
{
  "id": "string"
}

Sub zbos/kiosk/datasource/delete/event/{kiosk_id}

response: Delete a datasource

Parameters
kiosk_id
required
string

ID of kiosk

Accepts the following message:

String

Payload
string
Kiosk

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/kiosk/composition/pin/lock

Pin a composition

Accepts the following message:

PinnedComposition

Payload
object
id
string

Additional properties are allowed.

Kiosk

Examples

PinnedComposition
Payload
Example #1
{
  "id": "string"
}

Pub zbos/kiosk/composition/pin/unlock

Unpin a composition

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Kiosk

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/kiosk/composition/pin/get

Request the current pin status & pinned composition.

see <<zbos/kiosk/composition/pin/get/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Kiosk

Examples

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

Sub zbos/kiosk/composition/pin/get/response/{key}

response: pin status & pinned composition

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

PinnedCompositionState

Payload
object
isPinned
boolean
id
string

Additional properties are allowed.

Kiosk

Examples

PinnedCompositionState
Payload
Example #1
{
  "id": "string",
  "pinned": true
}

Pub zbos/kiosk/app/pin/lock

Pin an app, if installed

A locked app will be launched immediately when the kiosk opens.

Accepts the following message:

PinnedApplication

Payload
object
packageName
string

Additional properties are allowed.

Kiosk

Examples

PinnedApplication
Payload
Example #1
{
  "packageName": "string"
}

Pub zbos/kiosk/app/pin/unlock

Unpin an app.

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Kiosk

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/kiosk/app/pin/get

Request the current pin status & pinned app.

see <<zbos/kiosk/app/pin/get/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Kiosk

Examples

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

Sub zbos/kiosk/app/pin/get/response/{key}

response: pin status & pinned app

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

PinnedApplicationState

Payload
object
isPinned
boolean
packageName
string

Additional properties are allowed.

Kiosk

Examples

PinnedApplicationState
Payload
Example #1
{
  "packageName": "string",
  "pinned": true
}

Pub zbos/leds/chestlight/set

Set chest light color

Accepts the following message:

LedOptions

Payload
object
part
object
Enum: "CHEST" "MOUTH" "EYES" "HEAD" "SPEECH"
name
string
ordinal
integer

Additional properties are allowed.

color
string

The format is "#FF0000" (red)

breathe
boolean
breathDuration
integer
duration
integer

Additional properties are allowed.

Leds

Examples

LedOptions
Payload
Example #1
{
  "part": "CHEST",
  "color": "#ff077e",
  "breathDuration": 1500,
  "duration": -1
}

Pub zbos/media/library/list

List all media libraries

[DEPRECATED] Please use <<zbos/media/library/list/get>>

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Media

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/media/library/list/event

event: Listing all media libraries

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Media

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/media/library/list/get

Get a list of media items

see <<zbos/media/library/list/response/{key}>> for response

Accepts the following message:

FilteringRequest

Payload
object
key
string
limit
integer
offset
integer
filters
array<object>
field
string

Field to check on. Note that the field should be camelCase, not snake_case

value
string

Value to check on. For numbers you should use 'min' and 'max'.

min
number

Minimum value, only usable for number fields

max
number

Maximum value, only usable for number fields

direction
object

Direction to sort on. Can be 'asc' or 'desc'. The default direction is 'asc'

Enum: "ASC" "DESC"
name
string
ordinal
integer

Additional properties are allowed.

operator
object

Operator for either the child filters, or this filter object itself. Can be 'and', 'or' or 'not'. Default is 'and'. The root operator is always 'and'

Enum: "AND" "OR" "NOT"
name
string
ordinal
integer

Additional properties are allowed.

match_type
object

Match type for string values. Can be 'exact', 'contains', 'starts_with', 'ends_with'. The default match_type is 'contains'

Enum: "EXACT" "CONTAINS" "STARTS_WITH" "ENDS_WITH"
name
string
ordinal
integer

Additional properties are allowed.

filters
array<object>

Filters on which the operator will be applied. If there are no child filters, the operator will be applied to the filter object itself.

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

field_filters
array<object>

Filters to apply on the child fields of the field. Will only work if the field is an object, array/list or map.

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

Additional items are allowed.

sort
array<object>
field
string

Field to check on. Note that the field should be camelCase, not snake_case

value
string

Value to check on. For numbers you should use 'min' and 'max'.

min
number

Minimum value, only usable for number fields

max
number

Maximum value, only usable for number fields

direction
object

Direction to sort on. Can be 'asc' or 'desc'. The default direction is 'asc'

Enum: "ASC" "DESC"
name
string
ordinal
integer

Additional properties are allowed.

operator
object

Operator for either the child filters, or this filter object itself. Can be 'and', 'or' or 'not'. Default is 'and'. The root operator is always 'and'

Enum: "AND" "OR" "NOT"
name
string
ordinal
integer

Additional properties are allowed.

match_type
object

Match type for string values. Can be 'exact', 'contains', 'starts_with', 'ends_with'. The default match_type is 'contains'

Enum: "EXACT" "CONTAINS" "STARTS_WITH" "ENDS_WITH"
name
string
ordinal
integer

Additional properties are allowed.

filters
array<object>

Filters on which the operator will be applied. If there are no child filters, the operator will be applied to the filter object itself.

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

field_filters
array<object>

Filters to apply on the child fields of the field. Will only work if the field is an object, array/list or map.

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

Additional items are allowed.

Additional properties are allowed.

Media

Examples

FilteringRequest
Payload
Example #1
{
  "key": "Test123",
  "limit": 50,
  "offset": 10,
  "filters": [
    {
      "operator": "or",
      "filters": [
        {
          "field": "name",
          "value": "foo",
          "operator": "and",
          "match_type": "contains"
        },
        {
          "field": "name",
          "value": "bar",
          "operator": "and",
          "match_type": "contains"
        }
      ],
      "match_type": "contains"
    },
    {
      "field": "type",
      "value": "image",
      "operator": "and",
      "filters": [
        {
          "field": "type",
          "value": "image",
          "operator": "and",
          "match_type": "contains"
        }
      ],
      "match_type": "contains"
    },
    {
      "field": "date",
      "operator": "and",
      "filters": [
        {
          "field": "date",
          "operator": "and",
          "match_type": "contains"
        }
      ],
      "match_type": "contains"
    }
  ],
  "sort": [
    {
      "field": "extension",
      "operator": "and",
      "filters": [
        {
          "field": "extension",
          "operator": "and",
          "match_type": "contains"
        }
      ],
      "match_type": "contains"
    },
    {
      "field": "name",
      "operator": "and",
      "filters": [
        {
          "field": "name",
          "operator": "and",
          "match_type": "contains"
        }
      ],
      "match_type": "contains"
    }
  ]
}

Sub zbos/media/library/list/response/{key}

response: Get a list of media items

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<MediaFile>

Payload
array<object>
fileId
string
path
string
fileName
string
extension
string
type
string
mimeType
string
downloadPath
string
previewPath
string
thumbnailPath
string
checksum
string
cloudFileId
string
size
number
modifiedAt
number
isDefaultAsset
boolean
fullPath
string

Additional items are allowed.

Media

Examples

Array<MediaFile>
Payload
Example #1
{
  "fileId": "string",
  "path": "string",
  "fileName": "string",
  "extension": "string",
  "type": "string",
  "mimeType": "string",
  "downloadPath": "string",
  "previewPath": "string",
  "thumbnailPath": "string",
  "checksum": "string",
  "cloudFileId": "string",
  "size": 0,
  "modifiedAt": 0,
  "fullPath": "string/string.string",
  "defaultAsset": false
}

Sub zbos/media/library/event

Library item changed event

This event is published when an item in the media library list changes

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Media

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/media/sync/device/get

Get media sync devices

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Media

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/media/sync/device/event

event: Media sync devices

Accepts the following message:

String

Payload
string
Media

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/media/export/get

Get all media exports

Accepts the following message:

ExportRequestDto

Payload
object
clientId
string
compositionId
string
compositionName
string
mediaPaths
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Media

Examples

ExportRequestDto
Payload
Example #1
{
  "clientId": "string",
  "compositionId": "string",
  "compositionName": "string",
  "mediaPaths": [
    "string"
  ]
}

Sub zbos/media/export/event

event: All media exported

Accepts the following message:

ExportRequestDto

Payload
object
clientId
string
compositionId
string
compositionName
string
mediaPaths
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Media

Examples

ExportRequestDto
Payload
Example #1
{
  "clientId": "string",
  "compositionId": "string",
  "compositionName": "string",
  "mediaPaths": [
    "string"
  ]
}

Pub zbos/media/apk/install

Install APK

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Media

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/media/delete/all

Delete all media

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Media

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

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

see <<zbos/motion/animation/response/{key}>> for response

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

Request key to create a unique subscription topic

Accepts the following message:

Array<AvailableAnimation>

Payload
array<object>
id
string
name
string
animation
string
type
string

Additional items are allowed.

Motion

Examples

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

Sub zbos/motion/animation/event

Event: animation started/stopped

A message (Boolean) is publish on this topic when an animation started or stopped running

Accepts the following message:

Boolean

Payload
boolean
Motion

Examples

Boolean
Payload 
true
This example has been generated automatically.

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/start/random

Start random dance

Start a random default 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/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

see <<zbos/motion/dance/response/{key}>> for response

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

Request key to create a unique subscription topic

Accepts the following message:

Array<AvailableDance>

Payload
array<object>
id
string
name
string
animation
string
song
string

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
angle
object
degree
number
>= -100 <= 100

Angles in percent between -100 en +100

Additional properties are allowed.

force
number
distance
number

In meters

relative_rotation
number
partName
string

Additional properties are allowed.

Motion

Examples

MobilityActionOptions
Payload
Example #1
{
  "requestId": "string",
  "yaw": 10,
  "pitch": 0,
  "angle": {
    "degree": 90
  },
  "force": 50,
  "distance": 2,
  "relativeRotation": 0,
  "partName": "string"
}

Pub zbos/motion/control/movement

Move head

Publish on this topic to move the head of the robot.

Accepts the following message:

MobilityActionOptions

Payload
object
requestId
string
yaw
number
pitch
number
angle
object
degree
number
>= -100 <= 100

Angles in percent between -100 en +100

Additional properties are allowed.

force
number
distance
number

In meters

relative_rotation
number
partName
string

Additional properties are allowed.

Motion

Examples

MobilityActionOptions
Payload
Example #1
{
  "requestId": "string",
  "yaw": 10,
  "pitch": 0,
  "angle": {
    "degree": 90
  },
  "force": 50,
  "distance": 2,
  "relativeRotation": 0,
  "partName": "string"
}

Pub zbos/motion/control/part/{name}

Move a specific part of the robot

Publish on this topic to move a specific part of the robot, like an arm or a leg.

Parameters
name
required
string

Name of the part which you want to control

Accepts the following message:

MobilityActionOptions

Payload
object
requestId
string
yaw
number
pitch
number
angle
object
degree
number
>= -100 <= 100

Angles in percent between -100 en +100

Additional properties are allowed.

force
number
distance
number

In meters

relative_rotation
number
partName
string

Additional properties are allowed.

Motion

Examples

MobilityActionOptions
Payload
Example #1
{
  "requestId": "string",
  "yaw": 10,
  "pitch": 0,
  "angle": {
    "degree": 90
  },
  "force": 50,
  "distance": 2,
  "relativeRotation": 0,
  "partName": "string"
}

Sub zbos/motion/event

Event: started/stopped

A message (Boolean) is publish on this topic when the robot chassis starts, or stops moving.

Accepts the following message:

Boolean

Payload
boolean
Motion

Examples

Boolean
Payload 
true
This example has been generated automatically.

Pub zbos/emotion/eyes/run

Run animation for the eyes

Accepts the following message:

EmotionOptions

Payload
object
requestId
string
emotionId
string

Additional properties are allowed.

Motion

Examples

EmotionOptions
Payload
Example #1
{
  "emotionId": "2"
}

Pub zbos/emotion/eyes/get

Get list of available emotions for the eyes

see <<zbos/emotion/eyes/response/{key}>> for response

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/emotion/eyes/response/{key}

response: Get list of available emotions for the eyes

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<AvailableEmotion>

Payload
array<object>
id
string
name
string
animation
string
translationkey
string

Additional items are allowed.

Motion

Examples

Array<AvailableEmotion>
Payload
Example #1
{
  "id": "2",
  "name": "Eyeroll"
}

Pub zbos/followme/enable

Enable follow me

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/followme/disable

Disable follow me

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Motion

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/followme/event

response: follow me status

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/gestures/data

Gestures data

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/gestures/enable

Enable gestures

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/gestures/disable

Disable gestures

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/gym/get/all

Get all the gym movements that can be used in the composer

see <<zbos/gym/get/all/response/{key}>> for response

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/gym/get/all/response/{key}

response: Get all gym movements

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<AvailableGymMovement>

Payload
array<object>
categories
array<object>
name
string
translation
string
exercises
array<object>
name
string
translation
string
speedIn_min
number
speedIn_max
number
speedOut_min
number
speedOut_max
number
duty_min
number
duty_max
number
period_min
number
period_max
number
cycles_min
number
cycles_max
number
profiles
array<object>
name
string
code
string
translation
string

Additional items are allowed.

Additional items are allowed.

Additional items are allowed.

Additional items are allowed.

Motion

Examples

Array<AvailableGymMovement>
Payload
Example #1
{
  "categories": [
    {
      "name": "string",
      "translation": "string",
      "exercises": [
        {
          "name": "string",
          "translation": "string",
          "profiles": [
            {
              "name": "string",
              "code": "string",
              "translation": "string"
            }
          ],
          "speedIn_min": 15,
          "speedIn_max": 50,
          "speedOut_min": 25,
          "speedOut_max": 60,
          "duty_min": 5,
          "duty_max": 10,
          "period_min": 5,
          "period_max": 10,
          "cycles_min": 5,
          "cycles_max": 10
        }
      ]
    }
  ]
}

Pub zbos/security/motiondetect/start

Start motion detection

Accepts the following message:

MotionDetectionOptions

Payload
object
key
string

Required key

unit
string

Can be "s", "h" or "m" (seconds, hours, minutes), used for duration. Defaults to seconds

initialDelay
number
>= 0

How long to wait until starting motion detection, in milliseconds. Defaults to 2000, lower values may cause false positives

interval
number
>= 0

How often the camera should check for motion, in milliseconds. Defaults to 200

duration
number
>= 0

The maximum time the motion detection will be active, after the time is elapsed, the motion detection will stop. Defaults to 10

stopOnDetection
boolean

If true the motion detection will stop after the first detection. Defaults to true

upload
boolean

If true, the picture with motion detected will be uploaded to the cloud. A notification is sent to zbos-control (if enabled). Defaults to false

stopAfterDuration
boolean

If true the motion detection will stop at the end of the duration. Defaults to true

Additional properties are allowed.

Motion detection

Examples

MotionDetectionOptions
Payload
Example #1
{
  "key": "test",
  "unit": "h",
  "initialDelay": 2500,
  "interval": 250,
  "duration": 7,
  "stopOnDetection": true,
  "upload": true,
  "stopAfterDuration": true,
  "timeInMilliseconds": 25200000
}

Pub zbos/security/motiondetect/stop

Stop motion detection

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Motion detection

Examples

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

Sub zbos/security/motiondetect/event/{key}

event: Motion detected

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

MotionDetectionEvent

Payload
object
image
string

Image of the detected motion, only given if upload is enabled in motion detection options.

Additional properties are allowed.

Motion detection

Examples

MotionDetectionEvent
Payload
Example #1
{
  "image": "SomeBase64Image"
}

Sub zbos/security/motiondetect/started/{key}

Motion detection started

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Motion detection

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/security/motiondetect/stopped/{key}

Motion detection stopped

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Motion detection

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/sensors/touch/get

Get all touch sensors

see <<zbos/sensors/touch/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Sensors

Examples

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

Sub zbos/sensors/touch/response/{key}

response: Get all touch sensors

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

AvailableSensor

Payload
object
id
string
type
object
Enum: "TOUCHSENSOR" "TOUCHSENSOR_GROUP"
name
string
ordinal
integer

Additional properties are allowed.

translationkey
string

Additional properties are allowed.

Sensors

Examples

AvailableSensor
Payload
Example #1
{
  "id": "string",
  "type": "TOUCHSENSOR",
  "translationkey": "string"
}

Sub zbos/sensors/event

event: Sensor

Accepts the following message:

SensorEvent

Payload
object
id
string
type
string
source
string
state
string

Additional properties are allowed.

Sensors

Examples

SensorEvent
Payload
Example #1
{
  "id": "string",
  "type": "string",
  "state": "string"
}

Pub zbos/settings/get

Get settings

Get all settings for the provided category

Accepts the following message:

GetSettingsRequest

Payload
object
key
string
category
string
setting_keys
array<string>

Optional, will return all settings if not set.

Items:

0
string

Additional items are allowed.

subcategories
object

Optional, will return all subcategories if not set.

Additional properties are allowed.

Additional properties are allowed.

Settings

Examples

GetSettingsRequest
Payload
Example #1
{
  "key": "abc",
  "category": "category_1"
}
Example #2
{
  "key": "abc",
  "category": "category_1",
  "setting_keys": [
    "setting_key_1",
    "setting_key_2"
  ]
}

Pub zbos/settings/get/response/{key}

Response: Get settings

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SettingsCategory

Payload
object
label_key
string

Translation key should use the dot notation: {category}.{key}

description_key
string

Optional description key Translation key should use the dot notation: {category}.{key}

settings
object

Additional properties are allowed.

subcategories
object

Optional subcategories

Additional properties are allowed.

orphaned
boolean

The orphaned state indicates that this category was not added again since boot.

Additional properties are allowed.

Settings

Examples

SettingsCategory
Payload
Example #1
{
  "category": {
    "settings": {
      "setting_key_1": {
        "value": "Value 1",
        "type": "string",
        "required": true,
        "label_key": "translations_category.setting_1_label",
        "description_key": "translations_category.setting_1_description"
      },
      "setting_key_2": {
        "value": "100",
        "type": "integer",
        "range": {
          "min": 0,
          "max": 150
        },
        "required": false,
        "label_key": "translations_category.setting_2_label",
        "description_key": "translations_category.setting_2_description"
      },
      "setting_key_3": {
        "value": "100.50",
        "type": "number",
        "range": {
          "min": 1,
          "max": 150
        },
        "required": true,
        "label_key": "translations_category.setting_3_label",
        "description_key": "translations_category.setting_3_description"
      },
      "setting_key_4": {
        "value": "true",
        "type": "boolean",
        "label_key": "translations_category.setting_4_label",
        "description_key": "translations_category.setting_4_description"
      },
      "setting_key_5": {
        "value": "option_1",
        "type": "select_single",
        "options": [
          {
            "key": "option_1",
            "value": "Option 1",
            "label_key": "translations_category.setting_5_option_1"
          },
          {
            "key": "option_2",
            "value": "Option 2",
            "label_key": "translations_category.setting_5_option_2"
          }
        ],
        "label_key": "translations_category.translations_category.setting_5_label",
        "description_key": "translations_category.setting_5_description"
      },
      "setting_key_6": {
        "values": [
          "option_1",
          "option_2"
        ],
        "type": "select_multi",
        "options": [
          {
            "key": "option_1",
            "value": "Option 1",
            "label_key": "translations_category.setting_6_option_1"
          },
          {
            "key": "option_2",
            "value": "Option 2",
            "label_key": "translations_category.setting_6_option_2"
          },
          {
            "key": "option_3",
            "value": "Option 3",
            "label_key": "translations_category.setting_6_option_3"
          }
        ],
        "label_key": "translations_category.setting_6_label",
        "description_key": "translations_category.setting_6_description"
      }
    },
    "label_key": "translations_category.category_1_label"
  }
}
Example #2
{
  "category": {
    "settings": {
      "setting_key_1": {
        "value": "Value 1",
        "type": "string",
        "required": true,
        "label_key": "translations_category.setting_1_label",
        "description_key": "translations_category.setting_1_description"
      },
      "setting_key_2": {
        "value": "100",
        "type": "integer",
        "range": {
          "min": 0,
          "max": 150
        },
        "required": false,
        "label_key": "translations_category.setting_2_label",
        "description_key": "translations_category.setting_2_description"
      },
      "setting_key_3": {
        "value": "100.50",
        "type": "number",
        "range": {
          "min": 1,
          "max": 150
        },
        "required": true,
        "label_key": "translations_category.setting_3_label",
        "description_key": "translations_category.setting_3_description"
      },
      "setting_key_4": {
        "value": "true",
        "type": "boolean",
        "label_key": "translations_category.setting_4_label",
        "description_key": "translations_category.setting_4_description"
      },
      "setting_key_5": {
        "value": "option_1",
        "type": "select_single",
        "options": [
          {
            "key": "option_1",
            "value": "Option 1",
            "label_key": "translations_category.setting_5_option_1"
          },
          {
            "key": "option_2",
            "value": "Option 2",
            "label_key": "translations_category.setting_5_option_2"
          }
        ],
        "label_key": "translations_category.translations_category.setting_5_label",
        "description_key": "translations_category.setting_5_description"
      },
      "setting_key_6": {
        "values": [
          "option_1",
          "option_2"
        ],
        "type": "select_multi",
        "options": [
          {
            "key": "option_1",
            "value": "Option 1",
            "label_key": "translations_category.setting_6_option_1"
          },
          {
            "key": "option_2",
            "value": "Option 2",
            "label_key": "translations_category.setting_6_option_2"
          },
          {
            "key": "option_3",
            "value": "Option 3",
            "label_key": "translations_category.setting_6_option_3"
          }
        ],
        "label_key": "translations_category.setting_6_label",
        "description_key": "translations_category.setting_6_description"
      }
    },
    "subcategories": {
      "category_2a": {
        "settings": {},
        "label_key": "translations_category.category_2a_label"
      }
    },
    "label_key": "translations_category.category_2_label"
  }
}

Pub zbos/settings/request

Request settings registrations

Request all setting providers to register their settings using the topics below.

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Settings

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/settings/add

Add settings

Add settings with their default values. These default values will be used as long as they are not updated via <<zbos/settings/update>>

Accepts the following message:

AddSettingsRequest

Payload
object
key
string
category_name
string
file
string

Optional. Use either category or file

category
object

Optional. Use either category or file

label_key
string

Translation key should use the dot notation: {category}.{key}

description_key
string

Optional description key Translation key should use the dot notation: {category}.{key}

settings
object

Additional properties are allowed.

subcategories
object

Optional subcategories

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

Settings

Examples

AddSettingsRequest
Payload
Example #1
{
  "key": "abc",
  "category": {
    "settings": {
      "setting_key_1": {
        "type": "string",
        "required": true,
        "default_value": "Value 1",
        "label_key": "translations_category.setting_1_label",
        "description_key": "translations_category.setting_1_description"
      },
      "setting_key_2": {
        "type": "integer",
        "range": {
          "min": 0,
          "max": 150
        },
        "required": false,
        "default_value": "100",
        "label_key": "translations_category.setting_2_label",
        "description_key": "translations_category.setting_2_description"
      },
      "setting_key_3": {
        "type": "number",
        "range": {
          "min": 1,
          "max": 150
        },
        "required": true,
        "default_value": "100.50",
        "label_key": "translations_category.setting_3_label",
        "description_key": "translations_category.setting_3_description"
      },
      "setting_key_4": {
        "type": "boolean",
        "default_value": "true",
        "label_key": "translations_category.setting_4_label",
        "description_key": "translations_category.setting_4_description"
      },
      "setting_key_5": {
        "type": "select_single",
        "options": [
          {
            "key": "option_1",
            "value": "Option 1",
            "label_key": "translations_category.setting_5_option_1"
          },
          {
            "key": "option_2",
            "value": "Option 2",
            "label_key": "translations_category.setting_5_option_2"
          }
        ],
        "default_value": "option_1",
        "label_key": "translations_category.translations_category.setting_5_label",
        "description_key": "translations_category.setting_5_description"
      },
      "setting_key_6": {
        "type": "select_multi",
        "options": [
          {
            "key": "option_1",
            "value": "Option 1",
            "label_key": "translations_category.setting_6_option_1"
          },
          {
            "key": "option_2",
            "value": "Option 2",
            "label_key": "translations_category.setting_6_option_2"
          },
          {
            "key": "option_3",
            "value": "Option 3",
            "label_key": "translations_category.setting_6_option_3"
          }
        ],
        "label_key": "translations_category.setting_6_label",
        "description_key": "translations_category.setting_6_description"
      }
    },
    "label_key": "translations_category.category_1_label"
  },
  "category_name": "category_1"
}
Example #2
{
  "key": "abc",
  "category": {
    "settings": {
      "setting_key_1": {
        "type": "string",
        "required": true,
        "default_value": "Value 1",
        "label_key": "translations_category.setting_1_label",
        "description_key": "translations_category.setting_1_description"
      },
      "setting_key_2": {
        "type": "integer",
        "range": {
          "min": 0,
          "max": 150
        },
        "required": false,
        "default_value": "100",
        "label_key": "translations_category.setting_2_label",
        "description_key": "translations_category.setting_2_description"
      },
      "setting_key_3": {
        "type": "number",
        "range": {
          "min": 1,
          "max": 150
        },
        "required": true,
        "default_value": "100.50",
        "label_key": "translations_category.setting_3_label",
        "description_key": "translations_category.setting_3_description"
      },
      "setting_key_4": {
        "type": "boolean",
        "default_value": "true",
        "label_key": "translations_category.setting_4_label",
        "description_key": "translations_category.setting_4_description"
      },
      "setting_key_5": {
        "type": "select_single",
        "options": [
          {
            "key": "option_1",
            "value": "Option 1",
            "label_key": "translations_category.setting_5_option_1"
          },
          {
            "key": "option_2",
            "value": "Option 2",
            "label_key": "translations_category.setting_5_option_2"
          }
        ],
        "default_value": "option_1",
        "label_key": "translations_category.translations_category.setting_5_label",
        "description_key": "translations_category.setting_5_description"
      },
      "setting_key_6": {
        "type": "select_multi",
        "options": [
          {
            "key": "option_1",
            "value": "Option 1",
            "label_key": "translations_category.setting_6_option_1"
          },
          {
            "key": "option_2",
            "value": "Option 2",
            "label_key": "translations_category.setting_6_option_2"
          },
          {
            "key": "option_3",
            "value": "Option 3",
            "label_key": "translations_category.setting_6_option_3"
          }
        ],
        "label_key": "translations_category.setting_6_label",
        "description_key": "translations_category.setting_6_description"
      }
    },
    "subcategories": {
      "category_2a": {
        "settings": {},
        "label_key": "translations_category.category_2a_label"
      }
    },
    "label_key": "translations_category.category_2_label"
  },
  "category_name": "category_2"
}
Example #3
{
  "key": "abc",
  "file": "path/to/file.json",
  "category_name": "category_3"
}

Pub zbos/settings/add/response/{key}

Response: Add settings

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Settings

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/settings/update

Update settings

Update settings overriding the default values.

Accepts the following message:

UpdateSettingsRequest

Payload
object
key
string
category_name
string
category
object
settings
object

Additional properties are allowed.

subcategories
object

Optional subcategories

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

Settings

Examples

UpdateSettingsRequest
Payload
Example #1
{
  "key": "abc",
  "category": {
    "settings": {
      "setting_key_1": {
        "value": "Value 1B"
      },
      "setting_key_2": {
        "value": "50"
      },
      "setting_key_3": {
        "value": "110.20"
      },
      "setting_key_4": {
        "value": "false"
      },
      "setting_key_5": {
        "value": "option_2"
      },
      "setting_key_6": {
        "values": [
          "option_2",
          "option_3"
        ]
      }
    },
    "subcategories": {
      "category_1a": {
        "settings": {
          "setting_key_1a": {
            "value": "Value 1A"
          }
        }
      }
    }
  },
  "category_name": "category_1"
}

Pub zbos/settings/update/response/{key}

Response: Update settings

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Settings

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/settings/changed/event/{category}

Event: Settings changed

Parameters
category
required
string

ID of the settings category that was changed

Accepts the following message:

SettingsChangedEvent

Payload
object
category_name
string
category
object
settings
object

Additional properties are allowed.

subcategories
object

Optional subcategories

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

Settings

Examples

SettingsChangedEvent
Payload
Example #1
{
  "category": {
    "settings": {
      "setting_key_1": {
        "type": "string",
        "value": "Value 1"
      },
      "setting_key_2": {
        "type": "integer",
        "value": "100"
      },
      "setting_key_3": {
        "type": "number",
        "value": "100.50"
      },
      "setting_key_4": {
        "type": "boolean",
        "value": "true"
      },
      "setting_key_5": {
        "type": "select_single",
        "value": "option_1",
        "options": [
          {
            "key": "option_1",
            "value": "Option 1",
            "label_key": "translations_category.setting_5_option_1"
          },
          {
            "key": "option_2",
            "value": "Option 2",
            "label_key": "translations_category.setting_5_option_2"
          }
        ]
      },
      "setting_key_6": {
        "type": "select_multi",
        "values": [
          "option_1",
          "option_2"
        ],
        "options": [
          {
            "key": "option_1",
            "value": "Option 1",
            "label_key": "translations_category.setting_6_option_1"
          },
          {
            "key": "option_2",
            "value": "Option 2",
            "label_key": "translations_category.setting_6_option_2"
          },
          {
            "key": "option_3",
            "value": "Option 3",
            "label_key": "translations_category.setting_6_option_3"
          }
        ]
      }
    }
  },
  "category_name": "category_1"
}

Pub zbos/settings/reset

Reset settings

Reset settings to their default values

Accepts the following message:

ResetSettingsRequest

Payload
object
key
string
category
string

Additional properties are allowed.

Settings

Examples

ResetSettingsRequest
Payload
Example #1
{
  "key": "abc",
  "category": "category_1"
}

Pub zbos/settings/reset/response/{key}

Response: Reset settings

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Settings

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Sub zbos/sip/config/event

SIP config changed

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SIP

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/sip/errors/get

Get SIP errors

see <<zbos/sip/errors/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

SIP

Examples

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

Sub zbos/sip/errors/response/{key}

response: SIP errors

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<SipError>

Payload
array<object>
error
string

Additional items are allowed.

SIP

Examples

Array<SipError>
Payload
Example #1
{
  "error": "string"
}

Pub zbos/sip/call/end

End the current SIP call

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SIP

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/sip/call/end/event

The current SIP call has ended

Accepts the following message:

CallEndInfo

Payload
object
success
boolean

Additional properties are allowed.

SIP

Examples

CallEndInfo
Payload
Example #1
{
  "success": true
}

Pub zbos/slam/start

Start slam service

see <<zbos/slam/start/response/{key}>> for response

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/start/response/{key}

response: Start slam

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/stop

Stop slam service

see <<zbos/slam/stop/response/{key}>> for response

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/stop/response/{key}

response: Stop slam

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/error

ERROR in Slam

Accepts the following message:

SlamError

Payload
object
errorCode
string
message
string

Additional properties are allowed.

SLAM

Examples

SlamError
Payload
Example #1
{
  "errorCode": "String",
  "message": "string"
}

Sub zbos/slam/collision/start/event

One or more collisions have started

Accepts the following message:

Array<AvailableSensor>

Payload
array<object>
id
string
type
object
Enum: "TOUCHSENSOR" "TOUCHSENSOR_GROUP"
name
string
ordinal
integer

Additional properties are allowed.

translationkey
string

Additional items are allowed.

SLAM

Examples

Array<AvailableSensor>
Payload
Example #1
{
  "id": "string",
  "type": "TOUCHSENSOR",
  "translationkey": "string"
}

Sub zbos/slam/collision/end/event

One or more collisions have stopped

Accepts the following message:

Array<AvailableSensor>

Payload
array<object>
id
string
type
object
Enum: "TOUCHSENSOR" "TOUCHSENSOR_GROUP"
name
string
ordinal
integer

Additional properties are allowed.

translationkey
string

Additional items are allowed.

SLAM

Examples

Array<AvailableSensor>
Payload
Example #1
{
  "id": "string",
  "type": "TOUCHSENSOR",
  "translationkey": "string"
}

Pub zbos/slam/status/get

Get SLAM status

see <<zbos/slam/status/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

SLAM

Examples

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

Sub zbos/slam/status/response/{key}

response: Get SLAM status

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SlamStatus

Payload
object
mappingConfigurable
boolean
mappingEnabled
boolean

Additional properties are allowed.

SLAM

Examples

SlamStatus
Payload
Example #1
{
  "mappingConfigurable": true,
  "mappingEnabled": true
}

Sub zbos/slam/status/event

event: Status SLAM

Accepts the following message:

SlamStatus

Payload
object
mappingConfigurable
boolean
mappingEnabled
boolean

Additional properties are allowed.

SLAM

Examples

SlamStatus
Payload
Example #1
{
  "mappingConfigurable": true,
  "mappingEnabled": true
}

Pub zbos/slam/mapview/clear

Clear current map view

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/mapview/clear/event

event: Map view cleared

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/mapview/current

event: Map view changed

Accepts the following message:

String

Payload
string
SLAM

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/slam/mapview/current/get

Get current map view

see <<zbos/slam/mapview/current/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

SLAM

Examples

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

Sub zbos/slam/mapview/current/response/{key}

response: Get current map view

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

RemoteMapResponseObject

Payload
object
mapName
string
data
string

Additional properties are allowed.

SLAM

Examples

RemoteMapResponseObject
Payload
Example #1
{
  "mapName": "string",
  "data": "string"
}

Pub zbos/slam/mapping/enable

Enable SLAM mapping

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/mapping/disable

Disable SLAM mapping

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/mapping/extend/start

Start extending SLAM mapping

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/mapping/extend/cancel

Stop extending SLAM mapping

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/mapping/extend/get

Get extending SLAM mapping

see <<zbos/slam/mapping/extend/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

SLAM

Examples

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

Sub zbos/slam/mapping/extend/response/{key}

response: Get extending SLAM mapping

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
SLAM

Examples

String
Payload 
"string"
This example has been generated automatically.

Sub zbos/slam/mapping/extend/started

event: SLAM mapping extending started

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/mapping/extend/stopped

event: SLAM mapping extending stopped

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/mapping/extend/failed

event: SLAM mapping extending failed

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/mapping/extend/canceled

event: SLAM mapping extending canceled

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/maps/list/get

Get maps

see <<zbos/slam/maps/list/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

SLAM

Examples

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

Sub zbos/slam/maps/list/response/{key}

event: Get all maps

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<String>

Payload
array<string>

Items:

0
string

Additional items are allowed.

SLAM

Examples

Array<String>
Payload 
[
  "string"
]
This example has been generated automatically.

Pub zbos/slam/maps/get/current

Get current maps

see <<zbos/slam/maps/get/current/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

SLAM

Examples

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

Sub zbos/slam/maps/get/current/response/{key}

event: Get current maps

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SlamMap

Payload
object
mapName
string
poiList
array<object>
name
string
uuid
string
type
object
Enum: "DEFAULT" "CHARGING_STATION" "INTERACTIVE"
name
string
ordinal
integer

Additional properties are allowed.

coordinate
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

inAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

outAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

SLAM

Examples

SlamMap
Payload
Example #1
{
  "mapName": "string",
  "poiList": [
    {
      "name": "string",
      "uuid": "string",
      "type": "DEFAULT",
      "coordinate": {
        "x": 15,
        "y": 15,
        "rotation": 90,
        "rawX": 14.8,
        "rawY": 15.4
      },
      "inAction": {
        "actionType": "MQTT",
        "radius": 270,
        "target": "string",
        "data": "string"
      },
      "outAction": {
        "actionType": "MQTT",
        "radius": 270,
        "target": "string",
        "data": "string"
      }
    }
  ]
}

Pub zbos/slam/maps/load

Load map

Accepts the following message:

String

Payload
string
SLAM

Examples

String
Payload
Example #1
"string"

Sub zbos/slam/maps/load/event

event: Load map

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/maps/save

Save map

Accepts the following message:

String

Payload
string
SLAM

Examples

String
Payload
Example #1
"string"

Sub zbos/slam/maps/save/event

event: Save map

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/maps/delete

Delete map

Accepts the following message:

String

Payload
string
SLAM

Examples

String
Payload
Example #1
"string"

Pub zbos/slam/maps/delete/all

Deletes all maps

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/maps/delete/event

event: Delete map

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/location/current

event: Location changed

Accepts the following message:

ZbosLocation

Payload
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

SLAM

Examples

ZbosLocation
Payload
Example #1
{
  "x": 15,
  "y": 15,
  "rotation": 90,
  "rawX": 14.8,
  "rawY": 15.4
}

Pub zbos/slam/location/current/get

Get robot location

see <<zbos/slam/location/current/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

SLAM

Examples

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

Sub zbos/slam/location/current/response/{key}

response: Get robot location

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

ZbosLocation

Payload
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

SLAM

Examples

ZbosLocation
Payload
Example #1
{
  "x": 15,
  "y": 15,
  "rotation": 90,
  "rawX": 14.8,
  "rawY": 15.4
}

Pub zbos/slam/location/current/set

Set robot location

see <<zbos/slam/location/current/set/response/{key}>> for response

Accepts the following message:

ZbosSetLocationRequest

Payload
object
key
string

Required random key

coordinate
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

Additional properties are allowed.

SLAM

Examples

ZbosSetLocationRequest
Payload
Example #1
{
  "key": "string",
  "coordinate": {
    "x": 15,
    "y": 15,
    "rotation": 90,
    "rawX": 14.8,
    "rawY": 15.4
  }
}

Sub zbos/slam/location/current/set/response/{key}

response: Set robot location

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/location/recover

Recover robot location

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/location/recover/started

Location revocery started

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/location/recover/stopped

Location revocery stopped

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/location/recover/failed

Location revocery failed

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/location/reset/chargingstation

Reset robot to charging station

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/location/reset/chargingstation/started

Reset robot to charging station started

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/location/reset/chargingstation/stopped

Reset robot to charging station stopped

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/location/home

Home location changed

Accepts the following message:

ZbosLocation

Payload
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

SLAM

Examples

ZbosLocation
Payload
Example #1
{
  "x": 15,
  "y": 15,
  "rotation": 90,
  "rawX": 14.8,
  "rawY": 15.4
}

Pub zbos/slam/location/home/get

Get home location

see <<zbos/slam/location/home/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

SLAM

Examples

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

Sub zbos/slam/location/home/response/{key}

response: Get home location

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

ZbosLocation

Payload
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

SLAM

Examples

ZbosLocation
Payload
Example #1
{
  "x": 15,
  "y": 15,
  "rotation": 90,
  "rawX": 14.8,
  "rawY": 15.4
}

Pub zbos/slam/walls/clear

clear all walls

Save is optional, if false, then the map will not be saved. By default the map will be saved.

Accepts the following message:

WallClearRequest

Payload
object
save
boolean

Additional properties are allowed.

SLAM

Examples

WallClearRequest
Payload
Example #1
{
  "save": true
}

Sub zbos/slam/walls/clear/event

response: Clear all walls

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/walls/current

Walls changed

Accepts the following message:

String

Payload
string
SLAM

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/slam/walls/current/get

Get current walls

see <<zbos/slam/walls/current/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

SLAM

Examples

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

Sub zbos/slam/walls/current/response/{key}

response: Get current walls

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<Wall>

Payload
array<object>
startPoint
object
x
number
y
number

Additional properties are allowed.

endPoint
object
x
number
y
number

Additional properties are allowed.

segmentId
string
save
boolean

Additional items are allowed.

SLAM

Examples

Array<Wall>
Payload
Example #1
{
  "startPoint": {
    "x": 1,
    "y": 1
  },
  "endPoint": {
    "x": 5,
    "y": 5
  },
  "segmentId": "string",
  "save": true
}

Pub zbos/slam/walls/add

Add wall

Accepts the following message:

Wall

Payload
object
startPoint
object
x
number
y
number

Additional properties are allowed.

endPoint
object
x
number
y
number

Additional properties are allowed.

segmentId
string
save
boolean

Additional properties are allowed.

SLAM

Examples

Wall
Payload
Example #1
{
  "startPoint": {
    "x": 1,
    "y": 1
  },
  "endPoint": {
    "x": 5,
    "y": 5
  },
  "segmentId": "string",
  "save": true
}

Sub zbos/slam/walls/add/event

event: Add wall

Accepts the following message:

Wall

Payload
object
startPoint
object
x
number
y
number

Additional properties are allowed.

endPoint
object
x
number
y
number

Additional properties are allowed.

segmentId
string
save
boolean

Additional properties are allowed.

SLAM

Examples

Wall
Payload
Example #1
{
  "startPoint": {
    "x": 1,
    "y": 1
  },
  "endPoint": {
    "x": 5,
    "y": 5
  },
  "segmentId": "string",
  "save": true
}

Pub zbos/slam/walls/remove

Remove wall

Accepts the following message:

WallRemoveRequest

Payload
object
segmentId
integer
save
boolean

Additional properties are allowed.

SLAM

Examples

WallRemoveRequest
Payload
Example #1
{
  "segmentId": 5,
  "save": true
}

Pub zbos/slam/walls/remove/multiple

Remove walls

Accepts the following message:

Array<WallRemoveRequest>

Payload
array<object>
segmentId
integer
save
boolean

Additional items are allowed.

SLAM

Examples

Array<WallRemoveRequest>
Payload
Example #1
{
  "segmentId": 5,
  "save": true
}
Example #2
{
  "segmentId": 7,
  "save": true
}

Sub zbos/slam/walls/remove/event

event: Remove wall

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/walls/update

Update wall

Accepts the following message:

Wall

Payload
object
startPoint
object
x
number
y
number

Additional properties are allowed.

endPoint
object
x
number
y
number

Additional properties are allowed.

segmentId
string
save
boolean

Additional properties are allowed.

SLAM

Examples

Wall
Payload
Example #1
{
  "startPoint": {
    "x": 1,
    "y": 1
  },
  "endPoint": {
    "x": 5,
    "y": 5
  },
  "segmentId": "string",
  "save": true
}

Pub zbos/slam/walls/update/multiple

Update walls

Accepts the following message:

Array<Wall>

Payload
array<object>
startPoint
object
x
number
y
number

Additional properties are allowed.

endPoint
object
x
number
y
number

Additional properties are allowed.

segmentId
string
save
boolean

Additional items are allowed.

SLAM

Examples

Array<Wall>
Payload
Example #1
{
  "startPoint": {
    "x": 1,
    "y": 1
  },
  "endPoint": {
    "x": 5,
    "y": 5
  },
  "segmentId": "string",
  "save": true
}
Example #2
{
  "startPoint": {
    "x": 10,
    "y": 5
  },
  "endPoint": {
    "x": 20,
    "y": 10
  },
  "segmentId": "another_id",
  "save": true
}

Sub zbos/slam/walls/update/event

event: Update wall

Accepts the following message:

Wall

Payload
object
startPoint
object
x
number
y
number

Additional properties are allowed.

endPoint
object
x
number
y
number

Additional properties are allowed.

segmentId
string
save
boolean

Additional properties are allowed.

SLAM

Examples

Wall
Payload
Example #1
{
  "startPoint": {
    "x": 1,
    "y": 1
  },
  "endPoint": {
    "x": 5,
    "y": 5
  },
  "segmentId": "string",
  "save": true
}

Pub zbos/slam/interaction/moveto

Move robot to coordinates

Accepts the following message:

ZbosMoveToPointRequest

Payload
object
mapName
string
coordinate
object
x
number
y
number

Additional properties are allowed.

Additional properties are allowed.

SLAM

Examples

ZbosMoveToPointRequest
Payload
Example #1
{
  "mapName": "First floor",
  "coordinate": {
    "x": 39,
    "y": 40
  }
}

Sub zbos/slam/interaction/moveto/started

MoveTo started

Accepts the following message:

String

Payload
string
SLAM

Examples

String
Payload 
"string"
This example has been generated automatically.

Sub zbos/slam/interaction/moveto/stopped

MoveTo stopped

Accepts the following message:

String

Payload
string
SLAM

Examples

String
Payload 
"string"
This example has been generated automatically.

Sub zbos/slam/interaction/moveto/failed

MoveTo failed

Accepts the following message:

String

Payload
string
SLAM

Examples

String
Payload 
"string"
This example has been generated automatically.

Sub zbos/slam/interaction/moveto/aborted

MoveTo aborted

Accepts the following message:

String

Payload
string
SLAM

Examples

String
Payload 
"string"
This example has been generated automatically.

Sub zbos/slam/interaction/moveto/blocked

MoveTo Blocked

Accepts the following message:

String

Payload
string
SLAM

Examples

String
Payload 
"string"
This example has been generated automatically.

Sub zbos/slam/interaction/moveto/retrying

MoveTo retrying

Accepts the following message:

String

Payload
string
SLAM

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/slam/interaction/stop

Stop moving

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/interaction/stop/event

event: Movement stopped

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/laserscan/enable

Enable laserscan

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/laserscan/disable

disable laserscan

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/laserscan/current

event: Laserscan changed

Accepts the following message:

ZbosLaserScan

Payload
object
angle
number
distance
number

Additional properties are allowed.

SLAM

Examples

ZbosLaserScan
Payload
Example #1
{
  "angle": 0,
  "distance": 15
}

Sub zbos/slam/poi/current

event: POI changed

Accepts the following message:

SlamMap

Payload
object
mapName
string
poiList
array<object>
name
string
uuid
string
type
object
Enum: "DEFAULT" "CHARGING_STATION" "INTERACTIVE"
name
string
ordinal
integer

Additional properties are allowed.

coordinate
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

inAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

outAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

SLAM

Examples

SlamMap
Payload
Example #1
{
  "mapName": "First floor",
  "poiList": [
    {
      "name": "string",
      "uuid": "string",
      "type": "DEFAULT",
      "coordinate": {
        "x": 15,
        "y": 15,
        "rotation": 90,
        "rawX": 14.8,
        "rawY": 15.4
      },
      "inAction": {
        "actionType": "MQTT",
        "radius": 270,
        "target": "string",
        "data": "string"
      },
      "outAction": {
        "actionType": "MQTT",
        "radius": 270,
        "target": "string",
        "data": "string"
      }
    }
  ]
}

Pub zbos/slam/poi/clear

Clear all pois

Save is optional, if false, then the map will not be saved. By default the map will be saved.

Accepts the following message:

ZbosClearPoiRequest

Payload
object
mapName
string
save
boolean

Additional properties are allowed.

SLAM

Examples

ZbosClearPoiRequest
Payload
Example #1
{
  "mapName": "First floor",
  "save": true
}

Sub zbos/slam/poi/clear/event

event: Clear all pois

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/poi/list/all/get

Get list of pois for all maps

see <<zbos/slam/poi/list/all/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

SLAM

Examples

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

Sub zbos/slam/poi/list/all/response/{key}

event: Get list of pois for all maps

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<SlamMap>

Payload
array<object>
mapName
string
poiList
array<object>
name
string
uuid
string
type
object
Enum: "DEFAULT" "CHARGING_STATION" "INTERACTIVE"
name
string
ordinal
integer

Additional properties are allowed.

coordinate
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

inAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

outAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

Additional items are allowed.

Additional items are allowed.

SLAM

Examples

Array<SlamMap>
Payload
Example #1
{
  "mapName": "First floor",
  "poiList": [
    {
      "name": "string",
      "uuid": "string",
      "type": "DEFAULT",
      "coordinate": {
        "x": 15,
        "y": 15,
        "rotation": 90,
        "rawX": 14.8,
        "rawY": 15.4
      },
      "inAction": {
        "actionType": "MQTT",
        "radius": 270,
        "target": "string",
        "data": "string"
      },
      "outAction": {
        "actionType": "MQTT",
        "radius": 270,
        "target": "string",
        "data": "string"
      }
    }
  ]
}

Pub zbos/slam/poi/list/get

Get list of pois for current map

see <<zbos/slam/poi/list/response/{key}>> for response

Accepts the following message:

ZbosMapDetailRequest

Payload
object
key
string

Required random key

mapName
string

Additional properties are allowed.

SLAM

Examples

ZbosMapDetailRequest
Payload
Example #1
{
  "key": "_dfse",
  "mapName": "First floor"
}

Sub zbos/slam/poi/list/response/{key}

event: Get list of pois for current map

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SlamMap

Payload
object
mapName
string
poiList
array<object>
name
string
uuid
string
type
object
Enum: "DEFAULT" "CHARGING_STATION" "INTERACTIVE"
name
string
ordinal
integer

Additional properties are allowed.

coordinate
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

inAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

outAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

SLAM

Examples

SlamMap
Payload
Example #1
{
  "mapName": "First floor",
  "poiList": [
    {
      "name": "string",
      "uuid": "string",
      "type": "DEFAULT",
      "coordinate": {
        "x": 15,
        "y": 15,
        "rotation": 90,
        "rawX": 14.8,
        "rawY": 15.4
      },
      "inAction": {
        "actionType": "MQTT",
        "radius": 270,
        "target": "string",
        "data": "string"
      },
      "outAction": {
        "actionType": "MQTT",
        "radius": 270,
        "target": "string",
        "data": "string"
      }
    }
  ]
}

Pub zbos/slam/poi/add

Add poi

Accepts the following message:

ZbosAddPoiRequest

Payload
object
mapName
string
poi
object
name
string
uuid
string
type
object
Enum: "DEFAULT" "CHARGING_STATION" "INTERACTIVE"
name
string
ordinal
integer

Additional properties are allowed.

coordinate
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

inAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

outAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

Additional properties are allowed.

save
boolean

Additional properties are allowed.

SLAM

Examples

ZbosAddPoiRequest
Payload
Example #1
{
  "mapName": "First floor",
  "poi": {
    "name": "Home",
    "uuid": "string",
    "type": "DEFAULT",
    "coordinate": {
      "x": 15,
      "y": 15,
      "rotation": 90
    }
  },
  "save": false
}

Sub zbos/slam/poi/add/event

event: Add poi

Accepts the following message:

Poi

Payload
object
name
string
uuid
string
type
object
Enum: "DEFAULT" "CHARGING_STATION" "INTERACTIVE"
name
string
ordinal
integer

Additional properties are allowed.

coordinate
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

inAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

outAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

Additional properties are allowed.

SLAM

Examples

Poi
Payload
Example #1
{
  "name": "string",
  "uuid": "string",
  "type": "DEFAULT",
  "coordinate": {
    "x": 15,
    "y": 15,
    "rotation": 90
  }
}

Pub zbos/slam/poi/edit

Edit poi

Accepts the following message:

ZbosEditPoiRequest

Payload
object
mapName
string
poi
object
name
string
uuid
string
type
object
Enum: "DEFAULT" "CHARGING_STATION" "INTERACTIVE"
name
string
ordinal
integer

Additional properties are allowed.

coordinate
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

inAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

outAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

Additional properties are allowed.

save
boolean

Additional properties are allowed.

SLAM

Examples

ZbosEditPoiRequest
Payload
Example #1
{
  "mapName": "First floor",
  "poi": {
    "name": "Home",
    "uuid": "string",
    "type": "DEFAULT",
    "coordinate": {
      "x": 15,
      "y": 15,
      "rotation": 90
    }
  },
  "save": false
}

Sub zbos/slam/poi/edit/event

event: Edit poi

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/poi/remove/name

Remove poi by name

Accepts the following message:

ZbosRemovePoiByNameRequest

Payload
object
mapName
string
name
string
save
boolean

Additional properties are allowed.

SLAM

Examples

ZbosRemovePoiByNameRequest
Payload
Example #1
{
  "mapName": "First floor",
  "name": "Home",
  "save": false
}

Sub zbos/slam/poi/remove/name/event

event: Remove poi by name

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/poi/remove/uuid

Remove poi by uuid

Accepts the following message:

ZbosRemovePoiByUUIDRequest

Payload
object
mapName
string
uuid
string
save
boolean

Additional properties are allowed.

SLAM

Examples

ZbosRemovePoiByUUIDRequest
Payload
Example #1
{
  "mapName": "First floor",
  "uuid": "abcd-qsdf-qsdfd-qsdf",
  "save": false
}

Sub zbos/slam/poi/remove/uuid/event

event: Remove poi by uuid

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/poi/moveto/uuid

Move robot to poi

Accepts the following message:

ZbosMoveToPoiByUUIDRequest

Payload
object
mapName
string
uuid
string
speed
integer
>= 0 <= 100

Percentage value between with range 0 to 100

Additional properties are allowed.

SLAM

Examples

ZbosMoveToPoiByUUIDRequest
Payload
Example #1
{
  "mapName": "First floor",
  "uuid": "abcd-qsdf-qsdfd-qsdf",
  "speed": 50
}

Sub zbos/slam/path/remaining/current

Path remaining changed

Accepts the following message:

ZbosRemainingPathObject

Payload
object
remainingPathPoints
array<object>
x
number
y
number
z
number

Additional items are allowed.

remainingMilestones
array<object>
x
number
y
number
z
number

Additional items are allowed.

Additional properties are allowed.

SLAM

Examples

ZbosRemainingPathObject
Payload
Example #1
{
  "remainingPathPoints": [
    {
      "x": 50,
      "y": 35,
      "z": 1
    }
  ],
  "remainingMilestones": [
    {
      "x": 50,
      "y": 35,
      "z": 1
    }
  ]
}

Sub zbos/slam/charging/required/started

Charging required

Is published when battery is low/critical to indicate the robot is going to try charge itself.

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/charging/required/stopped

Battery is not critical

Is published when robot has stopped charging itself

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/charging/goto

Go to charging station

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/charging/goto/started

Move to charging station started

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/charging/goto/stopped

Move to charging station stopped

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/charging/goto/failed

Move to charging station failed

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/slam/docking/undock/start

Undock

Leave charging station

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/docking/undock/started

Undocking started

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/docking/undock/finished

Undocking finished

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/slam/docking/undock/failed

Undocking failed

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

SLAM

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/languages/available/get

Get available languages

Legacy topic for getting all installed languages (both tts and asr combined). Better not to use this.see <<zbos/dialog/languages/available/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Speech

Examples

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

Sub zbos/dialog/languages/available/response/{key}

response: Get available languages

response: Legacy topic for getting all installed languages (both tts and asr combined)

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<String>

Payload
array<string>

Items:

0
string

Additional items are allowed.

Speech

Examples

Array<String>
Payload
Example #1
"en-US"
Example #2
"nl-BE"
Example #3
"fr-FR"

Pub zbos/dialog/languages/current/get

Get current language

see <<zbos/dialog/languages/current/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Speech

Examples

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

Sub zbos/dialog/languages/current/response/{key}

response: Get current language

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
Speech

Examples

String
Payload
Example #1
"en-US"

Pub zbos/dialog/languages/current/set

Set current language

Set the active language, example: 'en-US'. Note: this will be probably be changed to <<zbos/dialog/set/language>> in a future release.

Accepts the following message:

String

Payload
string
Speech

Examples

String
Payload
Example #1
"en-US"

Pub zbos/dialog/set/message

Speak a message

Use this to make the robot say something.

Accepts the following message:

String

Payload
string
Speech

Examples

String
Payload
Example #1
"Hello world"

Pub zbos/dialog/set

Speak a message with parameters

Use this to make the robot say something with parameters. Only message is required, other params are optional.

Accepts the following message:

DialogOptions

Payload
object
requestId
string
message
string
speed
integer
language
string

Language string like "en-US"

volume
integer
gesticulation
boolean
voice
string
pitch
integer
blocking
boolean

Additional properties are allowed.

Speech

Examples

DialogOptions
Payload
Example #1
{
  "requestId": "1",
  "message": "Hello world",
  "speed": 50,
  "language": "en-US",
  "volume": 50,
  "gesticulation": true,
  "voice": "Ava",
  "pitch": 120
}

Sub zbos/dialog/languages/current/event

event: Current language

Event when the system is done with changing language to a new language.

Accepts the following message:

String

Payload
string
Speech

Examples

String
Payload
Example #1
"en-US"

Pub zbos/dialog/animatedspeech/enable

Enable animated speech

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/animatedspeech/disable

Disable animated speech

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/animatedspeech/get

Get status of animated speech

see <<zbos/dialog/animatedspeech/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Speech

Examples

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

Sub zbos/dialog/animatedspeech/response/{key}

response: Get status of animated speech

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Boolean

Payload
boolean
Speech

Examples

Boolean
Payload 
true
This example has been generated automatically.

Pub zbos/dialog/tts/start

event: TTS started

Event when the robot starts speaking and what it is saying

Accepts the following message:

String

Payload
string
Speech

Examples

String
Payload
Example #1
"Hi, my name is James"

Pub zbos/dialog/pause/hotword

pause hotword recognition

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/resume/hotword

resume hotword recognition

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/dialog/tts/end

event: TTS ended

Event when the robot has finished speaking

Accepts the following message:

String

Payload
string
Speech

Examples

String
Payload 
"string"
This example has been generated automatically.

Sub zbos/event/dialog/listen/started

event: robot starts listening

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/event/dialog/listen/stopped

event: robot stops listening

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/listen/start

Start listening

Start listening for hotword and commands

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/listen/stop

Stop listening

Cancel hotword recognition

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/service/start

Start dialog service

Start the dialog service so the robot can listen to the mic.

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/service/stop

Stop dialog service

Stop the dialog service so the mic is free to use by other applications.

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/dialog/service/stopped

Event: dialog service stopped

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/dialog/service/started

Event: dialog service started

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/iflytek/rotation/started

Iflytek rotation started

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/iflytek/rotation/stopped

Iflytek rotation stopped

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/tts/phonemereached

event. Phoneme reached

Accepts the following message:

PhonemeInfo

Payload
object
jawOpen
boolean
lipTension
integer
mouthHeight
integer
mouthUpturn
integer
mouthWidth
integer
teethLowerVisible
integer
teethUpperVisible
integer
tonguePosition
integer

Additional properties are allowed.

Speech

Examples

PhonemeInfo
Payload
Example #1
{
  "jawOpen": false,
  "lipTension": 0,
  "mouthHeight": 10,
  "mouthUpturn": 0,
  "mouthWidth": 5,
  "teethLowerVisible": 1,
  "teethUpperVisible": 1,
  "tonguePosition": 1
}

Pub zbos/dialog/grammars/add/multiple

Grammars: add multiple

This is an extension for the grammar add topic. It removes all grammars first and then triggers a single platform reload. Hence grammars are added a lot faster.see <<zbos/dialog/grammars/add/response>> for response

Accepts the following message:

Array<CustomGrammar>

Payload
array<object>
id
string

a unique id of the grammar. This must be unique among the application (next field).

app
string

The application name. This will be used to determined which MQTT topic will be used to post the json output to.

continuous
boolean
input
object

Contains an array for each language with all the possible sentences. The sentences need to be in a format that the speech software understands.

Additional properties are allowed.

variables
object

Additional properties are allowed.

Additional items are allowed.

Speech

Examples

Array<CustomGrammar>
Payload
Example #1
{
  "id": "question_1_variable",
  "app": "App",
  "continuous": true,
  "input": {
    "nl-BE": [
      "Ken jij $name"
    ],
    "en-US": [
      "Do you know $name"
    ]
  },
  "variables": {
    "name": {
      "nl-BE": [
        {
          "input": "Arno",
          "data": "name_in_dutch"
        },
        {
          "input": "Gilles",
          "data": "name_in_dutch"
        }
      ],
      "en-US": [
        {
          "input": "Arno",
          "data": "name_in_english"
        },
        {
          "input": "Gilles",
          "data": "name_in_english"
        }
      ]
    }
  }
}

Sub zbos/dialog/grammars/add/response

response: grammar add

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Speech

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/dialog/grammars/remove/multiple

Grammars: remove multiple

This is an extension for the grammar remove topic. It removes all grammars first and then triggers a single platform reload. Hence grammars are removed a lot faster.see <<zbos/dialog/grammars/remove/response>> for response

Accepts the following message:

Array<CustomGrammar>

Payload
array<object>
id
string

a unique id of the grammar. This must be unique among the application (next field).

app
string

The application name. This will be used to determined which MQTT topic will be used to post the json output to.

continuous
boolean
input
object

Contains an array for each language with all the possible sentences. The sentences need to be in a format that the speech software understands.

Additional properties are allowed.

variables
object

Additional properties are allowed.

Additional items are allowed.

Speech

Examples

Array<CustomGrammar>
Payload
Example #1
{
  "id": "id send in add",
  "app": "app from add"
}

Sub zbos/dialog/grammars/remove/response

response: grammar add

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Speech

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/dialog/grammars/match/{appId}

Event: grammar match

Event when a custom grammar match is found, the output data is posted here.

Parameters
appId
required
string

Should be replaced by the app id used in the 'zbos/dialog/grammars/add/multiple' topic

Accepts the following message:

GrammarMatch

Payload
object
app
string
triggered-by
string

The id of the grammer that has matched with the user input. This is the id from the input json.

language
string

Language that speech software was configured in when the sentence is recognised.

variables
object

Additional properties are allowed.

Additional properties are allowed.

Speech

Examples

GrammarMatch
Payload
Example #1
{
  "app": "food_pair_question_2_variable",
  "id": "input ID",
  "language": "en-US",
  "variables": {
    "beverage": {
      "input": "Wine",
      "data": "this is wine"
    },
    "dish": {
      "input": "hamburger",
      "data": "this is a hamburger"
    }
  }
}

Pub zbos/dialog/custom/grammar/rules/get

Gets all custom grammar rules

see <<zbos/dialog/custom/grammar/rules/get/response>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Speech

Examples

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

Sub zbos/dialog/custom/grammar/rules/get/response

response: Get all custom grammar rules

Accepts the following message:

Array<String>

Payload
array<string>

Items:

0
string

Additional items are allowed.

Speech

Examples

Array<String>
Payload 
[
  "string"
]
This example has been generated automatically.

Pub zbos/dialog/tts/languages/get

Get TTS languages

Get a list of languages that the TTS engine can use to talk.see <<zbos/dialog/tts/languages/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Speech

Examples

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

Sub zbos/dialog/tts/languages/response/{key}

response: TTS languages list

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
Speech

Examples

String
Payload
Example #1
"BE"

Pub zbos/dialog/tts/languages/current/get

Get current TTS language

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Speech

Examples

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

Pub zbos/dialog/tts/languages/current/set

Set TTS language

Accepts the following message:

String

Payload
string
Speech

Examples

String
Payload
Example #1
"nl-BE"

Pub zbos/dialog/asr/languages/get

Get ASR languages

Get a list of languages recognized by the ASR engine. note: For now this is limited to the language code defined in the config. No Vocon load check is done yet.see <<zbos/dialog/asr/languages/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Speech

Examples

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

Sub zbos/dialog/asr/languages/response/{key}

response: ASR languages list

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
Speech

Examples

String
Payload
Example #1
"nl-BE"

Pub zbos/dialog/asr/languages/current/get

Get current ASR language

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Speech

Examples

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

Pub zbos/dialog/asr/languages/current/set

Set ASR language

Accepts the following message:

String

Payload
string
Speech

Examples

String
Payload
Example #1
"nl-BE"

Sub zbos/asr/recognition/result

Speech recognised event

Event send by the dialog service when user said something. Mainly for subtitles.

Accepts the following message:

SpeechToTextResult

Payload
object
language
object
baseLocale
object
language
string
script
string
region
string
variant
string
hash
integer

Additional properties are allowed.

localeExtensions
object
extensionMap
object

Additional properties are allowed.

id
string

Additional properties are allowed.

hashCodeValue
integer
languageTag
string

Additional properties are allowed.

text
string
confidence
number

Additional properties are allowed.

Speech

Examples

SpeechToTextResult
Payload
Example #1
{
  "text": "Okay James",
  "confidence": 78
}

Pub zbos/dialog/grammars/load

Grammars: load

Request from speech software to load custom grammars from the storage on the robot.see <<zbos/dialog/grammars/load/response>> for response

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/dialog/grammars/load/response

response: loaded grammars

Response from the RIL with all the rules stored in a file on the robot.

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/speech/provider/start

Start speech provider

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/speech/provider/stop

Stop speech provider

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/text/command

Send a text message to dialog system

Accepts the following message:

String

Payload
string
Speech

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/dialog/language/setup/start

Start language setup

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/language/setup/stop

Stop language setup

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/set/config

Set the current speech config

see <<zbos/dialog/set/config/response/{key}>> for response

Accepts the following message:

SetDialogConfigRequest

Payload
object
config_items
object

One or more config items.

Additional properties are allowed.

key
string

Required random key

Additional properties are allowed.

Speech

Examples

SetDialogConfigRequest
Payload
Example #1
{
  "key": "ABCxyz",
  "config_items": {}
}

Sub zbos/dialog/set/config/response/{key}

response: Speech config was set

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SetDialogConfigRequest

Payload
object
config_items
object

One or more config items.

Additional properties are allowed.

key
string

Required random key

Additional properties are allowed.

Speech

Examples

SetDialogConfigRequest
Payload
Example #1
{
  "key": "ABCxyz",
  "config_items": {}
}

Pub zbos/dialog/get/config

Get the current speech config

see <<zbos/dialog/get/config/response>> for response

Accepts the following message:

GetDialogConfigRequest

Payload
object
config_items
array<string>

One or more config keys.

Items:

0
string

Additional items are allowed.

key
string

Required random key

Additional properties are allowed.

Speech

Examples

GetDialogConfigRequest
Payload
Example #1
{
  "key": "ABCxyz",
  "config_items": []
}

Sub zbos/dialog/get/config/response

response: Current dialog config

Accepts the following message:

GetDialogConfigRequest

Payload
object
config_items
array<string>

One or more config keys.

Items:

0
string

Additional items are allowed.

key
string

Required random key

Additional properties are allowed.

Speech

Examples

GetDialogConfigRequest
Payload
Example #1
{
  "key": "ABCxyz",
  "config_items": []
}

Pub zbos/dialog/reset/config

Reset the current speech config

see <<zbos/dialog/reset/config/response>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Speech

Examples

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

Sub zbos/dialog/reset/config/response

response: Config has been reset

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Speech

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Sub zbos/dialog/odp/system/ready

ODP System is initialised

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/dialog/odp/started

ODP event: Speech engine starts or stops

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/odp/text/command

ODP: speak a message

Accepts the following message:

OdpParseContextMessage

Payload
object
text
string
offerMoreHelp
boolean

Additional properties are allowed.

Speech

Examples

OdpParseContextMessage
Payload
Example #1
{
  "text": "Text",
  "offerMoreHelp": true
}

Pub zbos/dialog/odp/get/config

ODP: get config

see <<zbos/dialog/odp/get/config/response>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Speech

Examples

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

Sub zbos/dialog/odp/get/config/response

ODP response: get config

Accepts the following message:

Map

Payload
object

Additional properties are allowed.

Speech

Examples

Map
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/odp/reset/config

ODP: reset config

see <<zbos/dialog/odp/reset/config/response>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Speech

Examples

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

Sub zbos/dialog/odp/reset/config/response

ODP response: reset config

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Speech

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/dialog/odp/pause/hotword

ODP: pause hotword

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/odp/resume/hotword

ODP: resume hotword

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/dialog/odp/hotword/recognised

ODP event: hotword recognised

Accepts the following message:

OdpHotwordRecognisedPayload

Payload
object
language
string
confidence
number
text
string

Additional properties are allowed.

Speech

Examples

OdpHotwordRecognisedPayload
Payload
Example #1
{
  "language": "en-US",
  "confidence": 50,
  "text": "Okay James"
}

Pub zbos/dialog/odp/grammars/load

ODP: load grammars

see <<zbos/dialog/odp/grammars/load/response>> for response

Accepts the following message:

String

Payload
string
Speech

Examples

String
Payload 
"string"
This example has been generated automatically.

Sub zbos/dialog/odp/grammars/load/response

ODP response: load grammars

Accepts the following message:

String

Payload
string
Speech

Examples

String
Payload 
"string"
This example has been generated automatically.

Sub zbos/dialog/odp/asr/recognition/result

ODP event: asr recognition

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/odp/tts/languages/get

ODP: get tts languages

see <<zbos/dialog/odp/tts/languages/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Speech

Examples

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

Sub zbos/dialog/odp/tts/languages/response/{key}

ODP response: get tts languages

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<TtsVoiceInfo>

Payload
array<object>
service
string
name
string
age
string
language
string
languageCode
string
gender
string
languageVersion
string
frequency
integer

Additional items are allowed.

Speech

Examples

Array<TtsVoiceInfo>
Payload
Example #1
{
  "service": "Service",
  "name": "Name",
  "age": "21",
  "language": "English",
  "languageCode": "en-US",
  "gender": "Female",
  "languageVersion": "4.2.0",
  "frequency": 65
}

Pub zbos/dialog/odp/asr/enable

ODP: enable ASR

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/odp/asr/disable

ODP: disable ASR

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/odp/asr/languages/get

ODP: get ASR languages

see <<zbos/dialog/odp/asr/languages/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Speech

Examples

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

Sub zbos/dialog/odp/asr/languages/response/{key}

ODP response: get ASR languages

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<OdpAsrLanguagesResponse>

Payload
array<object>
languageCode
string

Additional items are allowed.

Speech

Examples

Array<OdpAsrLanguagesResponse>
Payload
Example #1
{
  "languageCode": "en-US"
}

Sub zbos/dialog/odp/languages/current/event

ODP event: current language

Accepts the following message:

String

Payload
string
Speech

Examples

String
Payload 
"string"
This example has been generated automatically.

Sub zbos/dialog/odp/listen/started

ODP event: listen started

Accepts the following message:

Boolean

Payload
boolean
Speech

Examples

Boolean
Payload 
true
This example has been generated automatically.

Sub zbos/dialog/odp/listen/stopped

ODP event: listen stopped

Accepts the following message:

Boolean

Payload
boolean
Speech

Examples

Boolean
Payload 
true
This example has been generated automatically.

Pub zbos/dialog/odp/listen/start

ODP: start listening

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/odp/listen/stop

ODP: stop listening

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/dialog/odp/asr/event

ODP event: ASR

Accepts the following message:

OdpSpeechRecognisedMessage

Payload
object
recogniseId
string
language
string
confidence
number
text
string

Additional properties are allowed.

Speech

Examples

OdpSpeechRecognisedMessage
Payload
Example #1
{
  "recogniseId": "ID",
  "language": "en-US",
  "confidence": 50,
  "text": "Hello James"
}

Sub zbos/dialog/odp/tts/phonemereached

ODP event: tts phoneme reached

Accepts the following message:

OdpPhonemeInfo

Payload
object
jawOpen
boolean
lipTension
integer
mouthHeight
integer
mouthUpturn
integer
mouthWidth
integer
teethLowerVisible
integer
teethUpperVisible
integer
tonguePosition
integer

Additional properties are allowed.

Speech

Examples

OdpPhonemeInfo
Payload
Example #1
{
  "jawOpen": false,
  "lipTension": 0,
  "mouthHeight": 2,
  "mouthUpturn": 0,
  "mouthWidth": 5,
  "teethLowerVisible": 1,
  "teethUpperVisible": 1,
  "tonguePosition": 0
}

Pub zbos/dialog/odp/tts/phonemes/on

ODP: start tts phoneme

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/odp/tts/phonemes/off

ODP: stop tts phoneme

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/odp/grammars/add/multiple

ODP: add multiple grammars

see <<zbos/dialog/odp/grammars/add/response>> for response

Accepts the following message:

OdpCustomGrammar

Payload
object
id
string

a unique id of the grammar. This must be unique among the application (next field).

app
string

The application name. This will be used to determined which MQTT topic will be used to post the json output to.

continuous
boolean
input
object

Contains an array for each language with all the possible sentences. The sentences need to be in a format that the speech software understands.

Additional properties are allowed.

variables
object

Additional properties are allowed.

Additional properties are allowed.

Speech

Examples

OdpCustomGrammar
Payload
Example #1
{
  "id": "question_1_variable",
  "app": "App",
  "continuous": true,
  "input": {
    "en-US": [
      "Do you know $name"
    ],
    "nl-BE": [
      "Ken jij $name"
    ]
  },
  "variables": {
    "name": {
      "en-US": [
        {
          "input": "Arno",
          "data": "name_in_english"
        },
        {
          "input": "Gilles",
          "data": "name_in_english"
        }
      ],
      "nl-BE": [
        {
          "input": "Arno",
          "data": "name_in_dutch"
        },
        {
          "input": "Gilles",
          "data": "name_in_dutch"
        }
      ]
    }
  }
}

Sub zbos/dialog/odp/grammars/add/response

ODP response: add multiple grammars

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Speech

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/dialog/odp/grammars/remove/multiple

ODP: remove multiple grammars

see <<zbos/dialog/odp/grammars/remove/response>> for response

Accepts the following message:

OdpRemoveCustomGrammarRequest

Payload
object
id
string
app
string

Additional properties are allowed.

Speech

Examples

OdpRemoveCustomGrammarRequest
Payload
Example #1
{
  "id": "ID",
  "app": "App"
}

Sub zbos/dialog/odp/grammars/remove/response

ODP response: remove multiple grammars

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Speech

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/dialog/odp/grammars/match/{key}

ODP: match grammars

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

OdpGrammarMatchResponse

Payload
object
triggered-by
string
language
string
variables
object

Additional properties are allowed.

Additional properties are allowed.

Speech

Examples

OdpGrammarMatchResponse
Payload
Example #1
{
  "language": "en-US",
  "variables": {
    "name": {
      "input": "James",
      "data": "name_james"
    }
  },
  "triggered-by": "I am $name"
}

Pub zbos/dialog/odp/custom/grammar/rules/get

ODP: get custom grammar rules

see <<zbos/dialog/odp/custom/grammar/rules/get/response>> for response

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/dialog/odp/custom/grammar/rules/get/response

ODP response: get custom grammar rules

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/dialog/odp/context/event

event: Context parsing triggered by ODP

Accepts the following message:

OdpContextParsed

Payload
object
synthesisId
string
language
string
text
string

Additional properties are allowed.

Speech

Examples

OdpContextParsed
Payload
Example #1
{
  "language": "en-US",
  "text": "Hi my name is James"
}

Pub zbos/dialog/odp/context/listen/request

New request for user input

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/dialog/odp/tts/say

ODP: tts say

see <<zbos/dialog/odp/tts/say/response/{key}>> for response

Accepts the following message:

OdpTtsSayMessage

Payload
object
synthesisId
string
mqttResponseKey
string
language
string
voiceName
string
ssml
string

Additional properties are allowed.

Speech

Examples

OdpTtsSayMessage
Payload
Example #1
{
  "language": "en-US",
  "voiceName": "default"
}

Sub zbos/dialog/odp/tts/say/response/{key}

ODP response: tts say

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/dialog/odp/tts/started

ODP event: tts started

Accepts the following message:

Boolean

Payload
boolean
Speech

Examples

Boolean
Payload 
true
This example has been generated automatically.

Sub zbos/dialog/odp/tts/stopped

ODP event: tts stopped

Accepts the following message:

Boolean

Payload
boolean
Speech

Examples

Boolean
Payload 
true
This example has been generated automatically.

Pub zbos/dialog/odp/beep

Beep

see <<zbos/dialog/odp/beep/response/{key}>> for response

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/dialog/odp/beep/response/{key}

response: Beep

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Boolean

Payload
boolean
Speech

Examples

Boolean
Payload 
true
This example has been generated automatically.

Pub zbos/dialog/odp/offer/help

Offer help

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Speech

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/notification/all/event

Notify everything

Accepts the following message:

NotificationOptions

Message json

Payload
object
message
object
message
string
translate
boolean
formatArguments
array<string>

Items:

0
string

Additional items are allowed.

translationCategory
string

Additional properties are allowed.

Additional properties are allowed.

Status

Examples

NotificationOptions
Payload
Example #1
{
  "message": {
    "message": "string",
    "translate": true,
    "formatArguments": [
      "string"
    ]
  }
}

Sub zbos/notification/info/event

Notify information

Accepts the following message:

NotificationOptions

Message json

Payload
object
message
object
message
string
translate
boolean
formatArguments
array<string>

Items:

0
string

Additional items are allowed.

translationCategory
string

Additional properties are allowed.

Additional properties are allowed.

Status

Examples

NotificationOptions
Payload
Example #1
{
  "message": {
    "message": "string",
    "translate": true,
    "formatArguments": [
      "string"
    ]
  }
}

Sub zbos/notification/warning/event

Notify warnings

Accepts the following message:

NotificationOptions

Message json

Payload
object
message
object
message
string
translate
boolean
formatArguments
array<string>

Items:

0
string

Additional items are allowed.

translationCategory
string

Additional properties are allowed.

Additional properties are allowed.

Status

Examples

NotificationOptions
Payload
Example #1
{
  "message": {
    "message": "string",
    "translate": true,
    "formatArguments": [
      "string"
    ]
  }
}

Sub zbos/notification/error/event

Notify errors

Accepts the following message:

NotificationOptions

Message json

Payload
object
message
object
message
string
translate
boolean
formatArguments
array<string>

Items:

0
string

Additional items are allowed.

translationCategory
string

Additional properties are allowed.

Additional properties are allowed.

Status

Examples

NotificationOptions
Payload
Example #1
{
  "message": {
    "message": "string",
    "translate": true,
    "formatArguments": [
      "string"
    ]
  }
}

Pub zbos/survey/get

Get survey

see <<zbos/survey/get/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Survey

Examples

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

Sub zbos/survey/get/response/{key}

response: Get survey

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
Survey

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/survey/all/get

Get all surveys

see <<zbos/survey/all/get/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Survey

Examples

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

Sub zbos/survey/all/get/response/{key}

response: Get all surveys

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<SimpleSurvey>

Payload
array<object>
id
string
name
string
type
string
meta
object
languages
array<string>

Items:

0
string

Additional items are allowed.

default_language
string
version
string
created_on
string
last_updated_on
string

Additional properties are allowed.

Additional items are allowed.

Survey

Examples

Array<SimpleSurvey>
Payload
Example #1
{
  "id": "string",
  "name": "string"
}

Pub zbos/survey/save

Add/save survey

Accepts the following message:

SimpleSurvey

Payload
object
id
string
name
string
type
string
meta
object
languages
array<string>

Items:

0
string

Additional items are allowed.

default_language
string
version
string
created_on
string
last_updated_on
string

Additional properties are allowed.

Additional properties are allowed.

Survey

Examples

SimpleSurvey
Payload
Example #1
{
  "id": "string"
}

Sub zbos/survey/save/event

event: Survey added/saved

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Survey

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/survey/delete

Delete survey

Accepts the following message:

SimpleSurvey

Payload
object
id
string
name
string
type
string
meta
object
languages
array<string>

Items:

0
string

Additional items are allowed.

default_language
string
version
string
created_on
string
last_updated_on
string

Additional properties are allowed.

Additional properties are allowed.

Survey

Examples

SimpleSurvey
Payload
Example #1
{
  "id": "string"
}

Sub zbos/survey/delete/event

event: Survey deleted

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Survey

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/alarm/trigger

Call for help

Send an Alarm message, trigger alarm, call for help.

Accepts the following message:

SipConfig

Payload
object
serverDomain
string
localUsername
string
localPassword
string
localPort
integer
peerUsername
string
peerPassword
string
peerPort
integer
metaData
object

Additional properties are allowed.

alarmType
object
Enum: "DEFAULT" "VERKLIZAN" "SENSOR"
name
string
ordinal
integer

Additional properties are allowed.

callTimeout
integer
hangupAllowed
boolean
enabled
boolean

Additional properties are allowed.

System

Examples

SipConfig
Payload
Example #1
{
  "serverDomain": "string",
  "localUsername": "string",
  "localPassword": "string",
  "localPort": 5060,
  "peerUsername": "string",
  "peerPassword": "string",
  "peerPort": 5060,
  "metaData": {},
  "alarmType": "DEFAULT",
  "callTimeout": 120000,
  "hangupAllowed": false,
  "enabled": false
}

Sub zbos/alarm/trigger/event

event: Trigger alarm and call for help

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

System

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/alarm/call/started

Alarm call started

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

System

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/alarm/call/established

Alarm call established

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

System

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/alarm/call/ended

Alarm call ended

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

System

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/alarm/set

Set alarm call

see <<zbos/alarm/set/response>> for response

Accepts the following message:

ZbosAlarm

Payload
object
key
string
alarmServiceProvider
object
Enum: "verklizan" "sensor"
name
string
ordinal
integer

Additional properties are allowed.

metadata
object

Additional properties are allowed.

Additional properties are allowed.

System

Examples

ZbosAlarm
Payload
Example #1
{
  "key": "string",
  "alarmServiceProvider": "sensor",
  "metadata": {}
}

Sub zbos/alarm/set/response

response: Set alarm call

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

System

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Sub zbos/alarm/event

Alarm has been received

An event indicating an alarm was triggered

Accepts the following message:

Map

Payload
object

Additional properties are allowed.

System

Examples

Map
Payload 
{}
This example has been generated automatically.

Pub zbos/alarm/config/get

Get alarm configs

Get an object containing all alarm configssee <<zbos/alarm/config/get/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

System

Examples

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

Sub zbos/alarm/config/get/response/{key}

Get alarm configs response

Response of configs by alarm name

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

HashMap

Payload
object

Additional properties are allowed.

System

Examples

HashMap
Payload 
{}
This example has been generated automatically.

Pub zbos/alarm/config/set

Set alarm config

Sets the config for a specific alarm type

Accepts the following message:

AlarmConfigRequest

Payload
object
key
string
type
string
config
object

Additional properties are allowed.

Additional properties are allowed.

System

Examples

AlarmConfigRequest
Payload
Example #1
{
  "type": "string",
  "config": {
    "string": "string"
  }
}

Sub zbos/alarm/config/set/event

Set alarm config response

An event indicating the alarm config was changed

Accepts the following message:

AlarmConfigResult

Payload
object
success
boolean
error
object
Enum: "MALFORMED_REQUEST" "MISSING_CONFIG_PROPERTY" "TYPE_NOT_FOUND"
name
string
ordinal
integer

Additional properties are allowed.

Additional properties are allowed.

System

Examples

AlarmConfigResult
Payload
Example #1
{
  "type": "string",
  "config": {
    "string": "string"
  }
}

Pub zbos/alarm/database/get

Get alarm database

Retrieves a list of all the alarms stored in the databasesee <<zbos/alarm/database/get/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

System

Examples

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

Sub zbos/alarm/database/get/response/{key}

Get alarm database response

The response to a database get request

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<MonitoringResult>

Payload
array<object>
id
string
type
string
downloadPath
string
previewPath
string
mediaFile
string
timestamp
number
metadata
object

Additional properties are allowed.

Additional items are allowed.

System

Examples

Array<MonitoringResult>
Payload
Example #1
{
  "id": "string",
  "type": "string",
  "downloadPath": "string",
  "previewPath": "string",
  "mediaFile": "string",
  "timestamp": 1012001,
  "metadata": {}
}

Pub zbos/alarm/database/remove

Remove alarm database

Remove all alarms from the database

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

System

Examples

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

Sub zbos/alarm/database/remove/event

Remove alarm database response

An event indicating the alarm database was removed

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

System

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/alarm/images/remove

Remove alarm images

Remove all alarm images from the robot

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

System

Examples

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

Sub zbos/alarm/images/remove/event

Remove alarm images response

An event indicating images were removed

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

System

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/alarm/all/remove

Remove alarm images and database

Remove all alarm images and database entries from the robot

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

System

Examples

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

Sub zbos/alarm/all/remove/event

Remove alarm images and database response

An event indicating images and databases were removed

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

System

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/status/battery/get

Get battery status

see <<zbos/status/battery/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

System

Examples

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

Sub zbos/status/battery/response/{key}

response: Get battery status

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

BatteryEvent

Payload
object
level
integer
>= 0 <= 100

Percentage value between with range 0 to 100

charging
boolean
docked
boolean

Additional properties are allowed.

System

Examples

BatteryEvent
Payload
Example #1
{
  "level": 50,
  "charging": true,
  "docked": true
}

Sub zbos/status/battery/event

event: Battery change

A message (json) is published on this topic when the robot battery status changes. Level is the battery level in percent. If the battery status is not yet available, then the level is -1.

Accepts the following message:

BatteryEvent

Payload
object
level
integer
>= 0 <= 100

Percentage value between with range 0 to 100

charging
boolean
docked
boolean

Additional properties are allowed.

System

Examples

BatteryEvent
Payload
Example #1
{
  "level": 50,
  "charging": true,
  "docked": true
}

Pub zbos/status/battery/low/set

Set the battery low level threshold

At what battery percentage the robot will act as if it is at low battery

Accepts the following message:

BatterySetRequest

Payload
object
percent
integer
>= 0 <= 100

Percentage value between with range 0 to 100

Additional properties are allowed.

System

Examples

BatterySetRequest
Payload
Example #1
{
  "percent": 30
}

Pub zbos/status/battery/low/get

Get the battery low level threshold

see <<zbos/status/battery/low/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

System

Examples

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

Sub zbos/status/battery/low/response/{key}

Response: battery low level

Response which shows the battery low level threshold

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
System

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/status/battery/critical/set

Set the battery critical level threshold

At what battery percentage the robot will act as if it is at critical battery

Accepts the following message:

BatterySetRequest

Payload
object
percent
integer
>= 0 <= 100

Percentage value between with range 0 to 100

Additional properties are allowed.

System

Examples

BatterySetRequest
Payload
Example #1
{
  "percent": 10
}

Pub zbos/status/battery/critical/get

Get the battery critical level threshold

see <<zbos/status/battery/critical/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

System

Examples

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

Sub zbos/status/battery/critical/response/{key}

Response: battery critical level

Response which shows the battery critical level threshold

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
System

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/system/robot/identification/get

Request robot identification

Use this to ask a detailed list of robot specifics like serial, features, ...

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

System

Examples

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

Sub zbos/system/robot/identification/event

response: Robot identification

A detailed list of robot specifics

Accepts the following message:

RobotIdentification

Payload
object
robot_type
string
body_id
string
serial
string
name
string
versions
object

Additional properties are allowed.

network_info
object
ip
string
mac_address
string
ssid
string

Additional properties are allowed.

features
object
external_displays
array<object>
video
boolean
audio
boolean
width
integer
height
integer

Additional items are allowed.

cameras
array<object>
key
string
primary
boolean
rotation
integer
image_rotation
integer

Additional items are allowed.

can_poi
boolean
can_move
boolean
can_dance
boolean
can_speech
boolean
has_storage
boolean
can_animate
boolean
can_gym
boolean
has_sensors
boolean
has_emotions
boolean
can_video_stream
boolean
can_take_picture
boolean
has_slam_image_map
boolean
has_security_mode
boolean
can_detect_motion
boolean
can_face_recognize
boolean
can_poi_interactive
boolean
has_monitoring
boolean
has_qr_scanner
boolean
can_change_ntp_server
boolean
voice_feature
object
supports_gesticulate
boolean
supports_language
boolean
supports_pitch
boolean
supports_speed
boolean
supports_volume
boolean
supports_speech_volume
boolean

Additional properties are allowed.

listen_feature
object
can_trigger_manual
boolean
can_trigger_hotword
boolean

Additional properties are allowed.

slam_feature
object
can_navigate
boolean
can_extend_map
boolean
can_manage_pois
boolean
can_manage_walls
boolean
has_docking_station
boolean

Additional properties are allowed.

voip_feature
object
supportsVoip
boolean

Additional properties are allowed.

face_recognition_feature
object
can_detect_known_faces
boolean
can_detect_number_of_faces
boolean

Additional properties are allowed.

Additional properties are allowed.

hardware
object
heads
array<object>
moveable
boolean
can_reset_to_default_position
boolean

Additional items are allowed.

parts
array<object>
name
string
moveable
boolean
can_reset_to_default_position
boolean

Additional items are allowed.

usb
array<object>
type
object
Enum: "USB_1" "USB_1_1" "USB_2" "USB_3" "USB_3_1" "USB_3_2" "USB_4"
name
string
ordinal
integer

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

composer
object
simple
object
dance
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

speech
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

animation
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

emotion
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

wait_duration
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

wait_sensor
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

wait_face
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

wait_voice
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

wait_qr_code
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

motion_head
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

motion_detection
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

multimedia
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

poi
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

mqtt
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

app_start
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

change_datasource
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

input
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

multimedia_stop
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

browser
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

gym
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

Additional properties are allowed.

advanced
object
math_formula
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

math_operations
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

if_else
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

variables
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

api
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

loop
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

start
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

stop
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

supported_file_types
array<object>
mime_type
string
type
string

Additional items are allowed.

connection_features
object
has_wifi
boolean
has_cable
boolean
has_hotspot
boolean
cable_features
object
adapter_names
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

wifi_features
object
can_configure
boolean
adapter_names
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

hotspot_features
object
can_activate
boolean
can_change_ssid
boolean
can_change_password
boolean
adapter_names
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

System

Examples

RobotIdentification
Payload
Example #1
{
  "serial": "SH-J01-00096",
  "name": "Jamesy",
  "versions": {},
  "features": {
    "cameras": [
      {
        "key": "kiosk",
        "primary": true,
        "rotation": 0
      }
    ],
    "external_displays": [
      {
        "video": true,
        "audio": true,
        "width": 1280,
        "height": 800
      }
    ],
    "can_poi": true,
    "can_move": true,
    "can_dance": false,
    "can_speech": true,
    "has_storage": true,
    "can_animate": false,
    "can_gym": false,
    "has_sensors": true,
    "has_emotions": false,
    "can_video_stream": true,
    "can_take_picture": true,
    "has_slam_image_map": true,
    "has_security_mode": true,
    "can_detect_motion": true,
    "can_face_recognize": true,
    "can_poi_interactive": true,
    "has_monitoring": false,
    "has_qr_scanner": false,
    "can_change_ntp_server": false,
    "voice_feature": {
      "supports_gesticulate": false,
      "supports_language": true,
      "supports_pitch": true,
      "supports_speed": true,
      "supports_volume": true,
      "supports_speech_volume": true
    },
    "listen_feature": {
      "can_trigger_manual": true,
      "can_trigger_hotword": true
    },
    "slam_feature": {
      "can_navigate": true,
      "can_extend_map": true,
      "can_manage_pois": true,
      "can_manage_walls": true,
      "has_docking_station": false
    },
    "voip_feature": {
      "supportsVoip": true
    },
    "face_recognition_feature": {
      "can_detect_known_faces": false,
      "can_detect_number_of_faces": true
    }
  },
  "hardware": {
    "heads": [
      {
        "moveable": true,
        "can_reset_to_default_position": true
      }
    ],
    "parts": [
      {
        "name": "Leg",
        "moveable": false,
        "can_reset_to_default_position": false
      }
    ]
  },
  "composer": {
    "simple": {
      "dance": {
        "enabled": false,
        "enabled_sources": []
      },
      "speech": {
        "enabled": true,
        "enabled_sources": [
          "scheduler",
          "composer"
        ]
      },
      "animation": {
        "enabled": false,
        "enabled_sources": []
      },
      "emotion": {
        "enabled": false,
        "enabled_sources": []
      },
      "multimedia": {
        "enabled": true,
        "enabled_sources": [
          "scheduler",
          "composer"
        ]
      },
      "poi": {
        "enabled": true,
        "enabled_sources": [
          "scheduler",
          "composer"
        ]
      },
      "mqtt": {
        "enabled": true,
        "enabled_sources": [
          "scheduler",
          "composer"
        ]
      },
      "input": {
        "enabled": true,
        "enabled_sources": [
          "composer"
        ]
      },
      "browser": {
        "enabled": true,
        "enabled_sources": [
          "scheduler",
          "composer"
        ]
      },
      "gym": {
        "enabled": false,
        "enabled_sources": []
      },
      "wait_duration": {
        "enabled": true,
        "enabled_sources": [
          "composer"
        ]
      },
      "wait_sensor": {
        "enabled": true,
        "enabled_sources": [
          "composer"
        ]
      },
      "wait_face": {
        "enabled": false,
        "enabled_sources": []
      },
      "wait_voice": {
        "enabled": false,
        "enabled_sources": []
      },
      "wait_qr_code": {
        "enabled": false,
        "enabled_sources": []
      },
      "motion_head": {
        "enabled": true,
        "enabled_sources": [
          "scheduler",
          "composer"
        ]
      },
      "motion_detection": {
        "enabled": true,
        "enabled_sources": [
          "composer"
        ]
      },
      "app_start": {
        "enabled": true,
        "enabled_sources": [
          "scheduler",
          "composer"
        ]
      },
      "change_datasource": {
        "enabled": true,
        "enabled_sources": [
          "scheduler",
          "composer"
        ]
      },
      "multimedia_stop": {
        "enabled": true,
        "enabled_sources": [
          "scheduler",
          "composer"
        ]
      }
    },
    "advanced": {
      "variables": {
        "enabled": false,
        "enabled_sources": []
      },
      "api": {
        "enabled": false,
        "enabled_sources": []
      },
      "loop": {
        "enabled": false,
        "enabled_sources": []
      },
      "start": {
        "enabled": false,
        "enabled_sources": []
      },
      "stop": {
        "enabled": false,
        "enabled_sources": []
      },
      "math_formula": {
        "enabled": false,
        "enabled_sources": []
      },
      "math_operations": {
        "enabled": false,
        "enabled_sources": []
      },
      "if_else": {
        "enabled": false,
        "enabled_sources": []
      }
    }
  },
  "robot_type": "James",
  "body_id": "D2EE32C8F3EFF59FDFEAF6E21834F71C",
  "network_info": {
    "ip": "172.16.0.100",
    "ssid": "string",
    "mac_address": "02:00:00:00:00:00"
  },
  "supported_file_types": [
    {
      "type": "string",
      "mime_type": "string"
    }
  ],
  "connection_features": {
    "has_wifi": true,
    "has_cable": false,
    "has_hotspot": true,
    "cable_features": {
      "adapter_names": []
    },
    "wifi_features": {
      "can_configure": false,
      "adapter_names": [
        "wlan0"
      ]
    },
    "hotspot_features": {
      "can_activate": true,
      "can_change_ssid": true,
      "can_change_password": true,
      "adapter_names": [
        "WIFI1",
        "WIFI2"
      ]
    }
  }
}

Pub zbos/system/name/set

Set robot name

Use this to change the robot name. The change will be published through <<zbos/system/robot/identification/event>>

Accepts the following message:

RobotIdentification

Payload
object
robot_type
string
body_id
string
serial
string
name
string
versions
object

Additional properties are allowed.

network_info
object
ip
string
mac_address
string
ssid
string

Additional properties are allowed.

features
object
external_displays
array<object>
video
boolean
audio
boolean
width
integer
height
integer

Additional items are allowed.

cameras
array<object>
key
string
primary
boolean
rotation
integer
image_rotation
integer

Additional items are allowed.

can_poi
boolean
can_move
boolean
can_dance
boolean
can_speech
boolean
has_storage
boolean
can_animate
boolean
can_gym
boolean
has_sensors
boolean
has_emotions
boolean
can_video_stream
boolean
can_take_picture
boolean
has_slam_image_map
boolean
has_security_mode
boolean
can_detect_motion
boolean
can_face_recognize
boolean
can_poi_interactive
boolean
has_monitoring
boolean
has_qr_scanner
boolean
can_change_ntp_server
boolean
voice_feature
object
supports_gesticulate
boolean
supports_language
boolean
supports_pitch
boolean
supports_speed
boolean
supports_volume
boolean
supports_speech_volume
boolean

Additional properties are allowed.

listen_feature
object
can_trigger_manual
boolean
can_trigger_hotword
boolean

Additional properties are allowed.

slam_feature
object
can_navigate
boolean
can_extend_map
boolean
can_manage_pois
boolean
can_manage_walls
boolean
has_docking_station
boolean

Additional properties are allowed.

voip_feature
object
supportsVoip
boolean

Additional properties are allowed.

face_recognition_feature
object
can_detect_known_faces
boolean
can_detect_number_of_faces
boolean

Additional properties are allowed.

Additional properties are allowed.

hardware
object
heads
array<object>
moveable
boolean
can_reset_to_default_position
boolean

Additional items are allowed.

parts
array<object>
name
string
moveable
boolean
can_reset_to_default_position
boolean

Additional items are allowed.

usb
array<object>
type
object
Enum: "USB_1" "USB_1_1" "USB_2" "USB_3" "USB_3_1" "USB_3_2" "USB_4"
name
string
ordinal
integer

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

composer
object
simple
object
dance
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

speech
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

animation
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

emotion
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

wait_duration
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

wait_sensor
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

wait_face
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

wait_voice
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

wait_qr_code
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

motion_head
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

motion_detection
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

multimedia
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

poi
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

mqtt
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

app_start
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

change_datasource
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

input
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

multimedia_stop
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

browser
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

gym
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

Additional properties are allowed.

advanced
object
math_formula
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

math_operations
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

if_else
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

variables
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

api
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

loop
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

start
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

stop
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

supported_file_types
array<object>
mime_type
string
type
string

Additional items are allowed.

connection_features
object
has_wifi
boolean
has_cable
boolean
has_hotspot
boolean
cable_features
object
adapter_names
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

wifi_features
object
can_configure
boolean
adapter_names
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

hotspot_features
object
can_activate
boolean
can_change_ssid
boolean
can_change_password
boolean
adapter_names
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

System

Examples

RobotIdentification
Payload
Example #1
{
  "name": "Betsy",
  "versions": {}
}

Pub zbos/system/version/get

Get system version

see <<zbos/system/version/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

System

Examples

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

Sub zbos/system/version/response/{key}

response: Get system version

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

AppVersion

Payload
object
name
string
version
string
buildDate
object
fastTime
number
cdate
object
cachedYear
integer
cachedFixedDateJan1
number
cachedFixedDateNextJan1
number

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

System

Examples

AppVersion
Payload
Example #1
{
  "name": "CR-16",
  "version": "4.2.0",
  "buildDate": 1616061847107
}

Pub zbos/system/serial/get

Get system serial number

see <<zbos/system/serial/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

System

Examples

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

Sub zbos/system/serial/response/{key}

response: Get system serial number

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
System

Examples

String
Payload 
"string"
This example has been generated automatically.

Sub zbos/event/system/poke

Poke robot

When robot receives this event, it responds by showing he received the event. This can be by flashing a led. This is useful to see which robot your are controlling.

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

System

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/system/ready/event

event: System ready

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

System

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/system/ready/request

Get system ready

see <<zbos/system/ready/response/{key}>> for response

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

System

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/system/ready/response/{key}

response: System ready

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

System

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/system/hotword/rotation

Enable hotword rotation

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

System

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/system/hotword/rotation/changed/event

Hotword rotation changed event

Accepts the following message:

String

Payload
string
System

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/system/hotword/rotation/get

Get hotword rotation

see <<zbos/system/hotword/rotation/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

System

Examples

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

Sub zbos/system/hotword/rotation/response/{key}

Response: hotword rotation

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
System

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/system/adblogs/upload

Enable adb logs upload

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

System

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/system/adblogs/changed/event

Adb logs changed event

Accepts the following message:

String

Payload
string
System

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/system/adblogs/get

Get adb logs

see <<zbos/system/adblogs/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

System

Examples

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

Sub zbos/system/adblogs/response/{key}

Response: Get adb logs

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
System

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/system/cloud/enable

Enable cloud broker

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

System

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/system/cloud/enable/changing/event

Cloud broker state is currently changing

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

System

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/system/cloud/enable/changed/event

Cloud broker enable changed event

Accepts the following message:

String

Payload
string
System

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/system/cloud/enable/get

Get cloud broker enabled state

see <<zbos/system/cloud/enable/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

System

Examples

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

Sub zbos/system/cloud/enable/response/{key}

Response: cloud broker enabled state

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
System

Examples

String
Payload 
"string"
This example has been generated automatically.

Sub zbos/cloud/broker/status/event

event: Broker status

Accepts the following message:

BrokerStatus

Payload
object
connected
boolean
graceful
boolean

Additional properties are allowed.

System

Examples

BrokerStatus
Payload
Example #1
{
  "connected": true,
  "graceful": true
}

Pub zbos/system/multimedia/rename

Rename file

Rename a multimedia filesee <<zbos/system/multimedia/rename/response>> for response

Accepts the following message:

RenameRequest

Payload
object
path
string

Path of existing file

name
string

New name of file with extension

Additional properties are allowed.

System

Examples

RenameRequest
Payload
Example #1
{
  "path": "string",
  "name": "string"
}

Sub zbos/system/multimedia/rename/response

response: Rename file

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

System

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/system/multimedia/delete/request

Remove a file from the robot

Removes a file from the robot; limited to files inside of the zbos_media_library directory.see zbos/system/multimedia/delete/response/{key} for response

Accepts the following message:

DeleteRequest

Payload
object
key
string
path
string

Additional properties are allowed.

System

Examples

DeleteRequest
Payload
Example #1
{
  "path": "string"
}

Sub zbos/system/multimedia/delete/response/{key}

response: Remove a file from the robot

Result if file is successfully deleted

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

DeleteResponse

Payload
object
success
boolean
error
object
Enum: "FILE_NOT_EXIST" "NOT_PERMITTED" "FAILED"
name
string
ordinal
integer

Additional properties are allowed.

Additional properties are allowed.

System

Examples

DeleteResponse
Payload
Example #1
{
  "success": false,
  "error": "FILE_NOT_EXIST"
}

Sub zbos/monitoring/event/{source}/{type}

Monitoring event

Parameters
source
required
string

Source of monitoring event

type
required
string

Type of monitoring event

Accepts the following message:

MonitoringEvent

Payload
object
id
string

Mandatory. A unique ID for the event

timestamp
number

Mandatory. The time at which the event occurred

type
string

Mandatory. The type of event this is, no dots allowed

source
string

Mandatory. What device produced this event, no dots allowed

value
string

Optional. A value relating to the event such as a temperature

data
object

Optional. Extra data related to the event

Additional properties are allowed.

unit
string

Optional. The type of unit the value is expressed in such as °C

alarms
array<object>

Optional. Alarms attached to this event

type
object

Mandatory. The type of alarm

Enum: "ItemOmission" "ItemCommission" "ServiceOmission" "ServiceCommission" "TransientServiceOmission" "TransientServiceCommission" "EarlyServiceOmission" "LateServiceCommission" "EarlyServiceStart" "LateServiceStart" "BoundedOmissionInterval" "UndetectableValueError" "BelowRange" "AboveRange" "BoundedValueChange" "StuckValue" "OutOfBounds" "OutOfOrder" "OutOfCalibration" "EarlyDelivery" "LateDelivery" "HighRate" "LowRate" "RateJitter" "EarlyService" "DelayedService" "SymmetricReplicationError" "AsymmetricApproximateValue" "AsymmetricExactValue" "AsymmetricItemOmission" "AsymmetricServiceOmission" "AsymmetricTiming" "ReadWriteRace" "WriteWriteRace" "Deadlock" "Starvation" "AuthorizationError" "AuthenticationError"
name
string
ordinal
integer

Additional properties are allowed.

severity
integer

Mandatory. How critical the alarm is

persist
boolean

Mandatory. If this is an ongoing alarm

timestamp
number

Mandatory. When the alarm initially started

Additional items are allowed.

Additional properties are allowed.

System

Examples

MonitoringEvent
Payload 
{
  "id": "string",
  "timestamp": 0,
  "type": "string",
  "source": "string",
  "value": "string",
  "data": {},
  "unit": "string",
  "alarms": [
    {
      "type": "ItemOmission",
      "severity": 0,
      "persist": true,
      "timestamp": 0
    }
  ]
}
This example has been generated automatically.

Pub zbos/monitoring/list/get

Get monitoring events

Accepts the following message:

FilteringRequest

Payload
object
key
string
limit
integer
offset
integer
filters
array<object>
field
string

Field to check on. Note that the field should be camelCase, not snake_case

value
string

Value to check on. For numbers you should use 'min' and 'max'.

min
number

Minimum value, only usable for number fields

max
number

Maximum value, only usable for number fields

direction
object

Direction to sort on. Can be 'asc' or 'desc'. The default direction is 'asc'

Enum: "ASC" "DESC"
name
string
ordinal
integer

Additional properties are allowed.

operator
object

Operator for either the child filters, or this filter object itself. Can be 'and', 'or' or 'not'. Default is 'and'. The root operator is always 'and'

Enum: "AND" "OR" "NOT"
name
string
ordinal
integer

Additional properties are allowed.

match_type
object

Match type for string values. Can be 'exact', 'contains', 'starts_with', 'ends_with'. The default match_type is 'contains'

Enum: "EXACT" "CONTAINS" "STARTS_WITH" "ENDS_WITH"
name
string
ordinal
integer

Additional properties are allowed.

filters
array<object>

Filters on which the operator will be applied. If there are no child filters, the operator will be applied to the filter object itself.

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

field_filters
array<object>

Filters to apply on the child fields of the field. Will only work if the field is an object, array/list or map.

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

Additional items are allowed.

sort
array<object>
field
string

Field to check on. Note that the field should be camelCase, not snake_case

value
string

Value to check on. For numbers you should use 'min' and 'max'.

min
number

Minimum value, only usable for number fields

max
number

Maximum value, only usable for number fields

direction
object

Direction to sort on. Can be 'asc' or 'desc'. The default direction is 'asc'

Enum: "ASC" "DESC"
name
string
ordinal
integer

Additional properties are allowed.

operator
object

Operator for either the child filters, or this filter object itself. Can be 'and', 'or' or 'not'. Default is 'and'. The root operator is always 'and'

Enum: "AND" "OR" "NOT"
name
string
ordinal
integer

Additional properties are allowed.

match_type
object

Match type for string values. Can be 'exact', 'contains', 'starts_with', 'ends_with'. The default match_type is 'contains'

Enum: "EXACT" "CONTAINS" "STARTS_WITH" "ENDS_WITH"
name
string
ordinal
integer

Additional properties are allowed.

filters
array<object>

Filters on which the operator will be applied. If there are no child filters, the operator will be applied to the filter object itself.

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

field_filters
array<object>

Filters to apply on the child fields of the field. Will only work if the field is an object, array/list or map.

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

Additional items are allowed.

Additional properties are allowed.

System

Examples

FilteringRequest
Payload
Example #1
{
  "key": "Test123",
  "limit": 50,
  "offset": 10,
  "filters": [
    {
      "operator": "or",
      "filters": [
        {
          "field": "name",
          "value": "foo",
          "operator": "and",
          "match_type": "contains"
        },
        {
          "field": "name",
          "value": "bar",
          "operator": "and",
          "match_type": "contains"
        }
      ],
      "match_type": "contains"
    },
    {
      "field": "type",
      "value": "image",
      "operator": "and",
      "filters": [
        {
          "field": "type",
          "value": "image",
          "operator": "and",
          "match_type": "contains"
        }
      ],
      "match_type": "contains"
    },
    {
      "field": "date",
      "operator": "and",
      "filters": [
        {
          "field": "date",
          "operator": "and",
          "match_type": "contains"
        }
      ],
      "match_type": "contains"
    }
  ],
  "sort": [
    {
      "field": "extension",
      "operator": "and",
      "filters": [
        {
          "field": "extension",
          "operator": "and",
          "match_type": "contains"
        }
      ],
      "match_type": "contains"
    },
    {
      "field": "name",
      "operator": "and",
      "filters": [
        {
          "field": "name",
          "operator": "and",
          "match_type": "contains"
        }
      ],
      "match_type": "contains"
    }
  ]
}

Sub zbos/monitoring/list/get/response/{key}

response: Get monitoring events

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<MonitoringEvent>

Payload
array<object>
id
string

Mandatory. A unique ID for the event

timestamp
number

Mandatory. The time at which the event occurred

type
string

Mandatory. The type of event this is, no dots allowed

source
string

Mandatory. What device produced this event, no dots allowed

value
string

Optional. A value relating to the event such as a temperature

data
object

Optional. Extra data related to the event

Additional properties are allowed.

unit
string

Optional. The type of unit the value is expressed in such as °C

alarms
array<object>

Optional. Alarms attached to this event

type
object

Mandatory. The type of alarm

Enum: "ItemOmission" "ItemCommission" "ServiceOmission" "ServiceCommission" "TransientServiceOmission" "TransientServiceCommission" "EarlyServiceOmission" "LateServiceCommission" "EarlyServiceStart" "LateServiceStart" "BoundedOmissionInterval" "UndetectableValueError" "BelowRange" "AboveRange" "BoundedValueChange" "StuckValue" "OutOfBounds" "OutOfOrder" "OutOfCalibration" "EarlyDelivery" "LateDelivery" "HighRate" "LowRate" "RateJitter" "EarlyService" "DelayedService" "SymmetricReplicationError" "AsymmetricApproximateValue" "AsymmetricExactValue" "AsymmetricItemOmission" "AsymmetricServiceOmission" "AsymmetricTiming" "ReadWriteRace" "WriteWriteRace" "Deadlock" "Starvation" "AuthorizationError" "AuthenticationError"
name
string
ordinal
integer

Additional properties are allowed.

severity
integer

Mandatory. How critical the alarm is

persist
boolean

Mandatory. If this is an ongoing alarm

timestamp
number

Mandatory. When the alarm initially started

Additional items are allowed.

Additional items are allowed.

System

Examples

Array<MonitoringEvent>
Payload 
[
  {
    "id": "string",
    "timestamp": 0,
    "type": "string",
    "source": "string",
    "value": "string",
    "data": {},
    "unit": "string",
    "alarms": [
      {
        "type": "ItemOmission",
        "severity": 0,
        "persist": true,
        "timestamp": 0
      }
    ]
  }
]
This example has been generated automatically.

Pub zbos/monitoring/event/add

Add a new event

Accepts the following message:

AddMonitoringEventRequest

Payload
object
key
string
event
object
timestamp
number

Mandatory. The time at which the event occurred

type
string

Mandatory. The type of event this is, no dots allowed

source
string

Mandatory. What device produced this event, no dots allowed

value
string

Optional. A value relating to the event such as a temperature

data
object

Optional. Extra data related to the event

Additional properties are allowed.

unit
string

Optional. The type of unit the value is expressed in such as °C

alarms
array<object>

Optional. Alarms attached to this event

type
object

Mandatory. The type of alarm

Enum: "ItemOmission" "ItemCommission" "ServiceOmission" "ServiceCommission" "TransientServiceOmission" "TransientServiceCommission" "EarlyServiceOmission" "LateServiceCommission" "EarlyServiceStart" "LateServiceStart" "BoundedOmissionInterval" "UndetectableValueError" "BelowRange" "AboveRange" "BoundedValueChange" "StuckValue" "OutOfBounds" "OutOfOrder" "OutOfCalibration" "EarlyDelivery" "LateDelivery" "HighRate" "LowRate" "RateJitter" "EarlyService" "DelayedService" "SymmetricReplicationError" "AsymmetricApproximateValue" "AsymmetricExactValue" "AsymmetricItemOmission" "AsymmetricServiceOmission" "AsymmetricTiming" "ReadWriteRace" "WriteWriteRace" "Deadlock" "Starvation" "AuthorizationError" "AuthenticationError"
name
string
ordinal
integer

Additional properties are allowed.

severity
integer

Mandatory. How critical the alarm is

persist
boolean

Mandatory. If this is an ongoing alarm

timestamp
number

Mandatory. When the alarm initially started

Additional items are allowed.

Additional properties are allowed.

Additional properties are allowed.

System

Examples

AddMonitoringEventRequest
Payload
Example #1
{
  "key": "some_key",
  "event": {
    "timestamp": 1349333576093,
    "type": "SomeType",
    "source": "SomeSource",
    "valid": true
  }
}

Sub zbos/monitoring/event/add/response/{key}

response: Add a new event

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

System

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/monitoring/event/delete

Delete an event

Accepts the following message:

MonitoringEvent

Payload
object
id
string

Mandatory. A unique ID for the event

timestamp
number

Mandatory. The time at which the event occurred

type
string

Mandatory. The type of event this is, no dots allowed

source
string

Mandatory. What device produced this event, no dots allowed

value
string

Optional. A value relating to the event such as a temperature

data
object

Optional. Extra data related to the event

Additional properties are allowed.

unit
string

Optional. The type of unit the value is expressed in such as °C

alarms
array<object>

Optional. Alarms attached to this event

type
object

Mandatory. The type of alarm

Enum: "ItemOmission" "ItemCommission" "ServiceOmission" "ServiceCommission" "TransientServiceOmission" "TransientServiceCommission" "EarlyServiceOmission" "LateServiceCommission" "EarlyServiceStart" "LateServiceStart" "BoundedOmissionInterval" "UndetectableValueError" "BelowRange" "AboveRange" "BoundedValueChange" "StuckValue" "OutOfBounds" "OutOfOrder" "OutOfCalibration" "EarlyDelivery" "LateDelivery" "HighRate" "LowRate" "RateJitter" "EarlyService" "DelayedService" "SymmetricReplicationError" "AsymmetricApproximateValue" "AsymmetricExactValue" "AsymmetricItemOmission" "AsymmetricServiceOmission" "AsymmetricTiming" "ReadWriteRace" "WriteWriteRace" "Deadlock" "Starvation" "AuthorizationError" "AuthenticationError"
name
string
ordinal
integer

Additional properties are allowed.

severity
integer

Mandatory. How critical the alarm is

persist
boolean

Mandatory. If this is an ongoing alarm

timestamp
number

Mandatory. When the alarm initially started

Additional items are allowed.

Additional properties are allowed.

System

Examples

MonitoringEvent
Payload
Example #1
{
  "id": "some_id",
  "timestamp": 1349333576093,
  "type": "SomeType",
  "source": "SomeSource",
  "valid": true
}

Sub zbos/monitoring/event/delete/event

event: Delete an event

Accepts the following message:

MonitoringResponse

Payload
object
key
string

The key used by the add request

success
boolean

Did the operation succeed

id
string

The ID of the new event

Additional properties are allowed.

System

Examples

MonitoringResponse
Payload 
{
  "key": "string",
  "success": true,
  "id": "string"
}
This example has been generated automatically.

Pub zbos/time/info/get

Get Time information, such as the accuracy

see <<zbos/time/info/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Time

Examples

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

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

response: Time information

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

TimeInfo

Payload
object
accurate
boolean

Additional properties are allowed.

Time

Examples

TimeInfo
Payload
Example #1
{
  "accurate": true
}

Pub zbos/quiet/hours

Quiet hours

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Time

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/scheduler/save

Save schedule

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Time

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/scheduler/save/event

event: Schedule saved

Accepts the following message:

SimpleScheduler

Payload
object
id
string
name
string

Additional properties are allowed.

Time

Examples

SimpleScheduler
Payload
Example #1
{
  "id": "string",
  "name": "string"
}

Pub zbos/scheduler/load

Get schedule

see <<zbos/scheduler/load/response/{key}>> for response

Accepts the following message:

SimpleScheduler

Payload
object
id
string
name
string

Additional properties are allowed.

Time

Examples

SimpleScheduler
Payload
Example #1
{
  "id": "string"
}

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

response: Get schedule

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
Time

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/scheduler/delete

Delete schedule

Accepts the following message:

SimpleScheduler

Payload
object
id
string
name
string

Additional properties are allowed.

Time

Examples

SimpleScheduler
Payload
Example #1
{
  "id": "string"
}

Sub zbos/scheduler/delete/event

event: Schedule deleted

Accepts the following message:

String

Payload
string
Time

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/scheduler/list/get

Get all schedules

see <<zbos/scheduler/list/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Time

Examples

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

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

response: Get all schedules

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

Array<SimpleScheduler>

Payload
array<object>
id
string
name
string

Additional items are allowed.

Time

Examples

Array<SimpleScheduler>
Payload
Example #1
{
  "id": "string",
  "name": "string"
}

Pub zbos/scheduler/start

Start schedule by name

Accepts the following message:

SimpleScheduler

Payload
object
id
string
name
string

Additional properties are allowed.

Time

Examples

SimpleScheduler
Payload
Example #1
{
  "name": "string"
}

Sub zbos/scheduler/start/event

event: Started schedule

Accepts the following message:

String

Payload
string
Time

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/scheduler/start/id

Start schedule by id

Accepts the following message:

SimpleScheduler

Payload
object
id
string
name
string

Additional properties are allowed.

Time

Examples

SimpleScheduler
Payload
Example #1
{
  "id": "string"
}

Pub zbos/scheduler/stop

Stop schedule

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Time

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/scheduler/stop/event

event: Schedule stopped

Accepts the following message:

String

Payload
string
Time

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/scheduler/current/get

Get current schedule

see <<zbos/scheduler/current/get/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Time

Examples

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

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

response: Get current schedule

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
Time

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/translations/get

Get translations

Get translations for the provided category and language. You have two ways to get the translations: either pass the category + the corresponding keys, or only pass the keys, but prefix each one with the category and a dot. Eg: {category}.{key}

Accepts the following message:

GetTranslationsRequest

Payload
object
key
string
category
string

Optional when using the dot notation in the translations keys.

language
string

ISO 639-1 language code, Eg: 'en' or 'en-US'

translation_keys
array<string>

Optional if the category is set. In that case it will return all translations for that category.

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Translations

Examples

GetTranslationsRequest
Payload
Example #1
{
  "key": "abc",
  "category": "category_1",
  "language": "en-US"
}
Example #2
{
  "key": "abc",
  "category": "category_1",
  "language": "en-US",
  "translation_keys": [
    "translation_key_1",
    "translation_key_2"
  ]
}
Example #3
{
  "key": "abc",
  "language": "en-US",
  "translation_keys": [
    "category_1.translation_key_1",
    "category_1.translation_key_2"
  ]
}

Pub zbos/translations/get/response/{key}

Response: Get translations

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

GetTranslationsResponse

Payload
object
translations
object

Additional properties are allowed.

Additional properties are allowed.

Translations

Examples

GetTranslationsResponse
Payload
Example #1
{
  "translations": {
    "translation_key_1": "Translation 1",
    "translation_key_2": "Translation 2"
  },
  "valid": true
}

Pub zbos/translations/request

Request translation registrations

Request all translation providers to register their translations using the topics below.

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Translations

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/translations/add

Add translations

Add translations with their default values. These default values will be used as long as they are not updated via zbos/translations/update

Accepts the following message:

AddTranslationsRequest

Payload
object
key
string
category
string
language
string

ISO 639-1 language code, Eg: 'en' or 'en-US'

file
string

Optional. Use either translations or file. The file location should be a path accessible for the RAIL. The content should be a json object with key-value pairs. Dots (.) are not allowed in the keys and will be replaced with underscores (_)"

translations
object

Optional. Use either translations or file Dots (.) are not allowed in the keys and will be replaced with underscores (_)

Additional properties are allowed.

Additional properties are allowed.

Translations

Examples

AddTranslationsRequest
Payload
Example #1
{
  "key": "abc",
  "category": "category_1",
  "language": "en-US",
  "translations": {
    "translation_key_1": "Translation 1",
    "translation_key_2": "Translation 2"
  },
  "valid": true
}
Example #2
{
  "key": "abc",
  "category": "category_1",
  "language": "en-US",
  "file": "path/to/file.json",
  "valid": true
}

Pub zbos/translations/add/response/{key}

Response: Add translations

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Translations

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/translations/update

Update translations

Update translations overriding the default values.

Accepts the following message:

UpdateTranslationsRequest

Payload
object
key
string
category
string
language
string

ISO 639-1 language code, Eg: 'en' or 'en-US'

file
string

Optional. Use either translations or file. The file location should be a path accessible for the RAIL. The content should be a json object with key-value pairs.

translations
object

Optional. Use either translations or file

Additional properties are allowed.

Additional properties are allowed.

Translations

Examples

UpdateTranslationsRequest
Payload
Example #1
{
  "key": "abc",
  "category": "category_1",
  "language": "en-US",
  "translations": {
    "translation_key_1": "Translation 1",
    "translation_key_2": "Translation 2"
  },
  "valid": true
}
Example #2
{
  "key": "abc",
  "category": "category_1",
  "language": "en-US",
  "file": "path/to/file.json",
  "valid": true
}

Pub zbos/translations/update/response/{key}

Response: Update translations

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Translations

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/translations/changed/event/{category}

Event: Translations changed

Parameters
category
required
string

ID of the translations category that was changed

Accepts the following message:

TranslationsChangedEvent

Payload
object
category
string
language
string

ISO 639-1 language code, Eg: 'en' or 'en-US'

Additional properties are allowed.

Translations

Examples

TranslationsChangedEvent
Payload
Example #1
{
  "category": "category_1",
  "language": "en-US",
  "valid": true
}

Pub zbos/translations/reset

Reset translations

Reset translations to their default values

Accepts the following message:

ResetTranslationsRequest

Payload
object
key
string
category
string
language
string

ISO 639-1 language code, Eg: 'en' or 'en-US'

Additional properties are allowed.

Translations

Examples

ResetTranslationsRequest
Payload
Example #1
{
  "key": "abc",
  "category": "category_1",
  "language": "en-US",
  "valid": true
}

Pub zbos/translations/reset/response/{key}

Response: Reset translations

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

Translations

Examples

SuccessMessage
Payload
Example #1
{
  "success": true
}

Pub zbos/variables/get

Get all variables

see <<zbos/variables/response/{key}>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Variables

Examples

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

Sub zbos/variables/response/{key}

response: Get all variables

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

GlobalVariables

Payload
object
variables
array<object>

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

name
string
value
string
id
string
state
string

Additional items are allowed.

status
boolean

Will be present when status is false (error message)

message
string

Additional properties are allowed.

Variables

Examples

GlobalVariables
Payload
Example #1
{
  "variables": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "status": true,
  "message": "string"
}

Pub zbos/variables/set

Set variables

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

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Variables

Examples

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

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

response: indicates if the save was successful or not

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

GlobalVariables

Payload
object
variables
array<object>

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

name
string
value
string
id
string
state
string

Additional items are allowed.

status
boolean

Will be present when status is false (error message)

message
string

Additional properties are allowed.

Variables

Examples

GlobalVariables
Payload
Example #1
{
  "variables": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "status": true,
  "message": "string"
}

Pub zbos/wifi/scan

Request WiFi scan

Start scanning for WiFi networks

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Wifi

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Sub zbos/wifi/event/scan

event: Wifi scan

All WiFi scan results are publish as an event. The event can be triggered by a scan request or by the robot system.

Accepts the following message:

Array<AccessPoint>

Payload
array<object>
ssid
string
bssid
string
channel
string
bandwidth
string
auth
string

type off network, "0" for open networks

is_5g
string
rssi
string
>= 0 <= 100

Network strength (0-100)

save
string
>= 0 <= 2

"0" not saved, "1" saved, "2" currently connected

password
string

Additional items are allowed.

Wifi

Examples

Array<AccessPoint>
Payload
Example #1
{
  "ssid": "QMBTEERO",
  "bssid": "0025.9e45.24a0",
  "channel": "20",
  "bandwidth": "45",
  "auth": "1",
  "rssi": "100",
  "save": "2",
  "password": "string",
  "savedNetwork": {
    "ssid": "QMBTEERO",
    "encryption": "SHARE",
    "password": "string",
    "hidden": false
  },
  "scannedNetwork": {
    "ssid": "QMBTEERO",
    "encryption": "SHARE",
    "signal": 100,
    "serviceId": "0025.9e45.24a0",
    "channel": 20,
    "saved": true
  }
}

Pub zbos/wifi/connect

Connect to wifi

Accepts the following message:

AccessPoint

Payload
object
ssid
string
bssid
string
channel
string
bandwidth
string
auth
string

type off network, "0" for open networks

is_5g
string
rssi
string
>= 0 <= 100

Network strength (0-100)

save
string
>= 0 <= 2

"0" not saved, "1" saved, "2" currently connected

password
string

Additional properties are allowed.

Wifi

Examples

AccessPoint
Payload
Example #1
{
  "ssid": "QBMTEERO",
  "password": "string",
  "savedNetwork": {
    "ssid": "QBMTEERO",
    "encryption": "UNSECURE",
    "password": "string",
    "hidden": false
  },
  "scannedNetwork": {
    "ssid": "QBMTEERO",
    "encryption": "UNSECURE",
    "saved": false
  }
}

Sub zbos/wifi/event/connected

event: Wifi connected

Whenever there is a WiFi status available, this will be published. This can be triggered by a request, or the robot system at any time independently of an actual change in the status. On these topic the current WiFi status is also published.

Accepts the following message:

WispStatus

Payload
object
app_enable
string
auth
string

type off network, "0" for open networks

auto
string
bandwidth
string
bssid
string
channel
string
dns0
string
dns1
string
enable
string
encrypt
string
gw
string

The gateway

internet
string

0 - internet is available, anything else: no internet available

ip
string
is_wan_priority
string
key
string
mask
string
rssi
string
>= 0 <= 100

Network strength (0-100)

run_time
string
ssid
string
status
string
>= 0 <= 3

0 - disconnected, 1 - connected, 3 - connecting

Additional properties are allowed.

Wifi

Examples

WispStatus
Payload
Example #1
{
  "app_enable": "string",
  "auth": "1",
  "auto": "string",
  "bandwidth": "50",
  "bssid": "0025.9e45.24a0",
  "channel": "20",
  "dns0": "8.8.8.8",
  "dns1": "8.8.4.4",
  "enable": "string",
  "encrypt": "WPA/ WPA2",
  "gw": "192.168.0.1",
  "internet": "0",
  "ip": "192.168.0.100",
  "key": "string",
  "mask": "255.255.255.0",
  "rssi": "100",
  "run_time": "string",
  "ssid": "QMBTEERO",
  "status": "1",
  "wifiStatus": {
    "ssid": "QMBTEERO",
    "encryption": "SHARE",
    "ip4": "192.168.0.100",
    "dhcp": false,
    "subnetmask": "255.255.255.0",
    "gateway": "192.168.0.1",
    "dns": {
      "dns1": "8.8.8.8",
      "dns2": "8.8.4.4",
      "adapterName": "wlan0",
      "valid": true
    },
    "serviceId": "0025.9e45.24a0",
    "connectionStatus": "CONNECTED",
    "hasInternet": true,
    "adapterName": "wlan0"
  },
  "dnsconfig": {
    "dns1": "8.8.8.8",
    "dns2": "8.8.4.4",
    "adapterName": "wlan0",
    "valid": true
  }
}

Sub zbos/wifi/event/disconnected

event: Wifi disconnected

Whenever there is a WiFi status available, this will be published. This can be triggered by a request, or the robot system at any time independently of an actual change in the status. On these topic the current WiFi status is also published.

Accepts the following message:

WispStatus

Payload
object
app_enable
string
auth
string

type off network, "0" for open networks

auto
string
bandwidth
string
bssid
string
channel
string
dns0
string
dns1
string
enable
string
encrypt
string
gw
string

The gateway

internet
string

0 - internet is available, anything else: no internet available

ip
string
is_wan_priority
string
key
string
mask
string
rssi
string
>= 0 <= 100

Network strength (0-100)

run_time
string
ssid
string
status
string
>= 0 <= 3

0 - disconnected, 1 - connected, 3 - connecting

Additional properties are allowed.

Wifi

Examples

WispStatus
Payload
Example #1
{
  "app_enable": "string",
  "auth": "1",
  "auto": "string",
  "bandwidth": "50",
  "bssid": "0025.9e45.24a0",
  "channel": "20",
  "dns0": "8.8.8.8",
  "dns1": "8.8.4.4",
  "enable": "string",
  "encrypt": "WPA/ WPA2",
  "gw": "192.168.0.1",
  "internet": "0",
  "ip": "192.168.0.100",
  "key": "string",
  "mask": "255.255.255.0",
  "rssi": "100",
  "run_time": "string",
  "ssid": "QMBTEERO",
  "status": "0",
  "wifiStatus": {
    "ssid": "QMBTEERO",
    "encryption": "SHARE",
    "ip4": "192.168.0.100",
    "dhcp": false,
    "subnetmask": "255.255.255.0",
    "gateway": "192.168.0.1",
    "dns": {
      "dns1": "8.8.8.8",
      "dns2": "8.8.4.4",
      "adapterName": "wlan0",
      "valid": true
    },
    "serviceId": "0025.9e45.24a0",
    "connectionStatus": "DISCONNECTED",
    "hasInternet": true,
    "adapterName": "wlan0"
  },
  "dnsconfig": {
    "dns1": "8.8.8.8",
    "dns2": "8.8.4.4",
    "adapterName": "wlan0",
    "valid": true
  }
}

Pub zbos/wifi/status/get

get Wifi status

see zbos/wifi/status/response for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Wifi

Examples

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

Sub zbos/wifi/status/response

response: Wifi status

All WiFi scan results are publish as an event. The event can be triggered by a scan request or by the robot system.

Accepts the following message:

WispStatus

Payload
object
app_enable
string
auth
string

type off network, "0" for open networks

auto
string
bandwidth
string
bssid
string
channel
string
dns0
string
dns1
string
enable
string
encrypt
string
gw
string

The gateway

internet
string

0 - internet is available, anything else: no internet available

ip
string
is_wan_priority
string
key
string
mask
string
rssi
string
>= 0 <= 100

Network strength (0-100)

run_time
string
ssid
string
status
string
>= 0 <= 3

0 - disconnected, 1 - connected, 3 - connecting

Additional properties are allowed.

Wifi

Examples

WispStatus
Payload
Example #1
{
  "app_enable": "string",
  "auth": "1",
  "auto": "string",
  "bandwidth": "50",
  "bssid": "0025.9e45.24a0",
  "channel": "20",
  "dns0": "8.8.8.8",
  "dns1": "8.8.4.4",
  "enable": "string",
  "encrypt": "WPA/ WPA2",
  "gw": "192.168.0.1",
  "internet": "0",
  "ip": "192.168.0.100",
  "key": "string",
  "mask": "255.255.255.0",
  "rssi": "100",
  "run_time": "string",
  "ssid": "QMBTEERO",
  "status": "0",
  "wifiStatus": {
    "ssid": "QMBTEERO",
    "encryption": "SHARE",
    "ip4": "192.168.0.100",
    "dhcp": false,
    "subnetmask": "255.255.255.0",
    "gateway": "192.168.0.1",
    "dns": {
      "dns1": "8.8.8.8",
      "dns2": "8.8.4.4",
      "adapterName": "wlan0",
      "valid": true
    },
    "serviceId": "0025.9e45.24a0",
    "connectionStatus": "DISCONNECTED",
    "hasInternet": true,
    "adapterName": "wlan0"
  },
  "dnsconfig": {
    "dns1": "8.8.8.8",
    "dns2": "8.8.4.4",
    "adapterName": "wlan0",
    "valid": true
  }
}

Sub zbos/wifi/status/event

event: Wifi status

Accepts the following message:

WispStatus

Payload
object
app_enable
string
auth
string

type off network, "0" for open networks

auto
string
bandwidth
string
bssid
string
channel
string
dns0
string
dns1
string
enable
string
encrypt
string
gw
string

The gateway

internet
string

0 - internet is available, anything else: no internet available

ip
string
is_wan_priority
string
key
string
mask
string
rssi
string
>= 0 <= 100

Network strength (0-100)

run_time
string
ssid
string
status
string
>= 0 <= 3

0 - disconnected, 1 - connected, 3 - connecting

Additional properties are allowed.

Wifi

Examples

WispStatus
Payload
Example #1
{
  "app_enable": "string",
  "auth": "1",
  "auto": "string",
  "bandwidth": "50",
  "bssid": "0025.9e45.24a0",
  "channel": "20",
  "dns0": "8.8.8.8",
  "dns1": "8.8.4.4",
  "enable": "string",
  "encrypt": "WPA/ WPA2",
  "gw": "192.168.0.1",
  "internet": "0",
  "ip": "192.168.0.100",
  "key": "string",
  "mask": "255.255.255.0",
  "rssi": "100",
  "run_time": "string",
  "ssid": "QMBTEERO",
  "status": "0",
  "wifiStatus": {
    "ssid": "QMBTEERO",
    "encryption": "SHARE",
    "ip4": "192.168.0.100",
    "dhcp": false,
    "subnetmask": "255.255.255.0",
    "gateway": "192.168.0.1",
    "dns": {
      "dns1": "8.8.8.8",
      "dns2": "8.8.4.4",
      "adapterName": "wlan0",
      "valid": true
    },
    "serviceId": "0025.9e45.24a0",
    "connectionStatus": "DISCONNECTED",
    "hasInternet": true,
    "adapterName": "wlan0"
  },
  "dnsconfig": {
    "dns1": "8.8.8.8",
    "dns2": "8.8.4.4",
    "adapterName": "wlan0",
    "valid": true
  }
}

Sub zbos/wifi/error

Wifi error

A message is published on this topic, whenever there is an error, during execution of WiFi commands

Accepts the following message:

String

Payload
string
Wifi

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/wifi/forget

Forget network

Forget a saved network, only possible when not connected to the saved network.

Accepts the following message:

AccessPoint

Payload
object
ssid
string
bssid
string
channel
string
bandwidth
string
auth
string

type off network, "0" for open networks

is_5g
string
rssi
string
>= 0 <= 100

Network strength (0-100)

save
string
>= 0 <= 2

"0" not saved, "1" saved, "2" currently connected

password
string

Additional properties are allowed.

Wifi

Examples

AccessPoint
Payload
Example #1
{
  "ssid": "QMBTEERO",
  "savedNetwork": {
    "ssid": "QMBTEERO",
    "encryption": "UNSECURE",
    "hidden": false
  },
  "scannedNetwork": {
    "ssid": "QMBTEERO",
    "encryption": "UNSECURE",
    "saved": false
  }
}

Sub zbos/wifi/forget/event

event: Wifi forgotten

Accepts the following message:

ForgetResponse

Payload
object
bssid
string
success
boolean

Additional properties are allowed.

Wifi

Examples

ForgetResponse
Payload
Example #1
{}

Pub zbos/wifi/repair

Repair Wifi

Accepts the following message:

EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

Wifi

Examples

EmptyMessage
Payload 
{}
This example has been generated automatically.

Pub zbos/wifi/accesspoint/password/set

Set hotspot password

Accepts the following message:

String

Payload
string
Wifi

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/wifi/accesspoint/password/get

Get hotspot password

see <<zbos/wifi/accesspoint/password/response>> for response

Accepts the following message:

KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

Wifi

Examples

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

Sub zbos/wifi/accesspoint/password/response

response: Get hotspot password

Accepts the following message:

String

Payload
string
Wifi

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/wifi/hotspot/set

Set wifi hotspot

see <<zbos/wifi/hotspot/set/response/{key}>> for response

Accepts the following message:

PostFieldsHotspot

Payload
object
network_mode
string
port_id
string
ap_id
string
AP_SSID
string
SSID_broadcast
string
channel_band
string
channel_num
string
channel_width
string
need_reboot
string
radio_criterion
string
region
string
waln_partition
string
wire_enable
string
wire_mac
string

Additional properties are allowed.

Wifi

Examples

PostFieldsHotspot
Payload
Example #1
{
  "port_id": "string",
  "ap_id": "string"
}

Sub zbos/wifi/hotspot/set/response/{key}

response: Set wifi hotspot

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
Wifi

Examples

String
Payload 
"string"
This example has been generated automatically.

Pub zbos/wifi/hotspot/get

Get wifi hotspot

see <<zbos/wifi/hotspot/get/response/{key}>> for response

Accepts the following message:

PostFieldsHotspot

Payload
object
network_mode
string
port_id
string
ap_id
string
AP_SSID
string
SSID_broadcast
string
channel_band
string
channel_num
string
channel_width
string
need_reboot
string
radio_criterion
string
region
string
waln_partition
string
wire_enable
string
wire_mac
string

Additional properties are allowed.

Wifi

Examples

PostFieldsHotspot
Payload
Example #1
{
  "port_id": "string",
  "ap_id": "string"
}

Sub zbos/wifi/hotspot/get/response/{key}

response: Get wifi hotspot

Parameters
key
required
string

Request key to create a unique subscription topic

Accepts the following message:

String

Payload
string
Wifi

Examples

String
Payload 
"string"
This example has been generated automatically.

Messages

#1 KeyResult

Random key

Payload
object
key
string

Required random key

Additional properties are allowed.

#2 Array<ApplicationCategory>

Payload
array<object>
id
string
name
string

Use name for a static name, or name_key for a translatable name

name_key
string

Use name for a static name, or name_key for a translatable name

weight
integer

Additional items are allowed.

#3 GetApplicationsRequest

Payload
object
key
string
limit
integer
offset
integer
filters
array<object>
field
string

Field to check on. Note that the field should be camelCase, not snake_case

value
string

Value to check on. For numbers you should use 'min' and 'max'.

min
number

Minimum value, only usable for number fields

max
number

Maximum value, only usable for number fields

direction
object

Direction to sort on. Can be 'asc' or 'desc'. The default direction is 'asc'

Enum: "ASC" "DESC"
name
string
ordinal
integer

Additional properties are allowed.

operator
object

Operator for either the child filters, or this filter object itself. Can be 'and', 'or' or 'not'. Default is 'and'. The root operator is always 'and'

Enum: "AND" "OR" "NOT"
name
string
ordinal
integer

Additional properties are allowed.

match_type
object

Match type for string values. Can be 'exact', 'contains', 'starts_with', 'ends_with'. The default match_type is 'contains'

Enum: "EXACT" "CONTAINS" "STARTS_WITH" "ENDS_WITH"
name
string
ordinal
integer

Additional properties are allowed.

filters
array<object>

Filters on which the operator will be applied. If there are no child filters, the operator will be applied to the filter object itself.

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

field_filters
array<object>

Filters to apply on the child fields of the field. Will only work if the field is an object, array/list or map.

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

Additional items are allowed.

language
string

Optional. Set the language to have all translations filled in. The language format is ISO 639-1 language code, Eg: 'en' or 'en-US'

Additional properties are allowed.

#4 Array<Application>

Payload
array<object>
id
string

This could be a package name, or some other defined unique ID

name
string

Use name for a static name, or name_key for a translatable name

name_key
string

Use name for a static name, or name_key for a translatable name

category_id
string
weight
integer
actions
array<object>
application_id
string
name
string

Use name for a static name, or name_key for a translatable name

name_key
string

Use name for a static name, or name_key for a translatable name

type
object

List of available actions: open: Opens an application handled by the RAILopen_control: Opens an application handled by the control settings: Opens the settings, handled by the control datasource: Edit the datasource, handled by the control other: Should be handled by the app itself

Enum: "OPEN" "OPEN_CONTROL" "SETTINGS" "DATASOURCES" "OTHER"
name
string
ordinal
integer

Additional properties are allowed.

data
object

Optional data that an action might need.

Additional properties are allowed.

Additional items are allowed.

Additional items are allowed.

#5 Application

Payload
object
id
string

This could be a package name, or some other defined unique ID

name
string

Use name for a static name, or name_key for a translatable name

name_key
string

Use name for a static name, or name_key for a translatable name

category_id
string
weight
integer
actions
array<object>
application_id
string
name
string

Use name for a static name, or name_key for a translatable name

name_key
string

Use name for a static name, or name_key for a translatable name

type
object

List of available actions: open: Opens an application handled by the RAILopen_control: Opens an application handled by the control settings: Opens the settings, handled by the control datasource: Edit the datasource, handled by the control other: Should be handled by the app itself

Enum: "OPEN" "OPEN_CONTROL" "SETTINGS" "DATASOURCES" "OTHER"
name
string
ordinal
integer

Additional properties are allowed.

data
object

Optional data that an action might need.

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

#6 GetApplicationIconRequest

Payload
object
key
string
max_width
integer

Optional, can be used to decrease payload size

max_height
integer

Optional, can be used to decrease payload size

application_id
string

Additional properties are allowed.

#7 ApplicationIcon

Payload
object
application_id
string
icon
string

Base 64 encoded PNG

Additional properties are allowed.

#8 ApplicationAction

Payload
object
application_id
string
name
string

Use name for a static name, or name_key for a translatable name

name_key
string

Use name for a static name, or name_key for a translatable name

type
object

List of available actions: open: Opens an application handled by the RAILopen_control: Opens an application handled by the control settings: Opens the settings, handled by the control datasource: Edit the datasource, handled by the control other: Should be handled by the app itself

Enum: "OPEN" "OPEN_CONTROL" "SETTINGS" "DATASOURCES" "OTHER"
name
string
ordinal
integer

Additional properties are allowed.

data
object

Optional data that an action might need.

Additional properties are allowed.

Additional properties are allowed.

#9 SuccessMessage

Success message

Payload
object
success
boolean

Success message

Additional properties are allowed.

#10 EmptyMessage

Empty message

Payload
object

Additional properties are allowed.

#11 RegisterApplicationRequest

Payload
object
key
string
application
object
id
string

This could be a package name, or some other defined unique ID

name
string

Use name for a static name, or name_key for a translatable name

name_key
string

Use name for a static name, or name_key for a translatable name

category_id
string
weight
integer
actions
array<object>
application_id
string
name
string

Use name for a static name, or name_key for a translatable name

name_key
string

Use name for a static name, or name_key for a translatable name

type
object

List of available actions: open: Opens an application handled by the RAILopen_control: Opens an application handled by the control settings: Opens the settings, handled by the control datasource: Edit the datasource, handled by the control other: Should be handled by the app itself

Enum: "OPEN" "OPEN_CONTROL" "SETTINGS" "DATASOURCES" "OTHER"
name
string
ordinal
integer

Additional properties are allowed.

data
object

Optional data that an action might need.

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

Additional properties are allowed.

#12 UnregisterApplicationRequest

Payload
object
key
string
id
string

Additional properties are allowed.

#13 DatasourceGetRequest

Payload
object
applicationName
string
datasourceId
string

Additional properties are allowed.

#14 String

Payload
string
#15 DatasourceSetRequest

Payload
object
applicationName
string
datasourceId
string
datasourceData
string

Additional properties are allowed.

#16 Int

Payload
integer
>= 0 <= 100
#17 StreamStartRequest

Payload
object
cameraId
string

Camera id

extras
object

Additional properties are allowed.

Additional properties are allowed.

#18 VideoOptions

Payload
object
requestId
string
cameraId
string

camera id

Additional properties are allowed.

#19 StreamAnswer

Payload
object
type
object
Enum: "OFFER" "PRANSWER" "ANSWER"
name
string
ordinal
integer

Additional properties are allowed.

sdp
string

Additional properties are allowed.

#20 Candidate

Payload
object
cameraId
string

camera id

type
string

Always returns "candidate"

label
integer

sdpMLineIndex

id
string

sdpMid

candidate
string

Additional properties are allowed.

#21 QrScanStartRequest

Payload
object
scan_id
string

Unique ID that will be used in related topics.

scan_timeout
integer

Timeout in seconds after which the scan should automatically be stopped. Pass 0 to not have a timeout. 0 is also the default when no value was passed.

Additional properties are allowed.

#22 QrScanStopRequest

Payload
object
scan_id
string

Unique ID that should be the same as the one used in the start request.

Additional properties are allowed.

#23 QrScanStoppedEvent

Payload
object
scan_id
string

Unique ID that will be the same as the one used in the start request.

Additional properties are allowed.

#24 QrResultEvent

Payload
object
content
string

Additional properties are allowed.

#25 LoginResponse

Payload
object
token
string

jwt auth token

success
boolean

Additional properties are allowed.

#26 Map

Payload
object

Additional properties are allowed.

#27 FileUploadRequest

Payload
object
file
string
storageAccount
string
key
string
metadata
object

Additional properties are allowed.

Additional properties are allowed.

#28 CloudResult

Payload
object
success
boolean
cloudFileId
string

Additional properties are allowed.

#29 SimpleComposition

Payload
object
id
string
name
string
type
object
Enum: "SIMPLE_COMPOSITION" "ADVANCED_COMPOSITION"
name
string
ordinal
integer

Additional properties are allowed.

settings
object
pinned
boolean
schedulerParallel
boolean

Additional properties are allowed.

Additional properties are allowed.

#30 LoopProperty

Payload
object
infinite
boolean
repeatTimes
integer

Total loop count

currentRepeatTimes
integer

current loop count

Additional properties are allowed.

#31 TimelinePropertiesWrapper

Payload
object
properties
object
loop
object
infinite
boolean
repeatTimes
integer

Total loop count

currentRepeatTimes
integer

current loop count

Additional properties are allowed.

general
object
stoppable
boolean
powerManagement
object
Enum: "DEFAULT" "AWARE" "DISABLED"
name
string
ordinal
integer

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

timelineId
string

Composition ID

isScheduler
boolean
isPinned
boolean
type
object
Enum: "SIMPLE_COMPOSITION" "ADVANCED_COMPOSITION"
name
string
ordinal
integer

Additional properties are allowed.

Additional properties are allowed.

#32 SaveMultipleCompositionRequest

Payload
object
key
string

Required key

compositions
array<object>

Array of compositions

id
string
name
string
type
object
Enum: "SIMPLE_COMPOSITION" "ADVANCED_COMPOSITION"
name
string
ordinal
integer

Additional properties are allowed.

settings
object
pinned
boolean
schedulerParallel
boolean

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

#33 Array<SimpleComposition>

Payload
array<object>
id
string
name
string
type
object
Enum: "SIMPLE_COMPOSITION" "ADVANCED_COMPOSITION"
name
string
ordinal
integer

Additional properties are allowed.

settings
object
pinned
boolean
schedulerParallel
boolean

Additional properties are allowed.

Additional items are allowed.

#34 CompositionError

Payload
object
type
string

Block type that caused the error, 'UNKNOWN' if not known

id
string

Block ID that caused the error, 'UNKNOWN' if not known

reasons
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

#35 ApiRequestBlock

Payload
object
name
string
endpoint
string
body
string
params
object

Additional properties are allowed.

headers
object

Additional properties are allowed.

Additional properties are allowed.

#36 Array<String>

Payload
array<string>

Items:

0
string

Additional items are allowed.

#37 CompositionStatus

Payload
object
id
string
state
object

Default, playing or paused

Enum: "DEFAULT" "PLAYING" "PAUSED"
name
string
ordinal
integer

Additional properties are allowed.

activeBlocks
array<string>

Items:

0
string

Additional items are allowed.

properties
object

Composition properties

loop
object
infinite
boolean
repeatTimes
integer

Total loop count

currentRepeatTimes
integer

current loop count

Additional properties are allowed.

general
object
stoppable
boolean
powerManagement
object
Enum: "DEFAULT" "AWARE" "DISABLED"
name
string
ordinal
integer

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

playCount
integer

Current repeat iteration

Additional properties are allowed.

#38 Block

Payload
object
id
string

Block ID

index
integer
blocking
boolean
input
object
connectors
array<object>
id
string
connection
object
blockId
string
connectorId
string

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

output
object
connectors
array<object>
id
string
connection
object
blockId
string
connectorId
string

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

nextBlockId
string

Additional properties are allowed.

#39 ConnectionStatus

Payload
object
wifi
array<object>
ssid
string
encryption
object
Enum: "UNSECURE" "SHARE" "WEP" "WPA" "WPA_PSK" "WPA_OR_WPA2" "WPA_OR_WPA2_PSK" "WPA2" "WPA2_PSK" "WPA2_EAP" "WAI_CERT" "WAI_PSK"
name
string
ordinal
integer

Additional properties are allowed.

ip4
string
ip6
string
dhcp
boolean
subnetmask
string
gateway
string
dns
object
dns1
string
dns2
string
adapterName
string

Additional properties are allowed.

serviceId
string
connectionStatus
object
Enum: "CONNECTING" "CONNECTED" "DISCONNECTED"
name
string
ordinal
integer

Additional properties are allowed.

hasInternet
boolean
adapterName
string

Additional items are allowed.

cable
array<object>
ip4
string
ip6
string
dhcp
boolean
subnetmask
string
gateway
string
dns
object
dns1
string
dns2
string
adapterName
string

Additional properties are allowed.

hasConnection
boolean
hasInternet
boolean
serviceId
string
adapterName
string

Additional items are allowed.

ap
array<object>
ssid
string
ip
string
encryption
object
Enum: "UNSECURE" "SHARE" "WEP" "WPA" "WPA_PSK" "WPA_OR_WPA2" "WPA_OR_WPA2_PSK" "WPA2" "WPA2_PSK" "WPA2_EAP" "WAI_CERT" "WAI_PSK"
name
string
ordinal
integer

Additional properties are allowed.

hasConnection
boolean
hasInternet
boolean
adapterName
string

Additional items are allowed.

Additional properties are allowed.

#40 Array<ScannedNetwork>

Payload
array<object>
ssid
string
encryption
object
Enum: "UNSECURE" "SHARE" "WEP" "WPA" "WPA_PSK" "WPA_OR_WPA2" "WPA_OR_WPA2_PSK" "WPA2" "WPA2_PSK" "WPA2_EAP" "WAI_CERT" "WAI_PSK"
name
string
ordinal
integer

Additional properties are allowed.

signal
number
isSaved
boolean
serviceId
string
channel
number

Additional items are allowed.

#41 ConnectToNetwork

Payload
object
ssid
string
encryption
object
Enum: "UNSECURE" "SHARE" "WEP" "WPA" "WPA_PSK" "WPA_OR_WPA2" "WPA_OR_WPA2_PSK" "WPA2" "WPA2_PSK" "WPA2_EAP" "WAI_CERT" "WAI_PSK"
name
string
ordinal
integer

Additional properties are allowed.

password
string
username
string
serviceId
string
isSaved
boolean
hidden
boolean
channel
number
adapterName
string

Additional properties are allowed.

#42 ConnectionResponse

Payload
object
success
boolean
message
string

Additional properties are allowed.

#43 ForgetNetwork

Payload
object
ssid
string
serviceId
string
adapterName
string

Additional properties are allowed.

#44 Array<SavedNetwork>

Payload
array<object>
ssid
string
encryption
object
Enum: "UNSECURE" "SHARE" "WEP" "WPA" "WPA_PSK" "WPA_OR_WPA2" "WPA_OR_WPA2_PSK" "WPA2" "WPA2_PSK" "WPA2_EAP" "WAI_CERT" "WAI_PSK"
name
string
ordinal
integer

Additional properties are allowed.

password
string
username
string
hidden
boolean
networkConfig
object
dhcp
boolean
fixedIp4
string
fixedIp6
string
subnetmask
string
gateway
string
adapterName
string

Additional properties are allowed.

dns
object
dns1
string
dns2
string
adapterName
string

Additional properties are allowed.

Additional items are allowed.

#45 NetworkConfig

Payload
object
dhcp
boolean
fixedIp4
string
fixedIp6
string
subnetmask
string
gateway
string
adapterName
string

Additional properties are allowed.

#46 DNSConfig

Payload
object
dns1
string
dns2
string
adapterName
string

Additional properties are allowed.

#47 APConfig

Payload
object
enabled
boolean
ssid
string
password
string
adapterName
string

Additional properties are allowed.

#48 DiagnosticState

Payload
object
partId
string

Name of the part

partType
object

Type of the part

Enum: "MOTOR" "MOTOR_CONTROLLER" "SERVO" "SERVO_CONTROLLER" "CPU" "MEMORY" "LIDAR" "POWER_BOARD" "BATTERY"
name
string
ordinal
integer

Additional properties are allowed.

info
object
translationKey
string

status code

message
string

status message

Additional properties are allowed.

temperature
string

optional, depending on robot

Additional properties are allowed.

#49 Array<DiagnosticState>

Payload
array<object>
partId
string

Name of the part

partType
object

Type of the part

Enum: "MOTOR" "MOTOR_CONTROLLER" "SERVO" "SERVO_CONTROLLER" "CPU" "MEMORY" "LIDAR" "POWER_BOARD" "BATTERY"
name
string
ordinal
integer

Additional properties are allowed.

info
object
translationKey
string

status code

message
string

status message

Additional properties are allowed.

temperature
string

optional, depending on robot

Additional items are allowed.

#50 Settings

Payload
object
ADD
string
ADD_RESPONSE
string
CHANGED_EVENT
string
GET
string
GET_RESPONSE
string
REQUEST
string
RESET
string
RESET_RESPONSE
string
UPDATE
string
UPDATE_RESPONSE
string

Additional properties are allowed.

#51 Array<PluginState>

Payload
array<object>
brand
string
state
object

Can be: INITIALIZING, CONNECTING, CONNECTION_FAILED, CONNECTION_SUCCEEDED

Enum: "INITIALIZING" "CONNECTING" "CONNECTION_FAILED" "CONNECTION_SUCCEEDED" "NOT_CONFIGURED"
name
string
ordinal
integer

Additional properties are allowed.

Additional items are allowed.

#52 Array<DomoticaDevice>

Payload
array<object>
id
string
room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

type
string
brand
string

Additional items are allowed.

#53 DomoticaDevice

Payload
object
id
string
room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

type
string
brand
string

Additional properties are allowed.

#54 Room

Payload
object
key
string
devices
array<object>
id
string
room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

type
string
brand
string

Additional items are allowed.

Additional properties are allowed.

#55 DeviceState

Payload
object
room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

state
object
value
object

Additional properties are allowed.

optionalValue
object

Additional properties are allowed.

unit
string

Additional properties are allowed.

type
string
id
string

Additional properties are allowed.

#56 PluginState

Payload
object
brand
string
state
object

Can be: INITIALIZING, CONNECTING, CONNECTION_FAILED, CONNECTION_SUCCEEDED

Enum: "INITIALIZING" "CONNECTING" "CONNECTION_FAILED" "CONNECTION_SUCCEEDED" "NOT_CONFIGURED"
name
string
ordinal
integer

Additional properties are allowed.

Additional properties are allowed.

#57 DomoticaSetDeviceOptions

Payload
object
type
string

The device type. Currently supported types are: light, dimmer, switch, plug, door, shutter, speaker.

state
boolean

True for on/open/..., false for off/closed/...

room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

#58 DomoticaGetOptions

Payload
object
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

#59 DomoticaSetBooleanOptions

Payload
object
state
boolean

True for on, false for off

room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

#60 DomoticaSetIntOptions

Payload
object
value
integer

Value between 0 and 100 (percentage). To turn off, give value zero

room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

#61 DomoticaSetSpeakerOptions

Payload
object
command
string

Supported commands: play, pause, mute, unmute, set volume, increase volume, decrease volume, next song, previous song

value
integer

Optional. Only used for 'set volume' command. Value between 0 and 100 (percentage)

room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

#62 DomoticaPlaySceneOptions

Payload
object
room
string
scene
string

Optional

Additional properties are allowed.

#63 Any

Payload
object

Additional properties are allowed.

#64 Detection

Payload
object
name
string
role
string
lastUpdated
object
fastTime
number
cdate
object
cachedYear
integer
cachedFixedDateJan1
number
cachedFixedDateNextJan1
number

Additional properties are allowed.

Additional properties are allowed.

lastSeen
object
fastTime
number
cdate
object
cachedYear
integer
cachedFixedDateJan1
number
cachedFixedDateNextJan1
number

Additional properties are allowed.

Additional properties are allowed.

seenCount
integer

Additional properties are allowed.

#65 ApplicationStartRequest

Payload
object
appName
string
extras
object

Additional properties are allowed.

Additional properties are allowed.

#66 Array<SimpleApplicationNodeDto>

Payload
array<object>
app_name
string
package_name
string
image_base64
string

Additional items are allowed.

#67 InputBlock

Payload
object
question
string
textType
string
confirmText
string

Additional properties are allowed.

#68 InputResponse

Payload
object
input
string

Additional properties are allowed.

#69 Image

Payload
object
id
string
path
string
extension
string
fileName
string
style
object
backgroundColor
string

Additional properties are allowed.

url
string

Additional properties are allowed.

#70 Video

Payload
object
id
string
url
string
repeat
boolean
audioUrl
string
videoOnly
boolean
showControls
boolean

Additional properties are allowed.

#71 OpenBrowserBlock

Payload
object
blocking
boolean
id
string
index
integer
url
string

Additional properties are allowed.

#72 Action

Payload
object

Additional properties are allowed.

#73 LockStatus

Payload
object
isLocked
boolean
isPincodeSet
boolean

Additional properties are allowed.

#74 LockResponse

Payload
object
response
string
success
boolean

Additional properties are allowed.

#75 Array<SimpleDataSource>

Payload
array<object>
id
string
name
string

Additional items are allowed.

#76 SimpleDataSource

Payload
object
id
string
name
string

Additional properties are allowed.

#77 ChangeDatasourceRequest

Payload
object
id
string

Additional properties are allowed.

#78 PinnedComposition

Payload
object
id
string

Additional properties are allowed.

#79 PinnedCompositionState

Payload
object
isPinned
boolean
id
string

Additional properties are allowed.

#80 PinnedApplication

Payload
object
packageName
string

Additional properties are allowed.

#81 PinnedApplicationState

Payload
object
isPinned
boolean
packageName
string

Additional properties are allowed.

#82 LedOptions

Payload
object
part
object
Enum: "CHEST" "MOUTH" "EYES" "HEAD" "SPEECH"
name
string
ordinal
integer

Additional properties are allowed.

color
string

The format is "#FF0000" (red)

breathe
boolean
breathDuration
integer
duration
integer

Additional properties are allowed.

#83 FilteringRequest

Payload
object
key
string
limit
integer
offset
integer
filters
array<object>
field
string

Field to check on. Note that the field should be camelCase, not snake_case

value
string

Value to check on. For numbers you should use 'min' and 'max'.

min
number

Minimum value, only usable for number fields

max
number

Maximum value, only usable for number fields

direction
object

Direction to sort on. Can be 'asc' or 'desc'. The default direction is 'asc'

Enum: "ASC" "DESC"
name
string
ordinal
integer

Additional properties are allowed.

operator
object

Operator for either the child filters, or this filter object itself. Can be 'and', 'or' or 'not'. Default is 'and'. The root operator is always 'and'

Enum: "AND" "OR" "NOT"
name
string
ordinal
integer

Additional properties are allowed.

match_type
object

Match type for string values. Can be 'exact', 'contains', 'starts_with', 'ends_with'. The default match_type is 'contains'

Enum: "EXACT" "CONTAINS" "STARTS_WITH" "ENDS_WITH"
name
string
ordinal
integer

Additional properties are allowed.

filters
array<object>

Filters on which the operator will be applied. If there are no child filters, the operator will be applied to the filter object itself.

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

field_filters
array<object>

Filters to apply on the child fields of the field. Will only work if the field is an object, array/list or map.

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

Additional items are allowed.

sort
array<object>
field
string

Field to check on. Note that the field should be camelCase, not snake_case

value
string

Value to check on. For numbers you should use 'min' and 'max'.

min
number

Minimum value, only usable for number fields

max
number

Maximum value, only usable for number fields

direction
object

Direction to sort on. Can be 'asc' or 'desc'. The default direction is 'asc'

Enum: "ASC" "DESC"
name
string
ordinal
integer

Additional properties are allowed.

operator
object

Operator for either the child filters, or this filter object itself. Can be 'and', 'or' or 'not'. Default is 'and'. The root operator is always 'and'

Enum: "AND" "OR" "NOT"
name
string
ordinal
integer

Additional properties are allowed.

match_type
object

Match type for string values. Can be 'exact', 'contains', 'starts_with', 'ends_with'. The default match_type is 'contains'

Enum: "EXACT" "CONTAINS" "STARTS_WITH" "ENDS_WITH"
name
string
ordinal
integer

Additional properties are allowed.

filters
array<object>

Filters on which the operator will be applied. If there are no child filters, the operator will be applied to the filter object itself.

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

field_filters
array<object>

Filters to apply on the child fields of the field. Will only work if the field is an object, array/list or map.

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

Additional items are allowed.

Additional properties are allowed.

#84 Array<MediaFile>

Payload
array<object>
fileId
string
path
string
fileName
string
extension
string
type
string
mimeType
string
downloadPath
string
previewPath
string
thumbnailPath
string
checksum
string
cloudFileId
string
size
number
modifiedAt
number
isDefaultAsset
boolean
fullPath
string

Additional items are allowed.

#85 ExportRequestDto

Payload
object
clientId
string
compositionId
string
compositionName
string
mediaPaths
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

#86 AnimationOptions

Payload
object
requestId
string
type
string
animationId
string

Additional properties are allowed.

#87 Array<AvailableAnimation>

Payload
array<object>
id
string
name
string
animation
string
type
string

Additional items are allowed.

#88 Boolean

Payload
boolean
#89 DanceOptions

Payload
object
requestId
string
danceId
string

Additional properties are allowed.

#90 Array<AvailableDance>

Payload
array<object>
id
string
name
string
animation
string
song
string

Additional items are allowed.

#91 MobilityActionOptions

Payload
object
requestId
string
yaw
number
pitch
number
angle
object
degree
number
>= -100 <= 100

Angles in percent between -100 en +100

Additional properties are allowed.

force
number
distance
number

In meters

relative_rotation
number
partName
string

Additional properties are allowed.

#92 EmotionOptions

Payload
object
requestId
string
emotionId
string

Additional properties are allowed.

#93 Array<AvailableEmotion>

Payload
array<object>
id
string
name
string
animation
string
translationkey
string

Additional items are allowed.

#94 Array<AvailableGymMovement>

Payload
array<object>
categories
array<object>
name
string
translation
string
exercises
array<object>
name
string
translation
string
speedIn_min
number
speedIn_max
number
speedOut_min
number
speedOut_max
number
duty_min
number
duty_max
number
period_min
number
period_max
number
cycles_min
number
cycles_max
number
profiles
array<object>
name
string
code
string
translation
string

Additional items are allowed.

Additional items are allowed.

Additional items are allowed.

Additional items are allowed.

#95 MotionDetectionOptions

Payload
object
key
string

Required key

unit
string

Can be "s", "h" or "m" (seconds, hours, minutes), used for duration. Defaults to seconds

initialDelay
number
>= 0

How long to wait until starting motion detection, in milliseconds. Defaults to 2000, lower values may cause false positives

interval
number
>= 0

How often the camera should check for motion, in milliseconds. Defaults to 200

duration
number
>= 0

The maximum time the motion detection will be active, after the time is elapsed, the motion detection will stop. Defaults to 10

stopOnDetection
boolean

If true the motion detection will stop after the first detection. Defaults to true

upload
boolean

If true, the picture with motion detected will be uploaded to the cloud. A notification is sent to zbos-control (if enabled). Defaults to false

stopAfterDuration
boolean

If true the motion detection will stop at the end of the duration. Defaults to true

Additional properties are allowed.

#96 MotionDetectionEvent

Payload
object
image
string

Image of the detected motion, only given if upload is enabled in motion detection options.

Additional properties are allowed.

#97 AvailableSensor

Payload
object
id
string
type
object
Enum: "TOUCHSENSOR" "TOUCHSENSOR_GROUP"
name
string
ordinal
integer

Additional properties are allowed.

translationkey
string

Additional properties are allowed.

#98 SensorEvent

Payload
object
id
string
type
string
source
string
state
string

Additional properties are allowed.

#99 GetSettingsRequest

Payload
object
key
string
category
string
setting_keys
array<string>

Optional, will return all settings if not set.

Items:

0
string

Additional items are allowed.

subcategories
object

Optional, will return all subcategories if not set.

Additional properties are allowed.

Additional properties are allowed.

#100 SettingsCategory

Payload
object
label_key
string

Translation key should use the dot notation: {category}.{key}

description_key
string

Optional description key Translation key should use the dot notation: {category}.{key}

settings
object

Additional properties are allowed.

subcategories
object

Optional subcategories

Additional properties are allowed.

orphaned
boolean

The orphaned state indicates that this category was not added again since boot.

Additional properties are allowed.

#101 AddSettingsRequest

Payload
object
key
string
category_name
string
file
string

Optional. Use either category or file

category
object

Optional. Use either category or file

label_key
string

Translation key should use the dot notation: {category}.{key}

description_key
string

Optional description key Translation key should use the dot notation: {category}.{key}

settings
object

Additional properties are allowed.

subcategories
object

Optional subcategories

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

#102 UpdateSettingsRequest

Payload
object
key
string
category_name
string
category
object
settings
object

Additional properties are allowed.

subcategories
object

Optional subcategories

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

#103 SettingsChangedEvent

Payload
object
category_name
string
category
object
settings
object

Additional properties are allowed.

subcategories
object

Optional subcategories

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

#104 ResetSettingsRequest

Payload
object
key
string
category
string

Additional properties are allowed.

#105 Array<SipError>

Payload
array<object>
error
string

Additional items are allowed.

#106 CallEndInfo

Payload
object
success
boolean

Additional properties are allowed.

#107 SlamError

Payload
object
errorCode
string
message
string

Additional properties are allowed.

#108 Array<AvailableSensor>

Payload
array<object>
id
string
type
object
Enum: "TOUCHSENSOR" "TOUCHSENSOR_GROUP"
name
string
ordinal
integer

Additional properties are allowed.

translationkey
string

Additional items are allowed.

#109 SlamStatus

Payload
object
mappingConfigurable
boolean
mappingEnabled
boolean

Additional properties are allowed.

#110 RemoteMapResponseObject

Payload
object
mapName
string
data
string

Additional properties are allowed.

#111 SlamMap

Payload
object
mapName
string
poiList
array<object>
name
string
uuid
string
type
object
Enum: "DEFAULT" "CHARGING_STATION" "INTERACTIVE"
name
string
ordinal
integer

Additional properties are allowed.

coordinate
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

inAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

outAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

#112 ZbosLocation

Payload
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

#113 ZbosSetLocationRequest

Payload
object
key
string

Required random key

coordinate
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

Additional properties are allowed.

#114 WallClearRequest

Payload
object
save
boolean

Additional properties are allowed.

#115 Array<Wall>

Payload
array<object>
startPoint
object
x
number
y
number

Additional properties are allowed.

endPoint
object
x
number
y
number

Additional properties are allowed.

segmentId
string
save
boolean

Additional items are allowed.

#116 Wall

Payload
object
startPoint
object
x
number
y
number

Additional properties are allowed.

endPoint
object
x
number
y
number

Additional properties are allowed.

segmentId
string
save
boolean

Additional properties are allowed.

#117 WallRemoveRequest

Payload
object
segmentId
integer
save
boolean

Additional properties are allowed.

#118 Array<WallRemoveRequest>

Payload
array<object>
segmentId
integer
save
boolean

Additional items are allowed.

#119 ZbosMoveToPointRequest

Payload
object
mapName
string
coordinate
object
x
number
y
number

Additional properties are allowed.

Additional properties are allowed.

#120 ZbosLaserScan

Payload
object
angle
number
distance
number

Additional properties are allowed.

#121 ZbosClearPoiRequest

Payload
object
mapName
string
save
boolean

Additional properties are allowed.

#122 Array<SlamMap>

Payload
array<object>
mapName
string
poiList
array<object>
name
string
uuid
string
type
object
Enum: "DEFAULT" "CHARGING_STATION" "INTERACTIVE"
name
string
ordinal
integer

Additional properties are allowed.

coordinate
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

inAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

outAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

Additional items are allowed.

Additional items are allowed.

#123 ZbosMapDetailRequest

Payload
object
key
string

Required random key

mapName
string

Additional properties are allowed.

#124 ZbosAddPoiRequest

Payload
object
mapName
string
poi
object
name
string
uuid
string
type
object
Enum: "DEFAULT" "CHARGING_STATION" "INTERACTIVE"
name
string
ordinal
integer

Additional properties are allowed.

coordinate
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

inAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

outAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

Additional properties are allowed.

save
boolean

Additional properties are allowed.

#125 Poi

Payload
object
name
string
uuid
string
type
object
Enum: "DEFAULT" "CHARGING_STATION" "INTERACTIVE"
name
string
ordinal
integer

Additional properties are allowed.

coordinate
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

inAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

outAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

Additional properties are allowed.

#126 ZbosEditPoiRequest

Payload
object
mapName
string
poi
object
name
string
uuid
string
type
object
Enum: "DEFAULT" "CHARGING_STATION" "INTERACTIVE"
name
string
ordinal
integer

Additional properties are allowed.

coordinate
object
x
number
y
number
rotation
number
rawX
number
rawY
number

Additional properties are allowed.

inAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

outAction
object
actionType
object
Enum: "MQTT" "API"
name
string
ordinal
integer

Additional properties are allowed.

radius
number
target
string

Mqtt topic or API url

data
string

Mqtt payload or post body

Additional properties are allowed.

Additional properties are allowed.

save
boolean

Additional properties are allowed.

#127 ZbosRemovePoiByNameRequest

Payload
object
mapName
string
name
string
save
boolean

Additional properties are allowed.

#128 ZbosRemovePoiByUUIDRequest

Payload
object
mapName
string
uuid
string
save
boolean

Additional properties are allowed.

#129 ZbosMoveToPoiByUUIDRequest

Payload
object
mapName
string
uuid
string
speed
integer
>= 0 <= 100

Percentage value between with range 0 to 100

Additional properties are allowed.

#130 ZbosRemainingPathObject

Payload
object
remainingPathPoints
array<object>
x
number
y
number
z
number

Additional items are allowed.

remainingMilestones
array<object>
x
number
y
number
z
number

Additional items are allowed.

Additional properties are allowed.

#131 DialogOptions

Payload
object
requestId
string
message
string
speed
integer
language
string

Language string like "en-US"

volume
integer
gesticulation
boolean
voice
string
pitch
integer
blocking
boolean

Additional properties are allowed.

#132 PhonemeInfo

Payload
object
jawOpen
boolean
lipTension
integer
mouthHeight
integer
mouthUpturn
integer
mouthWidth
integer
teethLowerVisible
integer
teethUpperVisible
integer
tonguePosition
integer

Additional properties are allowed.

#133 Array<CustomGrammar>

Payload
array<object>
id
string

a unique id of the grammar. This must be unique among the application (next field).

app
string

The application name. This will be used to determined which MQTT topic will be used to post the json output to.

continuous
boolean
input
object

Contains an array for each language with all the possible sentences. The sentences need to be in a format that the speech software understands.

Additional properties are allowed.

variables
object

Additional properties are allowed.

Additional items are allowed.

#134 GrammarMatch

Payload
object
app
string
triggered-by
string

The id of the grammer that has matched with the user input. This is the id from the input json.

language
string

Language that speech software was configured in when the sentence is recognised.

variables
object

Additional properties are allowed.

Additional properties are allowed.

#135 SpeechToTextResult

Payload
object
language
object
baseLocale
object
language
string
script
string
region
string
variant
string
hash
integer

Additional properties are allowed.

localeExtensions
object
extensionMap
object

Additional properties are allowed.

id
string

Additional properties are allowed.

hashCodeValue
integer
languageTag
string

Additional properties are allowed.

text
string
confidence
number

Additional properties are allowed.

#136 SetDialogConfigRequest

Payload
object
config_items
object

One or more config items.

Additional properties are allowed.

key
string

Required random key

Additional properties are allowed.

#137 GetDialogConfigRequest

Payload
object
config_items
array<string>

One or more config keys.

Items:

0
string

Additional items are allowed.

key
string

Required random key

Additional properties are allowed.

#138 OdpParseContextMessage

Payload
object
text
string
offerMoreHelp
boolean

Additional properties are allowed.

#139 OdpHotwordRecognisedPayload

Payload
object
language
string
confidence
number
text
string

Additional properties are allowed.

#140 Array<TtsVoiceInfo>

Payload
array<object>
service
string
name
string
age
string
language
string
languageCode
string
gender
string
languageVersion
string
frequency
integer

Additional items are allowed.

#141 Array<OdpAsrLanguagesResponse>

Payload
array<object>
languageCode
string

Additional items are allowed.

#142 OdpSpeechRecognisedMessage

Payload
object
recogniseId
string
language
string
confidence
number
text
string

Additional properties are allowed.

#143 OdpPhonemeInfo

Payload
object
jawOpen
boolean
lipTension
integer
mouthHeight
integer
mouthUpturn
integer
mouthWidth
integer
teethLowerVisible
integer
teethUpperVisible
integer
tonguePosition
integer

Additional properties are allowed.

#144 OdpCustomGrammar

Payload
object
id
string

a unique id of the grammar. This must be unique among the application (next field).

app
string

The application name. This will be used to determined which MQTT topic will be used to post the json output to.

continuous
boolean
input
object

Contains an array for each language with all the possible sentences. The sentences need to be in a format that the speech software understands.

Additional properties are allowed.

variables
object

Additional properties are allowed.

Additional properties are allowed.

#145 OdpRemoveCustomGrammarRequest

Payload
object
id
string
app
string

Additional properties are allowed.

#146 OdpGrammarMatchResponse

Payload
object
triggered-by
string
language
string
variables
object

Additional properties are allowed.

Additional properties are allowed.

#147 OdpContextParsed

Payload
object
synthesisId
string
language
string
text
string

Additional properties are allowed.

#148 OdpTtsSayMessage

Payload
object
synthesisId
string
mqttResponseKey
string
language
string
voiceName
string
ssml
string

Additional properties are allowed.

#149 NotificationOptions

Message json

Payload
object
message
object
message
string
translate
boolean
formatArguments
array<string>

Items:

0
string

Additional items are allowed.

translationCategory
string

Additional properties are allowed.

Additional properties are allowed.

#150 Array<SimpleSurvey>

Payload
array<object>
id
string
name
string
type
string
meta
object
languages
array<string>

Items:

0
string

Additional items are allowed.

default_language
string
version
string
created_on
string
last_updated_on
string

Additional properties are allowed.

Additional items are allowed.

#151 SimpleSurvey

Payload
object
id
string
name
string
type
string
meta
object
languages
array<string>

Items:

0
string

Additional items are allowed.

default_language
string
version
string
created_on
string
last_updated_on
string

Additional properties are allowed.

Additional properties are allowed.

#152 SipConfig

Payload
object
serverDomain
string
localUsername
string
localPassword
string
localPort
integer
peerUsername
string
peerPassword
string
peerPort
integer
metaData
object

Additional properties are allowed.

alarmType
object
Enum: "DEFAULT" "VERKLIZAN" "SENSOR"
name
string
ordinal
integer

Additional properties are allowed.

callTimeout
integer
hangupAllowed
boolean
enabled
boolean

Additional properties are allowed.

#153 ZbosAlarm

Payload
object
key
string
alarmServiceProvider
object
Enum: "verklizan" "sensor"
name
string
ordinal
integer

Additional properties are allowed.

metadata
object

Additional properties are allowed.

Additional properties are allowed.

#154 HashMap

Payload
object

Additional properties are allowed.

#155 AlarmConfigRequest

Payload
object
key
string
type
string
config
object

Additional properties are allowed.

Additional properties are allowed.

#156 AlarmConfigResult

Payload
object
success
boolean
error
object
Enum: "MALFORMED_REQUEST" "MISSING_CONFIG_PROPERTY" "TYPE_NOT_FOUND"
name
string
ordinal
integer

Additional properties are allowed.

Additional properties are allowed.

#157 Array<MonitoringResult>

Payload
array<object>
id
string
type
string
downloadPath
string
previewPath
string
mediaFile
string
timestamp
number
metadata
object

Additional properties are allowed.

Additional items are allowed.

#158 BatteryEvent

Payload
object
level
integer
>= 0 <= 100

Percentage value between with range 0 to 100

charging
boolean
docked
boolean

Additional properties are allowed.

#159 BatterySetRequest

Payload
object
percent
integer
>= 0 <= 100

Percentage value between with range 0 to 100

Additional properties are allowed.

#160 RobotIdentification

Payload
object
robot_type
string
body_id
string
serial
string
name
string
versions
object

Additional properties are allowed.

network_info
object
ip
string
mac_address
string
ssid
string

Additional properties are allowed.

features
object
external_displays
array<object>
video
boolean
audio
boolean
width
integer
height
integer

Additional items are allowed.

cameras
array<object>
key
string
primary
boolean
rotation
integer
image_rotation
integer

Additional items are allowed.

can_poi
boolean
can_move
boolean
can_dance
boolean
can_speech
boolean
has_storage
boolean
can_animate
boolean
can_gym
boolean
has_sensors
boolean
has_emotions
boolean
can_video_stream
boolean
can_take_picture
boolean
has_slam_image_map
boolean
has_security_mode
boolean
can_detect_motion
boolean
can_face_recognize
boolean
can_poi_interactive
boolean
has_monitoring
boolean
has_qr_scanner
boolean
can_change_ntp_server
boolean
voice_feature
object
supports_gesticulate
boolean
supports_language
boolean
supports_pitch
boolean
supports_speed
boolean
supports_volume
boolean
supports_speech_volume
boolean

Additional properties are allowed.

listen_feature
object
can_trigger_manual
boolean
can_trigger_hotword
boolean

Additional properties are allowed.

slam_feature
object
can_navigate
boolean
can_extend_map
boolean
can_manage_pois
boolean
can_manage_walls
boolean
has_docking_station
boolean

Additional properties are allowed.

voip_feature
object
supportsVoip
boolean

Additional properties are allowed.

face_recognition_feature
object
can_detect_known_faces
boolean
can_detect_number_of_faces
boolean

Additional properties are allowed.

Additional properties are allowed.

hardware
object
heads
array<object>
moveable
boolean
can_reset_to_default_position
boolean

Additional items are allowed.

parts
array<object>
name
string
moveable
boolean
can_reset_to_default_position
boolean

Additional items are allowed.

usb
array<object>
type
object
Enum: "USB_1" "USB_1_1" "USB_2" "USB_3" "USB_3_1" "USB_3_2" "USB_4"
name
string
ordinal
integer

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

composer
object
simple
object
dance
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

speech
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

animation
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

emotion
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

wait_duration
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

wait_sensor
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

wait_face
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

wait_voice
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

wait_qr_code
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

motion_head
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

motion_detection
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

multimedia
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

poi
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

mqtt
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

app_start
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

change_datasource
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

input
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

multimedia_stop
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

browser
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

gym
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

Additional properties are allowed.

advanced
object
math_formula
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

math_operations
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

if_else
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

variables
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

api
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

loop
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

start
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

stop
object
enabled
boolean
enabled_sources
array<object>
topicName
string
name
string
ordinal
integer

Additional items are allowed.

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

supported_file_types
array<object>
mime_type
string
type
string

Additional items are allowed.

connection_features
object
has_wifi
boolean
has_cable
boolean
has_hotspot
boolean
cable_features
object
adapter_names
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

wifi_features
object
can_configure
boolean
adapter_names
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

hotspot_features
object
can_activate
boolean
can_change_ssid
boolean
can_change_password
boolean
adapter_names
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

#161 AppVersion

Payload
object
name
string
version
string
buildDate
object
fastTime
number
cdate
object
cachedYear
integer
cachedFixedDateJan1
number
cachedFixedDateNextJan1
number

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

#162 BrokerStatus

Payload
object
connected
boolean
graceful
boolean

Additional properties are allowed.

#163 RenameRequest

Payload
object
path
string

Path of existing file

name
string

New name of file with extension

Additional properties are allowed.

#164 DeleteRequest

Payload
object
key
string
path
string

Additional properties are allowed.

#165 DeleteResponse

Payload
object
success
boolean
error
object
Enum: "FILE_NOT_EXIST" "NOT_PERMITTED" "FAILED"
name
string
ordinal
integer

Additional properties are allowed.

Additional properties are allowed.

#166 MonitoringEvent

Payload
object
id
string

Mandatory. A unique ID for the event

timestamp
number

Mandatory. The time at which the event occurred

type
string

Mandatory. The type of event this is, no dots allowed

source
string

Mandatory. What device produced this event, no dots allowed

value
string

Optional. A value relating to the event such as a temperature

data
object

Optional. Extra data related to the event

Additional properties are allowed.

unit
string

Optional. The type of unit the value is expressed in such as °C

alarms
array<object>

Optional. Alarms attached to this event

type
object

Mandatory. The type of alarm

Enum: "ItemOmission" "ItemCommission" "ServiceOmission" "ServiceCommission" "TransientServiceOmission" "TransientServiceCommission" "EarlyServiceOmission" "LateServiceCommission" "EarlyServiceStart" "LateServiceStart" "BoundedOmissionInterval" "UndetectableValueError" "BelowRange" "AboveRange" "BoundedValueChange" "StuckValue" "OutOfBounds" "OutOfOrder" "OutOfCalibration" "EarlyDelivery" "LateDelivery" "HighRate" "LowRate" "RateJitter" "EarlyService" "DelayedService" "SymmetricReplicationError" "AsymmetricApproximateValue" "AsymmetricExactValue" "AsymmetricItemOmission" "AsymmetricServiceOmission" "AsymmetricTiming" "ReadWriteRace" "WriteWriteRace" "Deadlock" "Starvation" "AuthorizationError" "AuthenticationError"
name
string
ordinal
integer

Additional properties are allowed.

severity
integer

Mandatory. How critical the alarm is

persist
boolean

Mandatory. If this is an ongoing alarm

timestamp
number

Mandatory. When the alarm initially started

Additional items are allowed.

Additional properties are allowed.

#167 Array<MonitoringEvent>

Payload
array<object>
id
string

Mandatory. A unique ID for the event

timestamp
number

Mandatory. The time at which the event occurred

type
string

Mandatory. The type of event this is, no dots allowed

source
string

Mandatory. What device produced this event, no dots allowed

value
string

Optional. A value relating to the event such as a temperature

data
object

Optional. Extra data related to the event

Additional properties are allowed.

unit
string

Optional. The type of unit the value is expressed in such as °C

alarms
array<object>

Optional. Alarms attached to this event

type
object

Mandatory. The type of alarm

Enum: "ItemOmission" "ItemCommission" "ServiceOmission" "ServiceCommission" "TransientServiceOmission" "TransientServiceCommission" "EarlyServiceOmission" "LateServiceCommission" "EarlyServiceStart" "LateServiceStart" "BoundedOmissionInterval" "UndetectableValueError" "BelowRange" "AboveRange" "BoundedValueChange" "StuckValue" "OutOfBounds" "OutOfOrder" "OutOfCalibration" "EarlyDelivery" "LateDelivery" "HighRate" "LowRate" "RateJitter" "EarlyService" "DelayedService" "SymmetricReplicationError" "AsymmetricApproximateValue" "AsymmetricExactValue" "AsymmetricItemOmission" "AsymmetricServiceOmission" "AsymmetricTiming" "ReadWriteRace" "WriteWriteRace" "Deadlock" "Starvation" "AuthorizationError" "AuthenticationError"
name
string
ordinal
integer

Additional properties are allowed.

severity
integer

Mandatory. How critical the alarm is

persist
boolean

Mandatory. If this is an ongoing alarm

timestamp
number

Mandatory. When the alarm initially started

Additional items are allowed.

Additional items are allowed.

#168 AddMonitoringEventRequest

Payload
object
key
string
event
object
timestamp
number

Mandatory. The time at which the event occurred

type
string

Mandatory. The type of event this is, no dots allowed

source
string

Mandatory. What device produced this event, no dots allowed

value
string

Optional. A value relating to the event such as a temperature

data
object

Optional. Extra data related to the event

Additional properties are allowed.

unit
string

Optional. The type of unit the value is expressed in such as °C

alarms
array<object>

Optional. Alarms attached to this event

type
object

Mandatory. The type of alarm

Enum: "ItemOmission" "ItemCommission" "ServiceOmission" "ServiceCommission" "TransientServiceOmission" "TransientServiceCommission" "EarlyServiceOmission" "LateServiceCommission" "EarlyServiceStart" "LateServiceStart" "BoundedOmissionInterval" "UndetectableValueError" "BelowRange" "AboveRange" "BoundedValueChange" "StuckValue" "OutOfBounds" "OutOfOrder" "OutOfCalibration" "EarlyDelivery" "LateDelivery" "HighRate" "LowRate" "RateJitter" "EarlyService" "DelayedService" "SymmetricReplicationError" "AsymmetricApproximateValue" "AsymmetricExactValue" "AsymmetricItemOmission" "AsymmetricServiceOmission" "AsymmetricTiming" "ReadWriteRace" "WriteWriteRace" "Deadlock" "Starvation" "AuthorizationError" "AuthenticationError"
name
string
ordinal
integer

Additional properties are allowed.

severity
integer

Mandatory. How critical the alarm is

persist
boolean

Mandatory. If this is an ongoing alarm

timestamp
number

Mandatory. When the alarm initially started

Additional items are allowed.

Additional properties are allowed.

Additional properties are allowed.

#169 MonitoringResponse

Payload
object
key
string

The key used by the add request

success
boolean

Did the operation succeed

id
string

The ID of the new event

Additional properties are allowed.

#170 TimeInfo

Payload
object
accurate
boolean

Additional properties are allowed.

#171 SimpleScheduler

Payload
object
id
string
name
string

Additional properties are allowed.

#172 Array<SimpleScheduler>

Payload
array<object>
id
string
name
string

Additional items are allowed.

#173 GetTranslationsRequest

Payload
object
key
string
category
string

Optional when using the dot notation in the translations keys.

language
string

ISO 639-1 language code, Eg: 'en' or 'en-US'

translation_keys
array<string>

Optional if the category is set. In that case it will return all translations for that category.

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

#174 GetTranslationsResponse

Payload
object
translations
object

Additional properties are allowed.

Additional properties are allowed.

#175 AddTranslationsRequest

Payload
object
key
string
category
string
language
string

ISO 639-1 language code, Eg: 'en' or 'en-US'

file
string

Optional. Use either translations or file. The file location should be a path accessible for the RAIL. The content should be a json object with key-value pairs. Dots (.) are not allowed in the keys and will be replaced with underscores (_)"

translations
object

Optional. Use either translations or file Dots (.) are not allowed in the keys and will be replaced with underscores (_)

Additional properties are allowed.

Additional properties are allowed.

#176 UpdateTranslationsRequest

Payload
object
key
string
category
string
language
string

ISO 639-1 language code, Eg: 'en' or 'en-US'

file
string

Optional. Use either translations or file. The file location should be a path accessible for the RAIL. The content should be a json object with key-value pairs.

translations
object

Optional. Use either translations or file

Additional properties are allowed.

Additional properties are allowed.

#177 TranslationsChangedEvent

Payload
object
category
string
language
string

ISO 639-1 language code, Eg: 'en' or 'en-US'

Additional properties are allowed.

#178 ResetTranslationsRequest

Payload
object
key
string
category
string
language
string

ISO 639-1 language code, Eg: 'en' or 'en-US'

Additional properties are allowed.

#179 GlobalVariables

Payload
object
variables
array<object>

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

name
string
value
string
id
string
state
string

Additional items are allowed.

status
boolean

Will be present when status is false (error message)

message
string

Additional properties are allowed.

#180 Array<AccessPoint>

Payload
array<object>
ssid
string
bssid
string
channel
string
bandwidth
string
auth
string

type off network, "0" for open networks

is_5g
string
rssi
string
>= 0 <= 100

Network strength (0-100)

save
string
>= 0 <= 2

"0" not saved, "1" saved, "2" currently connected

password
string

Additional items are allowed.

#181 AccessPoint

Payload
object
ssid
string
bssid
string
channel
string
bandwidth
string
auth
string

type off network, "0" for open networks

is_5g
string
rssi
string
>= 0 <= 100

Network strength (0-100)

save
string
>= 0 <= 2

"0" not saved, "1" saved, "2" currently connected

password
string

Additional properties are allowed.

#182 WispStatus

Payload
object
app_enable
string
auth
string

type off network, "0" for open networks

auto
string
bandwidth
string
bssid
string
channel
string
dns0
string
dns1
string
enable
string
encrypt
string
gw
string

The gateway

internet
string

0 - internet is available, anything else: no internet available

ip
string
is_wan_priority
string
key
string
mask
string
rssi
string
>= 0 <= 100

Network strength (0-100)

run_time
string
ssid
string
status
string
>= 0 <= 3

0 - disconnected, 1 - connected, 3 - connecting

Additional properties are allowed.

#183 ForgetResponse

Payload
object
bssid
string
success
boolean

Additional properties are allowed.

#184 PostFieldsHotspot

Payload
object
network_mode
string
port_id
string
ap_id
string
AP_SSID
string
SSID_broadcast
string
channel_band
string
channel_num
string
channel_width
string
need_reboot
string
radio_criterion
string
region
string
waln_partition
string
wire_enable
string
wire_mac
string

Additional properties are allowed.