Click or drag to resize

ClwDimuEx Class

Cameo Express 120V 230V and 277V ELV dimmers.
Inheritance Hierarchy

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

The ClwDimuEx type exposes the following members.

Constructors
 NameDescription
Public methodClwDimuEx Constructor to generate a new ClwDimuEx.
Top
Properties
 NameDescription
Public propertyBargraphValue Property to set the bargraph's value.
(Inherited from ClwDimex)
Public propertyButton Collection of buttons supported by the device.
(Inherited from ClwDimex)
Public propertyButtonLayout Property to get the current button layout information as reported by the device.
(Inherited from ClwDimex)
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 propertyDimmerRemoteButtonSettings Property to get the specific Remote button settings for the dimmer load.
(Inherited from ClwDimex)
Public propertyDimmerUISettings Property to get the specific UI settings for the dimmer load.
(Inherited from ClwDimex)
Public propertyDimmingLoads Collection of dimming loads for this device.
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyEnableNightLevel Property to enable all LEDs that are currently in the ‘on’ state to illuminate with a night level dim setting. true = Enable the Night Level on all active LEDs; false = Disable Night Level and use normal brightness setting on all active LEDs
Public propertyFeedbacks Property to get the array of feedbacks on the device.
(Inherited from ClwDimex)
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 propertyLoadErrorFeedback Property to indicate the type of error detected by the dimmer.

This property will trigger BaseEvent event with LoadErrorFeedbackEventId.

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 hundredths of a second. Default value is 0 seconds. Valid delay times range from 0s (no delay) to 10m (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 ClwDimex)
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 hundredths of a second. Default value is 1 second (100 hundredths of a 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 ClwDimex)
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 hundredths of a second. Default value is 1 second (100 hundredths of a 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 ClwDimex)
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 hundredths of a second. Default value is 3 seconds (300 hundredths of a second). Valid values range from 1 second to 5 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 ClwDimex)
Public propertyParameterSuppressFeedbackMode Parameter that defines how the SuppressFeedback property will operate when asserted. It may hold of all feedback and only send the latest snapshot when released, or always send with a predetermined delay.
Public propertyParameterZcSyncErrOnOffThreshold Parameter to define the threshold for current light level the dimmer should switch to either Full On or Off when the zero cross sync is lost due to noise on the AC Line. This is to prevent the user from being disturbed during noisy line conditions.

Valid values range from 0% to 100%. Default value is 15%.

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.

Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyPhaseControlFeedback Property to indicate the current phase mode operation detected.

This property will trigger BaseEvent event with PhaseControlFeedbackEventId.

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 propertySuppressFeedback Property to define if Feedback properties are suppressed/stopped. The associated parameter ParameterSuppressFeedbackMode is used to set options in how this feature operates. This property allows for the reduction of RF traffic to reduce latency when desired (such as whole house scenes). Note: On device startup, this property is internally cleared and not saved in NV: the device will send all properties on an update request and will continue to do so until this property is set to true and the parameter is set to the case SendOnRelease. true = Suppress Feedback properties; false = Release/Allow Feedback properties
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 methodDimmerSlot_OnSignalChange Subscription to the Dimmer Slot's Sig Change Event to retrigger Generic Events as needed.
(Inherited from ClwDimex)
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 methodInitializeDevice InitializeDevice
(Inherited from ClwDimex)
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 methodOnLearnableButtonEvent Method to triggered the LearnableButtonEvent
(Inherited from ClwDimex)
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 eventLearnableButtonEvent Event triggered when an learning event occurred on the device.
(Inherited from ClwDimex)
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_SpecificDimLoadCollection Collection of the loads specific to this device.
(Inherited from ClwDimex)
Public fieldStatic memberLoadErrorFeedbackEventId The value of LoadErrorFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberPhaseControlFeedbackEventId The value of PhaseControlFeedback 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