Clw |
public sealed class ClwDimuEx : ClwDimexP
The ClwDimuEx type exposes the following members.
| Name | Description | |
|---|---|---|
| BargraphValue |
Property to set the bargraph's value.
(Inherited from ClwDimex) | |
| Button |
Collection of buttons supported by the device.
(Inherited from ClwDimex) | |
| ButtonLayout |
Property to get the current button layout information as reported by the device.
(Inherited from ClwDimex) | |
| 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) | |
| DimmerRemoteButtonSettings |
Property to get the specific Remote button settings for the dimmer load.
(Inherited from ClwDimex) | |
| DimmerUISettings |
Property to get the specific UI settings for the dimmer load.
(Inherited from ClwDimex) | |
| DimmingLoads | Collection of dimming loads for this device. | |
| Disposed |
Property to indicate if the device has been disposed.
(Inherited from GenericDevice) | |
| EnableNightLevel | 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 | |
| Feedbacks |
Property to get the array of feedbacks on the device.
(Inherited from ClwDimex) | |
| 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) | |
| LoadErrorFeedback |
Property to indicate the type of error detected by the dimmer.
This property will trigger BaseEvent event with LoadErrorFeedbackEventId. | |
| 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 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) | |
| 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 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) | |
| 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 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) | |
| 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 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) | |
| ParameterSuppressFeedbackMode | 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. | |
| ParameterZcSyncErrOnOffThreshold |
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. | |
| Parent |
The parent that a given object was added to.
(Inherited from GenericBase) | |
| PhaseControlFeedback |
Property to indicate the current phase mode operation detected.
This property will trigger BaseEvent event with PhaseControlFeedbackEventId. | |
| 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) | |
| SuppressFeedback | 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 | |
| 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_OnSignalChange |
Subscription to the Dimmer Slot's Sig Change Event to retrigger Generic Events as needed.
(Inherited from ClwDimex) | |
| 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) | |
| InitializeDevice |
InitializeDevice
(Inherited from ClwDimex) | |
| 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) | |
| OnLearnableButtonEvent |
Method to triggered the LearnableButtonEvent
(Inherited from ClwDimex) | |
| 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) | |
| LearnableButtonEvent |
Event triggered when an learning event occurred on the device.
(Inherited from ClwDimex) | |
| 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 | |
|---|---|---|
| _SpecificDimLoadCollection |
Collection of the loads specific to this device.
(Inherited from ClwDimex) | |
| LoadErrorFeedbackEventId |
The value of LoadErrorFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| PhaseControlFeedbackEventId |
The value of PhaseControlFeedback has changed.
The BaseEvent event will trigger for this event id. |