Domotics

API for communication with ZBOS by Zora Robotics.

Channels

zbos/domotics/systems/get

PUB Get domotics systems

see zbos/domotics/systems/get/response/\{key} for response

Channel tags

  • Domotics

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

zbos/domotics/systems/get/response/\{key}

SUB Get domotics systems response

All domotics systems that are configured

Channel tags

  • Domotics

Array<DomoticsSystem>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. id

string

unique id of the domotics system

Any

Message Payload. brand

string

brand of the domotics system, eg: homeassistant, creadomotics, …​

Any

Message Payload. state

string

state of the domotics system

* initializing * connecting * connected * not_connected

Message Payload. name

string

human-readable name of the domotics system

Any
Examples of payload
{
  "id": "homeassistant_0d8cfe8b42594518975c10ebafe04c0c",
  "brand": "homeassistant",
  "state": "initializing",
  "name": "Home Assistant - Home"
}

zbos/domotics/systems/changed/event

SUB Domotics systems changed event

Fires all systems when the configuration of any of the domotics systems changes

Channel tags

  • Domotics

Array<DomoticsSystem>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. id

string

unique id of the domotics system

Any

Message Payload. brand

string

brand of the domotics system, eg: homeassistant, creadomotics, …​

Any

Message Payload. state

string

state of the domotics system

* initializing * connecting * connected * not_connected

Message Payload. name

string

human-readable name of the domotics system

Any
Examples of payload
{
  "id": "homeassistant_0d8cfe8b42594518975c10ebafe04c0c",
  "brand": "homeassistant",
  "state": "connected",
  "name": "Home Assistant - Home"
}

zbos/domotics/devices/get

PUB Get domotics devices

see zbos/domotics/devices/get/response/\{key} for response

Channel tags

  • Domotics

DomoticsDevicesGetRequest
Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

ids

array (string)

Optional, device ids to filter on

Any

rooms

array (string)

Optional, room ids to filter on

Any

tags

array (string)

Optional, tags to filter on

Any

type

string

Optional, device type to filter on

Any

system_ids

array (string)

Optional, system ids to filter on

Any

with_actions_only

boolean

Optional, if set to true, only devices with actions will be returned

Any

language

string

Optional. Set the language for all labels. Otherwise it will be the default language. The language format is ISO 639-1 language code, Eg: 'en' or 'en-US'

Any
Examples of payload
{
  "key": "abc"
}
{
  "key": "abc",
  "ids": [
    "light.kitchen"
  ]
}
{
  "key": "abc",
  "rooms": [
    "kitchen"
  ]
}
{
  "key": "abc",
  "tags": [
    "kitchen",
    "central"
  ]
}
{
  "key": "abc",
  "type": "light"
}
{
  "key": "abc",
  "system_ids": [
    "homeassistant_0d8cfe8b42594518975c10ebafe04c0c"
  ]
}
{
  "key": "abc",
  "with_actions_only": true
}

zbos/domotics/devices/get/response/\{key}

SUB Get domotics devices response

All domotics devices that are configured

Channel tags

  • Domotics

Array<DomoticsDevice>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. id

string

Unique id

Any

Message Payload. type

string

Device type. Different brands have different types

Any

Message Payload. type_generic

string

Generic brand-independent device type

Any

Message Payload. type_translation

string

Human-readable representation of the generic type

Any

Message Payload. name

string

Human-readable name

Any

Message Payload. room

string

Optional, id of the room the device is in

Any

Message Payload. tags

array (string)

Optional, list of tags the device has

Any

Message Payload. system_id

string

System ID this device belongs to

Any

Message Payload. brand

string

Brand of the system this device belongs to

Any

Message Payload. actions

object

Definitions of all actions you can perform with the device

Any

Message Payload. attributes

object

Definitions of all attributes of the device

Any
Examples of payload
{
  "id": "light.kitchen",
  "type": "light",
  "name": "Central light in the kitchen",
  "room": "kitchen",
  "tags": [
    "kitchen",
    "central"
  ],
  "brand": "homeassistant",
  "actions": {
    "turn_on": {
      "label": "Turn On",
      "components": {
        "brightness": {
          "required": false,
          "type": "integer",
          "label": "Brightness",
          "range": {
            "min": 0,
            "max": 255
          }
        }
      }
    },
    "turn_off": {
      "label": "Turn Off"
    },
    "toggle": {
      "label": "Toggle",
      "components": {
        "brightness": {
          "required": false,
          "type": "integer",
          "label": "Brightness",
          "range": {
            "min": 0,
            "max": 255
          }
        }
      }
    }
  },
  "attributes": {
    "state": {
      "type": "select_single",
      "label": "State",
      "options": [
        {
          "key": "on",
          "value": "on",
          "label": "On"
        },
        {
          "key": "off",
          "value": "off",
          "label": "Off"
        }
      ]
    },
    "brightness": {
      "type": "integer",
      "label": "Brightness",
      "range": {
        "min": 0,
        "max": 255
      }
    }
  },
  "type_generic": "light",
  "type_translation": "Light",
  "system_id": "homeassistant_0d8cfe8b42594518975c10ebafe04c0c"
}

zbos/domotics/devices/actions/execute

PUB Update device state

Updates all devices that match the "ids", "rooms", "tags", and "system_ids" filter |Leave any of the filters empty to ignore them.

Channel tags

  • Domotics

DomoticsDevicesActionsExecuteRequest
Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

ids

array (string)

Optional, Ids of the devices

Any

rooms

array (string)

Optional, Rooms of the devices

Any

tags

array (string)

Optional, Tags of the devices

Any

system_ids

array (string)

Optional, System Ids of devices

Any

type

string

Type of the device

Any

action

string

Action that should be performed

Any

attributes

object

Map of attributes for the action

Any
Examples of payload
{
  "key": "abc",
  "ids": [
    "light.kitchen"
  ],
  "type": "light",
  "action": "turn_on",
  "attributes": {
    "brightness": 112
  }
}
{
  "key": "abc",
  "rooms": [
    "kitchen"
  ],
  "tags": [
    "central"
  ],
  "type": "light",
  "action": "turn_off",
  "system_ids": [
    "homeassistant_0d8cfe8b42594518975c10ebafe04c0c"
  ]
}

zbos/domotics/devices/actions/execute/response/\{key}

SUB Update device state response

Channel tags

  • Domotics

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/domotics/states/get

PUB Get domotics states

see zbos/domotics/states/get/response/\{key} for response

Channel tags

  • Domotics

DomoticsStatesGetRequest
Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

ids

array (string)

Optional, ids to filter on

Any

rooms

array (string)

Optional, room ids to filter on

Any

tags

array (string)

Optional, tags to filter on

Any

type

string

Optional, type to filter on

Any

system_ids

array (string)

Optional, system ids to filter on

Any
Examples of payload
{
  "key": "abc"
}
{
  "key": "abc",
  "ids": [
    "light.kitchen"
  ]
}
{
  "key": "abc",
  "rooms": [
    "kitchen"
  ]
}
{
  "key": "abc",
  "tags": [
    "kitchen",
    "central"
  ]
}
{
  "key": "abc",
  "type": "light"
}
{
  "key": "abc",
  "system_ids": [
    "homeassistant_0d8cfe8b42594518975c10ebafe04c0c"
  ]
}

zbos/domotics/states/get/response/\{key}

SUB Get domotics states response

All the domotics states with their full data

Channel tags

  • Domotics

Array<DomoticsState>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. id

string

Unique id

Any

Message Payload. type

string

Device type

Any

Message Payload. name

string

Human-readable name

Any

Message Payload. room

string

Optional, id of the room the device is in

Any

Message Payload. tags

array (string)

Optional, list of tags the device has

Any

Message Payload. system_id

string

System ID this device belongs to

Any

Message Payload. brand

string

Brand of the system this device belongs to

Any

Message Payload. state

string

The main state value

