Click or drag to resize

ClcLedPwmRgbBaseClass Class

Base class for the CLC-1LEDPWM-RGBXX-EX dimmers.

This class will trigger BaseEvent event.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpPro.DeviceSupportClcLedPwmRgbBaseClass
        Crestron.SimplSharpPro.LightingClc1LedpwmRgbwGenericEx

Namespace: Crestron.SimplSharpPro.DeviceSupport
Assembly: Crestron.SimplSharpPro.DeviceSupport (in Crestron.SimplSharpPro.DeviceSupport.dll) Version: 2.21.121
Syntax
C#
public class ClcLedPwmRgbBaseClass : GenericDevice, 
	ISendParameters

The ClcLedPwmRgbBaseClass type exposes the following members.

Properties
 NameDescription
Public propertyBlueLevelFeedback Blue level feedback for this dimmer.

The BaseEvent event will trigger with BlueLevelFeedbackEventId.

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 propertyDimmingCurve Dimming Curve object for this device
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyGreenLevelFeedback Green level feedback for this dimmer

The BaseEvent event will trigger with GreenLevelFeedbackEventId.

Public propertyHueFeedback Hue feedback for this dimmer. The HueLevelFeedbackEventId event will trigger to indicate that the property has changed.
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIntensityFeedback Intensity feedback for this dimmer. The IntensityLevelFeedbackEventId event will trigger to indicate that the property has changed.
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 propertyParameterCustomPwmFrequency Parameter to set the custom frequency. Only valid when ParameterPwmFrequency is set to be Custom Valid range is 24 to 1200 with a default value of 1000.
Public propertyParameterPwmFrequency Parameter to set the PWM frequency
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyRedLevelFeedback Red Level feedback for this dimmer

The BaseEvent event will trigger with RedLevelFeedbackEventId.

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 propertySaturationFeedback Saturation feedback for this dimmer. The SaturationLevelFeedbackEventId event will trigger to indicate that the property has changed.
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)
Public propertyWhiteLevelFeedback White feedback for this dimmer.

The BaseEvent event will trigger with WhiteLevelFeedbackEventId.

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)
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodSendParameters Function for sending parameters on the fly.
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
Public fieldStatic memberBlueLevelFeedbackEventId The state of BlueLevelFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberDimmingCurveFeedbackEventId The state of CurrentDimmingCurveFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberGreenLevelFeedbackEventId The state of GreenLevelFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberHueLevelFeedbackEventId The state of HueFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberIntensityLevelFeedbackEventId The state of IntensityFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberRedLevelFeedbackEventId The state of RedLevelFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberSaturationLevelFeedbackEventId The state of SaturationFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberWhiteLevelFeedbackEventId The state of WhiteLevelFeedback 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