Kiosk

API for communication with ZBOS by Zora Robotics.

Channels

zbos/kiosk/resume/event

SUB event: Kiosk is active

Fired when kiosk is active after being moved to the background

Channel tags

  • Kiosk

EmptyMessage

Empty message

zbos/kiosk/view/change/event

SUB event: Kiosk view has changed

Fired when the kiosk view has changed

Channel tags

  • Kiosk

KioskViewChangedEvent
Payload

Name

Type

Description

Accepted values

view

string

* kiosk * settings * wifi * hotspot * quiet_hours * voip_errors * reset * language * account_link * local_account_link * activate_hotword * action_button * website * image * video * input * print * text_overlay * loading * subtitle_overlay * screensaver * slam_map
Examples of payload
{
  "view": "kiosk"
}

zbos/kiosk/ready/get

SUB Get kiosk ready

see zbos/kiosk/ready/get/response/\{key} for response

Channel tags

  • Kiosk

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

zbos/kiosk/ready/get/response/\{key}

SUB response: Kiosk ready

Channel tags

  • Kiosk

KioskReadyPayload
Payload

Name

Type

Description

Accepted values

is_ready

boolean

Any
Examples of payload
{
  "ready": true,
  "is_ready": true
}

zbos/kiosk/ready/event

SUB event: Kiosk ready

Channel tags

  • Kiosk

KioskReadyPayload
Payload

Name

Type

Description

Accepted values

is_ready

boolean

Any
Examples of payload
{
  "ready": true,
  "is_ready": true
}

zbos/remote/kiosk/apps/home

PUB Open home screen

Channel tags

  • Kiosk

EmptyMessage

Empty message

zbos/remote/kiosk/apps/start

PUB Start application remotely on Kiosk

Channel tags

  • Kiosk

ApplicationStartRequest
Payload

Name

Type

Description

Accepted values

appName

string

Any

extras

object

Any
Examples of payload
{}

zbos/remote/kiosk/apps/get

PUB Get installed applications on Kiosk

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

Channel tags

  • Kiosk

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

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

SUB response: Get installed applications on Kiosk

Channel tags

  • Kiosk

Array<SimpleApplicationNodeDto>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. app_name

string

Any

Message Payload. package_name

string

Any

Message Payload. image_base64

string

Any
Examples of payload
{
  "app_name": "string",
  "package_name": "string",
  "image_base64": "string"
}

zbos/remote/kiosk/apps/all/get

PUB 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

Channel tags

  • Kiosk

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

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

SUB response: Get installed applications on Kiosk

Channel tags

  • Kiosk

Array<SimpleApplicationNodeDto>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. app_name

string

Any

Message Payload. package_name

string

Any

Message Payload. image_base64

string

Any
Examples of payload
{
  "app_name": "string",
  "package_name": "string",
  "image_base64": "string"
}

zbos/remote/kiosk/input/show

PUB Show input prompt

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

Channel tags

  • Kiosk

ShowInputRequest
Payload

Name

Type

Description

Accepted values

id

string

Any

question

string

Any

textType

string

Any

confirmText

string

Any

executionId

string

Any
Examples of payload
{
  "question": "string",
  "textType": "string",
  "confirmText": "string"
}

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

SUB response: Show input prompt

Channel tags

  • Kiosk

InputResponse
Payload

Name

Type

Description

Accepted values

input

string

Any
Examples of payload
{
  "input": "input"
}

zbos/remote/kiosk/print/show

PUB Show print dialog

see zbos/remote/kiosk/print/show/response/\{key} for response

Channel tags

  • Kiosk

PrintOptions
Payload

Name

Type

Description

Accepted values

key

string

Any

file_path

string

Required. The path to a PDF file to print.

Any

media_size

string

Optional. The format of the paper to be printed, defaults to 'Letter'

Any

printer_name

string

Optional, only used when auto print is enabled. The name of or part of the name of a printer, defaults to first available printer

Any

auto_print

boolean

Optional. Whether to use the accessibility service to automatically print to the desired printer without user input

Any

execution_id

string

Any
Examples of payload
{
  "key": "some_key",
  "file_path": "/sdcard/zbos_media_library/dummy.pdf",
  "media_size": "ISO_A4",
  "printer_name": "HP LaserJet Pro",
  "auto_print": true
}

zbos/remote/kiosk/print/show/response/\{key}

SUB response: Show print dialog

Channel tags

  • Kiosk

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/remote/kiosk/text/overlay/show

PUB Show text overlay

see zbos/remote/kiosk/text/overlay/show/response/\{key} for response

Channel tags

  • Kiosk

TextOverlayOptions
Payload

Name

Type

Description

Accepted values

key

string

Any

text

string

Any

textColor

string

Any

backgroundColor

string

Any

executionId

string

Any
Examples of payload
{
  "key": "some_key",
  "text": "Hello George, nice to meet you!",
  "textColor": "#00FF00",
  "backgroundColor": "#FF0000",
  "executionId": "execution_id_1"
}

zbos/remote/kiosk/text/overlay/show/response/\{key}

SUB response: Show text overlay

Channel tags

  • Kiosk

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/remote/kiosk/text/overlay/hide

PUB Hide text overlay

see zbos/remote/kiosk/text/overlay/hide/response/\{key} for response

Channel tags

  • Kiosk

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

zbos/remote/kiosk/text/overlay/hide/response/\{key}

SUB response: Hide text overlay

Channel tags

  • Kiosk

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/remote/kiosk/slam/map/show

PUB Show SLAM map

see zbos/remote/kiosk/slam/map/show/response/\{key} for response

Channel tags

  • Kiosk

SlamMapOptions
Payload

Name

Type

Description

Accepted values

key

string

Any

executionId

string

Any

showPosition

boolean

Optional. Whether or not to show the current position, default true.

Any
Examples of payload
{
  "key": "some_key",
  "executionId": "execution_id_1",
  "showPosition": true
}

zbos/remote/kiosk/slam/map/show/response/\{key}

SUB response: Show SLAM map

Channel tags

  • Kiosk

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/remote/kiosk/slam/map/hide

PUB Hide SLAM map

see zbos/remote/kiosk/slam/map/hide/response/\{key} for response

Channel tags

  • Kiosk

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

zbos/remote/kiosk/slam/map/hide/response/\{key}

SUB response: Hide SLAM map

Channel tags

  • Kiosk

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/remote/kiosk/microphone/show

PUB Show microphone in composition

Channel tags

  • Kiosk

VoiceInfo
Payload

Name

Type

Description

Accepted values

showMic

boolean

Any
Examples of payload
{
  "showMic": true
}

zbos/remote/kiosk/multimedia/image/show

PUB Show image

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

Channel tags

  • Kiosk

Image
Payload

Name

Type

Description

Accepted values

id

string

Any

path

string

Any

extension

string

Any

fileName

string

Any

style

object

Any

style. backgroundColor

string

Any

style. scaleType

string

* MATRIX * FIT_XY * FIT_START * FIT_CENTER * FIT_END * CENTER * CENTER_CROP * CENTER_INSIDE

url

string

Any

executionId

string

Any

targetDisplayId

string

Any

cloudInfo

object

Any

cloudInfo. fileId

string

Any

cloudInfo. token

string

Any
Examples of payload
{
  "id": "string",
  "style": {
    "backgroundColor": "string",
    "scaleType": "FIT_CENTER"
  },
  "url": "string",
  "targetDisplayId": "main_display"
}

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

SUB response: Show image

Channel tags

  • Kiosk

Image
Payload

Name

Type

Description

Accepted values

id

string

Any

path

string

Any

extension

string

Any

fileName

string

Any

style

object

Any

style. backgroundColor

string

Any

style. scaleType

string

* MATRIX * FIT_XY * FIT_START * FIT_CENTER * FIT_END * CENTER * CENTER_CROP * CENTER_INSIDE

url

string

Any

executionId

string

Any

targetDisplayId

string

Any

cloudInfo

object

Any

cloudInfo. fileId

string

Any

cloudInfo. token

string

Any
Examples of payload
{
  "id": "string",
  "style": {
    "backgroundColor": "string",
    "scaleType": "CENTER_INSIDE"
  },
  "url": "string",
  "targetDisplayId": "main_display"
}

zbos/remote/kiosk/multimedia/image/stop

PUB Stop showing image

Channel tags

  • Kiosk

EmptyMessage

Empty message

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

SUB event: Image ended

Channel tags

  • Kiosk

EmptyMessage

Empty message

zbos/remote/kiosk/multimedia/video/show

PUB Show video

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

Channel tags

  • Kiosk

Video
Payload

Name

Type

Description

Accepted values

id

string

Any

url

string

Any

repeat

boolean

Any

audioUrl

string

Any

videoOnly

boolean

Any

showControls

boolean

Any

executionId

string

Any

targetDisplayId

string

Any

cloudInfo

object

Any

cloudInfo. fileId

string

Any

cloudInfo. token

string

Any
Examples of payload
{
  "id": "string",
  "url": "string",
  "repeat": true,
  "audioUrl": "string",
  "videoOnly": false,
  "showControls": true,
  "targetDisplayId": "main_display",
  "remoteVideo": false
}

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

SUB response: Show video

Channel tags

  • Kiosk

Video
Payload

Name

Type

Description

Accepted values

id

string

Any

url

string

Any

repeat

boolean

Any

audioUrl

string

Any

videoOnly

boolean

Any

showControls

boolean

Any

executionId

string

Any

targetDisplayId

string

Any

cloudInfo

object

Any

cloudInfo. fileId

string

Any

cloudInfo. token

string

Any
Examples of payload
{
  "id": "string",
  "url": "string",
  "repeat": true,
  "audioUrl": "string",
  "videoOnly": false,
  "showControls": true,
  "targetDisplayId": "main_display",
  "remoteVideo": false
}

