Häfele Connect MQTT API 0.2.0

The Häfele Connect MQTT API allows you to control Connect Devices with a Connect Gateway

Servers

  • mqtt://test.mosquitto.org:{port}/mqtttesting

    Test broker

    object
    port
    required
    string

    Secure connection (TLS) is available through port 8883.

    Default value:"1883"
      Allowed values:
    • "1883"
    • "8883"

Operations

  • SEND {gateway_topic}/rawMessage/send

    Operation IDsendRawMessage

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    Accepts the following message:

    sendRawMessage.message
    Message IDsendRawMessage.message
    object

    Send Access Message

    Examples

  • RECEIVE {gateway_topic}/rawMessage

    Operation IDrawMessages

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    Accepts the following message:

    rawMessages.message
    Message IDrawMessages.message
    object

    Access Message

    Examples

  • SEND {gateway_topic}/setNetworkConfiguration

    Operation IDsetNetworkConfiguration

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    Accepts the following message:

    setNetworkConfiguration.message
    Message IDsetNetworkConfiguration.message
    object

    Examples

  • RECEIVE {gateway_topic}/lights

    Operation IDlightsDiscovery

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    Accepts the following message:

    lightsDiscovery.message
    Message IDlightsDiscovery.message
    array<object>

    Examples

  • RECEIVE {gateway_topic}/groups

    Operation IDgroupDiscovery

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    Accepts the following message:

    groupDiscovery.message
    Message IDgroupDiscovery.message
    array<object>

    Examples

  • RECEIVE {gateway_topic}/scenes

    Operation IDsceneDiscovery

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    Accepts the following message:

    ScenessceneDiscovery.message
    Message IDsceneDiscovery.message
    array<object>

    Examples

  • RECEIVE {gateway_topic}/lights/{device_name}/status

    Operation IDlightStatus

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    device_name
    required
    string

    Escaped device name

    Accepts the following message:

    deviceLightStatus.message
    Message IDdeviceLightStatus.message
    oneOf

    Examples

  • RECEIVE {gateway_topic}/groups/{group_name}/status

    Operation IDgroupStatus

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    group_name
    required
    string

    Escaped group name

    Accepts the following message:

    groupStatus.message
    Message IDgroupStatus.message
    oneOf

    Examples

  • RECEIVE {gateway_topic}/groups/{group_name}/received/recallScene

    Operation IDonGroupRecallScene

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    group_name
    required
    string

    Escaped group name

    Accepts the following message:

    onGroupRecallScene.message
    Message IDonGroupRecallScene.message
    oneOf

    Examples

  • SEND {gateway_topic}/scenes/recallScene

    Operation IDrecallScene

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    Accepts the following message:

    recallScene.message
    Message IDrecallScene.message
    Payload
    string

    Escaped name of the scene

    Examples

  • SEND {gateway_topic}/scenes/recall_scene

    Operation IDrecallSceneLegacy

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    Accepts the following message:

    recallScene.message
    Message IDrecallScene.message
    Payload
    string

    Escaped name of the scene

    Examples

  • SEND {gateway_topic}/groups/{group_name}/recallScene

    Operation IDrecallSceneGroup

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    group_name
    required
    string

    Escaped group name

    Accepts the following message:

    recallSceneGroup.message
    Message IDrecallSceneGroup.message
    Payload
    string

    Escaped name of the scene

    Examples

  • SEND {gateway_topic}/groups/{group_name}/recall_scene

    Operation IDrecallSceneGroupLegacy

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    group_name
    required
    string

    Escaped group name

    Accepts the following message:

    recallSceneGroup.message
    Message IDrecallSceneGroup.message
    Payload
    string

    Escaped name of the scene

    Examples

  • SEND {gateway_topic}/lights/{device_name}/recallScene

    Operation IDrecallSceneDevice

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    device_name
    required
    string

    Escaped group name

    Accepts the following message:

    recallSceneDevice.message
    Message IDrecallSceneDevice.message
    Payload
    string

    Escaped name of the scene

    Examples

  • SEND {gateway_topic}/lights/{device_name}/recall_scene

    Operation IDrecallSceneDeviceLegacy

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    device_name
    required
    string

    Escaped group name

    Accepts the following message:

    recallSceneDevice.message
    Message IDrecallSceneDevice.message
    Payload
    string

    Escaped name of the scene

    Examples

  • SEND {gateway_topic}/groups/{group_name}/power

    Operation IDsetGroupPower

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    group_name
    required
    string

    Escaped group name

    Accepts the following message:

    setGroupPower.message
    Message IDsetGroupPower.message
    oneOf

    Examples

  • SEND {gateway_topic}/groups/{group_name}/powerGet

    Operation IDgetGroupPower

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    group_name
    required
    string

    Escaped group name

    Accepts the following message:

    Empty MessageEmpty.message
    Message IDEmpty.message
    Payload
    null

    Examples

  • SEND {gateway_topic}/groups/{group_name}/lightness

    Operation IDsetGroupLightness

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    group_name
    required
    string

    Escaped group name

    Accepts the following message:

    setGroupLightness.message
    Message IDsetGroupLightness.message
    oneOf

    Examples

  • SEND {gateway_topic}/groups/{group_name}/lightnessGet

    Operation IDgetGroupLightness

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    group_name
    required
    string

    Escaped group name

    Accepts the following message:

    Empty MessageEmpty.message
    Message IDEmpty.message
    Payload
    null

    Examples

  • SEND {gateway_topic}/groups/{group_name}/temperature

    Operation IDsetGroupTemperature

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    group_name
    required
    string

    Escaped group name

    Accepts the following message:

    setGroupTemperature.message
    Message IDsetGroupTemperature.message
    oneOf

    Examples

  • SEND {gateway_topic}/groups/{group_name}/hue

    Operation IDsetGroupHue

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    group_name
    required
    string

    Escaped group name

    Accepts the following message:

    setGroupHue.message
    Message IDsetGroupHue.message
    oneOf

    Examples

  • SEND {gateway_topic}/groups/{group_name}/saturation

    Operation IDsetGroupSaturation

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    group_name
    required
    string

    Escaped group name

    Accepts the following message:

    setGroupSaturation.message
    Message IDsetGroupSaturation.message
    oneOf

    Examples

  • SEND {gateway_topic}/groups/{group_name}/hsl

    Operation IDsetGroupHsl

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    group_name
    required
    string

    Escaped group name

    Accepts the following message:

    setGroupHsl.message
    Message IDsetGroupHsl.message
    object

    Examples

  • SEND {gateway_topic}/groups/{group_name}/hslGet

    Operation IDgetGroupHsl

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    group_name
    required
    string

    Escaped group name

    Accepts the following message:

    Empty MessageEmpty.message
    Message IDEmpty.message
    Payload
    null

    Examples

  • SEND {gateway_topic}/groups/{group_name}/ctl

    Operation IDsetGroupCtl

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    group_name
    required
    string

    Escaped group name

    Accepts the following message:

    setGroupCtl.message
    Message IDsetGroupCtl.message
    object

    Examples

  • SEND {gateway_topic}/groups/{group_name}/ctlGet

    Operation IDgetGroupCtl

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    group_name
    required
    string

    Escaped group name

    Accepts the following message:

    Empty MessageEmpty.message
    Message IDEmpty.message
    Payload
    null

    Examples

  • SEND {gateway_topic}/lights/{light_name}/power

    Operation IDsetDevicePower

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    light_name
    required
    string

    Escaped device name

    Accepts the following message:

    setGroupPower.message
    Message IDsetGroupPower.message
    oneOf

    Examples

  • SEND {gateway_topic}/lights/{light_name}/powerGet

    Operation IDgetDevicePower

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    light_name
    required
    string

    Escaped device name

    Accepts the following message:

    Empty MessageEmpty.message
    Message IDEmpty.message
    Payload
    null

    Examples

  • SEND {gateway_topic}/lights/{device_name}/lightness

    Operation IDsetDeviceLightness

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    device_name
    required
    string

    Escaped device name

    Accepts the following message:

    setGroupLightness.message
    Message IDsetGroupLightness.message
    oneOf

    Examples

  • SEND {gateway_topic}/lights/{light_name}/lightnessGet

    Operation IDgetDeviceLightness

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    light_name
    required
    string

    Escaped device name

    Accepts the following message:

    Empty MessageEmpty.message
    Message IDEmpty.message
    Payload
    null

    Examples

  • SEND {gateway_topic}/lights/{device_name}/temperature

    Operation IDsetDeviceTemperature

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    device_name
    required
    string

    Escaped device name

    Accepts the following message:

    setGroupTemperature.message
    Message IDsetGroupTemperature.message
    oneOf

    Examples

  • SEND {gateway_topic}/lights/{device_name}/hue

    Operation IDsetDeviceHue

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    device_name
    required
    string

    Escaped device name

    Accepts the following message:

    setGroupHue.message
    Message IDsetGroupHue.message
    oneOf

    Examples

  • SEND {gateway_topic}/lights/{device_name}/saturation

    Operation IDsetDeviceSaturation

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    device_name
    required
    string

    Escaped device name

    Accepts the following message:

    setGroupSaturation.message
    Message IDsetGroupSaturation.message
    oneOf

    Examples

  • SEND {gateway_topic}/lights/{device_name}/hsl

    Operation IDsetDeviceHsl

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    device_name
    required
    string

    Escaped device name

    Accepts the following message:

    setGroupHsl.message
    Message IDsetGroupHsl.message
    object

    Examples

  • SEND {gateway_topic}/lights/{light_name}/hslGet

    Operation IDgetDeviceHsl

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    light_name
    required
    string

    Escaped device name

    Accepts the following message:

    Empty MessageEmpty.message
    Message IDEmpty.message
    Payload
    null

    Examples

  • SEND {gateway_topic}/lights/{device_name}/ctl

    Operation IDsetDeviceCtl

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    device_name
    required
    string

    Escaped device name

    Accepts the following message:

    setGroupCtl.message
    Message IDsetGroupCtl.message
    object

    Examples

  • SEND {gateway_topic}/lights/{light_name}/ctlGet

    Operation IDgetDeviceCtl

    Available only on servers:

    object
    gateway_topic
    required
    string

    The configured root topic.

    light_name
    required
    string

    Escaped device name

    Accepts the following message:

    Empty MessageEmpty.message
    Message IDEmpty.message
    Payload
    null

    Examples

