Page Comparison

...

After you have set up your broker, go to Settings → Site → Local API to enter the broker connection details.

...

This will connect your access point to the provided broker and it will start to publish and listen to defined topics.

...

There are basically three different topic categories:

Discovery topic (config)

Topic where Connect can be asked to describe devices that are available. When a request is being made on discovery<API id>/searchConnect will respond publishing all devices on topic discovery<API id>/<type>/<gateway-id>/<device-id>/config

...

When a message has been sent to discovery<API id>/search, Connect will return the devices on discovery<API id>/<type>/<gateway-id>/<device-id>/config, for example discovery<API id>/sensor/00201232ab45/100234abc35/config.

You can also provide your own discovery prefix in the payload. Glamox Connect will then send the discovery/config messages using this prefix.

Example: If you send payload "discovery_prefix": "homeassistant" to discovery/search, Glamox Connect will return the previous example using the provided prefix: homeassistant/sensor/00201232ab45/100234abc35/config

Devices and entities

So we have mentioned device types. Technically this is what we call entities. A device can have one or more entities. That means that one device in Glamox Connect can send more than one entity on the discovery topics.

...

• The max value for brightness is given as brightness_scale. I.e. 100 means that the scale is 0-100

• If the light has a color_mode this is given as ‘true’ as well as listing the level of control in supported_color_modes

  • 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

• If you can activate effects on the light, this is given as effect: ‘true’

• The effect_list will (if effect) contain a list of effects the light can perform, i.e. ‘identify’ to blink the light

Light config payload (Example has “connect” as API ID):

state_topic: connect/light/001fee00000053a6/17880107102b0c/state
schema: json
unique_id: 17880107102b0c_light
object_id: 17880107102b0c_light
device:
  identifiers:
    - 17880107102b0c
  name: 17880107102b0c
  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

...

• The device_class will tell you which kind of sensor the entity is

  • illuminance

  • temperature

• For sensors, the unit_of_measurement is provided to indicate how to interpret the state.

  • This is NOT available for binary sensors as they are always ‘ON’/'OFF'

• A 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.

Sensor config payload (Example has “connect” as API ID):

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

Binary_sensor config payload (Example has “connect” as API ID):

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

...

command_topic: connect/light/001fee00000053a6/17880107102b0c/set

To change a value for this entity we need to send a valid json payload to the given topic

...

{
  "brightness": 80
}

Device health

We provide device health status for devices through the use of virtual binary sensors entities. These sensors act like any other binary sensors, but whose values are based on certain health states a device can hold.

Health state can be obtained through the state topic for the virtual sensors like for any other entity. Device classes used for these virtual sensors are off either "problem" or "connectivity" class and is used to give meaning to the “ON” / “OFF” values.

Virtual sensors entities for all devices

These virtual sensors are common for all devices:

Virtual sensor entities only for emergency devices

For emergency devices, we offer the following additional virtual sensors in addition to the common virtual sensors: