ZBOS MQTT API 1.2.8

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: 8883, 9001 DEFAULT: 8883
zbos-mqtt.zoracloud.com mqtt

This is the cloud broker.

Security:
  • User / Password: No description

Operations

Pub zbos/audio/player/start

Play media

Play specific media file from path

Accepts the following message:

Payload
string
audio

Examples

"string"
This example has been generated automatically.

Pub zbos/audio/player/stop

Stop media

Accepts the following message:

emptyJson

empty json

Payload
object

Additional properties are allowed.

audio

Examples

{}
This example has been generated automatically.

Pub zbos/audio/volume/get

Get volume

Accepts the following message:

keyMessage

Random key

Payload
string

Required random key

Examples: { "key": "ABCxyz" }
audio

Examples

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

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

response: Get volume

Parameters
key
required
string

Accepts the following message:

Payload
int
audio

Examples

""
This example has been generated automatically.

Pub zbos/audio/volume/set

Set volume

Accepts the following message:

Payload
int
audio

Examples

""
This example has been generated automatically.

Pub zbos/audio/beep

Play beep

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

Accepts the following message:

emptyJson

empty json

Payload
object

Additional properties are allowed.

audio

Examples

{}
This example has been generated automatically.

Sub zbos/audio/volume/event

event: Volume change

Notify subscribers of a volume change.

Accepts the following message:

Payload
int
audio

Examples

""
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:

emptyJson

empty json

Payload
object

Additional properties are allowed.

video stream

Examples

{}
This example has been generated automatically.

Pub zbos/camera/stream/start

Start the camera stream of the selected camera.

Accepts the following message:

Payload
string

camera id

video stream

Examples

"string"
This example has been generated automatically.

Pub zbos/camera/stream/stop

Stop camera stream

Accepts the following message:

emptyJson

empty json

Payload
object

Additional properties are allowed.

video stream

Examples

{}
This example has been generated automatically.

Pub zbos/camera/stream/offer

Handsake offer for camera stream

Accepts the following message:

Payload
string

WebRTC Session Description

video stream

Examples

"string"
This example has been generated automatically.

Sub zbos/camera/stream/answer

Handsake answer for camera stream

Accepts the following message:

Payload
string

WebRTC Session Description

video stream

Examples

"string"
This example has been generated automatically.

Sub zbos/camera/stream/candidate/core

RTC ICE Candidate Core

Accepts the following message:

Payload
object

WebRTC Session Description

type
string

Always returns "candidate"

label
string

sdpMLineIndex

id
string

sdpMid

candidate
string

Additional properties are allowed.

video stream

Examples

{
  "type": "string",
  "label": "string",
  "id": "string",
  "candidate": "string"
}
This example has been generated automatically.

Sub zbos/camera/stream/candidate/control

RTC ICE Candidate Control

Accepts the following message:

Payload
object
type
string

Always returns "candidate"

label
string

sdpMLineIndex

id
string

sdpMid

candidate
string

Additional properties are allowed.

video stream

Examples

{
  "type": "string",
  "label": "string",
  "id": "string",
  "candidate": "string"
}
This example has been generated automatically.

Pub zbos/camera/picture/get

Get picture

Accepts the following message:

emptyJson

empty json

Payload
object

Additional properties are allowed.

video stream

Examples

{}
This example has been generated automatically.

Sub zbos/camera/picture/event

event: Get picture

Accepts the following message:

Payload
string

Picture in base64 format

video stream

Examples

"string"
This example has been generated automatically.

Pub zbos/camera/picture/save/request

Take picture and save

Take picture and save to SD card. Respond with path on zbos/camera/picture/save/response when done

Accepts the following message:

emptyJson

empty json

Payload
object

Additional properties are allowed.

video stream

Examples

{}
This example has been generated automatically.

Sub zbos/camera/picture/save/response

response: Picture taken and saved

Accepts the following message:

Payload
string

Path to picture

video stream

Examples

"string"
This example has been generated automatically.

Sub zbos/camera/error

event: Camera encountered error

List of possible error reasons:
'STREAM_CLOSED_DURING_SNAPSHOT': The camera stream was closed while a picture was being taken, automatically retries.

Accepts the following message:

Payload
object
error
string

