Cloud

API for communication with ZBOS cloud by Zora Robotics.

Channels

push/\{serial}/alarm/set

PUB Request cloud to trigger an alarm

RaiseAlarmRequest
Payload

Name

Type

Description

Accepted values

alarmServiceProvider

string

Any

key

string

Any

metadata

object

Any
Example of payload (generated)
{
  "alarmServiceProvider": "string",
  "key": "string",
  "metadata": {}
}

zbos/\{serial}/alarm/set/response/\{key}

SUB Response to an alarm trigger

RaiseAlarmResponse
Payload

Name

Type

Description

Accepted values

id

string

Any
Example of payload (generated)
{
  "id": "string"
}

zbos/\{serial}/cloud/webhook/event

SUB Event for the robot when a webhook has been triggered

WebhookTriggeredEvent
Payload

Name

Type

Description

Accepted values

arguments

object

Any

data

string

Any

id

string

Any
Example of payload (generated)
{
  "arguments": {
    "property1": "string",
    "property2": "string"
  },
  "data": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

push/\{serial}/cloud/govirtual/login

PUB perform a user login (this links the robot to the user)

GoVirtualLoginRequest
Payload

Name

Type

Description

Accepted values

jwt

string

Any

key

string

Any
Example of payload (generated)
{
  "jwt": "string",
  "key": "string"
}

zbos/\{serial}/cloud/govirtual/login/response/\{key}

SUB result of logging in

BaseResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "success": true
}

push/\{serial}/cloud/govirtual/rooms/get

PUB get list of rooms

BaseListRequest
Payload

Name

Type

Description

Accepted values

filter

string

Any

key

string

Any

limit

integer

Any

offset

integer

Any

search

string

Any
Example of payload (generated)
{
  "filter": "",
  "key": "string",
  "limit": 0,
  "offset": 0,
  "search": ""
}

zbos/\{serial}/cloud/govirtual/rooms/get/response/\{key}

SUB a list with rooms

RoomListResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

limit

integer

Any

numResults

integer

Any

offset

integer

Any

rooms

array (object)

Any

rooms. id

string

Any

rooms. name

string

Any

rooms. description

string

Any

rooms. createdTimestamp

number

Any

rooms. maxSize

integer

Any

rooms. currentSize

integer

Any

rooms. startingEnvironment

string

Any

rooms. matrixId

string

Any

rooms. environments

array (object)

Any

rooms.environments. id

string

Any

rooms.environments. name

string

Any

rooms.environments. modifiedTimestamp

number

Any

rooms.environments. spawnPoints

object

Any

rooms.environments.spawnPoints. name

string

Any

rooms.environments.spawnPoints. x

number

Any

rooms.environments.spawnPoints. y

number

Any

rooms.environments.spawnPoints. z

number

Any

rooms.environments.spawnPoints. r

number

Any

rooms.environments. defaultSpawnPoint

string

Any

rooms.environments. pointsOfInterest

object

Any

rooms.environments.pointsOfInterest. name

string

Any

rooms.environments.pointsOfInterest. x

number

Any

rooms.environments.pointsOfInterest. y

number

Any

rooms.environments.pointsOfInterest. z

number

Any

rooms.environments.pointsOfInterest. r

number

Any

rooms.environments. animations

array (object)

Any

rooms.environments.animations. id

string

Any

rooms.environments.animations. name

string

Any

rooms.environments. metadata

object

Any

rooms. local

boolean

Any

rooms. multiplayer

boolean

Any

rooms. metadata

object

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "limit": 0,
  "numResults": 0,
  "offset": 0,
  "rooms": [],
  "success": true
}

push/\{serial}/cloud/govirtual/room/get

PUB get the current room of the robot

BaseRequest
Payload

Name

Type

Description

Accepted values

key

string

Any
Example of payload (generated)
{
  "key": "string"
}

zbos/\{serial}/cloud/govirtual/room/get/response/\{key}

SUB room that the robot is a member of

CurrentRoomResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

membership

object

Any

membership. id

string

Any

membership. userId

string

Any

membership. userName

string

Any

membership. userPicture

string

Any

membership. robotSerial

string

Any

membership. robotName

string

Any

membership. model

object

Any

membership.model. id

string

Any

membership.model. name

string

Any

membership.model. modelId

string

Any

membership.model. environmentId

string

Any

membership.model. state

object

Any

room

object

Any

room. id

string

Any

room. name

string

Any

room. description

string

Any

room. createdTimestamp

number

Any

room. maxSize

integer

Any

room. currentSize

integer

Any

room. startingEnvironment

string

Any

room. matrixId

string

Any

room. environments

array (object)

Any

room.environments. id

string

Any

room.environments. name

string

Any

room.environments. modifiedTimestamp

number

Any

room.environments. spawnPoints

object

Any

room.environments.spawnPoints. name

string

Any

room.environments.spawnPoints. x

number

Any

room.environments.spawnPoints. y

number

Any

room.environments.spawnPoints. z

number

Any

room.environments.spawnPoints. r

number

Any

room.environments. defaultSpawnPoint

string

Any

room.environments. pointsOfInterest

object

Any

room.environments.pointsOfInterest. name

string

Any

room.environments.pointsOfInterest. x

number

Any

room.environments.pointsOfInterest. y

number

Any

room.environments.pointsOfInterest. z

number

Any

room.environments.pointsOfInterest. r

number

Any

room.environments. animations

array (object)

Any

room.environments.animations. id

string

Any

room.environments.animations. name

string

Any

room.environments. metadata

object

Any

room. local

boolean

Any

room. multiplayer

boolean

Any

room. metadata

object

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "membership": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
    "userName": "string",
    "userPicture": "string",
    "robotSerial": "string",
    "robotName": "",
    "model": {
      "id": "string",
      "name": "",
      "modelId": "string",
      "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
      "state": {}
    }
  },
  "room": {
    "id": "string",
    "name": "string",
    "description": "string",
    "createdTimestamp": 0,
    "maxSize": 0,
    "currentSize": 0,
    "startingEnvironment": "string",
    "matrixId": "string",
    "environments": [],
    "local": true,
    "multiplayer": true,
    "metadata": {}
  },
  "success": true
}

push/\{serial}/cloud/govirtual/rooms/\{room}/get

PUB get a room by id

BaseRequest
Payload

Name

Type

Description

Accepted values

key

string

Any
Example of payload (generated)
{
  "key": "string"
}

zbos/\{serial}/cloud/govirtual/rooms/\{room}/get/response/\{key}

SUB room data

GetRoomResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

room

object

Any

room. id

string

Any

room. name

string

Any

room. description

string

Any

room. createdTimestamp

number

Any

room. maxSize

integer

Any

room. currentSize

integer

Any

room. startingEnvironment

string

Any

room. matrixId

string

Any

room. environments

array (object)

Any

room.environments. id

string

Any

room.environments. name

string

Any

room.environments. modifiedTimestamp

number

Any

room.environments. spawnPoints

object

Any

room.environments.spawnPoints. name

string

Any

room.environments.spawnPoints. x

number

Any

room.environments.spawnPoints. y

number

Any

room.environments.spawnPoints. z

number

Any

room.environments.spawnPoints. r

number

Any

room.environments. defaultSpawnPoint

string

Any

room.environments. pointsOfInterest

object

Any

room.environments.pointsOfInterest. name

string

Any

room.environments.pointsOfInterest. x

number

Any

room.environments.pointsOfInterest. y

number

Any

room.environments.pointsOfInterest. z

number

Any

room.environments.pointsOfInterest. r

number

Any

room.environments. animations

array (object)

Any

room.environments.animations. id

string

Any

room.environments.animations. name

string

Any

room.environments. metadata

object

Any

room. local

boolean

Any

room. multiplayer

boolean

Any

room. metadata

object

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "room": {
    "id": "string",
    "name": "string",
    "description": "string",
    "createdTimestamp": 0,
    "maxSize": 0,
    "currentSize": 0,
    "startingEnvironment": "string",
    "matrixId": "string",
    "environments": [],
    "local": true,
    "multiplayer": true,
    "metadata": {}
  },
  "success": true
}

push/\{serial}/cloud/govirtual/rooms/\{room}/join

PUB join a room

JoinRoomRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

model

object

Any

model. id

string

Any

model. name

string

Any

model. modelId

string

Any

model. environmentId

string

Any

model. state

object

Any

robotName

string

Any
Example of payload (generated)
{
  "key": "string",
  "model": {
    "id": "string",
    "name": "",
    "modelId": "string",
    "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
    "state": {}
  },
  "robotName": ""
}

zbos/\{serial}/cloud/govirtual/rooms/\{room}/join/response/\{key}

SUB result of joining a room

JoinRoomResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

membership

object

Any

membership. id

string

Any

membership. userId

string

Any

membership. userName

string

Any

membership. userPicture

string

Any

membership. robotSerial

string

Any

membership. robotName

string

Any

membership. model

object

Any

membership.model. id

string

Any

membership.model. name

string

Any

membership.model. modelId

string

Any

membership.model. environmentId

string

Any

membership.model. state

object

Any

room

object

Any

room. id

string

Any

room. name

string

Any

room. description

string

Any

room. createdTimestamp

number

Any

room. maxSize

integer

Any

room. currentSize

integer

Any

room. startingEnvironment

string

Any

room. matrixId

string

Any

room. environments

array (object)

Any

room.environments. id

string

Any

room.environments. name

string

Any

room.environments. modifiedTimestamp

number

Any

room.environments. spawnPoints

object

Any

room.environments.spawnPoints. name

string

Any

room.environments.spawnPoints. x

number

Any

room.environments.spawnPoints. y

number

Any

room.environments.spawnPoints. z

number

Any

room.environments.spawnPoints. r

number

Any

room.environments. defaultSpawnPoint

string

Any

room.environments. pointsOfInterest

object

Any

room.environments.pointsOfInterest. name

string

Any

room.environments.pointsOfInterest. x

number

Any

room.environments.pointsOfInterest. y

number

Any

room.environments.pointsOfInterest. z

number

Any

room.environments.pointsOfInterest. r

number

Any

room.environments. animations

array (object)

Any

room.environments.animations. id

string

Any

room.environments.animations. name

string

Any

room.environments. metadata

object

Any

room. local

boolean

Any

room. multiplayer

boolean

Any

room. metadata

object

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "membership": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
    "userName": "string",
    "userPicture": "string",
    "robotSerial": "string",
    "robotName": "",
    "model": {
      "id": "string",
      "name": "",
      "modelId": "string",
      "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
      "state": {}
    }
  },
  "room": {
    "id": "string",
    "name": "string",
    "description": "string",
    "createdTimestamp": 0,
    "maxSize": 0,
    "currentSize": 0,
    "startingEnvironment": "string",
    "matrixId": "string",
    "environments": [],
    "local": true,
    "multiplayer": true,
    "metadata": {}
  },
  "success": true
}

push/\{serial}/cloud/govirtual/rooms/\{room}/members/get

PUB get members of the specified room

BaseListRequest
Payload

Name

Type

Description

Accepted values

filter

string

Any

key

string

Any

limit

integer

Any

offset

integer

Any

search

string

Any
Example of payload (generated)
{
  "filter": "",
  "key": "string",
  "limit": 0,
  "offset": 0,
  "search": ""
}

zbos/\{serial}/cloud/govirtual/rooms/\{room}/members/get/response/\{key}

SUB a list with members of the room

RoomMemberListResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

limit

integer

Any

members

array (object)

Any

members. id

string

Any

members. userId

string

Any

members. userName

string

Any

members. userPicture

string

Any

members. robotSerial

string

Any

members. robotName

string

Any

members. model

object

Any

members.model. id

string

Any

members.model. name

string

Any

members.model. modelId

string

Any

members.model. environmentId

string

Any

members.model. state

object

Any

numResults

integer

Any

offset

integer

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "limit": 0,
  "members": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
      "userName": "string",
      "userPicture": "string",
      "robotSerial": "string",
      "robotName": "",
      "model": {
        "id": "string",
        "name": "",
        "modelId": "string",
        "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
        "state": {}
      }
    }
  ],
  "numResults": 0,
  "offset": 0,
  "success": true
}

push/\{serial}/cloud/govirtual/rooms/\{room}/leave

PUB leave a room

BaseRequest
Payload

Name

Type

Description

Accepted values

key

string

Any
Example of payload (generated)
{
  "key": "string"
}

zbos/\{serial}/cloud/govirtual/rooms/\{room}/leave/response/\{key}

SUB leave a previously joined room

BaseResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "success": true
}

push/\{serial}/cloud/govirtual/rooms/\{room}/animation/start

PUB robot starts an animation

StartAnimationRequest
Payload

Name

Type

Description

Accepted values

data

object

Any

modelId

string

Any
Example of payload (generated)
{
  "data": {},
  "modelId": "string"
}

push/\{serial}/cloud/govirtual/rooms/\{room}/animation/stop

PUB robot stops the animation

StopAnimationRequest
Payload

Name

Type

Description

Accepted values

data

object

Any

modelId

string

Any
Example of payload (generated)
{
  "data": {},
  "modelId": "string"
}

push/\{serial}/cloud/govirtual/rooms/\{room}/position/set

PUB robot sends its place in the world (xyz + rotation)

SetPositionRequest
Payload

Name

Type

Description

Accepted values

modelId

string

Any

state

object

Any
Example of payload (generated)
{
  "modelId": "string",
  "state": {}
}

push/\{serial}/cloud/govirtual/rooms/\{room}/position/action/set

PUB robot sends its progress on position events

SetPositionActionRequest
Payload

Name

Type

Description

Accepted values

action

object

Any

modelId

string

Any
Example of payload (generated)
{
  "action": {},
  "modelId": "string"
}

push/\{serial}/cloud/govirtual/rooms/\{room}/objects/get

PUB get list with info about all world objects in the room

BaseListRequest
Payload

Name

Type

Description

Accepted values

filter

string

Any

key

string

Any

limit

integer

Any

offset

integer

Any

search

string

Any
Example of payload (generated)
{
  "filter": "",
  "key": "string",
  "limit": 0,
  "offset": 0,
  "search": ""
}

zbos/\{serial}/cloud/govirtual/rooms/\{room}/objects/get/response/\{key}

SUB list with world objects in the room

WorldObjectListResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

limit

integer

Any

numResults

integer

Any

objects

array (object)

Any

objects. id

string

Any

objects. worldObjectId

string

Any

objects. environmentId

string

Any

objects. name

string

Any

objects. state

string

Any

objects. disabled

boolean

Any

objects. supportsMedia

boolean

Any

objects. switchesEnvironmentTo

object

Any

objects.switchesEnvironmentTo. id

string

Any

objects.switchesEnvironmentTo. spawnPoint

object

Any

objects.switchesEnvironmentTo.spawnPoint. name

string

Any

objects.switchesEnvironmentTo.spawnPoint. x

number

Any

objects.switchesEnvironmentTo.spawnPoint. y

number

Any

objects.switchesEnvironmentTo.spawnPoint. z

number

Any

objects.switchesEnvironmentTo.spawnPoint. r

number

Any

objects. concurrentUsageLimit

integer

Any

objects. lastChangedTimestamp

number

Any

objects. lastChangedBy

string

Any

objects. mediaFileId

string

Any

objects. mediaFileMimetype

string

Any

objects. inUseBy

array (string)

Any

objects. clientData

object

Any

objects. animations

array (object)

Any

objects.animations. id

string

Any

objects.animations. name

string

Any

objects. metadata

object

Any

objects. domoticsType

string

Any

objects. hasRenderFiles

boolean

Any

objects. position

object

Any

objects.position. x

number

Any

objects.position. y

number

Any

objects.position. z

number

Any

objects. rotation

object

Any

objects.rotation. x

number

Any

objects.rotation. y

number

Any

objects.rotation. z

number

Any

objects. scale

number

Any

objects. type

string

Any

objects. productIds

array (string)

Any

objects. actions

array (object)

Any

objects.actions. id

string

Any

objects.actions. type

string

Any

objects.actions. name

string

Any

objects.actions. data

object

Any

offset

integer

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "limit": 0,
  "numResults": 0,
  "objects": [
    {
      "id": "string",
      "worldObjectId": "ec563b42-9df2-460b-95b9-056eeaf737ee",
      "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
      "name": "string",
      "state": "string",
      "disabled": false,
      "supportsMedia": false,
      "switchesEnvironmentTo": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "spawnPoint": {
          "name": "string",
          "x": 0,
          "y": 0,
          "z": 0,
          "r": 0
        }
      },
      "concurrentUsageLimit": 0,
      "lastChangedTimestamp": 0,
      "lastChangedBy": "string",
      "mediaFileId": null,
      "mediaFileMimetype": null,
      "inUseBy": [],
      "clientData": {},
      "animations": [],
      "metadata": {},
      "domoticsType": null,
      "hasRenderFiles": false,
      "position": {
        "x": 0,
        "y": 0,
        "z": 0
      },
      "rotation": {
        "x": 0,
        "y": 0,
        "z": 0
      },
      "scale": 0,
      "type": null,
      "productIds": [],
      "actions": []
    }
  ],
  "offset": 0,
  "success": true
}

push/\{serial}/cloud/govirtual/rooms/\{room}/objects/\{object}/get

PUB get info about a world object

BaseRequest
Payload

Name

Type

Description

Accepted values

key

string

Any
Example of payload (generated)
{
  "key": "string"
}

zbos/\{serial}/cloud/govirtual/rooms/\{room}/objects/\{object}/get/response/\{key}

SUB info about a world object

GetWorldObjectResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

object

object

Any

object. id

string

Any

object. worldObjectId

string

Any

object. environmentId

string

Any

object. name

string

Any

object. state

string

Any

object. disabled

boolean

Any

object. supportsMedia

boolean

Any

object. switchesEnvironmentTo

object

Any

object.switchesEnvironmentTo. id

string

Any

object.switchesEnvironmentTo. spawnPoint

object

Any

object.switchesEnvironmentTo.spawnPoint. name

string

Any

object.switchesEnvironmentTo.spawnPoint. x

number

Any

object.switchesEnvironmentTo.spawnPoint. y

number

Any

object.switchesEnvironmentTo.spawnPoint. z

number

Any

object.switchesEnvironmentTo.spawnPoint. r

number

Any

object. concurrentUsageLimit

integer

Any

object. lastChangedTimestamp

number

Any

object. lastChangedBy

string

Any

object. mediaFileId

string

Any

object. mediaFileMimetype

string

Any

object. inUseBy

array (string)

Any

object. clientData

object

Any

object. animations

array (object)

Any

object.animations. id

string

Any

object.animations. name

string

Any

object. metadata

object

Any

object. domoticsType

string

Any

object. hasRenderFiles

boolean

Any

object. position

object

Any

object.position. x

number

Any

object.position. y

number

Any

object.position. z

number

Any

object. rotation

object

Any

object.rotation. x

number

Any

object.rotation. y

number

Any

object.rotation. z

number

Any

object. scale

number

Any

object. type

string

Any

object. productIds

array (string)

Any

object. actions

array (object)

Any

object.actions. id

string

Any

object.actions. type

string

Any

object.actions. name

string

Any

object.actions. data

object

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "object": {
    "id": "string",
    "worldObjectId": "ec563b42-9df2-460b-95b9-056eeaf737ee",
    "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
    "name": "string",
    "state": "string",
    "disabled": false,
    "supportsMedia": false,
    "switchesEnvironmentTo": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "spawnPoint": {
        "name": "string",
        "x": 0,
        "y": 0,
        "z": 0,
        "r": 0
      }
    },
    "concurrentUsageLimit": 0,
    "lastChangedTimestamp": 0,
    "lastChangedBy": "string",
    "mediaFileId": null,
    "mediaFileMimetype": null,
    "inUseBy": [],
    "clientData": {},
    "animations": [],
    "metadata": {},
    "domoticsType": null,
    "hasRenderFiles": false,
    "position": {
      "x": 0,
      "y": 0,
      "z": 0
    },
    "rotation": {
      "x": 0,
      "y": 0,
      "z": 0
    },
    "scale": 0,
    "type": null,
    "productIds": [],
    "actions": []
  },
  "success": true
}

