Appliances121 — Water Tank Level Monitoring

Matter Cluster 121 — Water Tank Level Monitoring

Matter Cluster 121 (0x0079) Water Tank Level Monitoring: attributes, commands, events, data types, shadow paths and bridge payload examples.

Matter Cluster 121 — Water Tank Level Monitoring Cluster

Matter Cluster 121, also written as 0x0079, is the Water Tank Level Monitoring Cluster.

This cluster is one of several alias clusters that share the same definition (Resource Monitoring Clusters): HEPA Filter Monitoring (<code>113</code>), Activated Carbon Filter Monitoring (<code>114</code>). Only the cluster ID and the measured quantity differ.

Cluster Identity

FieldValue
Cluster ID decimal121
Cluster ID hex0x0079
Cluster nameWater Tank Level Monitoring
Cluster revision (Matter 1.6.1)1
Roleapplication
ScopeEndpoint
PICS codeREPM
Typical endpoint1

Revision history

RevisionChange
1Initial revision

Shadow Path Format

Cluster 121 values in the device shadow use this format:

endpoint_id / 121 / attribute_id

Example:

{
  "1/121/2": 0
}
PartMeaning
1Endpoint ID
121Water Tank Level Monitoring cluster
2ChangeIndication attribute

Cluster 121 Features

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

BitCodeFeatureConformanceMeaning
0CONConditionOSupports monitoring the condition of the resource in percentage
1WRNWarningOSupports warning indication
2REPReplacementProductListOSupports specifying the list of replacement products

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


Data Types

ChangeIndicationEnum

ValueNameConformanceMeaning
0OKMResource is in good condition, no intervention required
1WarningWRNResource will be exhausted soon, intervention will shortly be required
2CriticalMResource is exhausted, immediate intervention is required

DegradationDirectionEnum

ValueNameConformanceMeaning
0UpMThe degradation of the resource is indicated by an upwards moving/increasing value
1DownMThe degradation of the resource is indicated by a downwards moving/decreasing value

ProductIdentifierTypeEnum

ValueNameConformanceMeaning
0UPCM12-digit Universal Product Code
1GTIN-8M8-digit Global Trade Item Number
2EANM13-digit European Article Number
3GTIN-14M14-digit Global Trade Item Number
4OEMMOriginal Equipment Manufacturer part number

ReplacementProductStruct (struct)

FieldNameTypeConformanceConstraintMeaning
0ProductIdentifierTypeProductIdentifierTypeEnumMdesc—
1ProductIdentifierValuestringMmax length 20—

Cluster 121 Attributes

Cluster 121 defines 6 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 …".

IDHexAttributeTypeConformanceAccessQualitiesDefault
00x0000ConditionpercentCONR (read: view)——
10x0001DegradationDirectionDegradationDirectionEnumCONR (read: view)——
20x0002ChangeIndicationChangeIndicationEnumMR (read: view)——
30x0003InPlaceIndicatorboolOR (read: view)——
40x0004LastChangedTimeepoch-sOR/W (read: view, write: operate)nullable, persistednull
50x0005ReplacementProductListlist of ReplacementProductStructREPR (read: view)——

Global attributes

IDHexAttributeMeaning
655280xFFF8GeneratedCommandListResponse command IDs this server generates.
655290xFFF9AcceptedCommandListCommand IDs this server accepts.
655310xFFFBAttributeListAttribute IDs implemented.
655320xFFFCFeatureMapImplemented optional features (see above).
655330xFFFDClusterRevisionCluster revision implemented; 1 for a Matter 1.6.1 device.

Attribute Details

Attribute 0 / 0x0000 — Condition

Path example:

1/121/0

No condensed specification text is available for Condition; use the type, conformance and constraint below together with the cluster description above.

PropertyValue
Typepercent
ConformanceCON
AccessR (read: view)

Example:

{
  "1/121/0": 1
}

Attribute 1 / 0x0001 — DegradationDirection

Path example:

1/121/1

No condensed specification text is available for DegradationDirection; use the type, conformance and constraint below together with the cluster description above.

PropertyValue
TypeDegradationDirectionEnum
ConformanceCON
AccessR (read: view)
Constraintdesc

Values (DegradationDirectionEnum):

ValueNameMeaning
0UpThe degradation of the resource is indicated by an upwards moving/increasing value
1DownThe degradation of the resource is indicated by a downwards moving/decreasing value

Example:

{
  "1/121/1": 0
}

Attribute 2 / 0x0002 — ChangeIndication

Path example:

1/121/2

No condensed specification text is available for ChangeIndication; use the type, conformance and constraint below together with the cluster description above.

PropertyValue
TypeChangeIndicationEnum
ConformanceM
AccessR (read: view)

Values (ChangeIndicationEnum):

ValueNameMeaning
0OKResource is in good condition, no intervention required
1WarningResource will be exhausted soon, intervention will shortly be required
2CriticalResource is exhausted, immediate intervention is required

Example:

{
  "1/121/2": 0
}

Attribute 3 / 0x0003 — InPlaceIndicator

Path example:

1/121/3

No condensed specification text is available for InPlaceIndicator; use the type, conformance and constraint below together with the cluster description above.

PropertyValue
Typebool
ConformanceO
AccessR (read: view)

Example:

{
  "1/121/3": true
}

Attribute 4 / 0x0004 — LastChangedTime

Path example:

1/121/4

No condensed specification text is available for LastChangedTime; use the type, conformance and constraint below together with the cluster description above.

PropertyValue
Typeepoch-s
ConformanceO
AccessR/W (read: view, write: operate)
Qualitiesnullable, persisted
Defaultnull

Example:

{
  "1/121/4": 0
}

Attribute 5 / 0x0005 — ReplacementProductList

Path example:

1/121/5

No condensed specification text is available for ReplacementProductList; use the type, conformance and constraint below together with the cluster description above.

PropertyValue
Typelist of ReplacementProductStruct
ConformanceREP
AccessR (read: view)
Constraintmax 5 entries

Each entry is a ReplacementProductStruct (see Data Types).

Example:

{
  "1/121/5": []
}

Cluster 121 Commands

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

IDHexCommandDirectionConformanceResponseDescription
00x00ResetConditionclient → serverOstatus—

AcceptedCommandList

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

endpoint_id / 121 / 65529
{
  "1/121/65529": [
    0
  ]
}

Before sending a Cluster 121 command, check that the command ID exists in endpoint/121/65529. Optional commands are only present when the matching feature is set in FeatureMap.


Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

For Cluster 121, always use "cluster_id": 121. 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: ResetCondition

Purpose

ResetCondition is a client-to-server command of the Water Tank Level Monitoring cluster.

Command Identity

FieldValue
Command ID0
Command hex0x00
Command nameResetCondition
Directionclient → server
ConformanceO
Responsestatus
Access(invoke: operate)

Payload Fields

This command has no payload fields.

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 121,
    "command_name": "ResetCondition",
    "payload": {}
  }
}

Cluster 121 Events

Cluster 121 defines no events.


SmartphoneKey Notes

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