One of the error codes described above.

Additional properties are allowed.

video stream

Examples

{
  "error": "string"
}
This example has been generated automatically.

Pub cloud/{account}/robots

Retrieve linked robot serials

Send by the cloud user to retrieve the serial of the robots linked to a cloud account

Parameters
account
required
string

Accepts the following message:

Payload
object
key
string

Additional properties are allowed.

cloud

Examples

{
  "key": "string"
}
This example has been generated automatically.

Sub cloud/{account}/robots/response

Response for linked robot serial request

Send by the cloud user to retrieve the serial of the robots linked to a cloud account

Parameters
account
required
string

Accepts the following message:

Payload
object
robots
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

cloud

Examples

{
  "robots": [
    "string"
  ]
}
This example has been generated automatically.

Pub cloud/{account}/registration/confirm

confirm robot linked to cloud account

Send by the robot to the cloud user that the registration is accepted and may be completed

Parameters
account
required
string

Accepts the following message:

Payload
object
serial
string

Additional properties are allowed.

cloud

Examples

{
  "serial": "string"
}
This example has been generated automatically.

Pub zbos/{serial}/registration/request

Ask robot to approve linking to a cloud account

Sent by zbos-control to ask the robot to confirm linking to the cloud account

Parameters
serial
required
string

Accepts the following message:

Username and email are optional but one of them will always be present. It depends on the type of account

Payload
object
account
string

cloud account uuid

email
string
username
array

Additional items are allowed.

info
string

extra info to display on the robot

Additional properties are allowed.

cloud

Examples

{
  "account": "string",
  "email": "string",
  "username": [],
  "info": "string"
}
This example has been generated automatically.

Pub push/{serial}/registration/list

Retrieve all cloud accounts for a robot

Retrieve a list of all the cloud accounts that are linked to the robot

Parameters
serial
required
string

Accepts the following message:

Payload
object
key
string

Additional properties are allowed.

cloud

Examples

{
  "key": "string"
}
This example has been generated automatically.

Sub zbos/{serial}/registration/list/response/{response_key}

response: Retrieve all cloud accounts for a robot

Parameters
serial
required
string
response_key
required
string

Accepts the following message:

for now only user names in the account objects but might expand later with other info

Payload
object
account
array<Unknown>

Items:

0

Additional items are allowed.

Additional properties are allowed.

cloud

Examples

{
  "account": [
    null
  ]
}
This example has been generated automatically.

Pub cloud/{account}/registration/delete

Remove link

Remove a link between the chosen cloud account and the robot.

Parameters
account
required
string

Accepts the following message:

Payload
object
key
string
serial
string

Additional properties are allowed.

cloud

Examples

{
  "key": "string",
  "serial": "string"
}
This example has been generated automatically.

Sub zbos/{serial}/registration/delete/response

response: Remove link. This is send when an account is no longer linked to a robot to notify the robot.

Parameters
serial
required
string

Accepts the following message:

Payload
object
success
boolean

Additional properties are allowed.

cloud

Examples

{
  "success": true
}
This example has been generated automatically.

Sub cloud/{account}/registration/delete/response/{response_key}

response: Remove link. This is send when an account is no longer linked to a robot to notify the control.

Parameters
account
required
string
response_key
required
string

Accepts the following message:

Payload
object
success
boolean

Additional properties are allowed.

cloud

Examples

{
  "success": true
}
This example has been generated automatically.

Pub push/{serial}/alarm/set

Trigger alarm

Send an alarm to a configured service provider (like verklizan). A temporary zbos control account is also created for the robot.

Parameters
serial
required
string

Accepts the following message:

Payload
object
key
string
alarmServiceProvider
string
metadata
object

Additional properties are allowed.

Additional properties are allowed.

cloud

Examples

{
  "key": "string",
  "alarmServiceProvider": "verklizan",
  "metadata": {}
}
This example has been generated automatically.

Sub zbos/{serial}/alarm/set/response/{response_key}

response: Alarm triggered

Parameters
serial
required
string
response_key
required
string

Accepts the following message:

Payload
object
success
boolean
info
string

tekst with additional information

ticketReference
string

id/ticker nr/identifier of alarm ticket

Additional properties are allowed.

cloud

Examples

{
  "success": true,
  "info": "string",
  "ticketReference": "string"
}
This example has been generated automatically.

Pub push/{serial}/cloud/login

Login request from robot

The robot can use this topic to login to the cloud and get a auth token.

Parameters
serial
required
string

Accepts the following message:

Payload
object
key
string

Additional properties are allowed.

cloud

Examples

{
  "key": "string"
}
This example has been generated automatically.

Sub zbos/{serial}/cloud/login/response/{response_key}

response: robot login request processed. This response contains the success flag and if the login is ok also an auth token.

Parameters
serial
required
string
response_key
required
string

Accepts the following message:

Payload
object
success
boolean
token
string

jwt auth token

Additional properties are allowed.

cloud

Examples

{
  "success": true,
  "token": "string"
}
This example has been generated automatically.

Pub zbos/composition/start

Start composition

Accepts the following message:

Payload
object

Composition json

Additional properties are allowed.

composer

Examples

{}
This example has been generated automatically.

Pub zbos/composition/block/start

Start composition block

Accepts the following message:

Payload
object
id
string

Block ID

type
string

Block type

blockInfo
object

Block parameters

Additional properties are allowed.

Additional properties are allowed.

composer

Examples

{
  "id": "string",
  "type": "string",
  "blockInfo": {}
}
This example has been generated automatically.

Sub zbos/composition/start/event

event: Composition started

Accepts the following message:

Timeline ID

Payload
string
composer

Examples

"string"
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:

Payload
object
id
string

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

type
string

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

reasons
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

composer

Examples

{
  "id": "string",
  "type": "string",
  "reasons": [
    "string"
  ]
}
This example has been generated automatically.

Pub zbos/composition/stop

Stop composition

Accepts the following message:

emptyJson

empty json

Payload
object

Additional properties are allowed.

composer

Examples

{}
This example has been generated automatically.

Pub zbos/composition/block/stop

Stop composition block

Accepts the following message:

Payload
object
key
string

Block ID to stop, if left empty this will stop all active blocks.

Additional properties are allowed.

composer

Examples

{
  "key": "string"
}
This example has been generated automatically.

Sub zbos/composition/stop/event

event: Composition stopped

Accepts the following message:

Timeline ID

Payload
string
composer

Examples

"string"
This example has been generated automatically.

Pub zbos/composition/pause

Pause composition

Accepts the following message:

emptyJson

empty json

Payload
object

Additional properties are allowed.

composer

Examples

{}
This example has been generated automatically.

Sub zbos/composition/pause/event

event: Composition paused

Accepts the following message:

Payload
string

Timeline ID

composer

Examples

"string"
This example has been generated automatically.

Sub zbos/composition/block/pause/event

event: Composition block paused

Accepts the following message:

Block ID

Payload
string
composer

Examples

"string"
This example has been generated automatically.

Pub zbos/composition/resume

Resume composition

Accepts the following message:

emptyJson

empty json

Payload
object

Additional properties are allowed.

composer

Examples

{}
This example has been generated automatically.

Sub zbos/composition/resume/event

event: Composition Resumed

Accepts the following message:

Timeline ID

Payload
string
composer

Examples

"string"
This example has been generated automatically.

Pub zbos/composition/start/id

Start composition by id

Accepts the following message:

Composition id

Payload
string
composer

Examples

"string"
This example has been generated automatically.

Pub zbos/composition/save

Save composition

Accepts the following message:

Payload
object

Additional properties are allowed.

composer

Examples

{}
This example has been generated automatically.

Pub zbos/composition/status/get

Get composition status

Accepts the following message:

Payload
object
key
string

Additional properties are allowed.

composer

Examples

{
  "key": "string"
}
This example has been generated automatically.

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

response: Composition status

Accepts the following message:

Payload
object
state
string

DEFAULT, PLAYING or PAUSED

activeBlocks
array<string>

Items:

0
string

Block ID

Additional items are allowed.

properties
object

Composition properties

Additional properties are allowed.

playCount
int

Current repeat iteration

Additional properties are allowed.

composer

Examples

{
  "state": "string",
  "activeBlocks": [
    "string"
  ],
  "properties": {},
  "playCount": null
}
This example has been generated automatically.

Pub zbos/composition/save/multiple

Save multiple compositions

Accepts the following message:

Payload
object
key
string

Optional key

compositions
array<object>

Array of compositions

Items:

0
object

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

composer

Examples

{
  "key": "string",
  "compositions": [
    {}
  ]
}
This example has been generated automatically.

Pub zbos/composition/load

Load composition

Accepts the following message:

Payload
string
composer

Examples

"string"
This example has been generated automatically.

Pub zbos/composition/delete

Delete composition by id

Accepts the following message:

Payload
object
id
string

Additional properties are allowed.

composer

Examples

{
  "id": "string"
}
This example has been generated automatically.

Sub zbos/composition/delete/response

response: Delete composition

Accepts the following message:

Indicates success or fail

Payload
boolean
composer

Examples

true
This example has been generated automatically.

Pub zbos/composition/delete/all

Deletes all compositions

Accepts the following message:

emptyJson

empty json

Payload
object

Additional properties are allowed.

composer

Examples

{}
This example has been generated automatically.

Sub zbos/composition/end/event

event: Composition finished

Accepts the following message:

emptyJson

empty json

Payload
object

Additional properties are allowed.

composer

Examples

{}
This example has been generated automatically.

Sub zbos/composition/loop/event

event: Composition loop state

Accepts the following message:

Payload
object
infinite
boolean
repeatTimes
int

total loop count

currentRepeatTimes
int

current loop count

Additional properties are allowed.

composer

Examples

{
  "infinite": true,
  "repeatTimes": null,
  "currentRepeatTimes": null
}
This example has been generated automatically.

Sub zbos/composition/settings

Settings for a given composition

Accepts the following message:

Payload
object
timelineId
string

Composition ID

properties
object
loop
object

Loop related settings

Additional properties are allowed.

general
object

General composition settings

Additional properties are allowed.

Additional properties are allowed.

Additional properties are allowed.

composer

Examples

{
  "timelineId": "string",
  "properties": {
    "loop": {},
    "general": {}
  }
}
This example has been generated automatically.

Sub zbos/composition/list

Get list of compositions

Accepts the following message:

emptyJson

empty json

Payload
object

Additional properties are allowed.

composer

Examples

{}
This example has been generated automatically.

Sub zbos/composition/list/event

event: Get list of compositions

Accepts the following message:

Payload
array<object>

Items:

0
object
name
string
id
string

Additional properties are allowed.

Additional items are allowed.

composer

Examples

[
  {
    "name": "string",
    "id": "string"
  }
]
This example has been generated automatically.

Sub zbos/composition/save/event

event: Composition Saved

Accepts the following message:

emptyJson

empty json

Payload
object

Additional properties are allowed.

composer

Examples

{}
This example has been generated automatically.

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

response: Save multiple compositions

Key value object:
Key: The id of the composition.
Value: Whether it saved successfully.

Parameters
key
required
string

Accepts the following message:

Payload
object

Additional properties are allowed.

composer

Examples

{}
This example has been generated automatically.

Sub zbos/composition/load/event

event: Composition loaded

Accepts the following message:

emptyJson

empty json

Payload
object

Additional properties are allowed.

composer

Examples

{}
This example has been generated automatically.

Pub zbos/composition/default/variable/request

Get default composition variables

Accepts the following message:

Payload
object
key
string

Optional key

Additional properties are allowed.

composer

Examples

{
  "key": "string"
}
This example has been generated automatically.

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

response: Get default composition variables

Parameters
key
required
string

Accepts the following message:

Payload
array<string>

Items:

0
string

Variable name

Additional items are allowed.

composer

Examples

[
  "string"
]
This example has been generated automatically.

Pub zbos/domotica/get/settings

Get settings

Accepts the following message:

keyMessage

Random key

Payload
string

Required random key

Examples: { "key": "ABCxyz" }
domotics

Examples

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

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

Get settings response

Accepts the following message:

Payload
array<object>
Examples: [ { "brand": "creadomotics", "login": "admin", "password": "admin", "ip": "192.168.0.123" }, { "brand": "homeassistant", "login": "admin", "password": "admin", "ip": "192.168.0.123" } ]

Items:

0
object
brand
string
login
string
password
string
ip
string

Additional properties are allowed.

Additional items are allowed.

domotics

Examples

Example #1
[
  {
    "brand": "creadomotics",
    "login": "admin",
    "password": "admin",
    "ip": "192.168.0.123"
  },
  {
    "brand": "homeassistant",
    "login": "admin",
    "password": "admin",
    "ip": "192.168.0.123"
  }
]

Pub zbos/domotica/get/status

Get status

Accepts the following message:

keyMessage

Random key

Payload
string

Required random key

Examples: { "key": "ABCxyz" }
domotics

Examples

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

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

Get status response

Accepts the following message:

Payload
array<object>
Examples: [ { "brand": "creadomotics", "state": "CONNECTION_FAILED" }, { "brand": "homeassistant", "state": "CONNECTION_SUCCEEDED" } ]

Items:

0
object
brand
string
state
string

Can be: INITIALIZING, CONNECTING, CONNECTION_FAILED, CONNECTION_SUCCEEDED

Additional properties are allowed.

Additional items are allowed.

domotics

Examples

Example #1
[
  {
    "brand": "creadomotics",
    "state": "CONNECTION_FAILED"
  },
  {
    "brand": "homeassistant",
    "state": "CONNECTION_SUCCEEDED"
  }
]

Pub zbos/domotica/set/setting

Set settings

Sets login, pasword 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:

Payload
object
Examples: { "brand": "creadomotics", "login": "admin", "password": "admin", "ip": "192.168.0.123" }
brand
string
login
string
password
string
ip
string

Additional properties are allowed.

domotics

Examples

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/config from the device.

Accepts the following message:

emptyJson

empty json

Payload
object

Additional properties are allowed.

domotics

Examples

{}
This example has been generated automatically.

Pub zbos/domotica/get/devices

Get devices

Accepts the following message:

keyMessage

Random key

Payload
string

Required random key

Examples: { "key": "ABCxyz" }
domotics

Examples

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

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

Get devices response

Accepts the following message:

Payload
array<object>
Examples: [ { "brand": "creadomotics", "id": 123, "room": "kitchen", "tags": [ "bar" ], "type": "dimmer" }, { "brand": "homeassistant", "id": "light.kitchen_1", "room": "kitchen", "tags": [ "kitchen" ], "type": "light" } ]

Items:

0
object
brand
string
id
string
room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

type
string

Additional properties are allowed.

Additional items are allowed.

domotics

Examples

Example #1
[
  {
    "brand": "creadomotics",
    "id": 123,
    "room": "kitchen",
    "tags": [
      "bar"
    ],
    "type": "dimmer"
  },
  {
    "brand": "homeassistant",
    "id": "light.kitchen_1",
    "room": "kitchen",
    "tags": [
      "kitchen"
    ],
    "type": "light"
  }
]

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:

Payload
object
Examples: { "brand": "creadomotics", "id": "123", "room": "kitchen", "tags": [ "bar" ], "type": "light" }
brand
string
id
string
room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

type
string

Additional properties are allowed.

domotics

Examples

Example #1
{
  "brand": "creadomotics",
  "id": "123",
  "room": "kitchen",
  "tags": [
    "bar"
  ],
  "type": "light"
}

Pub zbos/domotica/delete/device

Delete device

Accepts the following message:

Payload
object
id
string

Additional properties are allowed.

domotics

Examples

{
  "id": "string"
}
This example has been generated automatically.

Pub zbos/domotica/delete/devices/all

Delete all devices

Deletes all locally configured devices.

Accepts the following message:

emptyJson

empty json

Payload
object

Additional properties are allowed.

domotics

Examples

{}
This example has been generated automatically.

Pub zbos/domotica/get/rooms

Get rooms

Accepts the following message:

keyMessage

Random key

Payload
string

Required random key

Examples: { "key": "ABCxyz" }
domotics

Examples

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

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

Get rooms response

Accepts the following message:

Payload
array<object>
Examples: [ { "key": "kitchen", "devices": [ { "brand": "creadomotics", "id": 123, "room": "kitchen", "tags": [ "bar" ], "type": "dimmer" }, { "brand": "homeassistant", "id": "light.kitchen_1", "room": "kitchen", "tags": [ "kitchen" ], "type": "light" } ] }, { "key": "living", "devices": [ { "brand": "creadomotics", "id": 123, "room": "living", "tags": [ "table" ], "type": "light" } ] } ]

Items:

0
object
key
string
devices
array<object>

Items:

0
object
brand
string
id
string
room
string
tags
array<string>

Items:

0
string

Additional items are allowed.

type
string

Additional properties are allowed.

Additional items are allowed.

Additional properties are allowed.

Additional items are allowed.

domotics

Examples

Example #1
[
  {
    "key": "kitchen",
    "devices": [
      {
        "brand": "creadomotics",
        "id": 123,
        "room": "kitchen",
        "tags": [
          "bar"
        ],
        "type": "dimmer"
      },
      {
        "brand": "homeassistant",
        "id": "light.kitchen_1",
        "room": "kitchen",
        "tags": [
          "kitchen"
        ],
        "type": "light"
      }
    ]
  },
  {
    "key": "living",
    "devices": [
      {
        "brand": "creadomotics",
        "id": 123,
        "room": "living",
        "tags": [
          "table"
        ],
        "type": "light"
      }
    ]
  }
]

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:

Payload
object
Examples: { "device_types": [ "light", "dimmer" ] } { "device_types": [ "all" ] } { "device_types": null }
device_types
array<string>

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

Example #1
{
  "device_types": [
    "light",
    "dimmer"
  ]
}
Example #2
{
  "device_types": [
    "all"
  ]
}
Example #3
{
  "device_types": null
}

Sub zbos/domotica/event

Domotica event

Domotica device state changes trigger this event.

Accepts the following message:

Payload
object
Examples: { "id": 123, "room": "living", "type": "motion", "state": { "value": "ON" }, "tags": [ "tag1", "tag2" ] }
id
string
room
string
type
string
state
object
value

Additional properties are allowed.

tags
array

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

Example #1
{
  "id": 123,
  "room": "living",
  "type": "motion",
  "state": {
    "value": "ON"
  },
  "tags": [
    "tag1",
    "tag2"
  ]
}

Sub zbos/domotica/device/event/{devideId}/{value}

Device event

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

Accepts the following message:

Payload
object

Additional properties are allowed.

domotics

Examples

{}
This example has been generated automatically.

Sub zbos/domotica/plugin/event

Plugin event

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

Accepts the following message:

Payload
object
Examples: { "brand": "homeassistant", "state": "INITIALIZING" }
brand
string
state
string

Can be: INITIALIZING, CONNECTING, CONNECTION_FAILED, CONNECTION_SUCCEEDED

Additional properties are allowed.

domotics

Examples

Example #1
{
  "brand": "homeassistant",
  "state": "INITIALIZING"
}

Pub zbos/domotica/set/device/bool

Set device

Generic device boolean setter. All devices in given room of given type including all given tags will be adressed.

Accepts the following message:

Payload
object
Examples: { "state": true, "type": "light", "room": "living", "tags": [ "test1", "test2" ] }
state
boolean

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

type
string

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

room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

Example #1
{
  "state": true,
  "type": "light",
  "room": "living",
  "tags": [
    "test1",
    "test2"
  ]
}

Pub zbos/domotica/get/light

Get light

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

Accepts the following message:

Payload
object
key
string
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

{
  "key": "string",
  "room": "string",
  "tags": [
    "string"
  ]
}
This example has been generated automatically.

Pub zbos/domotica/set/light

Set light

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

Accepts the following message:

Payload
object
Examples: { "state": true, "room": "living", "tags": [ "test1", "test2" ] }
state
boolean

true for on, false for off

room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

Example #1
{
  "state": true,
  "room": "living",
  "tags": [
    "test1",
    "test2"
  ]
}

Pub zbos/domotica/get/dimmer

Get dimmer

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

Accepts the following message:

Payload
object
key
string
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

{
  "key": "string",
  "room": "string",
  "tags": [
    "string"
  ]
}
This example has been generated automatically.

Pub zbos/domotica/set/dimmer

Set light

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

Accepts the following message:

Payload
object
Examples: { "value": 100, "room": "kitchen", "tags": [ "sink" ] }
value
int

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

