Click or drag to resize

ShadeExtendedStatus Class

Shade Extended Status class.

This class will trigger ExtendedStatusChange event.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.ShadesShadeExtendedStatus

Namespace: Crestron.SimplSharpPro.Shades
Assembly: Crestron.SimplSharpPro.Shades (in Crestron.SimplSharpPro.Shades.dll) Version: 2.21.121
Syntax
C#
public sealed class ShadeExtendedStatus : IParentInformation

The ShadeExtendedStatus type exposes the following members.

Properties
 NameDescription
Public propertyBatteryAboveLowFeedback Property to indicate that the remaining battery capacity is approximately greater than or equal to 25%.

The ExtendedStatusChange event will trigger with BatteryAboveLowEventId.

Remarks
'true' = battery remaining capacity is approximately greater than or equal to 25%; 'false' = battery remaining capacity is approximately not greater than or equal to 25%
Public propertyBatteryAnalogDisablePush Property to disable periodic push of BatteryLevelFeedback and BatteryCapacityLeftFeedback properties.
Public propertyBatteryAnalogDisablePushFeedback Property to indicate that the periodic push of BatteryLevelFeedback and BatteryCapacityLeftFeedback is disabled. true: periodic push of BatteryLevelFeedback and BatteryCapacityLeftFeedback is disabled false: periodic push of BatteryLevelFeedback and BatteryCapacityLeftFeedback is enabled

The ExtendedStatusChange event will trigger with BatteryAnalogDisablePushEventId.

Public propertyBatteryCapacityLeftFeedback Property to return the estimated remaining percentage of full capacity. 100% = 65535. Will be pushed a few times a day and when BatteryAboveLowFeedback, BatteryLowFeedback or BatteryUnusableFeedback properties change, if BatteryAnalogDisablePush property value is false. Use "SimplSharpDeviceHelper.PercentToUshort" to convert the percentage to a ushort value or "SimplSharpDeviceHelper.UshortToPercent" to convert the ushort value to percentage.

The ExtendedStatusChange event will trigger with BatteryCapacityLeftFeedbackEventId.

Public propertyBatteryLevelFeedback Property to return the current battery level. unsigned 0.01 volts per count. Value 100 means 100 * 0.01 volts = 1 volts. This property is not supported by [!:CsmQmtdc1633SgRc]. Will be pushed a few times a day and when BatteryAboveLowFeedback, BatteryLowFeedback or BatteryUnusableFeedback properties change, if BatteryAnalogDisablePush property value is false.

The ExtendedStatusChange event will trigger with BatteryLevelFeedbackEventId.

Public propertyBatteryLowFeedback Property to indicate that the battery remaining capacity is approximately less than 25%.

The ExtendedStatusChange event will trigger with BatteryLowEventId.

Remarks
'true' = battery remaining capacity is approximately less than 25%; 'false' = battery remaining capacity is not approximately less than 25%
Public propertyBatteryUnusableFeedback Property to indicate that the battery is too low to move motor.
Remarks
'true' battery is too low to move motor; 'false': battery is not too low to move motor

The ExtendedStatusChange event will trigger with BatteryUnusableEventId.

Public propertyConnectedRemotes Property to send out the command to motor querying number of remotes connected to the motor. This property is only supported by [!:CsmQmtdc1633SgRc].
Public propertyConnectedRemotesFeedback Property to indicate the feedback from motor querying number of remotes connected to the motor. Property value is 0 means no remotes connected Property value is greater than or equal to 1 means at least one remote connected This property is only supported by [!:CsmQmtdc1633SgRc].

The ExtendedStatusChange event will trigger with ConnectedRemotesFeedbackEventId.

Public propertyPairRemote Property to send out the "Remote Pairing Mode" command to Wistar motor. This command puts the motor in pairing mode for 3 seconds and then it will time out. This property is only supported by [!:CsmQmtdc1633SgRc].
Public propertyPairRemoteFeedback Property to indicate the feedback from motor containing the status of pairing mode. This property is only supported by [!:CsmQmtdc1633SgRc].

The ExtendedStatusChange event will trigger with PairRemoteFeedbackEventId.

Public propertyParent Parent switch
Public propertyPowerSourceFeedback Property to report the power source.
Remarks
'true': Reserved for Future Use; 'false': Battery
This property is not supported by [!:CsmQmtdc1633SgRc].

The ExtendedStatusChange event will trigger with PowerSourceEventId.

Public propertyUserSpecifiedObject User specified object
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodToString String representation of the ShadeExtendedStatus.
(Overrides ObjectToString)
Top
Events
 NameDescription
Public eventExtendedStatusChange Event fired when a property of the ShadeExtendedStatus has changed. EventIds for this event are located in the ShadeBase class.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also