Click or drag to resize

ClwiDimmer Class

Base class for CLWI dimmer devices.
Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.Lighting
Assembly: Crestron.SimplSharpPro.Lighting (in Crestron.SimplSharpPro.Lighting.dll) Version: 2.21.121
Syntax
C#
public class ClwiDimmer : ClcwBase, IClwiKeypad, 
	ILearnableButtons, IButton

The ClwiDimmer type exposes the following members.

Constructors
 NameDescription
Protected methodClwiDimmer Constructor to generate a new ClwiDimmer.
Top
Properties
 NameDescription
Public propertyButton Property to get the collection of buttons on the device.
Public propertyButtonLayoutFeedback Reports the button layout of the device.
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 propertyDimmerUISettings Class to specify the parameters of the user interface of this unit.
Public propertyDimmingLoads Collection of Dimming loads for this device.
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.
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyInNightlightMode Returns the input cue that can be used to enable or disable nightlight mode. When the input cue is set to true it enables nightlight mode when it is set to false it disables nightlight mode.
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyLeftRemoteBargraph Sets the left bargraph to the designated percentage. If set between 1 and 100 enables bargraph mode and sets bargraph to the designated percentage. Setting to 0 disables bargraph mode.
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 values range from 0s to 600s. Use the SimplSharpDeviceHelper.SecondsToUShort to convert the time to a ushort value or the SimplSharpDeviceHelper.UShortToSeconds to convert the ushort value to seconds
(Overrides ClcwBaseParameterDimmerDelayedOffTime)
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
(Overrides ClcwBaseParameterOffFadeTime)
Public propertyParameterPreset1Default Sets the default level of the corresponding preset. This level will be active at startup and whenever the reset function is triggered. Default value is 100% Valid values range from 0% to 100% Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyParameterPreset2Default Sets the default level of the corresponding preset. This level will be active at startup and whenever the reset function is triggered. Default value is 50% Valid values range from 0% to 100% Use the PercentToUshort(Single)to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyParameterPreset3Default Sets the default level of the corresponding preset. This level will be active at startup and whenever the reset function is triggered. Default value is 25% Valid values range from 0% to 100% Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
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
(Overrides ClcwBaseParameterPresetFadeTime)
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
(Overrides ClcwBaseParameterRaiseLowerRate)
Public propertyParameterRemoteDoubleTapTime The time between the end of the first tap and the start of the second tap for a double tap to be recognized. Valid values range from 0.20 to 1.00 second. Use the SimplSharpDeviceHelper.SecondsToUShort to convert the time to a ushort value or the SimplSharpDeviceHelper.UShortToSeconds to convert the ushort value to seconds
Public propertyParameterRemoteHoldTime The time that a button must be held before it is recognized as a "Hold" instead of a "Tap". Valid values range from 0.20 to 1.00 second. Use the SimplSharpDeviceHelper.SecondsToUShort to convert the time to a ushort value or the SimplSharpDeviceHelper.UShortToSeconds to convert the ushort value to seconds
Public propertyParameterRemoteWaitForDoubleTap Determines whether a "Tap" should be sent immediately on the release of the button, or if the unit should wait until a Double Tap event occurs.
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)
Public propertyRightRemoteBargraph Sets the Right bargraph to the designated percentage. If set between 1 and 100 enables bargraph mode and sets bargraph to the designated percentage. Setting to 0 disables bargraph mode.
Public propertySetMaxLevel Sets the maximum dim level setting. Allowable values between 0xC000-0xFFFF (75% - 100%). If passed a value outside this range the level will be set to 75%.
Public propertySetMinLevel Sets the minimum dim level setting. Allowable integer input range between 0x0000-0x7FFF (0% - 49%). Values outside this range shall clamp to 49%.
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
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 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 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)
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 eventLearnableButtonEvent Event triggered when a learning event occurs on the device.
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_DimmerSettingsSlot Dimmer slot device.
Protected field_DimmerUISettings Dimmer UI settings.
Protected field_UISettingsSlot UI settings slot device.
Public fieldStatic memberButtonLayoutEventId Event ID for the base event for when the button layout is reported.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also