push/\{serial}/cloud/govirtual/rooms/\{room}/objects/\{object}/set

PUB change a world object

SetWorldObjectRequest
Payload

Name

Type

Description

Accepted values

clientData

object

Any

inUse

boolean

Any

inUsePosition

integer

Any

key

string

Any

mediaFileId

string

Any

state

string

Any
Example of payload (generated)
{
  "clientData": {},
  "inUse": true,
  "inUsePosition": 0,
  "key": "string",
  "mediaFileId": "string",
  "state": "string"
}

zbos/\{serial}/cloud/govirtual/rooms/\{room}/objects/\{object}/set/response/\{key}

SUB result info of the world object set

SetWorldObjectResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "success": true
}

push/\{serial}/cloud/govirtual/rooms/\{room}/models/get

PUB model info for the room

BaseListRequest
Payload

Name

Type

Description

Accepted values

filter

string

Any

key

string

Any

limit

integer

Any

offset

integer

Any

search

string

Any
Example of payload (generated)
{
  "filter": "",
  "key": "string",
  "limit": 0,
  "offset": 0,
  "search": ""
}

zbos/\{serial}/cloud/govirtual/rooms/\{room}/models/get/response/\{key}

SUB info about models in the room

ModelListResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

limit

integer

Any

models

array (object)

Any

models. id

string

Any

models. name

string

Any

models. version

integer

Any

models. public

boolean

Any

models. ownerId

string

Any

models. metadata

object

Any

numResults

integer

Any

offset

integer

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "limit": 0,
  "models": [
    {
      "id": "string",
      "name": "string",
      "version": 0,
      "public": false,
      "ownerId": "string",
      "metadata": {}
    }
  ],
  "numResults": 0,
  "offset": 0,
  "success": true
}

push/\{serial}/cloud/govirtual/models/get

PUB get list of models the robot can use as its avatar

BaseListRequest
Payload

Name

Type

Description

Accepted values

filter

string

Any

key

string

Any

limit

integer

Any

offset

integer

Any

search

string

Any
Example of payload (generated)
{
  "filter": "",
  "key": "string",
  "limit": 0,
  "offset": 0,
  "search": ""
}

zbos/\{serial}/cloud/govirtual/models/get/response/\{key}

SUB list of available models

ModelListResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

limit

integer

Any

models

array (object)

Any

models. id

string

Any

models. name

string

Any

models. version

integer

Any

models. public

boolean

Any

models. ownerId

string

Any

models. metadata

object

Any

numResults

integer

Any

offset

integer

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "limit": 0,
  "models": [
    {
      "id": "string",
      "name": "string",
      "version": 0,
      "public": false,
      "ownerId": "string",
      "metadata": {}
    }
  ],
  "numResults": 0,
  "offset": 0,
  "success": true
}

push/\{serial}/cloud/govirtual/animations/get

PUB get list of animations the robot can use on its avatar

BaseListRequest
Payload

Name

Type

Description

Accepted values

filter

string

Any

key

string

Any

limit

integer

Any

offset

integer

Any

search

string

Any
Example of payload (generated)
{
  "filter": "",
  "key": "string",
  "limit": 0,
  "offset": 0,
  "search": ""
}

zbos/\{serial}/cloud/govirtual/animations/get/response/\{key}

SUB list of animations

AnimationListResponse
Payload

Name

Type

Description

Accepted values

animations

array (object)

Any

animations. id

string

Any

animations. name

string

Any

animations. category

string

Any

animations. version

integer

Any

error

string

Any

limit

integer

Any

numResults

integer

Any

offset

integer

Any

success

boolean

Any
Example of payload (generated)
{
  "animations": [
    {
      "id": "string",
      "name": "string",
      "category": "string",
      "version": 0
    }
  ],
  "error": "",
  "limit": 0,
  "numResults": 0,
  "offset": 0,
  "success": true
}

cloud/govirtual/rooms/\{room}/members/join/event

SUB send when someone joins the room

RoomJoinLeaveEvent
Payload

Name

Type

Description

Accepted values

membership

object

Any

membership. id

string

Any

membership. userId

string

Any

membership. userName

string

Any

membership. userPicture

string

Any

membership. robotSerial

string

Any

membership. robotName

string

Any

membership. model

object

Any

membership.model. id

string

Any

membership.model. name

string

Any

membership.model. modelId

string

Any

membership.model. environmentId

string

Any

membership.model. state

object

Any
Example of payload (generated)
{
  "membership": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
    "userName": "string",
    "userPicture": "string",
    "robotSerial": "string",
    "robotName": "",
    "model": {
      "id": "string",
      "name": "",
      "modelId": "string",
      "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
      "state": {}
    }
  }
}

cloud/govirtual/rooms/\{room}/members/leave/event

SUB send when someone leaves the room

RoomJoinLeaveEvent
Payload

Name

Type

Description

Accepted values

membership

object

Any

membership. id

string

Any

membership. userId

string

Any

membership. userName

string

Any

membership. userPicture

string

Any

membership. robotSerial

string

Any

membership. robotName

string

Any

membership. model

object

Any

membership.model. id

string

Any

membership.model. name

string

Any

membership.model. modelId

string

Any

membership.model. environmentId

string

Any

membership.model. state

object

Any
Example of payload (generated)
{
  "membership": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
    "userName": "string",
    "userPicture": "string",
    "robotSerial": "string",
    "robotName": "",
    "model": {
      "id": "string",
      "name": "",
      "modelId": "string",
      "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
      "state": {}
    }
  }
}

cloud/govirtual/rooms/\{room}/animation/start/event

SUB send on animation start

AnimationStartEvent
Payload

Name

Type

Description

Accepted values

animation

object

Any

animation. modelId

string

Any

animation. environmentId

string

Any

animation. worldObjectInstanceId

string

Any

animation. data

object

Any

robotSerial

string

Any
Example of payload (generated)
{
  "animation": {
    "modelId": "string",
    "environmentId": "string",
    "worldObjectInstanceId": "string",
    "data": {}
  },
  "robotSerial": "string"
}

cloud/govirtual/rooms/\{room}/animation/stop/event

SUB send when an animation ends

AnimationStopEvent
Payload

Name

Type

Description

Accepted values

animation

object

Any

animation. modelId

string

Any

animation. environmentId

string

Any

animation. worldObjectInstanceId

string

Any

animation. data

object

Any

robotSerial

string

Any
Example of payload (generated)
{
  "animation": {
    "modelId": "string",
    "environmentId": "string",
    "worldObjectInstanceId": "string",
    "data": {}
  },
  "robotSerial": "string"
}

cloud/govirtual/rooms/\{room}/position/event

SUB send when a robot position changes

PositionEvent
Payload

Name

Type

Description

Accepted values

environmentId

string

Any

modelId

string

Any

robotSerial

string

Any

state

object

Any
Example of payload (generated)
{
  "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
  "modelId": "string",
  "robotSerial": "string",
  "state": {}
}

cloud/govirtual/rooms/\{room}/position/action/event

SUB send when a robot position action changes

PositionActionEvent
Payload

Name

Type

Description

Accepted values

action

object

Any

modelId

string

Any

robotSerial

string

Any
Example of payload (generated)
{
  "action": {},
  "modelId": "string",
  "robotSerial": "string"
}

cloud/govirtual/rooms/\{room}/object/event

SUB send when a world object changes

WorldObjectChangeEvent
Payload

Name

Type

Description

Accepted values

data

object

Any

data. id

string

Any

data. worldObjectId

string

Any

data. environmentId

string

Any

data. name

string

Any

data. state

string

Any

data. disabled

boolean

Any

data. supportsMedia

boolean

Any

data. switchesEnvironmentTo

object

Any

data.switchesEnvironmentTo. id

string

Any

data.switchesEnvironmentTo. spawnPoint

object

Any

data.switchesEnvironmentTo.spawnPoint. name

string

Any

data.switchesEnvironmentTo.spawnPoint. x

number

Any

data.switchesEnvironmentTo.spawnPoint. y

number

Any

data.switchesEnvironmentTo.spawnPoint. z

number

Any

data.switchesEnvironmentTo.spawnPoint. r

number

Any

data. concurrentUsageLimit

integer

Any

data. lastChangedTimestamp

number

Any

data. lastChangedBy

string

Any

data. mediaFileId

string

Any

data. mediaFileMimetype

string

Any

data. inUseBy

array (string)

Any

data. clientData

object

Any

data. animations

array (object)

Any

data.animations. id

string

Any

data.animations. name

string

Any

data. metadata

object

Any

data. domoticsType

string

Any

data. hasRenderFiles

boolean

Any

data. position

object

Any

data.position. x

number

Any

data.position. y

number

Any

data.position. z

number

Any

data. rotation

object

Any

data.rotation. x

number

Any

data.rotation. y

number

Any

data.rotation. z

number

Any

data. scale

number

Any

data. type

string

Any

data. productIds

array (string)

Any

data. actions

array (object)

Any

data.actions. id

string

Any

data.actions. type

string

Any

data.actions. name

string

Any

data.actions. data

object

Any
Example of payload (generated)
{
  "data": {
    "id": "string",
    "worldObjectId": "ec563b42-9df2-460b-95b9-056eeaf737ee",
    "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
    "name": "string",
    "state": "string",
    "disabled": false,
    "supportsMedia": false,
    "switchesEnvironmentTo": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "spawnPoint": {
        "name": "string",
        "x": 0,
        "y": 0,
        "z": 0,
        "r": 0
      }
    },
    "concurrentUsageLimit": 0,
    "lastChangedTimestamp": 0,
    "lastChangedBy": "string",
    "mediaFileId": null,
    "mediaFileMimetype": null,
    "inUseBy": [],
    "clientData": {},
    "animations": [],
    "metadata": {},
    "domoticsType": null,
    "hasRenderFiles": false,
    "position": {
      "x": 0,
      "y": 0,
      "z": 0
    },
    "rotation": {
      "x": 0,
      "y": 0,
      "z": 0
    },
    "scale": 0,
    "type": null,
    "productIds": [],
    "actions": []
  }
}

cloud/govirtual/rooms/\{room}/environment/switch/event

SUB a device has switched between environments in the room

GoVirtualEnvironmentSwitchEvent
Payload

Name

Type

Description

Accepted values

robotSerial

string

Any

switchEnvironment

object

Any

switchEnvironment. id

string

Any

switchEnvironment. spawnPoint

object

Any

switchEnvironment.spawnPoint. name

string

Any

switchEnvironment.spawnPoint. x

number

Any

switchEnvironment.spawnPoint. y

number

Any

switchEnvironment.spawnPoint. z

number

Any

switchEnvironment.spawnPoint. r

number

Any
Example of payload (generated)
{
  "robotSerial": "string",
  "switchEnvironment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "spawnPoint": {
      "name": "string",
      "x": 0,
      "y": 0,
      "z": 0,
      "r": 0
    }
  }
}

cloud/\{account}/govirtual/model/event

SUB send when a GoVirtual model is changes or gets deleted

GoVirtualModelChangeEvent
Payload

Name

Type

Description

Accepted values

id

string

Any

multiplayerApproved

boolean

Any

name

string

Any

status

string

Any
Example of payload (generated)
{
  "id": "string",
  "multiplayerApproved": true,
  "name": "string",
  "status": "string"
}

cloud/\{account}/govirtual/model/scan/session/event

SUB send when a GoVirtual model scan session changes

GoVirtualModelScanSessionChangeEvent
Payload

Name

Type

Description

Accepted values

id

string

Any

status

string

Any
Example of payload (generated)
{
  "id": "string",
  "status": "string"
}

push/\{serial}/cloud/login

PUB request a new cloud auth token for a device

BaseRequest
Payload

Name

Type

Description

Accepted values

key

string

Any
Example of payload (generated)
{
  "key": "string"
}

zbos/\{serial}/cloud/login/response/\{key}

SUB login response with an auth token for the device

DeviceLoginResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

success

boolean

Any

token

string

Any
Example of payload (generated)
{
  "error": "",
  "success": true,
  "token": "string"
}

cloud/\{account}/robots

PUB request a list with all the devices linked to a cloud account

BaseListRequest
Payload

Name

Type

Description

Accepted values

filter

string

Any

key

string

Any

limit

integer

Any

offset

integer

Any

search

string

Any
Example of payload (generated)
{
  "filter": "",
  "key": "string",
  "limit": 0,
  "offset": 0,
  "search": ""
}

cloud/\{account}/robots/response/\{key}

SUB response to robots linked to a cloud account request

DeviceListResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

limit

integer

Any

numResults

integer

Any

offset

integer

Any

robots

array (string)

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "limit": 0,
  "numResults": 0,
  "offset": 0,
  "robots": [
    "string"
  ],
  "success": true
}

push/\{serial}/cloud/user/list

PUB request a list with all the accounts linked to a device

BaseListRequest
Payload

Name

Type

Description

Accepted values

filter

string

Any

key

string

Any

limit

integer

Any

offset

integer

Any

search

string

Any
Example of payload (generated)
{
  "filter": "",
  "key": "string",
  "limit": 0,
  "offset": 0,
  "search": ""
}

zbos/\{serial}/cloud/user/list/response/\{key}

SUB response to accounts linked to a device request

UserListResponse
Payload

Name

Type

Description

Accepted values

accounts

array (object)

Any

accounts. id

string

Any

accounts. username

string

Any

accounts. email

string

Any

accounts. picture

string

Any

accounts. admin

boolean

Any

accounts. mqttAccount

string

Any

error

string

Any

limit

integer

Any

numResults

integer

Any

offset

integer

Any

success

boolean

Any
Example of payload (generated)
{
  "accounts": [
    {
      "id": "string",
      "username": "string",
      "email": "string",
      "picture": "string",
      "admin": true,
      "mqttAccount": "string"
    }
  ],
  "error": "",
  "limit": 0,
  "numResults": 0,
  "offset": 0,
  "success": true
}

push/\{serial}/registration/list

PUB alias for UserListRequest

BaseListRequest
Payload

Name

Type

Description

Accepted values

filter

string

Any

key

string

Any

limit

integer

Any

offset

integer

Any

search

string

Any
Example of payload (generated)
{
  "filter": "",
  "key": "string",
  "limit": 0,
  "offset": 0,
  "search": ""
}

zbos/\{serial}/registration/list/response/\{key}

SUB alias for UserListResponse

UserListResponse
Payload

Name

Type

Description

Accepted values

accounts

array (object)

Any

accounts. id

string

Any

accounts. username

string

Any

accounts. email

string

Any

accounts. picture

string

Any

accounts. admin

boolean

Any

accounts. mqttAccount

string

Any

error

string

Any

limit

integer

Any

numResults

integer

Any

offset

integer

Any

success

boolean

Any
Example of payload (generated)
{
  "accounts": [
    {
      "id": "string",
      "username": "string",
      "email": "string",
      "picture": "string",
      "admin": true,
      "mqttAccount": "string"
    }
  ],
  "error": "",
  "limit": 0,
  "numResults": 0,
  "offset": 0,
  "success": true
}

push/\{serial}/cloud/link/request

PUB Create a new link request for a user and this device

CreateDeviceLinkRequest
Payload

Name

Type

Description

Accepted values

admin

boolean

Any

createLinkRequest

boolean

Any

key

string

Any

userId

string

Any
Example of payload (generated)
{
  "admin": false,
  "createLinkRequest": false,
  "key": "string",
  "userId": "string"
}

zbos/\{serial}/cloud/link/request/response/\{key}

SUB answer to the request to link a device to an account (with direct link confirm or approval needed info)

CreateDeviceLinkResponse
Payload

Name

Type

Description

Accepted values

adminInfo

object

Any

adminInfo. count

integer

Any

adminInfo. oldestAdminUsers

array (string)

Any

adminInfo. oldestAdmins

array (object)

Any

adminInfo.oldestAdmins. id

string

Any

adminInfo.oldestAdmins. name

string

Any

adminInfo.oldestAdmins. email

string

Any

error

string

Any

status

string

Any

success

boolean

Any
Example of payload (generated)
{
  "adminInfo": {
    "count": 0,
    "oldestAdminUsers": [
      "string"
    ],
    "oldestAdmins": [
      {
        "id": "string",
        "name": "string",
        "email": "string"
      }
    ]
  },
  "error": "",
  "status": "string",
  "success": true
}

cloud/\{account}/link/request/response/\{key}

SUB answer to the request to link a device to an account (with direct link confirm or approval needed info)

CreateDeviceLinkResponse
Payload

Name

Type

Description

Accepted values

adminInfo

object

Any

adminInfo. count

integer

Any

adminInfo. oldestAdminUsers

array (string)

Any

adminInfo. oldestAdmins

array (object)

Any

adminInfo.oldestAdmins. id

string

Any

adminInfo.oldestAdmins. name

string

Any

adminInfo.oldestAdmins. email

string

Any

error

string

Any

status

string

Any

success

boolean

Any
Example of payload (generated)
{
  "adminInfo": {
    "count": 0,
    "oldestAdminUsers": [
      "string"
    ],
    "oldestAdmins": [
      {
        "id": "string",
        "name": "string",
        "email": "string"
      }
    ]
  },
  "error": "",
  "status": "string",
  "success": true
}

cloud/\{account}/registration/delete

PUB request to unlink a cloud account from a device, can be done by both the device and the account

DeviceUnlinkRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

serial

string

Any
Example of payload (generated)
{
  "key": "string",
  "serial": "string"
}

zbos/\{serial}/registration/delete/response/\{key}

SUB response to request to unlink a device from an account

BaseResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "success": true
}

cloud/\{account}/registration/delete/response/\{key}

SUB response to request to unlink a device from an account

BaseResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "success": true
}

cloud/\{account}/robot/link/event

SUB a device was linked to an account

DeviceLinkEvent
Payload

Name

Type

Description

Accepted values

admin

boolean

Any

serial

string

Any
Example of payload (generated)
{
  "admin": true,
  "serial": "string"
}

cloud/\{account}/robot/unlink/event

SUB a robot was unlinked from an account

DeviceUnlinkEvent
Payload

Name

Type

Description

Accepted values

admin

boolean

Any

serial

string

Any
Example of payload (generated)
{
  "admin": true,
  "serial": "string"
}

cloud/\{account}/robot/link/request/event

SUB a user created a link request for a device. The device admins can listen to this topic.

DeviceLinkRequestEvent
Payload

Name

Type

Description

Accepted values

admin

boolean

Any

robotSerial

string

Any

status

string

Any

userEmail

string

Any

userId

string

Any

userName

string

Any
Example of payload (generated)
{
  "admin": true,
  "robotSerial": "string",
  "status": "string",
  "userEmail": "string",
  "userId": "string",
  "userName": "string"
}

cloud/\{account}/storage/file/event

SUB a file is fully processed after being uploaded

CloudFileEvent
Payload

Name

Type

Description

Accepted values

folder

string

Any

id

string

Any

mimetype

string

Any

name

string

Any

status

string

Any
Example of payload (generated)
{
  "folder": "string",
  "id": "string",
  "mimetype": "string",
  "name": "string",
  "status": "string"
}

zbos/\{serial}/cloud/storage/file/event

SUB a file is fully processed after being uploaded

CloudFileEvent
Payload

Name

Type

Description

Accepted values

folder

string

Any

id

string

Any

mimetype

string

Any

name

string

Any

status

string

Any
Example of payload (generated)
{
  "folder": "string",
  "id": "string",
  "mimetype": "string",
  "name": "string",
  "status": "string"
}

cloud/\{account}/sale/order/event

SUB a sale order has changed state

SaleOrderEvent
Payload

Name

Type

Description

Accepted values

id

string

Any

status

string

Any
Example of payload (generated)
{
  "id": "string",
  "status": "string"
}

push/\{serial}/cloud/mail/send

PUB request cloud to send a mail

TriggerCommunicationRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

parameters

object

Any

trigger

string

Any
Example of payload (generated)
{
  "key": "string",
  "parameters": {},
  "trigger": "string"
}

zbos/\{serial}/cloud/mail/send/response/\{key}

SUB result of sending mail

BaseResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "success": true
}

push/\{serial}/cloud/push-notification/send

PUB request cloud to send a push notification to a mobile device

TriggerCommunicationRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

parameters

object

Any

trigger

string

Any
Example of payload (generated)
{
  "key": "string",
  "parameters": {},
  "trigger": "string"
}

zbos/\{serial}/cloud/push-notification/send/response/\{key}

SUB result of sending push notification

BaseResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "success": true
}

push/\{serial}/cloud/license/list

PUB request to get the active licenses of a robot

BaseListRequest
Payload

Name

Type

Description

Accepted values

filter

string

Any

key

string

Any

limit

integer

Any

offset

integer

Any

search

string

Any
Example of payload (generated)
{
  "filter": "",
  "key": "string",
  "limit": 0,
  "offset": 0,
  "search": ""
}

zbos/\{serial}/cloud/license/list/response/\{key}

SUB request to get the active licenses of a robot

LicenseListResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

licenses

array (object)

Any

licenses. id

string

Any

licenses. type

string

Any

licenses. activationStatus

string

Any

licenses. activationCode

string

Any

licenses. createdTimestamp

number

Any

licenses. validFrom

integer

Any

licenses. validUntil

integer

Any

licenses. trial

boolean

Any

licenses. serial

string

Any

licenses. softwareId

string

Any

limit

integer

Any

numResults

integer

Any

offset

integer

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "licenses": [
    {
      "id": "string",
      "type": "string",
      "activationStatus": "string",
      "activationCode": "string",
      "createdTimestamp": 0,
      "validFrom": 0,
      "validUntil": 0,
      "trial": false,
      "serial": "string",
      "softwareId": "string"
    }
  ],
  "limit": 0,
  "numResults": 0,
  "offset": 0,
  "success": true
}

zbos/\{serial}/cloud/license/event

SUB a license for this device has changed

LicenseEvent
Payload

Name

Type

Description

Accepted values

id

string

Any

type

string

Any

activationStatus

string

Any

activationCode

string

Any

createdTimestamp

number

Any

validFrom

integer

Any

validUntil

integer

Any

trial

boolean

Any

serial

string

Any

softwareId

string

Any
Example of payload (generated)
{
  "id": "string",
  "type": "string",
  "activationStatus": "string",
  "activationCode": "string",
  "createdTimestamp": 0,
  "validFrom": 0,
  "validUntil": 0,
  "trial": false,
  "serial": "string",
  "softwareId": "string"
}

push/\{serial}/cloud/huddle/create

PUB create a huddle from a device

HuddleCreateRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

password

string

Any
Example of payload (generated)
{
  "key": "string",
  "password": "string"
}

zbos/\{serial}/cloud/huddle/create/response/\{key}

SUB result of huddle creation

HuddleCreateResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

id

string

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "id": "string",
  "success": true
}

control/\{account}/cloud/huddle/create

PUB create a huddle from a user

HuddleCreateRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

password

string

Any
Example of payload (generated)
{
  "key": "string",
  "password": "string"
}

control/\{account}/cloud/huddle/create/response/\{key}

SUB result of huddle creation

HuddleCreateResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

id

string

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "id": "string",
  "success": true
}

push/\{serial}/cloud/huddle/\{huddle}/join

PUB join an existing huddle

HuddleJoinRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

password

string

Any
Example of payload (generated)
{
  "key": "string",
  "password": "string"
}

zbos/\{serial}/cloud/huddle/\{huddle}/join/response/\{key}

SUB result of robot trying to join a huddle

BaseResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "success": true
}

control/\{account}/cloud/huddle/\{huddle}/join

PUB create a huddle from a user

HuddleJoinRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

password

string

Any
Example of payload (generated)
{
  "key": "string",
  "password": "string"
}

control/\{account}/cloud/huddle/\{huddle}/join/response/\{key}

SUB result of user trying to join a huddle

BaseResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "success": true
}

push/\{serial}/cloud/huddle/\{huddle}/leave

PUB leave a huddle from a device

BaseRequest
Payload

Name

Type

Description

Accepted values

key

string

Any
Example of payload (generated)
{
  "key": "string"
}

zbos/\{serial}/cloud/huddle/\{huddle}/leave/response/\{key}

SUB result of device trying to leave a huddle

BaseResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "success": true
}

control/\{account}/cloud/huddle/\{huddle}/leave

PUB leave the huddle from a user

BaseRequest
Payload

Name

Type

Description

Accepted values

key

string

Any
Example of payload (generated)
{
  "key": "string"
}

control/\{account}/cloud/huddle/\{huddle}/leave/response/\{key}

SUB result of user trying to leave the huddle

BaseResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "success": true
}

push/\{serial}/cloud/llm/chat

PUB Send a message to a large language model

LlmChatRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

message

string

Any

model

string

Any
Example of payload (generated)
{
  "key": "string",
  "message": "string",
  "model": "string"
}

zbos/\{serial}/cloud/llm/chat/response/\{key}

PUB Answer from a large language model to a message

LlmChatResponse
Payload

Name

Type

Description

Accepted values

message

string

Any

success

boolean

Any

tokens

integer

Any
Example of payload (generated)
{
  "message": "string",
  "success": true,
  "tokens": 0
}

push/\{serial}/cloud/energy/installation/get

PUB Get the energy installation linked to the device

BaseRequest
Payload

Name

Type

Description

Accepted values

key

string

Any
Example of payload (generated)
{
  "key": "string"
}

zbos/\{serial}/cloud/energy/installation/get/response/\{key}

PUB Answer with the energy installation linked to the device

GetEnergyInstallationResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

installation

object

Any

installation. serial

string

Any

installation. inverter

object

Any

installation.inverter. serial

string

Any

installation.inverter. brand

string

Any

installation.inverter. maxChargeRate

number

Any

installation.inverter. maxDischargeRate

number

Any

installation.inverter. metadata

object

Any

installation. battery

object

Any

installation.battery. brand

string

Any

installation.battery. capacity

number

Any

installation.battery. maxChargeRate

number

Any

installation.battery. maxDischargeRate

number

Any

installation.battery. minCharge

number

Any

installation.battery. maxCharge

number

Any

installation.battery. metadata

object

Any

installation. solarPanels

array (object)

Any

installation.solarPanels. brand

string

Any

installation.solarPanels. angle

integer

Any

