Matter Cluster 514 — Fan Control Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 514 values in the device shadow use this format:

endpoint_id / 514 / attribute_id

Example:

{
  "1/514/0": 0
}

Cluster 514 Features

The FeatureMap attribute (1/514/65532) is a bitmap. Each bit set means the device implements that feature and the attributes and commands that depend on it.

Example: FeatureMap = 0 means no optional feature is enabled; 63 means every feature listed above is enabled.

Data Types

AirflowDirectionEnum

FanModeEnum

FanModeSequenceEnum

StepDirectionEnum

RockBitmap (bitmap)

WindBitmap (bitmap)

Cluster 514 Attributes

Cluster 514 defines 12 attributes plus the global attributes. Conformance: M mandatory, O optional, a feature code means "mandatory when that feature is present", square brackets mean "optional when …".

Global attributes

Attribute Details

Attribute 0 / 0x0000 — FanMode

Path example:

1/514/0

Indicates the current speed mode of the fan. This attribute is set to one of the values in FanModeEnum supported by the server as indicated in the FanModeSequence attribute. The Low value is supported if and only if the FanModeSequence attribute value is less than 4. The Medium value is supported if and only if the FanModeSequence attribute value is 0 or 2.

Values (FanModeEnum):

Example:

{
  "1/514/0": 0
}

Attribute 1 / 0x0001 — FanModeSequence

Path example:

1/514/1

This attribute indicates the fan speed ranges that is supported by the server.

Values (FanModeSequenceEnum):

Example:

{
  "1/514/1": 0
}

Attribute 2 / 0x0002 — PercentSetting

Path example:

1/514/2

Indicates the speed setting for the fan with a value of 0 indicating that the fan is off and a value of 100 indicating that the fan is set to run at its maximum speed. If the FanMode attribute is set to Auto, the value of this attribute is set to null. This attribute may be written to by a client to indicate a new fan speed. If a client writes null to this attribute, the attribute value must NOT change.

Example:

{
  "1/514/2": 1
}

Attribute 3 / 0x0003 — PercentCurrent

Path example:

1/514/3

Indicates the actual currently operating fan speed, or zero to indicate that the fan is off. There may be a temporary mismatch between the value of this attribute and the value of the PercentSetting attribute due to other system requirements or constraints that would not allow the fan to operate at the requested setting. For example, if the value of this attribute is currently 50%, and the PercentSetting attribute is newly set to 25%, the value of this attribute may stay above 25% for a period necessary to dissipate internal heat, maintain product operational safety, etc.

Example:

{
  "1/514/3": 1
}

Attribute 4 / 0x0004 — SpeedMax

Path example:

1/514/4

Indicates the maximum value to which the SpeedSetting attribute can be set.

Example:

{
  "1/514/4": 1
}

Attribute 5 / 0x0005 — SpeedSetting

Path example:

1/514/5

Indicates the speed setting for the fan. This attribute may be written by a client to indicate a new fan speed. If the FanMode attribute is set to Auto, the value of this attribute is set to null. The server must support all values between 0 and SpeedMax.

Example:

{
  "1/514/5": 1
}

Attribute 6 / 0x0006 — SpeedCurrent

Path example:

1/514/6

Indicates the actual currently operating fan speed, or zero to indicate that the fan is off. There may be a temporary mismatch between the value of this attribute and the value of the SpeedSetting attribute due to other system requirements or constraints that would not allow the fan to operate at the requested setting. For example, if the value of this attribute is currently 5, and the SpeedSetting attribute is newly set to 2, the value of this attribute may stay above 2 for a period necessary to dissipate internal heat, maintain product operational safety, etc.

Example:

{
  "1/514/6": 1
}

Attribute 7 / 0x0007 — RockSupport

Path example:

1/514/7

This attribute is a bitmap that indicates the rocking motions that are supported by the server. If this attribute is supported by the server, at least one bit is set in this attribute.

Bits (RockBitmap):

Example:

{
  "1/514/7": 0
}

Attribute 8 / 0x0008 — RockSetting

Path example:

1/514/8

This attribute is a bitmap that indicates the currently active fan rocking motion setting. Each bit only be set to 1, if the corresponding bit in the RockSupport attribute is set to 1, otherwise a status code of CONSTRAINT_ERROR is returned. If a combination of supported bits is set by a client, and the server does not support the combination, the lowest supported single bit in the combination is set and active, and all other bits indicates zero. For example: If RockUpDown and RockRound are both set, but this combination is not possible, then only RockUpDown becomes active.

Bits (RockBitmap):

Example:

{
  "1/514/8": 0
}

Attribute 9 / 0x0009 — WindSupport

Path example:

1/514/9

This attribute is a bitmap that indicates what wind modes are supported by the server. If this attribute is supported by the server, at least one bit is set in this attribute.

Bits (WindBitmap):

Example:

{
  "1/514/9": 0
}

Attribute 10 / 0x000A — WindSetting

Path example:

1/514/10

This attribute is a bitmap that indicates the current active fan wind feature settings. Each bit only be set to 1, if the corresponding bit in the WindSupport attribute is set to 1, otherwise a status code of CONSTRAINT_ERROR is returned. If a combination of supported bits is set by a client, and the server does not support the combination, the lowest supported single bit in the combination is set and active, and all other bits indicates zero. For example: If Sleep Wind and Natural Wind are set, but this combination is not possible, then only Sleep Wind becomes active.

Bits (WindBitmap):

Example:

{
  "1/514/10": 0
}

Attribute 11 / 0x000B — AirflowDirection

Path example:

1/514/11

Indicates the current airflow direction of the fan. This attribute may be written by a client to indicate a new airflow direction for the fan. This attribute is set to one of the values in the AirflowDirectionEnum table.

Values (AirflowDirectionEnum):

Example:

{
  "1/514/11": 0
}

Cluster 514 Commands

Cluster 514 has 1 client-to-server command and 0 responses.

AcceptedCommandList

The AcceptedCommandList attribute lists the command IDs the endpoint actually implements:

endpoint_id / 514 / 65529

{
  "1/514/65529": [
    0
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 514,
    "command_name": "Step",
    "payload": {},
    "timed_request_timeout_ms": 1000
  }
}

For Cluster 514, always use "cluster_id": 514. Payload keys are the command field names in lowerCamelCase. Octet-string fields are base64-encoded. timed_request_timeout_ms is required for timed commands and ignored otherwise.

Command: Step

Purpose

This command indirectly changes the speed-oriented attributes of the fan in steps rather than using the speed-oriented attributes, FanMode, PercentSetting, or SpeedSetting, directly. This command supports, for example, a user-operated and wall-mounted toggle switch that can be used to increase or decrease the speed of the fan by pressing the toggle switch up or down until the desired fan speed is reached. How this command is interpreted by the server and how it affects the values of the speed-oriented attributes is implementation specific. For example, a fan supports this command, and the value of the FanModeSequence attribute is 0.

Command Identity

Payload Fields

Direction values (StepDirectionEnum): 0 = Increase, 1 = Decrease

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 514,
    "command_name": "Step",
    "payload": {
      "direction": 0
    }
  }
}

Cluster 514 Events

Cluster 514 defines no events.

SmartphoneKey Notes

• Cluster 514 is not currently exposed by SmartphoneKey devices. This page documents the Matter 1.6.1 specification so that future devices can be interpreted without changes to the backend.
• Shadow paths follow endpoint/514/attribute; attribute values that the device reports as unreadable are written as n/a.
• Attribute IDs, command IDs and enum values on this page come from the CSA Matter 1.6.1 data model; descriptions are condensed from the specification text.