Shade |
This class will trigger BaseEvent and ShadeSettingsPropertyChange events.
public class ShadeWithBasicSettings : ShadeBase
The ShadeWithBasicSettings type exposes the following members.
| Name | Description | |
|---|---|---|
| ConnectedIpList |
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) | |
| Description |
Get/Set the description of this device.
(Inherited from GenericBase) | |
| Disposed |
Property to indicate if the device has been disposed.
(Inherited from GenericDevice) | |
| ErrorFeedback |
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. (Inherited from ShadeBase) | |
| ID |
Property to get the ID of the device.
(Inherited from GenericDevice) | |
| IsFullyClosed |
Sig to report if the shade has reached its lower limit.
The BaseEvent event will trigger with IsFullyClosedEventId. (Inherited from ShadeBase) | |
| IsFullyOpened |
Sig to report if the shade has reached its upper limit.
The BaseEvent event will trigger with IsFullyOpenedEventId. (Inherited from ShadeBase) | |
| IsLowering |
Sig to report if the shade is moving towards its lower limit.
The BaseEvent event will trigger with IsLoweringEventId. (Inherited from ShadeBase) | |
| IsOnline |
Property to get the current online state of the device.
(Inherited from GenericDevice) | |
| IsRaising |
Sig to report if the shade is moving towards its upper limit.
The BaseEvent event will trigger with IsRaisingEventId. (Inherited from ShadeBase) | |
| IsStopped |
Sig to report if the shade has stopped.
The BaseEvent event will trigger with IsStoppedEventId. (Inherited from ShadeBase) | |
| LastDirection |
Property to report the last direction the shade's movement.
The BaseEvent event will trigger with LastDirectionEventId. (Inherited from ShadeBase) | |
| Lower |
Sig to move the shade towards the lower limit or closed position.
(Inherited from ShadeBase) | |
| Name |
Get the name of this device.
(Inherited from GenericBase) | |
| Parent |
The parent that a given object was added to.
(Inherited from GenericBase) | |
| PositionFeedback |
The position reported back from the ShadeBase device.
The BaseEvent event will trigger with PositionFeedbackEventId. (Inherited from ShadeBase) | |
| Raise |
Sig to move the shade towards the upper limit or open position.
(Inherited from ShadeBase) | |
| Registerable |
Property to indicate that this device can be registered.
(Inherited from GenericDevice) | |
| Registered |
Property to get the current registration state of the device.
(Inherited from GenericDevice) | |
| RegistrationFailureReason |
Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice) | |
| ShadeSettings |
Sub class that contains configuration methods and property for the shade.
The ShadeSettingsPropertyChange event will trigger with BasicShadeSettingEventIds. | |
| SIMPLDeviceImplementation |
Internal protected member used for actual device control.
(Inherited from GenericDevice) | |
| TouchDetectedFeedback |
Property to report if a touch action happened.
The BaseEvent event will trigger with TouchDetectedFeedbackEventId. This sig is only valid for the Crestron.SimplSharpPro.Shades.CsmQmtdcDrp3Ex and Crestron.SimplSharpPro.Shades.CsmQmtdcDrp3Cn device. (Inherited from ShadeBase) | |
| Type |
Property to determine to type of device this is.
(Inherited from GenericDevice) | |
| UnRegistrationFailureReason |
Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice) | |
| UserSpecifiedObject |
Can be assigned anything that user wants.
(Inherited from GenericBase) | |
| XioEndpointStubSIMPLDevice |
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) |
| Name | Description | |
|---|---|---|
| Close |
Moves the shade to the lower limit.
(Inherited from ShadeBase) | |
| DisableStateInformation |
Method to prevent the ShadeBase device from reporting state information to the control system.
(Inherited from ShadeBase) | |
| Dispose |
Clean up of resources.
(Inherited from GenericBase) | |
| Dispose(Boolean) |
Method to perform the actual disposing of the device.
(Inherited from GenericDevice) | |
| EnableStateInformation |
Method to allow the ShadeBase device to report state information to the control system.
(Inherited from ShadeBase) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize |
Destructor of the device.
(Inherited from GenericDevice) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| InitializeDevice |
Method to initialize the ShadeBase device.
(Inherited from ShadeBase) | |
| InitializeShadeErrorStatus |
Method to initialize the shade error status sig information.
(Inherited from ShadeBase) | |
| InitializeShadeInputs |
Method to initialize the input sig information.
(Inherited from ShadeBase) | |
| InitializeShadeOutputs |
Method to initialize the output sig information.
(Inherited from ShadeBase) | |
| InitializeSpecificShadeDevice |
Method to initialize the shade settings slot.
(Overrides ShadeBaseInitializeSpecificShadeDevice) | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
| OnBaseEvent(Int32) |
Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase) | |
| OnBaseEvent(Int32, UInt16) |
Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase) | |
| Open |
Moves the shade to the upper limit.
(Inherited from ShadeBase) | |
| Register |
Register this device with the system.
(Inherited from GenericDevice) | |
| SendParameters |
Function for sending parameters on the fly.
Not Currently implemented. This will throw a NotSupportedException
(Inherited from ShadeBase) | |
| SetPosition |
Method to send the ShadeBase to a particular position where 0x0000 is the lower limit and 0xffff corresponds to the upper limit.
(Inherited from ShadeBase) | |
| Stop |
Stops all shade movement.
(Inherited from ShadeBase) | |
| ToString |
Return the name of the device.
(Inherited from GenericDevice) | |
| UnRegister |
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) |
| Name | Description | |
|---|---|---|
| BaseEvent |
Generic base event, triggered when the there are no other handlers available
for a specific EventID.
(Inherited from GenericBase) | |
| IpInformationChange |
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) | |
| OnlineStatusChange |
Event triggered when the Online status of the device changes.
(Inherited from GenericDevice) |
| Name | Description | |
|---|---|---|
| SendLowOnPulse |
Flag to indicate if this shade will transmit a low for digital pulses.
(Inherited from ShadeBase) |