room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

Example #1
{
  "value": 100,
  "room": "kitchen",
  "tags": [
    "sink"
  ]
}

Pub zbos/domotica/get/switch

Get switch

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

Accepts the following message:

Payload
object
key
string
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

{
  "key": "string",
  "room": "string",
  "tags": [
    "string"
  ]
}
This example has been generated automatically.

Pub zbos/domotica/set/switch

Set switch

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

Accepts the following message:

Payload
object
Examples: { "state": true, "room": "living", "tags": [ "test1", "test2" ] }
state
boolean

true for on, false for off

room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

Example #1
{
  "state": true,
  "room": "living",
  "tags": [
    "test1",
    "test2"
  ]
}

Pub zbos/domotica/get/door

Get door

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

Accepts the following message:

Payload
object
key
string
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

{
  "key": "string",
  "room": "string",
  "tags": [
    "string"
  ]
}
This example has been generated automatically.

Pub zbos/domotica/set/door

Set door

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

Accepts the following message:

Payload
object
Examples: { "state": true, "room": "living", "tags": [ "kitchen" ] }
state
boolean

true for open, false for closed

room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

Example #1
{
  "state": true,
  "room": "living",
  "tags": [
    "kitchen"
  ]
}

Pub zbos/domotica/get/shutter

Get shutter

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

Accepts the following message:

Payload
object
key
string
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

{
  "key": "string",
  "room": "string",
  "tags": [
    "string"
  ]
}
This example has been generated automatically.

Pub zbos/domotica/set/shutter

Set shutter

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

Accepts the following message:

Payload
object
Examples: { "state": true, "room": "living", "tags": [ "kitchen" ] }
state
boolean

true for open, false for closed

room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

Example #1
{
  "state": true,
  "room": "living",
  "tags": [
    "kitchen"
  ]
}

Pub zbos/domotica/get/speaker

Get speaker

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

Accepts the following message:

Payload
object
key
string
room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

{
  "key": "string",
  "room": "string",
  "tags": [
    "string"
  ]
}
This example has been generated automatically.

Pub zbos/domotica/set/speaker

Set speaker

All speakers in given room including all given tags will be adressed. See commands property for functionality.

Accepts the following message:

Payload
object
Examples: { "command": "play", "room": "master bedroom" } { "command": "set volume", "value": 50, "room": "master bedroom" }
command
string

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

value
int

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

room
string

Optional

tags
array<string>

Optional

Items:

0
string

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

Example #1
{
  "command": "play",
  "room": "master bedroom"
}
Example #2
{
  "command": "set volume",
  "value": 50,
  "room": "master bedroom"
}

Pub zbos/domotica/get/doorsensor

Get doorsensor

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

Accepts the following message:

Payload
object
key
string
room
string

Optional

tags
array

Optional

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

{
  "key": "string",
  "room": "string",
  "tags": []
}
This example has been generated automatically.

Pub zbos/domotica/get/motionsensor

Get motionsensor

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

Accepts the following message:

Payload
object
key
string
room
string

Optional

tags
array

Optional

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

{
  "key": "string",
  "room": "string",
  "tags": []
}
This example has been generated automatically.

Pub zbos/domotica/get/floodsensor

Get floodsensor

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

Accepts the following message:

Payload
object
key
string
room
string

Optional

tags
array

Optional

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

{
  "key": "string",
  "room": "string",
  "tags": []
}
This example has been generated automatically.

Pub zbos/domotica/get/lightsensor

Get lightsensor

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

Accepts the following message:

Payload
object
key
string
room
string

Optional

tags
array

Optional

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

{
  "key": "string",
  "room": "string",
  "tags": []
}
This example has been generated automatically.

Pub zbos/domotica/get/temperature

Get temperature

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

Accepts the following message:

Payload
object
key
string
room
string

Optional

tags
array

Optional

Additional items are allowed.

Additional properties are allowed.

domotics

Examples

{
  "key": "string",
  "room": "string",
  "tags": []
}
This example has been generated automatically.

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.

Accepts the following message:

Payload
object
Examples: { "scene": "demo scene", "room": "kitchen" }
scene
string
room
string

Optional

Additional properties are allowed.

domotics

Examples</