Skip to content

[Documentation] Incomplete list of functionalChannelTypes #2

@Bizarrus

Description

@Bizarrus

The Connect API documentation (v1.0.1) only documents 6 functionalChannelType values:

  • DEVICE_BASE
  • DEVICE_SABOTAGE
  • DIMMER_CHANNEL
  • SHUTTER_CONTACT_CHANNEL
  • ALARM_SIREN_CHANNEL
  • ACCESS_CONTROLLER_CHANNEL

However, real devices expose channel types that are entirely undocumented. Example from a live getSystemState response:

  "functionalChannels": {                                                                                                                                                                                                                                                    
    "0": { "functionalChannelType": "DEVICE_OPERATIONLOCK" },
    "1": { "functionalChannelType": "DOOR_LOCK_CHANNEL", "lockState": "LOCKED" }                                                                                                                                                                                             
  }

Additionally, there is no dedicated reference section for functionalChannelType at all. The 6 known types only appear incidentally within JSON examples (e.g. getSystemState, DEVICE_CHANGED). A complete, searchable reference is entirely missing.

Impact

Without a complete reference of all functionalChannelType values and their respective:

  • state properties (e.g. lockState, windowState, dimLevel)
  • associated control endpoints (e.g. which path to use for which channel type)

...it is impossible to implement generic device control via the plugin API without reverse engineering live device responses.

Request

Please provide a complete reference table covering all functionalChannelType values, including:

  1. Their state properties and data types
  2. The associated /hmip/device/control/* endpoints
  3. The required request body parameters per endpoint
  4. A dedicated, searchable section in the documentation (not embedded in examples)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions