Clwi |
The ClwiDimmer type exposes the following members.
| Name | Description | |
|---|---|---|
| Button | Property to get the collection of buttons on the device. | |
| ButtonLayoutFeedback | Reports the button layout of the device. | |
| 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) | |
| DimmerUISettings | Class to specify the parameters of the user interface of this unit. | |
| DimmingLoads | Collection of Dimming loads for this device. | |
| Disposed |
Property to indicate if the device has been disposed.
(Inherited from GenericDevice) | |
| Feedbacks | Property to get the collection of feedbacks on the device. | |
| ID |
Property to get the ID of the device.
(Inherited from GenericDevice) | |
| InNightlightMode | 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. | |
| IsOnline |
Property to get the current online state of the device.
(Inherited from GenericDevice) | |
| LeftRemoteBargraph | 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. | |
| 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 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) | |
| 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
(Overrides ClcwBaseParameterOffFadeTime) | |
| ParameterPreset1Default | 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. | |
| ParameterPreset2Default | 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. | |
| ParameterPreset3Default | 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. | |
| 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
(Overrides ClcwBaseParameterPresetFadeTime) | |
| 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
(Overrides ClcwBaseParameterRaiseLowerRate) | |
| ParameterRemoteDoubleTapTime | 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 | |
| ParameterRemoteHoldTime | 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 | |
| ParameterRemoteWaitForDoubleTap | 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. | |
| 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) | |
| RightRemoteBargraph | 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. | |
| SetMaxLevel | 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%. | |
| SetMinLevel | Sets the minimum dim level setting. Allowable integer input range between 0x0000-0x7FFF (0% - 49%). Values outside this range shall clamp to 49%. | |
| SIMPLDeviceImplementation |
Internal protected member used for actual device control.
(Inherited from GenericDevice) | |
| 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) |