Any

Message Payload. data

object

The entire JSON as returned by the domotics system

Any
Examples of payload
{
  "id": "light.kitchen",
  "type": "light",
  "name": "Central light in the kitchen",
  "room": "kitchen",
  "tags": [
    "kitchen",
    "central"
  ],
  "brand": "homeassistant",
  "state": "on",
  "data": {
    "entity_id": {
      "content": "light.kitchen",
      "string": true
    },
    "state": {
      "content": "on",
      "string": true
    },
    "attributes": {
      "supported_color_modes": [
        {
          "content": "brightness",
          "string": true
        }
      ],
      "color_mode": {
        "content": "brightness",
        "string": true
      },
      "brightness": {
        "content": "22",
        "string": false
      },
      "friendly_name": {
        "content": "Central light in the kitchen",
        "string": true
      },
      "supported_features": {
        "content": "0",
        "string": false
      }
    },
    "last_changed": {
      "content": "2021-07-08T07:06:46.351322+00:00",
      "string": true
    },
    "last_updated": {
      "content": "2021-07-08T07:07:14.279327+00:00",
      "string": true
    },
    "context": {
      "id": {
        "content": "4dd02cfa0ba03df611e6b468d84a61b0",
        "string": true
      },
      "parent_id": {
        "string": false,
        "content": "null"
      },
      "user_id": {
        "string": false,
        "content": "null"
      }
    }
  },
  "system_id": "homeassistant_0d8cfe8b42594518975c10ebafe04c0c"
}

zbos/domotics/states/changed/event

SUB Domotics state changed event

Fired when a state changed

Channel tags

  • Domotics

DomoticsState
Payload

Name

Type

Description

Accepted values

id

string

Unique id

Any

type

string

Device type

Any

name

string

Human-readable name

Any

room

string

Optional, id of the room the device is in

Any

tags

array (string)

Optional, list of tags the device has

Any

system_id

string

System ID this device belongs to

Any

brand

string

Brand of the system this device belongs to

Any

state

string

The main state value

Any

data

object

The entire JSON as returned by the domotics system

Any
Examples of payload
{
  "id": "light.kitchen",
  "type": "light",
  "name": "Central light in the kitchen",
  "room": "kitchen",
  "tags": [
    "kitchen",
    "central"
  ],
  "brand": "homeassistant",
  "state": "on",
  "data": {
    "entity_id": {
      "content": "light.kitchen",
      "string": true
    },
    "old_state": {
      "entity_id": {
        "content": "light.kitchen",
        "string": true
      },
      "state": {
        "content": "on",
        "string": true
      },
      "attributes": {
        "supported_color_modes": [
          {
            "content": "brightness",
            "string": true
          }
        ],
        "color_mode": {
          "content": "brightness",
          "string": true
        },
        "brightness": {
          "content": "22",
          "string": false
        },
        "friendly_name": {
          "content": "Central light in the kitchen",
          "string": true
        },
        "supported_features": {
          "content": "0",
          "string": false
        }
      },
      "last_changed": {
        "content": "2021-07-08T07:06:46.351322+00:00",
        "string": true
      },
      "last_updated": {
        "content": "2021-07-08T07:07:14.279327+00:00",
        "string": true
      },
      "context": {
        "id": {
          "content": "4dd02cfa0ba03df611e6b468d84a61b0",
          "string": true
        },
        "parent_id": {
          "string": false,
          "content": "null"
        },
        "user_id": {
          "string": false,
          "content": "null"
        }
      }
    },
    "new_state": {
      "entity_id": {
        "content": "light.kitchen",
        "string": true
      },
      "state": {
        "content": "off",
        "string": true
      },
      "attributes": {
        "supported_color_modes": [
          {
            "content": "brightness",
            "string": true
          }
        ],
        "color_mode": {
          "content": "brightness",
          "string": true
        },
        "brightness": {
          "content": "0",
          "string": false
        },
        "friendly_name": {
          "content": "Central light in the kitchen",
          "string": true
        },
        "supported_features": {
          "content": "0",
          "string": false
        }
      },
      "last_changed": {
        "content": "2021-07-08T07:06:46.351322+00:00",
        "string": true
      },
      "last_updated": {
        "content": "2021-07-08T07:07:14.279327+00:00",
        "string": true
      },
      "context": {
        "id": {
          "content": "4dd02cfa0ba03df611e6b468d84a61b0",
          "string": true
        },
        "parent_id": {
          "string": false,
          "content": "null"
        },
        "user_id": {
          "string": false,
          "content": "null"
        }
      }
    }
  },
  "system_id": "homeassistant_0d8cfe8b42594518975c10ebafe04c0c"
}

zbos/domotics/events/types/get

PUB Get domotics event types

see zbos/domotics/events/types/get/response/\{key} for response

Channel tags

  • Domotics

DomoticsEventTypesGetRequest
Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

system_ids

array (string)

Optional, system ids to filter on

Any
Examples of payload
{
  "key": "abc",
  "system_ids": [
    "homeassistant_0d8cfe8b42594518975c10ebafe04c0c"
  ]
}

zbos/domotics/events/types/get/response/\{key}

SUB Get domotics event types response

All the possible event types that can occur

Channel tags

  • Domotics

Array<DomoticsEventType>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. type

string

Type key of the event type

Any

Message Payload. system_ids

array (string)

System ids that have this event type

Any
Examples of payload
{
  "type": "knx_event",
  "system_ids": [
    "homeassistant_0d8cfe8b42594518975c10ebafe04c0c"
  ]
}

zbos/domotics/events/event

SUB Domotics event

Fired when a domotics event is fired

Channel tags

  • Domotics

DomoticsEvent
Payload

Name

Type

Description

Accepted values

type

string

Type of the event

Any

system_id

string

System ID this event originates from

Any

data

object

The entire JSON of the event data, as returned by the domotics system

Any
Examples of payload
{
  "type": "knx_event",
  "data": {
    "data": [
      {
        "content": "255",
        "string": false
      }
    ],
    "destination": {
      "content": "0/4/1",
      "string": true
    },
    "direction": {
      "content": "Incoming",
      "string": true
    },
    "source": {
      "content": "1.1.1",
      "string": true
    },
    "telegramtype": {
      "content": "GroupValueWrite",
      "string": true
    }
  },
  "system_id": "homeassistant_0d8cfe8b42594518975c10ebafe04c0c"
}

zbos/domotics/camera/image/get

PUB Get camera image

see zbos/domotics/camera/image/get/response/\{key} for response

Channel tags

  • Domotics

DomoticsCameraImageGetRequest
Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

id

string

Required ID of the camera device

Any

system_id

string

Optional, system id to filter on

Any
Examples of payload
{
  "key": "abc",
  "id": "camera.frontdoor",
  "system_id": "homeassistant_0d8cfe8b42594518975c10ebafe04c0c"
}

zbos/domotics/camera/image/get/response/\{key}

SUB Get domotics image response

Image of the camera

Channel tags

  • Domotics

DomoticsCameraImageResponse
Payload

Name

Type

Description

Accepted values

base64

string

Base64-encoded representation of the image

Any
Examples of payload
{
  "base64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mM81MX1HwAFwwJXcxcsuQAAAABJRU5ErkJggg"
}

zbos/domotics/homeassistant/services/call

PUB Call Home Assistant service

Call a Home Assistant service, see https://www.home-assistant.io/docs/scripts/service-calls\ for more information.

Channel tags

  • Domotics

HomeAssistantServiceCall
Payload

Name

Type

Description

Accepted values

domain

string

The domain of the service, eg: 'light'

Any

service

string

The service itself, eg: 'turn_on'

Any

data

object

The data that should be passed to the service

Any

system_ids

array (string)

Optional, system ids of Home Assistant instances this call should execute on

Any
Examples of payload
{
  "domain": "light",
  "service": "turn_on",
  "data": {
    "entity_id": "light.kitchen",
    "brightness": 50
  },
  "system_ids": [
    "homeassistant_0d8cfe8b42594518975c10ebafe04c0c"
  ]
}

zbos/domotics/homeassistant/services/call_response

SUB Call Home Assistant service response

Channel tags

  • Domotics

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/domotics/discovery/entries/get

PUB Get discovered domotics entries

These domotics entries must be configured before they can be used

Channel tags

  • Domotics

DomoticsDiscoveryEntriesGetRequest
Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

system_ids

array (string)

Optional, System Ids of devices

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

zbos/domotics/discovery/entries/get/response/\{key}

SUB response: Get discovered domotics entries

Channel tags

  • Domotics

Array<DomoticsDiscoveryEntry>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. id

string

Identifier for this discovery entry

Any

Message Payload. handler

string

Integration that handles the configuration of this discovery entry

Any

Message Payload. name

string

Human-readable name for this discovery entry

Any

Message Payload. icon_url

string

URL path to the entry icon, this is usually an icon for the handler

Any

Message Payload. step_id

string

The current step of the discovery process

Any
Examples of payload
{
  "id": "entry1",
  "handler": "entry1_handler",
  "name": "Entry 1",
  "step_id": "discovery_confirm"
}

zbos/domotics/discovery/device/translation/get

PUB Get device title translations

Channel tags

  • Domotics

DomoticsDiscoveryTranslationGetRequest
Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

handler

string

Optional, only used for config translations. Handler to retrieve translations from

Any

language

string

ISO 639-1 language code, Eg: 'en' or 'en-US'

Any

system_id

string

Optional, system id to filter on

Any
Examples of payload
{
  "key": "test",
  "language": "en-US"
}

zbos/domotics/discovery/device/translation/get/response/\{key}

SUB response: Get device title translations

Channel tags

  • Domotics

Map
Payload

Name

Type

Description

Accepted values

Message Payload

object

Any
Examples of payload
{
  "component.entry1_handler.title": "Entry 1",
  "component.entry2_handler.title": "Entry 2"
}

zbos/domotics/discovery/config/form/get

PUB Get the config form for a discovered entry

This form can be used to construct a dialog for UI apps to configure the entry

Channel tags

  • Domotics

DomoticsDiscoveryConfigFormGetRequest
Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

entry_id

string

ID of the entry to retrieve

Any

system_id

string

Optional, system id to filter on

Any
Examples of payload
{
  "key": "test",
  "entry_id": "entry1"
}

zbos/domotics/discovery/config/form/get/response/\{key}

SUB response: Get the config form for a discovered entry

Channel tags

  • Domotics

DomoticsDiscoveryConfigForm
Payload

Name

Type

Description

Accepted values

handler

string

Integration that handles the configuration of this discovery entry

Any

step_id

string

The current step of the discovery process

Any

data_schema

array (object)

Schema to build and validate user input

Any

data_schema. name

string

Any

data_schema. type

string

* grid * constant * integer * select * multi_select * float * string * boolean * positive_time_period_dict

data_schema. default

object

Any

data_schema. required

boolean

Any

data_schema. description

object

Any

data_schema.description. suffix

string

Any

data_schema.description. suggested_value

object

Any

data_schema. context

object

Any

data_schema. column_min_width

string

Grid type only

Any

data_schema. schema

array (object)

Grid type only

Any

data_schema. selector

object

Any

data_schema.selector. action

object

Any

data_schema.selector. addon

object

Any

data_schema.selector.addon. name

string

Any

data_schema.selector.addon. slug

string

Any

data_schema.selector. area

object

Any

data_schema.selector.area. entity

object

Any

data_schema.selector.area.entity. integration

string

Any

data_schema.selector.area.entity. domain

object

String or array of strings

Any

data_schema.selector.area.entity. device_class

string

Any

data_schema.selector.area.entity. multiple

boolean

Any

data_schema.selector.area.entity. includeEntities

array (string)

Any

data_schema.selector.area.entity. excludeEntities

