Matter Cluster 59 — Switch Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 59 values in the device shadow use this format:

endpoint_id / 59 / attribute_id

Example:

{
  "1/59/0": 2
}

Cluster 59 Features

The FeatureMap attribute (1/59/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.

Cluster 59 Attributes

Cluster 59 defines 3 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 — NumberOfPositions

Path example:

1/59/0

Indicates the maximum number of positions the switch has. Any kind of switch has a minimum of 2 positions.

Example:

{
  "1/59/0": 2
}

Attribute 1 / 0x0001 — CurrentPosition

Path example:

1/59/1

Indicates the position of the switch. The valid range is zero to NumberOfPositions - 1. CurrentPosition value 0 is assigned to the default position of the switch: for example the "open" state of a rocker switch, or the "idle" state of a push button switch.

Example:

{
  "1/59/1": 1
}

Attribute 2 / 0x0002 — MultiPressMax

Path example:

1/59/2

Indicates how many consecutive presses can be detected and reported by a momentary switch which supports multi-press (MSM feature flag set). For example, a momentary switch supporting single press, double press and triple press, but not quad press and beyond, would return the value 3.

Example:

{
  "1/59/2": 2
}

Cluster 59 Commands

Cluster 59 defines no commands. It is read (and, for writable attributes, written) through attribute access only.

Cluster 59 Events

Event 0 — SwitchLatched

This event is generated, when the latching switch is moved to a new position. It may have been delayed by debouncing within the switch.

Event 1 — InitialPress

This event is generated, when the momentary switch starts to be pressed (after debouncing).

Event 2 — LongPress

This event is generated when the momentary switch has been pressed for a "long" time.

Event 3 — ShortRelease

If the server has the Action Switch (AS) feature flag set, this event must NOT be generated at all, since setting the Action Switch feature flag forbids the Momentary Switch ShortRelease (MSR) feature flag from being set. Otherwise, the following paragraphs describe the situations where this event is generated.

Event 4 — LongRelease

This event is generated, when the momentary switch has been released (after debouncing) and after having been pressed for a long time, i.e. this event is generated when the switch is released if a LongPress event has been generated since the previous InitialPress event.

Event 5 — MultiPressOngoing

If the server has the Action Switch (AS) feature flag set, this event must NOT be generated at all. Otherwise, the following paragraphs describe the situations where this event is generated. This event is generated to indicate how many times the momentary switch has been pressed in a multi-press sequence, during that sequence. 13.8, "Sequence of events for MultiPress".

Event 6 — MultiPressComplete

This event is generated to indicate how many times the momentary switch has been pressed in a multi-press sequence, after it has been detected that the sequence has ended. 13.8, "Sequence of events for MultiPress". The PreviousPosition field indicates the previous value of the CurrentPosition attribute, i.e. just prior to release.

SmartphoneKey Notes

• Cluster 59 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/59/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.