Click or drag to resize

ClfiLDimuex Class

CLFI-LDIMUEX plug-in, single-channel lighting dimmer , 230VAC
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpPro.DeviceSupportLightingBase
        Crestron.SimplSharpPro.LightingDimmer
          Crestron.SimplSharpPro.LightingAdvDimmer
            Crestron.SimplSharpPro.LightingClcwBase
              Crestron.SimplSharpPro.LightingClDimmer
                Crestron.SimplSharpPro.LightingClDimuex
                  Crestron.SimplSharpPro.LightingClfiLDimuex

Namespace: Crestron.SimplSharpPro.Lighting
Assembly: Crestron.SimplSharpPro.Lighting (in Crestron.SimplSharpPro.Lighting.dll) Version: 2.21.121
Syntax
C#
public sealed class ClfiLDimuex : ClDimuex

The ClfiLDimuex type exposes the following members.

Constructors
 NameDescription
Public methodClfiLDimuex Constructor to create a new CLFI-LDIMUEX single-channel lighting dimmer
Top
Properties
 NameDescription
Public propertyButton Collection of buttons supported by the device.
(Inherited from AdvDimmer)
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 propertyDimmerRemoteButtonsSettings Property to get the specific remote button settings for the dimmer device.
(Inherited from ClDimmer)
Public propertyDimmerUISettings Property to get the specific UI settings for the dimmer device.
(Inherited from ClDimmer)
Public propertyDimmingLoads Collection of Dimming loads for this device.
(Inherited from ClDimuex)
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyFeedbacks Property to get the collection of feedbacks on the device.
(Inherited from AdvDimmer)
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyParameterDimmerDelayedOffTime Sets the delay time prior to starting the off fade when performing a Dimmer delayed off operation. Field is in seconds. Default value is 0 seconds. Valid delay times range from 0s (no delay) to 600s (10 minutes). Use the SimplSharpDeviceHelper.SecondsToUShort to convert the time to a ushort value or the SimplSharpDeviceHelper.UShortToSeconds to convert the ushort value to seconds
(Inherited from ClDimmer)
Public propertyParameterOffFadeTime Sets the time that it takes to ramp the light level from its current level to 0% in full off and delayed off operations. Field is in seconds. Default value is 1 second. Valid values range from 0.25s to 30s. Use the SimplSharpDeviceHelper.SecondsToUShort to convert the time to a ushort value or the SimplSharpDeviceHelper.UShortToSeconds to convert the ushort value to seconds
(Inherited from ClDimmer)
Public propertyParameterPresetFadeTime Sets the time that it takes to ramp the light level from its current level to the target level in preset recalls or full on operations. Field is in seconds. Default value is 1 second. Valid values range from 0.25s to 10s. Use the SimplSharpDeviceHelper.SecondsToUShort to convert the time to a ushort value or the SimplSharpDeviceHelper.UShortToSeconds to convert the ushort value to seconds
(Inherited from ClDimmer)
Public propertyParameterRaiseLowerRate Sets the time that it takes to ramp the light level from 0% to 100% (or vice versa) in raise/lower operations. Field is in seconds. Default value is 3 seconds. Valid values range from 1 second to 10 seconds. Use the SimplSharpDeviceHelper.SecondsToUShort to convert the time to a ushort value or the SimplSharpDeviceHelper.UShortToSeconds to convert the ushort value to seconds
(Inherited from ClDimmer)
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
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 propertyStatusFeedback Property to get the currently reported error status of the device.
(Inherited from ClDimmer)
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
Protected method_DimmerSlot_CueChange Subscription to the SigChange Event for each of the dimmer slots. This method only support a two dimmer slot device that contains the base support for a single preset.
(Inherited from ClDimmer)
Protected methodDimmerRemoteButtonsSlot_CueChange Subscription to the Remote Buttons Settings slot.
(Inherited from ClDimmer)
Protected methodDimmerUISettingsSlot_CueChange Subscription to the UI Settings slot change event. This is done to fire the generic base event when the StatusFeedback property changes.
(Inherited from ClDimmer)
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 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 methodInitializeButtons Method to initialize the buttons of the device.
(Inherited from ClDimmer)
Protected methodInitializeDevice Method to initialize the device information as specified.
(Inherited from ClDimuex)
Protected methodInitializeLoadInformation Method to initialize the load information of the device.
(Inherited from ClDimuex)
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)
Protected methodOnButtonStateChange Method to fire the button state change event.
(Inherited from AdvDimmer)
Protected methodOnLoadStateChange Method to fire the LoadStateChange event.
(Inherited from LightingBase)
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodSendParameters This will send the parameters fields (if any) to the device. It allows the parameters to be modified and resent without unregistering and re-registering a device. It requires firmware support on the device. Not Currently implemented. This will throw a NotSupportedException
(Inherited from LightingBase)
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 eventButtonStateChange Event fired when a button state change was received from the device.
(Inherited from AdvDimmer)
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 eventLoadStateChange Event triggered when information from a load is received. EventIds for this event are located in the LoadEventIds class.
(Inherited from LightingBase)
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Inherited from GenericDevice)
Top
Fields
 NameDescription
Protected field_DimmerRemoteButtonsSlot Dimmer remote buttons slot device.
(Inherited from ClDimmer)
Protected field_DimmerSettingsSlot Dimmer settings slot device.
(Inherited from ClDimmer)
Protected field_DimmerSlots Array of slots that control the dimmer loads.
(Inherited from ClDimmer)
Protected field_DimmerUISettingsSlot UI settings slot device.
(Inherited from ClDimmer)
Protected field_NumberOfButtons Number of buttons this device supports.
(Inherited from ClDimmer)
Protected field_SpecificDimLoadCollection Collection of the loads specific to this device.
(Inherited from ClDimmer)
Public fieldDimmerStatusFeedbackEventId When the devices sends the control system a new error status, this is the event ID for the base event.
(Inherited from ClDimmer)
Public fieldPhaseControlFeedbackEventId Event ID for the base event for when the phase control of the load is reported.
(Inherited from ClDimuex)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also