installation.solarPanels. orientation

integer

Any

installation.solarPanels. maxPower

number

Any

installation.solarPanels. metadata

object

Any

installation. maxChargeRate

number

Any

installation. maxDischargeRate

number

Any

installation. latitude

number

Any

installation. longitude

number

Any

installation. modifiedTimestamp

number

Any

installation. metadata

object

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "installation": {
    "serial": "string",
    "inverter": {
      "serial": "string",
      "brand": "string",
      "maxChargeRate": 0,
      "maxDischargeRate": 0,
      "metadata": {}
    },
    "battery": {
      "brand": "string",
      "capacity": 0,
      "maxChargeRate": 0,
      "maxDischargeRate": 0,
      "minCharge": 0,
      "maxCharge": 0,
      "metadata": {}
    },
    "solarPanels": [],
    "maxChargeRate": 0,
    "maxDischargeRate": 0,
    "latitude": 0,
    "longitude": 0,
    "modifiedTimestamp": 0,
    "metadata": {}
  },
  "success": true
}

push/\{serial}/cloud/energy/installation/set

PUB Create or update the energy installation linked to the device

SetEnergyInstallationRequest
Payload

Name

Type

Description

Accepted values

installation

object

Any

installation. serial

string

Any

installation. inverter

object

Any

installation.inverter. serial

string

Any

installation.inverter. brand

string

Any

installation.inverter. maxChargeRate

number

Any

installation.inverter. maxDischargeRate

number

Any

installation.inverter. metadata

object

Any

installation. battery

object

Any

installation.battery. brand

string

Any

installation.battery. capacity

number

Any

installation.battery. maxChargeRate

number

Any

installation.battery. maxDischargeRate

number

Any

installation.battery. minCharge

number

Any

installation.battery. maxCharge

number

Any

installation.battery. metadata

object

Any

installation. solarPanels

array (object)

Any

installation.solarPanels. brand

string

Any

installation.solarPanels. angle

integer

Any

installation.solarPanels. orientation

integer

Any

installation.solarPanels. maxPower

number

Any

installation.solarPanels. metadata

object

Any

installation. maxChargeRate

number

Any

installation. maxDischargeRate

number

Any

installation. latitude

number

Any

installation. longitude

number

Any

installation. modifiedTimestamp

number

Any

installation. metadata

object

Any

key

string

Any
Example of payload (generated)
{
  "installation": {
    "serial": "string",
    "inverter": {
      "serial": "string",
      "brand": "string",
      "maxChargeRate": 0,
      "maxDischargeRate": 0,
      "metadata": {}
    },
    "battery": {
      "brand": "string",
      "capacity": 0,
      "maxChargeRate": 0,
      "maxDischargeRate": 0,
      "minCharge": 0,
      "maxCharge": 0,
      "metadata": {}
    },
    "solarPanels": [],
    "maxChargeRate": 0,
    "maxDischargeRate": 0,
    "latitude": 0,
    "longitude": 0,
    "modifiedTimestamp": 0,
    "metadata": {}
  },
  "key": "string"
}

zbos/\{serial}/cloud/energy/installation/set/response/\{key}

PUB Energy installation create/update response

BaseResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "success": true
}

push/\{serial}/cloud/energy/installation/state/get

PUB Get the current state of the energy installation linked to this device

BaseRequest
Payload

Name

Type

Description

Accepted values

key

string

Any
Example of payload (generated)
{
  "key": "string"
}

zbos/\{serial}/cloud/energy/installation/state/get/response/\{key}

PUB Energy installation state update response

GetEnergyInstallationStateResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

state

object

Any

state. lastUpdate

number

Any

state. stateOfCharge

number

Any

state. chargeDischargePower

number

Any

state. maxSolarPower

number

Any

state. pvExportTotal

number

Power generated by solar panels (PV) in kw/h

Any

state. batteryDischargeTotal

number

Power extracted from the battery in kw/h

Any

state. batteryChargeTotal

number

Power sent into the battery in kw/h

Any

state. gridExportTotal

number

Power injected into the energy grid in kw/h

Any

state. gridImportTotal

number

Power consumed from the energy grid in kw/h

Any

state. loadEnergyTotal

number

[.asyncapi-property-description]#The total kWh that was being consumed by ‘the house’. This can contain electricity produced by the PV installation, from the battery itself or imported from grid. #

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "state": {
    "lastUpdate": 0,
    "stateOfCharge": 0,
    "chargeDischargePower": 0,
    "maxSolarPower": 0,
    "pvExportTotal": 0,
    "batteryDischargeTotal": 0,
    "batteryChargeTotal": 0,
    "gridExportTotal": 0,
    "gridImportTotal": 0,
    "loadEnergyTotal": 0
  },
  "success": true
}

push/\{serial}/cloud/energy/installation/state/set

PUB Update the state of the energy installation linked to this device

SetEnergyInstallationStateRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

state

object

Any

state. lastUpdate

number

Any

state. stateOfCharge

number

Any

state. chargeDischargePower

number

Any

state. maxSolarPower

number

Any

state. pvExportTotal

number

Power generated by solar panels (PV) in kw/h

Any

state. batteryDischargeTotal

number

Power extracted from the battery in kw/h

Any

state. batteryChargeTotal

number

Power sent into the battery in kw/h

Any

state. gridExportTotal

number

Power injected into the energy grid in kw/h

Any

state. gridImportTotal

number

Power consumed from the energy grid in kw/h

Any

state. loadEnergyTotal

number

[.asyncapi-property-description]#The total kWh that was being consumed by ‘the house’. This can contain electricity produced by the PV installation, from the battery itself or imported from grid. #

Any
Example of payload (generated)
{
  "key": "string",
  "state": {
    "lastUpdate": 0,
    "stateOfCharge": 0,
    "chargeDischargePower": 0,
    "maxSolarPower": 0,
    "pvExportTotal": 0,
    "batteryDischargeTotal": 0,
    "batteryChargeTotal": 0,
    "gridExportTotal": 0,
    "gridImportTotal": 0,
    "loadEnergyTotal": 0
  }
}

zbos/\{serial}/cloud/energy/installation/state/set/response/\{key}

PUB Energy installation state update response

BaseResponse
Payload

Name

Type

Description

Accepted values

error

string

Any

success

boolean

Any
Example of payload (generated)
{
  "error": "",
  "success": true
}

zbos/\{serial}/cloud/energy/installation/steering/event

PUB Event with values that the device should pass to its linked energy installation

EnergyInstallationSteeringEvent
Payload

Name

Type

Description

Accepted values

chargeDischargePower

number

Any

lastUpdate

number

Any

maxSolarPower

number

Any
Example of payload (generated)
{
  "chargeDischargePower": 0,
  "lastUpdate": 0,
  "maxSolarPower": 0
}