Click or drag to resize

ShadeBase Class

Base class for shade and drape devices.

This class will trigger BaseEvent event.

Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.DeviceSupport
Assembly: Crestron.SimplSharpPro.DeviceSupport (in Crestron.SimplSharpPro.DeviceSupport.dll) Version: 2.21.121
Syntax
C#
public class ShadeBase : GenericDevice, ISendParameters

The ShadeBase type exposes the following members.

Properties
 NameDescription
Public propertyConnectedIpList A property containing the list of the ConnectedIpInformation objects which contain information about the devices that are connected to this IP ID. This property is only valid for an ethernet device. If this is not an ethernet device, then this property will return null. If this is an ethernet device, the list will be non-null. It will be empty if no devices are connected. The order of items in this list is not guaranteed.
(Inherited from GenericDevice)
Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyErrorFeedback Reports a bit-mapped error message as received from the ShadeBase device. For "Crestron.SimplSharpPro.Shades.CsmQmtdc1633SgRc" the value representations are as follows... Motor error bits: 0x0004 = Motor reports stopped on obstacle (verify fabric not caught up); 0x0010 = Communication problem with motor

The BaseEvent event will trigger with ErrorFeedbackEventId.

Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIsFullyClosed Sig to report if the shade has reached its lower limit.

The BaseEvent event will trigger with IsFullyClosedEventId.

Public propertyIsFullyOpened Sig to report if the shade has reached its upper limit.

The BaseEvent event will trigger with IsFullyOpenedEventId.

Public propertyIsLowering Sig to report if the shade is moving towards its lower limit.

The BaseEvent event will trigger with IsLoweringEventId.

Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyIsRaising Sig to report if the shade is moving towards its upper limit.

The BaseEvent event will trigger with IsRaisingEventId.

Public propertyIsStopped Sig to report if the shade has stopped.

The BaseEvent event will trigger with IsStoppedEventId.

Public propertyLastDirection Property to report the last direction the shade's movement.

The BaseEvent event will trigger with LastDirectionEventId.

Public propertyLower Sig to move the shade towards the lower limit or closed position.
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyPositionFeedback The position reported back from the ShadeBase device.

The BaseEvent event will trigger with PositionFeedbackEventId.

Public propertyRaise Sig to move the shade towards the upper limit or open position.
Public propertyRegisterable Property to indicate that this device can be registered.
(Inherited from GenericDevice)
Public propertyRegistered Property to get the current registration state of the device.
(Inherited from GenericDevice)
Public propertyRegistrationFailureReason Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice)
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertyTouchDetectedFeedback Property to report if a touch action happened.

The BaseEvent event will trigger with TouchDetectedFeedbackEventId.

Remarks
This sig is only valid for the Crestron.SimplSharpPro.Shades.CsmQmtdcDrp3Ex and Crestron.SimplSharpPro.Shades.CsmQmtdcDrp3Cn device.
Public propertyType Property to determine to type of device this is.
(Inherited from GenericDevice)
Public propertyUnRegistrationFailureReason Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice)
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from GenericBase)
Protected propertyXioEndpointStubSIMPLDevice The SIMPL "stub" Device that the XiO Director creates for an endpoint to send the 1C/0E to the correct place in hierarchy.
(Inherited from GenericDevice)
Top
Methods
 NameDescription
Public methodClose Moves the shade to the lower limit.
Public methodDisableStateInformation Method to prevent the ShadeBase device from reporting state information to the control system.
Public methodDispose Clean up of resources.
(Inherited from GenericBase)
Protected methodDispose(Boolean) Method to perform the actual disposing of the device.
(Inherited from GenericDevice)
Public methodEnableStateInformation Method to allow the ShadeBase device to report state information to the control system.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Destructor of the device.
(Inherited from GenericDevice)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodInitializeDevice Method to initialize the ShadeBase device.
Protected methodInitializeShadeErrorStatus Method to initialize the shade error status sig information.
Protected methodInitializeShadeInputs Method to initialize the input sig information.
Protected methodInitializeShadeOutputs Method to initialize the output sig information.
Protected methodInitializeSpecificShadeDevice Method used to initialize specific information of the ShadeBase device from the derived classes.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnBaseEvent(Int32) Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase)
Protected methodOnBaseEvent(Int32, UInt16) Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase)
Public methodOpen Moves the shade to the upper limit.
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodSendParameters Function for sending parameters on the fly. Not Currently implemented. This will throw a NotSupportedException
Public methodSetPosition Method to send the ShadeBase to a particular position where 0x0000 is the lower limit and 0xffff corresponds to the upper limit.
Public methodStop Stops all shade movement.
Public methodToString Return the name of the device.
(Inherited from GenericDevice)
Public methodUnRegister Unregister this device with the system. This function can not be called from the device's own SigChange event handler.

On successful unregistration, if this device supports the OnlineStatusChange event, it will trigger indicating the device when offline.


(Inherited from GenericDevice)
Top
Events
 NameDescription
Public eventBaseEvent Generic base event, triggered when the there are no other handlers available for a specific EventID.
(Inherited from GenericBase)
Public eventIpInformationChange Event that tells what IP Address is connected/disconnected from an IP ID for a non-UDP device. This is only valid for an Ethernet device. An exception will be thrown if it is not.
(Inherited from GenericDevice)
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Inherited from GenericDevice)
Top
Fields
 NameDescription
Public fieldStatic memberBatteryAboveLowEventId The state of "CsmQmtdc1631Sg.BatteryAboveLowFeedback" has changed.

The "ShadeExtendedStatus.ExtendedStatusChange" event will trigger for this event id.

Public fieldStatic memberBatteryAnalogDisablePushEventId The state of "CsmQmtdc1631Sg.BatteryAnalogDisablePushFeedback" has changed.

The "ShadeExtendedStatus.ExtendedStatusChange" event will trigger for this event id.

Public fieldStatic memberBatteryCapacityLeftFeedbackEventId The value of "CsmQmtdc1631Sg.BatteryCapacityLeftFeedback" has changed.

The "ShadeExtendedStatus.ExtendedStatusChange" event will trigger for this event id.

Public fieldStatic memberBatteryLevelFeedbackEventId The value of "CsmQmtdc1631Sg.BatteryLevelFeedback" has changed.

The "ShadeExtendedStatus.ExtendedStatusChange" event will trigger for this event id.

Public fieldStatic memberBatteryLowEventId The state of "CsmQmtdc1631Sg.BatteryLowFeedback" has changed.

The "ShadeExtendedStatus.ExtendedStatusChange" event will trigger for this event id.

Public fieldStatic memberBatteryUnusableEventId The state of "CsmQmtdc1631Sg.BatteryUnusableFeedback" has changed.

The "ShadeExtendedStatus.ExtendedStatusChange" event will trigger for this event id.

Public fieldStatic memberConnectedRemotesFeedbackEventId The state of "ShadeExtendedStatus.ConnectedRemotesFeedback" has changed.

The "ShadeExtendedStatus.ExtendedStatusChange" event will trigger for this event id.

Public fieldStatic memberErrorFeedbackEventId The value of ErrorFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberIsFullyClosedEventId The state of IsFullyClosed has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberIsFullyOpenedEventId The state of IsFullyOpened has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberIsLocatingBeeperOnEventId The state of "CsmQmtdc1631Sg.IsLocatingBeeperOnFeedback" has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberIsLoweringEventId The state of IsLowering has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberIsRaisingEventId The state of IsRaising has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberIsStoppedEventId The state of IsStopped has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberLastDirectionEventId The value of LastDirection has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberPairRemoteFeedbackEventId The state of "ShadeExtendedStatus.PairRemoteFeedback" has changed.

The "ShadeExtendedStatus.ExtendedStatusChange" event will trigger for this event id.

Public fieldStatic memberPositionFeedbackEventId The value of PositionFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberPowerSourceEventId The state of "CsmQmtdc1631Sg.PowerSourceFeedback" has changed.

The "ShadeExtendedStatus.ExtendedStatusChange" event will trigger for this event id.

Protected fieldSendLowOnPulse Flag to indicate if this shade will transmit a low for digital pulses.
Public fieldStatic memberTiltFeedbackEventId The value of "CsmQmtdcHsheerCn.TiltFeedback" has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTiltFullClosedEventId The value of "CsmQmtdcHsheerCn.TiltFullClosedFeedback" has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTiltFullOpenedEventId The value of "CsmQmtdcHsheerCn.TiltFullOpenedFeedback" has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTouchDetectedFeedbackEventId The value of TouchDetectedFeedback has changed.

The BaseEvent event will trigger for this event id.

Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also