Click or drag to resize

BasicShadeSettings Class

Basic shade configuration object.

This class will trigger ShadeSettingsPropertyChange event.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.ShadesBasicShadeSettings

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

The BasicShadeSettings type exposes the following members.

Properties
 NameDescription
Public propertyFindingLimits Sig to indicate that the Open Limit and Close Limit values are being found for a drape.

The ShadeSettingsPropertyChange event will trigger with FindingLimitsEventId.

Remarks
'true' = finding limits; 'false' = not finding limits
Public propertyLowerLimit Moves the shade or drape in the close direction. This signal is equivalent to "CLOSE" while in Upper Limit Setup Mode or Lower Limit Setup Mode.
Public propertyLowerLimitSet Sig to indicate that the shade's lower limit or the drape's close limit has been set.

The ShadeSettingsPropertyChange event will trigger with LowerLimitSetEventId.

Public propertyParameterUseMinimalRcb If set to 1, the device will send only one estimated RCB during the start of any motion. Default value is 0. Values from 0 to 65535 are valid. For CSM-QMTDC-163-1-SG and CSM-QMTDC-163-3-SG-RC this parameter is not supported.
Public propertyPositionKnown Sig to indicate if the position is known for a drape.

The ShadeSettingsPropertyChange event will trigger with PositionKnownEventId.

Remarks
'true' = position known; 'false' = position unknown
Public propertyRaiseIsClockwise Property to indicate the direction the motor will rotate to open the shade or drape. Default is CounterClockWise (false).

The ShadeSettingsPropertyChange event will trigger with RaiseIsClockWiseEventId.

Remarks
'true' = the raise/open direction is clockwise; 'false' = the raise/open direction is counter clockwise
Public propertyRaiseLimit Moves the shade or drape in the open direction. This signal is equivalent to "OPEN" while in Upper Limit Setup Mode or Lower Limit Setup Mode.
Public propertyUpperLimitSet Sig to indicate that the shade's upper limit or the drape's open limit has been set.

The ShadeSettingsPropertyChange event will trigger with UpperLimitSetEventId.

Top
Methods
 NameDescription
Public methodClearLowerLimit Temporarily disables the lower limit of the shade or the close limit of the drape. Limit shall not be permanently erased until the limit setting process is completed.
Public methodClearUpperLimit Temporarily disables the upper limit of the shade or the open limit of a drape. Limit shall not be permanently erased until the limit setting process is completed.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodFindLimits This method will allow the drape to automatically find hard limits.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodInitializeInputs Method to initialize all the input sigs going in to the shade device.
Protected methodInitializeOutputs Method to initialize all of the output sigs received from the shade device.
Public methodJogDownLimit For the CSC-DCCN/DCEX and CSM-QMT50-DCCN/DCEX this method will lower the shade for a short period of time or a fixed amount of encoder positions. Each subsequent resumes movement. All shade jogs are a fixed number of ticks for the CSC-ACCN/ACEX - 7 encoder ticks, 200 ticks per tube revolution). Drape jogs are defined by a fixed time.
Public methodJogUpLimit For the CSC-DCCN/DCEX and CSM-QMT50-DCCN/DCEX this method will raise the shade for a short period of time or a fixed amount of encoder positions. Each subsequent resumes movement. All shade jogs are a fixed number of ticks for the CSC-ACCN/ACEX - 7 encoder ticks, 200 ticks per tube revolution). Drape jogs are defined by a fixed time.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnShadeSettingsPropertyChange Method to trigger the ShadeSettingsPropertyChange event.
Public methodReverseDirection Method to toggle the rolling direction that was configured as the open direction. Action shall clear both upper/open and lower/close limits. This method is not supported by CSM-QMTDC-163-1-SG battery shade and call to this method is ignored. Method to reverse the direction of motor rotation. Invalidates both limits since changing direction makes their orientation invalid. Reversing the rotation will set the upper and lower limits to the current position of the shade, resulting in no movement when a position input is asserted. For this reason the upper and lower limits must be reset after the reverse command is triggered. For most applications the reverse command will be set only once, if necessary, during installation. The above description is for CSM-QMTDC-163-1-SG-RC battery shade only.
Public methodSetLowerLimit Method to set the lower limit for a shade or the close limit for a drape to the current position. This shall terminate the limit setting process.
Public methodSetUpperLimit Method to set the upper limit for a shade or the open limit for a drape to the current position. This shall terminate the limit setting process.
Public methodToString String representation of the BasicShadeSettings.
(Overrides ObjectToString)
Top
Events
 NameDescription
Public eventShadeSettingsPropertyChange Event fired when a property of the BasicShadeSettings has changed. EventIds for this event are located in the BasicShadeSettingEventIds class.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also