WindowCoveringTrait.SafetyStatus

data class WindowCoveringTrait.SafetyStatus

Reflects the state of the safety sensors and the common issues preventing movements.

Summary

Public constructors
`SafetyStatus( remoteLockout: Boolean, tamperDetection: Boolean, failedCommunication: Boolean, positionFailure: Boolean, thermalProtection: Boolean, obstacleDetected: Boolean, power: Boolean, stopInput: Boolean, motorJammed: Boolean, hardwareFailure: Boolean, manualOperation: Boolean, protection: Boolean )` Creates the SafetyStatus data class.

Public functions
`open ULong`	`toRaw()` Convert this ClusterBitmap to raw (bytes) format

Public properties
`String`	`bitmapName` Name of the Matter bitmap, in UpperCamelCase, e.g. "OnOffControlBitmap" from OnOff Cluster.
`Boolean`	`failedCommunication` Communication failure to sensors or other safety equipment.
`Boolean`	`hardwareFailure` PCB, fuse and other electrics problems.
`Boolean`	`manualOperation` The actuator is manually operated and is preventing actuator movement (for example, the actuator is disengaged or decoupled).
`Boolean`	`motorJammed` Mechanical problem related to the motor(s) detected.
`Boolean`	`obstacleDetected` An obstacle is preventing actuator movement.
`Boolean`	`positionFailure` Device failed to reach the desired position.
`Boolean`	`power` Device has a power-related issue or limitation.
`Boolean`	`protection` Protection is activated.
`Boolean`	`remoteLockout` Movement commands are ignored outside some time-and-date range.
`Boolean`	`stopInput` Local safety sensor is preventing movements (for example Safety EU Standard EN60335).
`Boolean`	`tamperDetection` Tampering detected on sensors or other safety equipment.
`Boolean`	`thermalProtection` Motor(s) and/or electric circuit thermal protection activated.
`String`	`traitId` Trait identifier of the Matter Cluster that defines the bitmap Data Type.

Public constructors

SafetyStatus

SafetyStatus(
    remoteLockout: Boolean = false,
    tamperDetection: Boolean = false,
    failedCommunication: Boolean = false,
    positionFailure: Boolean = false,
    thermalProtection: Boolean = false,
    obstacleDetected: Boolean = false,
    power: Boolean = false,
    stopInput: Boolean = false,
    motorJammed: Boolean = false,
    hardwareFailure: Boolean = false,
    manualOperation: Boolean = false,
    protection: Boolean = false
)

Creates the SafetyStatus data class.

Public functions

toRaw

open fun toRaw(): ULong

Convert this ClusterBitmap to raw (bytes) format

Public properties

bitmapName

val bitmapName: String

Name of the Matter bitmap, in UpperCamelCase, e.g. "OnOffControlBitmap" from OnOff Cluster.

failedCommunication

val failedCommunication: Boolean

Communication failure to sensors or other safety equipment.

hardwareFailure

val hardwareFailure: Boolean

PCB, fuse and other electrics problems.

manualOperation

val manualOperation: Boolean

The actuator is manually operated and is preventing actuator movement (for example, the actuator is disengaged or decoupled).

motorJammed

val motorJammed: Boolean

Mechanical problem related to the motor(s) detected.

obstacleDetected

val obstacleDetected: Boolean

An obstacle is preventing actuator movement.

positionFailure

val positionFailure: Boolean

Device failed to reach the desired position.

power

val power: Boolean

Device has a power-related issue or limitation.

protection

val protection: Boolean

Protection is activated.

remoteLockout

val remoteLockout: Boolean

Movement commands are ignored outside some time-and-date range.

stopInput

val stopInput: Boolean

Local safety sensor is preventing movements (for example Safety EU Standard EN60335).

tamperDetection

val tamperDetection: Boolean

Tampering detected on sensors or other safety equipment.

thermalProtection

val thermalProtection: Boolean

Motor(s) and/or electric circuit thermal protection activated.

traitId

val traitId: String

Trait identifier of the Matter Cluster that defines the bitmap Data Type. Refer to ClusterId.traitId for the format.