Messages

  • #1Empty MessageEmptyMessage
    Message IDEmptyMessage
    Payload
    null
  • #2onOffMessage
    Message IDonOffMessage
    oneOf
  • #3recallSceneMessage
    Message IDrecallSceneMessage
    oneOf
  • #4lightnessMessage
    Message IDlightnessMessage
    oneOf
  • #5temperatureMessage
    Message IDtemperatureMessage
    oneOf
  • #6hueMessage
    Message IDhueMessage
    oneOf
  • #7saturationMessage
    Message IDsaturationMessage
    oneOf
  • #8hslMessage
    Message IDhslMessage
    object
  • #9ctlMessage
    Message IDctlMessage
    object
  • #10statusMessage
    Message IDstatusMessage
    oneOf
  • #11sendRawMessage
    Message IDsendRawMessage
    object

    Send Access Message

  • #12rawMessage
    Message IDrawMessage
    object

    Access Message

  • #13setNetworkConfigurationMessage
    Message IDsetNetworkConfigurationMessage
    object

Schemas

  • onOff
    boolean
  • onOffEnum
    string
      Allowed values:
    • "on"
    • "off"
  • object
  • lightness
    number
    [ 0 .. 1 ]
  • object
  • temperature
    integer
    [ 800 .. 20000 ]
  • object
  • hue
    integer
    [ 0 .. 360 ]
  • object
  • saturation
    number
    [ 0 .. 1 ]
  • object
  • transition_time
    number
    [ 0 .. 372000 ]

    The transition time can be specified in deciseconds (0.1s). However, due to the limited resolution of transition times in the BLE Mesh Specification (Section 3.1.3), the provided time may be rounded down. The supported transition time increments are as follows: 0.1s steps within the range of 0-6.2s, 1s steps within the range of 0-62s, 10s steps within the range of 1-10.5 minutes, and 10-minute steps up to 10.5 hours.

  • object
  • object
  • scene
    string

    Escaped name of the scene

  • object
  • group_id
    integer

    A group id

  • object
  • object

    Send Access Message

  • object

    Access Message

  • object
  • device_name
    string

    Device Name

  • object
  • object
  • object