Clci |
public sealed class ClciDimuex : ClDimuex
The ClciDimuex type exposes the following members.
| Name | Description | |
|---|---|---|
| ClciDimuex | Constructor to create a new CLCI-DIMUEX Wireless In-Ceiling Dimmer |
| Name | Description | |
|---|---|---|
| Button |
Collection of buttons supported by the device.
(Inherited from AdvDimmer) | |
| ConnectedIpList |
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) | |
| Description |
Get/Set the description of this device.
(Inherited from GenericBase) | |
| DimmerRemoteButtonsSettings |
Property to get the specific remote button settings for the dimmer device.
(Inherited from ClDimmer) | |
| DimmerUISettings |
Property to get the specific UI settings for the dimmer device.
(Inherited from ClDimmer) | |
| DimmingLoads |
Collection of Dimming loads for this device.
(Inherited from ClDimuex) | |
| Disposed |
Property to indicate if the device has been disposed.
(Inherited from GenericDevice) | |
| Feedbacks |
Property to get the collection of feedbacks on the device.
(Inherited from AdvDimmer) | |
| ID |
Property to get the ID of the device.
(Inherited from GenericDevice) | |
| IsOnline |
Property to get the current online state of the device.
(Inherited from GenericDevice) | |
| Name |
Get the name of this device.
(Inherited from GenericBase) | |
| ParameterDimmerDelayedOffTime |
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) | |
| ParameterOffFadeTime |
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) | |
| ParameterPresetFadeTime |
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) | |
| ParameterRaiseLowerRate |
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) | |
| Parent |
The parent that a given object was added to.
(Inherited from GenericBase) | |
| Registerable |
Property to indicate that this device can be registered.
(Inherited from GenericDevice) | |
| Registered |
Property to get the current registration state of the device.
(Inherited from GenericDevice) | |
| RegistrationFailureReason |
Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice) | |
| SIMPLDeviceImplementation |
Internal protected member used for actual device control.
(Inherited from GenericDevice) | |
| StatusFeedback |
Property to get the currently reported error status of the device.
(Inherited from ClDimmer) | |
| Type |
Property to determine to type of device this is.
(Inherited from GenericDevice) | |
| UnRegistrationFailureReason |
Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice) | |
| UserSpecifiedObject |
Can be assigned anything that user wants.
(Inherited from GenericBase) | |
| XioEndpointStubSIMPLDevice |
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) |
| Name | Description | |
|---|---|---|
| _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) | |
| DimmerRemoteButtonsSlot_CueChange |
Subscription to the Remote Buttons Settings slot.
(Inherited from ClDimmer) | |
| DimmerUISettingsSlot_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) | |
| Dispose |
Clean up of resources.
(Inherited from GenericBase) | |
| Dispose(Boolean) |
Method to perform the actual disposing of the device.
(Inherited from GenericDevice) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize |
Destructor of the device.
(Inherited from GenericDevice) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| InitializeButtons |
Method to initialize the buttons of the device.
(Inherited from ClDimmer) | |
| InitializeDevice |
Method to initialize the device information as specified.
(Inherited from ClDimuex) | |
| InitializeLoadInformation |
Method to initialize the load information of the device.
(Inherited from ClDimuex) | |
| OnBaseEvent(Int32) |
Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase) | |
| OnBaseEvent(Int32, UInt16) |
Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase) | |
| OnButtonStateChange |
Method to fire the button state change event.
(Inherited from AdvDimmer) | |
| OnLoadStateChange |
Method to fire the LoadStateChange event.
(Inherited from LightingBase) | |
| Register |
Register this device with the system.
(Inherited from GenericDevice) | |
| SendParameters |
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) | |
| ToString |
Return the name of the device.
(Inherited from GenericDevice) | |
| UnRegister |
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) |
| Name | Description | |
|---|---|---|
| BaseEvent |
Generic base event, triggered when the there are no other handlers available
for a specific EventID.
(Inherited from GenericBase) | |
| ButtonStateChange |
Event fired when a button state change was received from the device.
(Inherited from AdvDimmer) | |
| IpInformationChange |
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) | |
| LoadStateChange |
Event triggered when information from a load is received.
EventIds for this event are located in the LoadEventIds class.
(Inherited from LightingBase) | |
| OnlineStatusChange |
Event triggered when the Online status of the device changes.
(Inherited from GenericDevice) |
| Name | Description | |
|---|---|---|
| _DimmerRemoteButtonsSlot |
Dimmer remote buttons slot device.
(Inherited from ClDimmer) | |
| _DimmerSettingsSlot |
Dimmer settings slot device.
(Inherited from ClDimmer) | |
| _DimmerSlots |
Array of slots that control the dimmer loads.
(Inherited from ClDimmer) | |
| _DimmerUISettingsSlot |
UI settings slot device.
(Inherited from ClDimmer) | |
| _NumberOfButtons |
Number of buttons this device supports.
(Inherited from ClDimmer) | |
| _SpecificDimLoadCollection |
Collection of the loads specific to this device.
(Inherited from ClDimmer) | |
| DimmerStatusFeedbackEventId |
When the devices sends the control system a new error status, this is the event ID for the base event.
(Inherited from ClDimmer) | |
| PhaseControlFeedbackEventId |
Event ID for the base event for when the phase control of the load is reported.
(Inherited from ClDimuex) |