Click or drag to resize

CsmQmtdcDrp3Ex Class

infiNET EX based digital QMT drapery track motor for Drapery tracks up to 16 feet. It allows for control of the position and direction of motion of the drapery

This class will trigger BaseEvent event.

Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.Shades
Assembly: Crestron.SimplSharpPro.Shades (in Crestron.SimplSharpPro.Shades.dll) Version: 2.21.121
Syntax
C#
public sealed class CsmQmtdcDrp3Ex : ShadeWithBasicSettings, 
	IShadeSpeed, IGroupableDevice<ShadeBase>

The CsmQmtdcDrp3Ex type exposes the following members.

Constructors
 NameDescription
Public methodCsmQmtdcDrp3Ex Constructor to generate a new CsmQmtdcDrp3Ex that is attached to the specified RF gateway.
Top
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 propertyDeviceGroups Shade groups that this shade has been added to. The keys are the shade group IDs.
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.


(Inherited from ShadeBase)
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.


(Inherited from ShadeBase)
Public propertyIsFullyOpened Sig to report if the shade has reached its upper limit.

The BaseEvent event will trigger with IsFullyOpenedEventId.


(Inherited from ShadeBase)
Public propertyIsLowering Sig to report if the shade is moving towards its lower limit.

The BaseEvent event will trigger with IsLoweringEventId.


(Inherited from ShadeBase)
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.


(Inherited from ShadeBase)
Public propertyIsStopped Sig to report if the shade has stopped.

The BaseEvent event will trigger with IsStoppedEventId.


(Inherited from ShadeBase)
Public propertyLastDirection Property to report the last direction the shade's movement.

The BaseEvent event will trigger with LastDirectionEventId.


(Inherited from ShadeBase)
Public propertyLower Sig to move the shade towards the lower limit or closed position.
(Inherited from ShadeBase)
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.


(Inherited from ShadeBase)
Public propertyRaise Sig to move the shade towards the upper limit or open position.
(Inherited from ShadeBase)
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)
Public propertyShadeSettings Sub class that contains configuration methods and property for the shade.

The ShadeSettingsPropertyChange event will trigger with BasicShadeSettingEventIds.


(Inherited from ShadeWithBasicSettings)
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.

(Inherited from ShadeBase)
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.
(Inherited from ShadeBase)
Public methodDisableStateInformation Method to prevent the ShadeBase device from reporting state information to the control system.
(Inherited from ShadeBase)
Public methodDisableTouchReaction Method to disable the CsmQmtdcDrp3Ex device's reaction to touch sensitivity.
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.
(Inherited from ShadeBase)
Public methodEnableTouchReaction Method to enable the CsmQmtdcDrp3Ex device's reaction to touch sensitivity.
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 Function to initialize the device
(Overrides ShadeBaseInitializeDevice(CrestronDeviceWithEvents))
Protected methodInitializeShadeErrorStatus Method to initialize the shade error status sig information.
(Inherited from ShadeBase)
Protected methodInitializeShadeInputs Method to initialize the input sig information.
(Inherited from ShadeBase)
Protected methodInitializeShadeOutputs Method to initialize the output sig information.
(Inherited from ShadeBase)
Protected methodInitializeSpecificShadeDevice Method to initialize the shade settings slot.
(Overrides ShadeWithBasicSettingsInitializeSpecificShadeDevice)
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.
(Inherited from ShadeBase)
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
(Inherited from ShadeBase)
Public methodSetPosition 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)
Public methodSpeed Method to set the rotational speed of the shade's motor. Valid Range is from 10 to 30, if set to zero the default of 25 is used.
Public methodStop Stops all shade movement.
(Inherited from ShadeBase)
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
Protected fieldSendLowOnPulse Flag to indicate if this shade will transmit a low for digital pulses.
(Inherited from ShadeBase)
Top
Example
This is an example of how to instantiate and use the CsmQmtdcDrp3Ex device. The device is added to an external CenRfgwEx device.
C#
// Register the device within the constructor or InitializeSystem function
public ControlSystem() : base()
{
    CenRfgwEx   myEXGateway;
    CsmQmtdcDrp3Ex myShadeDevice;

    // Instantiate the CenRfgwEx gateway
    myEXGateway = new CenRfgwEx(0x14,this);

    // Instantiate the device
    myShadeDevice = new CsmQmtdcDrp3Ex(0x10,myEXGateway);

    // Now register the event handlers
    // There is OnlineStatusChange handler for an EX device. However, you can subscribe to the  LinkStateChange handler on the ExtenderLinkState on the 
    // Gateway device.
    myShadeDevice.BaseEvent += new BaseEventHandler(ShadeDevice_BaseEventHandler);
    myShadeDevice.ShadeSettings.ShadeSettingsPropertyChange += new GenericEventHandler(ShadeDevice_ShadeSettingsPropertyChange);

    // Now register the gateway. This will register the all the devices which have been added to the gateway.
    if (myEXGateway.Register() != eDeviceRegistrationUnRegistrationResponse.Success)
        CrestronConsole.PrintLine(" Unable to register for device ");
    else
       CrestronConsole.PrintLine(" Device successfully registered "); 
}

// Event handler for the ShadeSettings
void ShadeDevice_ShadeSettingsPropertyChange(object sender, GenericEventArgs args)
{
    switch (args.EventId)
    {
        case BasicShadeSettingEventIds.LowerLimitSetEventId:
            break;
        case BasicShadeSettingEventIds.RaiseIsClockWiseEventId:
            break;
        case BasicShadeSettingEventIds.UpperLimitSetEventId:
            break;
    }
}

// Base Event Handler for the shade device
void ShadeDevice_BaseEventHandler(GenericBase device, BaseEventArgs args)
   {

    CrestronConsole.PrintLine(" Device named {0} - event Id is {1} ", device.ToString(), args.EventId.ToString());
    switch (args.EventId)
    {
        case ShadeBase.ErrorFeedbackEventId:
            CrestronConsole.PrintLine(" Shade error feedback bits are {0} ", myShadeDevice.ErrorFeedback.UShortValue);
            break;
        case ShadeBase.IsFullyClosedEventId:
            if (myShadeDevice.IsFullyClosed.BoolValue == false)
                CrestronConsole.PrintLine(" Shade not fully closed ");
            else
                CrestronConsole.PrintLine(" Shade fully closed ");
            break;
        case ShadeBase.IsFullyOpenedEventId:
            if (myShadeDevice.IsFullyOpened.BoolValue == false)
                CrestronConsole.PrintLine(" Shade not fully opened");
            else
                CrestronConsole.PrintLine(" Shade fully opened ");
            break;
        case ShadeBase.TouchDetectedFeedbackEventId:
            // This is only valid for the CsmQmtdcDrp3Ex and the CsmQmtdcDrp3Cn
            if (myShadeDevice.TouchDetectedFeedback.BoolValue == false)
                CrestronConsole.PrintLine(" Touch not detected");
            else
                CrestronConsole.PrintLine(" Touch detected ");
            break;
    }
}

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also