zbos/remote/kiosk/multimedia/video/stop

PUB Stop video

Channel tags

  • Kiosk

EmptyMessage

Empty message

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

SUB event: Video ended

Channel tags

  • Kiosk

EmptyMessage

Empty message

zbos/remote/kiosk/multimedia/page/show

PUB Show page in kiosk

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

Channel tags

  • Kiosk

OpenBrowserRequest
Payload

Name

Type

Description

Accepted values

id

string

Any

url

string

Any

executionId

string

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

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

SUB response: Show page in kiosk

Channel tags

  • Kiosk

OpenBrowserRequest
Payload

Name

Type

Description

Accepted values

id

string

Any

url

string

Any

executionId

string

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

zbos/remote/kiosk/action/start

PUB Start action

Channel tags

  • Kiosk

Action
Payload

Name

Type

Description

Accepted values

Message Payload

object

Any
Example of payload (generated)
{}

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

PUB Get current lockstate

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

Channel tags

  • Kiosk

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

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

SUB response: Get current lockstate

Channel tags

  • Kiosk

LockStatus
Payload

Name

Type

Description

Accepted values

isLocked

boolean

Any

isPincodeSet

boolean

Any
Examples of payload
{
  "pincodeSet": false,
  "locked": true
}

zbos/remote/kiosk/settings/unlock

PUB Unlock settings page

Channel tags

  • Kiosk

EmptyMessage

Empty message

zbos/remote/kiosk/settings/lock

PUB Lock settings page

Channel tags

  • Kiosk

EmptyMessage

Empty message

zbos/remote/kiosk/settings/lock/event

SUB response: Lock settings page

Channel tags

  • Kiosk

LockResponse
Payload

Name

Type

Description

Accepted values

response

string

Any

success

boolean

Any
Examples of payload
{}

zbos/remote/kiosk/settings/unlock/event

SUB response: Unlock settings page

Channel tags

  • Kiosk

LockResponse
Payload

Name

Type

Description

Accepted values

response

string

Any

success

boolean

Any
Examples of payload
{}

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

SUB response: Change current pincode

Channel tags

  • Kiosk

LockResponse
Payload

Name

Type

Description

Accepted values

response

string

Any

success

boolean

Any
Examples of payload
{}

zbos/remote/kiosk/settings/pincode/remove

PUB Remove current pincode

Channel tags

  • Kiosk

EmptyMessage

Empty message

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

SUB response: Remove current pincode

Channel tags

  • Kiosk

LockResponse
Payload

Name

Type

Description

Accepted values

response

string

Any

success

boolean

Any
Examples of payload
{}

zbos/kiosk/datasource/get/all

PUB Get all datasources

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

Channel tags

  • Kiosk

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

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

SUB response: Get all datasources

Channel tags

  • Kiosk

Array<SimpleDataSource>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. id

string

Any

Message Payload. name

string

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

zbos/kiosk/datasource/get

PUB Get specific datasources

see zbos/kiosk/datasource/get/response/\{key} for response

Channel tags

  • Kiosk

SimpleDataSource
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

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

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

SUB response: Get specific datasources

Channel tags

  • Kiosk

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Example of payload (generated)
"string"

zbos/kiosk/datasource/current/get

PUB Get active datasource ID

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

Channel tags

  • Kiosk

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

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

SUB response: Get active datasource ID

Channel tags

  • Kiosk

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Example of payload (generated)
"string"

zbos/kiosk/datasource/set

PUB Set current Kiosk datasources

Channel tags

  • Kiosk

ChangeDatasourceRequest
Payload

Name

Type

Description

Accepted values

id

string

ID of the datasource to change to

Any

initial_element_id

string

Element to open or execute upon changing the datasource

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

zbos/kiosk/datasource/save

PUB Save or add a datasource

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

Channel tags

  • Kiosk

SimpleDataSource
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

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

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

SUB response: Get active datasources

Channel tags

  • Kiosk

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Example of payload (generated)
"string"

zbos/kiosk/datasource/delete

PUB Delete a datasource

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

Channel tags

  • Kiosk

SimpleDataSource
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

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

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

SUB response: Delete a datasource

Channel tags

  • Kiosk

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Example of payload (generated)
"string"

zbos/kiosk/datasource/layout/info/get

PUB Get datasource layout info

see zbos/kiosk/datasource/layout/info/get/response/\{key} for response

Channel tags

  • Kiosk

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

zbos/kiosk/datasource/layout/info/get/response/\{key}

SUB response: Get datasource layout info

Channel tags

  • Kiosk

LayoutInfo
Payload

Name

Type

Description

Accepted values

grid_info

object

Any

grid_info. default_columns

integer

Any

grid_info. default_rows

integer

Any

grid_info. max_columns

integer

Any

grid_info. max_rows

integer

Any
Examples of payload
{
  "grid_info": {
    "default_columns": 4,
    "default_rows": 2,
    "max_columns": 6,
    "max_rows": 4
  }
}