Matter Clusteres are groups of wireless commands that allow using certain functions of a Matter device. In Z-Way each Matter device has a data holder entry for each Cluster supported. During the inclusion and interview of the device the Cluster structure is instantiated in the data holder and filled with certain data. Cluster commands change values of the corresponding data holder structure. The follow list shows the public commands of the Clusters supported with their parameters and the data holder objects changed.
In MATTER EXPERT USER INTERFACE navigate to Configuration > Expert Commands to execute commands of the supported Clusters and visualizes all data holder elements in as tree in a simplified user interface.
Profile Zigbee Device Profile (0x0104/260)
Attributes and commands for switching devices between ‘On’ and ‘Off’ states.
Data holders:
Syntax: Set(value, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zmatter_cc_on_off_set(ZMatter zmatter, ZMNWK node_id, ZEndPoint endpoint_id, ZWBOOL value, ZMJobCustomCallback successCallback, ZMJobCustomCallback failureCallback, void* callbackArg)
Description: Send On (0x00/0) or Off (0x01/1)
Parameter value: New onOff state:. TRUE - send On command. FALSE - send Off command
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Syntax: Toggle(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zmatter_cc_on_off_toggle(ZMatter zmatter, ZMNWK node_id, ZEndPoint endpoint_id, ZMJobCustomCallback successCallback, ZMJobCustomCallback failureCallback, void* callbackArg)
Description: Send Toggle (0x02/2)
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Syntax: OffWithEffect(effectId, effectVar, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zmatter_cc_on_off_off_with_effect(ZMatter zmatter, ZMNWK node_id, ZEndPoint endpoint_id, ZWBYTE effect_id, ZWBYTE effect_var, ZMJobCustomCallback successCallback, ZMJobCustomCallback failureCallback, void* callbackArg)
Description: Send Off with Effect (0x40/64)
Parameter effectId: Effect Id:. 0x00 - Delayed All Off. 0x01 - Dying Light. 0x02...0xFF - Reserved
Parameter effectVar: Effect Variant:. if effect_id 0x00:. @default: 0x00. 0x00 - Fade to off in 0.8 seconds. 0x01 - No fade. 0x02 - 50% dim down in 0.8 seconds then fade to off in 12 seconds. 0x03...0xFF - Reserved. if effect_id 0x01:. @default: 0x00. 0x00 - 20% dim up in 0.5s then fade to off in 1 second. 0x01...0xFF - Reserved. if effect_id 0x02...0xFF:. 0x00...0xFF - Reserved
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Syntax: OnWithRecallGlobalScene(successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zmatter_cc_on_off_on_with_recall_global_scene(ZMatter zmatter, ZMNWK node_id, ZEndPoint endpoint_id, ZMJobCustomCallback successCallback, ZMJobCustomCallback failureCallback, void* callbackArg)
Description: Send On with Recall Global Scene (0x41/65)
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Syntax: OnWithTimedOff(control, onTime, offWaitTime, successCallback = NULL, failureCallback = NULL)
C Syntax: ZWError zmatter_cc_on_off_on_with_timed_off(ZMatter zmatter, ZMNWK node_id, ZEndPoint endpoint_id, ZWBOOL control, ZWWORD on_time, ZWWORD off_wait_time, ZMJobCustomCallback successCallback, ZMJobCustomCallback failureCallback, void* callbackArg)
Description: Send On with Time Off (0x42/66)
Parameter control: Contains information on how the device is to be operated. 0x00 - The On With Timed Off command SHALL be processed unconditionally. 0x01...0x7F - Reserved. 0x80 - The On With Timed Off command SHALL only be accepted if the OnOff attribute is equal to 0x01. 0x81...0xFF - Reserved
Parameter onTime: The length of time (in 1/10ths second) that the device is to remain “on”. 0x0000...0xFFFE - time in 1/10th second. 0xFFFF - Reserved
Parameter offWaitTime: The length of time (in 1/10ths second) that the device SHALL remain “off”. 0x0000...0xFFFE - time in 1/10th second. 0xFFFF - Reserved
Parameter successCallback: Custom function to be called on function success. NULL if callback is not needed
Parameter failureCallback: Custom function to be called on function failure. NULL if callback is not needed
Profile Zigbee Device Profile (0x0104/260)
Profile ZigMatter Device Profile (0x0104/260)
Profile ZigMatter Device Profile (0x0104/260)
Profile ZigMatter Device Profile (0x0104/260)
Profile ZigMatter Device Profile (0x0104/260)
Profile ZigMatter Device Profile (0x0104/260)
Profile ZigMatter Device Profile (0x0104/260)
Profile Zigbee Device Profile (0x0104/260)