/
Description topics

Description topics

Owned by Joanna Kozakiewicz
Last updated: Mar 26, 2025
2 min read

Payload - In the context of communication protocols distinguishes metadata from actual data.

Payload returned on a discovery topic is a config message, describing the entities of devices.

State topic

In state topic all entities will give your system essential information on:

Type of information

Example

Type of information

Example

Unique ID of entity including device ID and type of entity.

unique_id: 17880107102b0c_light

Device Information including device ID, friendly name, manufacturer, LMS model, gateway through which it communicates.

device:

identifiers:

- 17880107102b0c

name: "Customers name/tag"

manufacturer: Glamox Connect API

model: Wireless Zigbee

suggested_area: mysitename

via_device: 001fee00000053a6

State topics will include different types of information depending on what type of device entity you are listening to.

Type of device

Type of information

Example

Type of device

Type of information

Example

  • Light

Device Location according to Glamox Connect Floorplan.

device_location:

floorplan_name: Floor 3

floorplan_id: 2bbd26bc-c1cc-4c73-b6f0-84cb43b5f8c5

floorplan_point:

'0.7114518843852604'

'0.05005221590401024'

room_id: b7d115c2-b910-40b8-93b7-99d6dc8b4535

room_name: LMS

  • Sensor

  • Binary_sensor

Device Class informs about the basic functionality of sensor

  • device_class: illuminance

  • device_class: occupancy

  • Sensor

Unite of measurement used by the sensor

unit_of_measurement: lx

  • Sensor

  • Binary_sensor

Value template is also included for the integrating system to know what the value field of this sensor is given as. In the example below the state will be reported as "lux": 480 in the json payload

  • value_template: '{{ value_json.lux }}'

  • value_template: '{{ value_json.presence }}'

Command topic

Command topic only comes as a response to your request if it is possible to control the device, so in this instance luminaires - light type of device

Type of information

Example

Type of information

Example

Brightness scale is the max value for brightness.
I.e. 100 means that the scale is 0-100

brightness_scale: 100

Color mode informs the system if the luminaire controls colour or brightness

color_mode: 'true'

Brightness support

brightness: 'true'

Supported color types:

  • brightness - only brightness control according to brightness_scale

  • color_temp - color_temp in mired and color_temp_kelvin as kelvin in addition to brightness

  • color - color control in addition to brightness and color_temp

supported_color_modes:

- brightness

- color_temp

- color_temp_kelvin

- color

Effect informs if there are effects you can activate on a light

effect: 'true'

Effect list will contain a list of effects the light can perform

effect_list:

- identify

state_topic: connect/light/001fee00000053a6/17880107102b0c/state schema: json unique_id: 17880107102b0c_light object_id: 17880107102b0c_light device_location: floorplan_name: Floor 3 floorplan_id: 2bbd26bc-c1cc-4c73-b6f0-84cb43b5f8c5 floorplan_point: - '0.7114518843852604' - '0.05005221590401024' room_id: b7d115c2-b910-40b8-93b7-99d6dc8b4535 room_name: LMS device: identifiers: - 17880107102b0c name: "Customers name/tag" manufacturer: Glamox Connect API model: Wireless Zigbee suggested_area: mysitename via_device: 001fee00000053a6 command_topic: connect/light/001fee00000053a6/17880107102b0c/set name: Light_17880107102b0c brightness_scale: 100 color_mode: 'true' brightness: 'true' supported_color_modes: - brightness effect: 'true' effect_list: - identify platform: mqtt
state_topic: connect/sensor/001fee00000053a6/17880107102b0c/state schema: json unique_id: 17880107102b0c_illuminance object_id: 17880107102b0c_illuminance device: identifiers: - 17880107102b0c name: 17880107102b0c manufacturer: Glamox Connect API model: Wireless Zigbee suggested_area: glamoxmoldetest via_device: 001fee00000053a6 name: Sensor/Illuminance_17880107102b0c device_class: illuminance unit_of_measurement: lx value_template: '{{ value_json.lux }}' platform: mqtt
state_topic: connect/binary_sensor/001fee00000053a6/17880107102b0c/state schema: json unique_id: 17880107102b0c_occupancy object_id: 17880107102b0c_occupancy device: identifiers: - 17880107102b0c name: 17880107102b0c manufacturer: Glamox Connect API model: Wireless Zigbee suggested_area: glamoxmoldetest via_device: 001fee00000053a6 name: Sensor/Occupancy_17880107102b0c value_template: '{{ value_json.presence }}' device_class: occupancy platform: mqtt

Related content