array (string)

Any

data_schema.selector.area. device

object

Any

data_schema.selector.area.device. integration

string

Any

data_schema.selector.area.device. manufacturer

string

Any

data_schema.selector.area.device. model

string

Any

data_schema.selector.area.device. entity

object

Any

data_schema.selector.area.device.entity. integration

string

Any

data_schema.selector.area.device.entity. domain

object

String or array of strings

Any

data_schema.selector.area.device.entity. device_class

string

Any

data_schema.selector.area.device.entity. multiple

boolean

Any

data_schema.selector.area.device.entity. includeEntities

array (string)

Any

data_schema.selector.area.device.entity. excludeEntities

array (string)

Any

data_schema.selector.area.device. multiple

boolean

Any

data_schema.selector.area. multiple

boolean

Any

data_schema.selector. attribute

object

Any

data_schema.selector.attribute. entity_id

string

Any

data_schema.selector. boolean

object

Any

data_schema.selector. color_rgb

object

Any

data_schema.selector. color_temp

object

Any

data_schema.selector.color_temp. min_mireds

number

Any

data_schema.selector.color_temp. max_mireds

number

Any

data_schema.selector. date

object

Any

data_schema.selector. datetime

object

Any

data_schema.selector. device

object

Any

data_schema.selector.device. integration

string

Any

data_schema.selector.device. manufacturer

string

Any

data_schema.selector.device. model

string

Any

data_schema.selector.device. entity

object

Any

data_schema.selector.device.entity. integration

string

Any

data_schema.selector.device.entity. domain

object

String or array of strings

Any

data_schema.selector.device.entity. device_class

string

Any

data_schema.selector.device.entity. multiple

boolean

Any

data_schema.selector.device.entity. includeEntities

array (string)

Any

data_schema.selector.device.entity. excludeEntities

array (string)

Any

data_schema.selector.device. multiple

boolean

Any

data_schema.selector. duration

object

Any

data_schema.selector.duration. enable_day

boolean

Any

data_schema.selector. entity

object

Any

data_schema.selector.entity. integration

string

Any

data_schema.selector.entity. domain

object

String or array of strings

Any

data_schema.selector.entity. device_class

string

Any

data_schema.selector.entity. multiple

boolean

Any

data_schema.selector.entity. includeEntities

array (string)

Any

data_schema.selector.entity. excludeEntities

array (string)

Any

data_schema.selector. icon

object

Any

data_schema.selector.icon. placeholder

string

Any

data_schema.selector.icon. fallbackPath

string

Any

data_schema.selector. location

object

Any

data_schema.selector.location. radius

boolean

Any

data_schema.selector.location. icon

string

Any

data_schema.selector. media

object

Any

data_schema.selector. number

object

Any

data_schema.selector.number. min

number

Any

data_schema.selector.number. max

number

Any

data_schema.selector.number. step

number

Any

data_schema.selector.number. mode

string

* box * slider

data_schema.selector.number. unit_of_measurement

string

Any

data_schema.selector. object

object

Any

data_schema.selector. select

object

Any

data_schema.selector.select. multiple

boolean

Any

data_schema.selector.select. custom_value

boolean

Any

data_schema.selector.select. mode

string

* list * dropdown

data_schema.selector.select. options

object

List of string or list of \{ value: string, label: string }

Any

data_schema.selector. text

object

Any

data_schema.selector.text. multiline

boolean

Any

data_schema.selector.text. type

string

* number * text * search * tel * url * email * password * date * month * week * time * datetime-local * color

data_schema.selector.text. suffix

string

Any

data_schema.selector. target

object

Any

data_schema.selector.target. entity

object

Any

data_schema.selector.target.entity. integration

string

Any

data_schema.selector.target.entity. domain

object

String or array of strings

Any

data_schema.selector.target.entity. device_class

string

Any

data_schema.selector.target.entity. multiple

boolean

Any

data_schema.selector.target.entity. includeEntities

array (string)

Any

data_schema.selector.target.entity. excludeEntities

array (string)

Any

data_schema.selector.target. device

object

Any

data_schema.selector.target.device. integration

string

Any

data_schema.selector.target.device. manufacturer

string

Any

data_schema.selector.target.device. model

string

Any

data_schema.selector.target.device. entity

object

Any

data_schema.selector.target.device.entity. integration

string

Any

data_schema.selector.target.device.entity. domain

object

String or array of strings

Any

data_schema.selector.target.device.entity. device_class

string

Any

data_schema.selector.target.device.entity. multiple

boolean

Any

data_schema.selector.target.device.entity. includeEntities

array (string)

Any

data_schema.selector.target.device.entity. excludeEntities

array (string)

Any

data_schema.selector.target.device. multiple

boolean

Any

data_schema.selector. template

object

Any

data_schema.selector. theme

object

Any

data_schema.selector. time

object

Any

data_schema. value

string

Constant type only

Any

data_schema. valueMin

integer

Integer type only

Any

data_schema. valueMax

integer

Integer type only

Any

data_schema. options

object

Select or multi-select type only

Any

data_schema. format

string

String type only

Any

errors

object

Optional errors dictionary

Any

description_placeholders

object

Detailed information about this step

Any
Examples of payload
{
  "handler": "entry1_handler",
  "errors": {},
  "step_id": "discovery_confirm",
  "data_schema": [
    {
      "name": "username",
      "type": "string",
      "required": true
    },
    {
      "name": "password",
      "type": "string",
      "required": true
    }
  ],
  "description_placeholders": {
    "name": "Entry 1",
    "ip_address": "192.168.0.1",
    "local_user_documentation_url": "https://google.com"
  }
}

zbos/domotics/discovery/config/form/submit

PUB Submit the config form for a discovered entry

This data should be validated according to the data schema

Channel tags

  • Domotics

DomoticsDiscoveryConfigFormSubmitRequest
Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

entry_id

string

ID of the entry to submit to

Any

data

object

The form data to submit, this should be a dictionary of the data schema received in the form get request

Any

system_id

string

Optional, system id to filter on

Any
Examples of payload
{
  "key": "test",
  "data": {
    "username": "testuser",
    "password": "testpassword"
  },
  "entry_id": "entry1"
}

zbos/domotics/discovery/config/form/submit/response/\{key}

SUB response: Submit the config form for a discovered entry

Channel tags

  • Domotics

DomoticsDiscoveryConfigFormSubmitResponse
Payload

Name

Type

Description

Accepted values

success

boolean

Any

errors

object

Errors, if any

Any
Examples of payload
{
  "success": true
}
{
  "success": false,
  "errors": {
    "password": "invalid_auth"
  }
}

zbos/domotics/discovery/config/translation/get

PUB Get translations for a discovery handler

Channel tags

  • Domotics

DomoticsDiscoveryTranslationGetRequest
Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

handler

string

Optional, only used for config translations. Handler to retrieve translations from

Any

language

string

ISO 639-1 language code, Eg: 'en' or 'en-US'

Any

system_id

string

Optional, system id to filter on

Any
Examples of payload
{
  "key": "test",
  "handler": "entry1_handler",
  "language": "en-US"
}

zbos/domotics/discovery/config/translation/get/response/\{key}

SUB response: Get translations for a discovery handler

Channel tags

  • Domotics

Map
Payload

Name

Type

Description

Accepted values

Message Payload

object

Any
Examples of payload
{
  "component.entry1_handler.config.error.invalid_auth": "Invalid authentication",
  "component.entry1_handler.config.flow_title": "{name} ({ip_address})",
  "component.entry1_handler.config.step.discovery_confirm.data.password": "Password",
  "component.entry1_handler.config.step.discovery_confirm.data.username": "Username",
  "component.entry1_handler.config.step.discovery_confirm.description": "Do you want to setup {name} ({ip_address})?",
  "component.entry1_handler.config.step.discovery_confirm.title": "Entry 1 Discovered"
}