Collect Zigbee cluster definitions

[luar123]

The correct setup of clusters is not always trivial and requires careful reading of the Zigbee cluster library
So lets collect endpoint/cluster/attribute definitions that are know to work. With this we can help each other to get working setups and it would help me to finally implement an automated setup of the definitions.

Device types have two purposes:

1. Let other zigbee devices find an endpoint that implements a certain functionality. Example: A thermostat could search for endpoints that have device type = HA_TEMPERATURE_SENSOR_DEVICE in oder to bind and read the temperature cluster.
2. Automatically setup mandatory clusters, so you don't need to define them manually.

Available device types can be found here, clusters that are included here and the full definitions are in the ZigBee Home Automation Application Profile

In the end it is up to you how you want to implement multiple devices. You can add all to one endpoint or setup many endpoints. If no device type is fitting you can always use TEST or CUSTOM_ATTR. (SIMPLE_SENSOR should only be used for a binary switch.)

[luar123]

Sensors:

(value is always the default value and could be different from what is shown here)

• Temperature

 endpoints:
    - device_type: TEMPERATURE_SENSOR
      num: 1
      clusters:
        - id: TEMP_MEASUREMENT
          attributes:
            - attribute_id: 0x0
              type: S16
              value: 100
              device: temp_id
              scale: 100

• Pressure:
  No fitting device type, often added to temperature endpoint

      clusters:
        - id: PRESSURE_MEASUREMENT
          attributes:
            - attribute_id: 0x0
              type: S16
              report: true
              value: 0x8000
              device: press_id

• Particular matter
  No fitting device type, often added to temperature endpoint

      clusters:
        - id: PM2_5_MEASUREMENT
          attributes:
            - attribute_id: 0x0
              type: single
              report: true
              value: 0
              device: pm25
            - attribute_id: 0x2 # maximum value is needed!
              type: single
              value: 999

• Humidity
  No fitting device type, often added to temperature endpoint

      clusters:
        - id: REL_HUMIDITY_MEASUREMENT
          attributes:
            - attribute_id: 0
              type: U16
              report: true
              value: 200
              device: hum_id
              scale: 100

• illuminance

 endpoints:
    - device_type: LIGHT_SENSOR
      num: 1
      clusters:
        - id: ILLUMINANCE_MEASUREMENT
          attributes:
            - attribute_id: 0
              type: U16
              report: true
              value: 0
              lambda: !lambda "return log10(x)*10000 + 1;"
              device: illum_id

[luar123]

Outputs

• Color dimmable light:
  (dimmable light and on_off light work the same, just use the correct device type and remove unneeded clusters.)

globals:
   - id: color_x
     type: float
     restore_value: no
     initial_value: '0'
   - id: color_y
     type: float
     restore_value: no
     initial_value: '0'

zigbee:
  endpoints:
    - num: 1
      device_type: COLOR_DIMMABLE_LIGHT
      clusters:
        - id: ON_OFF
          attributes:
            - attribute_id: 0
              type: bool
              on_value:
                then:
                  - light.control:
                      id: light_1
                      state: !lambda "return x;"
        - id: LEVEL_CONTROL
          attributes:
            - attribute_id: 0
              type: U8
              value: 255
              on_value:
                then:
                  - light.control:
                      id: light_1
                      brightness: !lambda "return (float)x/255;"
        - id: COLOR_CONTROL
          attributes:
            - attribute_id: 3
              type: U16
              on_value:
                then:
                  - lambda: id(color_x) = (float)x/65536;
                  - light.control:
                      id: light_1
                      red: !lambda "return zigbee::get_r_from_xy(id(color_x), id(color_y));"
                      green: !lambda "return zigbee::get_g_from_xy(id(color_x), id(color_y));"
                      blue: !lambda "return zigbee::get_b_from_xy(id(color_x), id(color_y));"
            - attribute_id: 4
              type: U16
              on_value:
                then:
                  - lambda: id(color_y) = (float)x/65536;
                  - light.control:
                      id: light_1
                      red: !lambda "return zigbee::get_r_from_xy(id(color_x), id(color_y));"
                      green: !lambda "return zigbee::get_g_from_xy(id(color_x), id(color_y));"
                      blue: !lambda "return zigbee::get_b_from_xy(id(color_x), id(color_y));"

[baal86]

• Fan control (0 = off; 1,2,3 = fan speeds)

        - id: FAN_CONTROL
          attributes:
            - attribute_id: 0x0000
              id: fan_mode_attr
              type: 8BIT_ENUM
              report: true
              on_value:
                then:
                  logger.log: 
                    format: "Received state %d" 
                    args: [!lambda "x"]