Input to the ModeBase changeToMode command

MatterSpecification.v13.Cluster § 1.10.7.1

interface ChangeToModeRequest {
    newMode: number;
}

Hierarchy (view full)

Properties

Properties

newMode: number

If the NewMode field doesn’t match the Mode field of any entry of the SupportedModes list, the ChangeToModeResponse command’s Status field shall indicate UnsupportedMode and the StatusText field shall be included and may be used to indicate the issue, with a human readable string, or include an empty string.

If the NewMode field matches the Mode field of one entry of the SupportedModes list, but the device is not able to transition as requested, the ChangeToModeResponse command shall:

• Have the Status set to a product-specific Status value representing the error, or GenericFailure if a more specific error cannot be provided. See Status Field for details.

• Provide a human readable string in the StatusText field.

If the NewMode field matches the Mode field of one entry of the SupportedModes list and the device is able to transition as requested, the server shall transition into the mode associated with NewMode, the ChangeToModeResponse command shall have the Status field set to Success, the StatusText field may be supplied with a human readable string or include an empty string and the CurrentMode field shall be set to the value of the NewMode field.

If the NewMode field is the same as the value of the CurrentMode attribute the ChangeToModeRe

sponse command shall have the Status field set to Success and the StatusText field may be supplied with a human readable string or include an empty string.

MatterSpecification.v13.Cluster § 1.10.7.1.1