Messages Overview

Destination

Message Purpose

Topic

LOGIN

Backend

Login request

backend/<device-type>/<device-id>/login

Device

Backend response

device/<device-type>/<device-id>/<token>/login

LOGOUT

Backend

Logout request

backend/<device-type>/<device-id>/logout

Device

Backend confirmation

device/<device-type>/<device-id>/<token>/logout

SETTINGS

Backend

Get device settings from backend

backend/<device-type>/<device-id>/getsettings

Device

Backend response

device/<device-type>/<device-id>/<token>/getsettings

SESSIONS

Backend

Open client session

backend/<device-type>/<device-id>/opensession

Device

Backend response

device/<device-type>/<device-id>/<token>/opensession

Backend

Close client session

backend/<device-type>/<device-id>/closesession

Device

Backend confirmation

device/<device-type>/<device-id>/<token>/closesession

Backend

Get currently opened/closed client session

backend/<device-type>/<device-id>/getsession

Device

Backend response

device/<device-type>/<device-id>/<token>/getsession

METADATA

Backend

Import CU Metadata

backend/<device-type>/<device-id>/metadata/<cu-type>/<cu-version>

Device

Backend confirmation

device/<device-type>/<device-id>/<token>/metadata/<cu-type>/<cu-version>

Backend

Import CU icon

backend/<device-type>/<device-id>/icon/<cu-type>/<cu-version>/<ocd-id>/<size>

Device

Backend confirmation

device/<device-type>/<device-id>/<token>/icon/<cu-type>/<cu-version>/<ocd-id>/<size>

CU TYPES

Backend

Inform the backend for CU Types and versions in the scope of the device

backend/<device-type>/<device-id>/settypes

Device

Backend response containing types with missing Metadata

device/<device-type>/<device-id>/<token>/settypes

Backend

Request the currently provided component types on the device

backend/<device-type>/<device-id>/gettypes

Device

Backend response

device/<device-type>/<device-id>/<token>/gettypes

Backend

Remove CU type from the scope of the device

backend/<device-type>/<device-id>/deldata/<cu-type>

Device

Backend confirmation

device/<device-type>/<device-id>/<token>/deldata/<cu-type>

CU DATA

Backend

General request for setting CU-related data of any kind, for any CU instance

backend/<device-type>/<device-id>/setdata

Device

Backend confirmation

device/<device-type>/<device-id>/<token>/setdata

Backend

Request for setting CU-related data of any kind, for specific CU instance

backend/<device-type>/<device-id>/setdata/<cu-type>/<cu-id>

Device

Backend confirmation

device/<device-type>/<device-id>/<token>/setdata/<cu-type>/<cu-id>

Backend

Request for setting CU state variable for specific CU instance

backend/<device-type>/<device-id>/setdata/<cu-type>/<cu-id>/<state-var-id>

Device

Backend confirmation

device/<device-type>/<device-id>/<token>/setdata/<cu-type>/<cu-id>/<state-var-id>

Backend

General request for getting CU state for one or more CU instances

backend/<device-type>/<device-id>/getdata

Device

Backend response

device/<device-type>/<device-id>/<token>/getdata

Backend

Request for getting CU state for specific CU instance

backend/<device-type>/<device-id>/getdata/<cu-type>/<cu-id>

Device

Backend response

device/<device-type>/<device-id>/<token>/getdata/<cu-type>/<cu-id>

Backend

Request for a state variable value of a specific CU

backend/<device-type>/<device-id>/getdata/<cu-type>/<cu-id>/<state-var-id>

Device

Backend response

device/<device-type>/<device-id>/<token>/getdata/<cu-type>/<cu-id>/<state-var-id>

Backend

Request for deleting a CU instance

backend/<device-type>/<device-id>/deldata/<cu-type>/<cu-id>

Device

Backend confirmation

device/<device-type>/<device-id>/<token>/deldata/<cu-type>/<cu-id>

ACTIONS

Device

Invoke a device action

device/<device-type>/<device-id>/<token>/invoke

Backend

Device response

backend/<device-type>/<device-id>/invoke

PING

Backend

Check backend status

backend/<device-type>/<device-id>/ping

Device

Backend response

device/<device-type>/<device-id>/<token>/ping


This chapter contains the following topics: