Click or drag to resize

HzDimLvEx Properties

The HzDimLvEx type exposes the following members.

Properties
 NameDescription
Public propertyBacklightLedSettings Backlight LED Settings present on this device.

This property will trigger BaseEvent with event IDs defined in HzKpBase.


(Inherited from HzDimBase)
Public propertyButton Collection of buttons supported by the device.
(Inherited from AdvDimmer)
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 propertyDefeatLocalButtonLogic When set to 'false', the device will control the local load. If set to 'true', the device will operate the buttons only as a remote logic (send button state information only).
(Inherited from HzDimBase)
Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDimmingLoads Collection of Dimmable load for this device.
(Inherited from Dimmer)
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyFeedbacks Property to get the collection of feedbacks with on and active indicators on HzDimBase.
(Inherited from HzDimBase)
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyLedBacklightEnabledFeedback Property to indicate the current LED Backlight status set by the EnableLedBacklight or DisableLedBacklight methods. true = LEDs enabled, false = LEDs disabled

This property will trigger BaseEvent with event id LedBacklightEnabledEventId.


(Inherited from HzDimBase)
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyParameterActiveFeedbackBlinkRate Parameter to define the fade blink rate time between the LED On color and LED Off color. Value in seconds (units of 0.01 sec precision) for the blink/fade period of the LEDs when they are in active feedback state. Valid range is from 0.1 to 2 seconds. 1 second is represented as 100. Default value is 0.75 seconds. Use the SecondsToUshort(Single) to convert the seconds to a ushort value or the UshortToSeconds(UInt16) to convert the ushort value to seconds.
(Inherited from HzDimBase)
Public propertyParameterAlternateColorTheme Parameter to select the color theme that is applied to the particular Button Feedback as set by the corresponding ButtonAlternateFeedback (true = Use Alternate Color Theme; false = Use Local Color Theme). If Custom is chosen, then the corresponding RedOrHue, GreenOrSaturation and BlueOrValue properties will get processed instead of preset internal color themes that match much of the defined 'local' color themes. Refer HzKpBaseeLedAlternateColorTheme enum for valid values.
(Inherited from HzDimBase)
Public propertyParameterCustomColorInputType Selects whether the properties in LedDayOnSettings/ LedDayOffSettings/ LedNightOnSettings/ LedNightOffSettings are to be processed as RGB (Red/Green/Blue) or HSV (Hue/Saturation/Value) component values. Refer HzKpBaseeCustomColorInputType enum for valid values.
(Inherited from HzDimBase)
Public propertyParameterDayNightThresholdSetting Indicates which internal setting to use when device is automatically configured to switch between day and night mode based on sensor reading. Default (0) indicates it uses either the factory default threshold setting or the manually calibrated setting if it was saved at least once. Other preset selections are estimated values based on a typical room brightness setting. Valid values are from 0 to 5. Refer HzKpBaseeDayNightThresholdSetting enum for valid values.
(Inherited from HzDimBase)
Public propertyParameterDoubleTapSpeed Returns and sets the time between the end of the first tap and the start of the second tap for a "DoubleTap" to be recognized. Use the SecondsToUshort(Single) to convert the seconds to a ushort value or the UshortToSeconds(UInt16) to convert the ushort value to seconds. Valid range is from 0.2 seconds to 1.0 seconds. 1 second is represented as 100.
(Inherited from HzDimBase)
Public propertyParameterFakeFeedback Parameter to set and get the Fake Feedback state. When set to true, the LED corresponding to button will fade blink between On LED color and Off LED color at the ParameterActiveFeedbackBlinkRate time, for a minimum of 2 sec, until the State or Active property value is initialized to some other state.
(Inherited from HzDimBase)
Public propertyParameterHoldTime Time value in seconds. A press longer than this value triggers a Hold event. A press shorter than this value triggers a Tap or DoubleTap event. Use the SecondsToUshort(Single) to convert the seconds to a ushort value or the UshortToSeconds(UInt16) to convert the ushort value to seconds. Valid range is from 0.2 seconds to 1.0 seconds. 1 second is represented as 100.
(Inherited from HzDimBase)
Public propertyParameterIsLargeRockerButtonInstalled Returns and sets the setting that tells the keypad if a large rocker button is installed false – LEDs on row 2 and 4 are enabled true – LEDs on row 2 and 4 are disabled

This parameter requires device firmware version 2.000.0050 or greater


(Inherited from HzDimBase)
Public propertyParameterLocalButton Parameter to specify which button combination/mode this device is set to. This device does not support None.
(Inherited from HzDimBase)
Public propertyParameterLocalButtonActiveFeedback Parameter to define the behavior of the LED(s) when a local button is pressed to turn on or off a load. LED(s) can either flash, enable, or do nothing, disable. The timing of the blink is set by ParameterActiveFeedbackBlinkRate.

For quick ramps to the preset level or 100% which take place within a second, the LED will flash at least one transition and end up at on or off state. For a manual raise/lower operation where the button is held down, it will continue to flash while the button is held down, but stop once the ramp is completed and ended at the target level.


(Inherited from HzDimBase)
Public propertyParameterLocalButtonStatusFeedback Parameter to define what LED(s) are turned on when the load is on (level above zero percent) or off.
(Inherited from HzDimBase)
Public propertyParameterLocalOnLevel Paramter defines what the local 'on' level setting should be when a 'local' button defined to control the load is triggered.

Valid values range from 1% to 100%. Default value is 100%.

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
(Inherited from HzDimBase)
Public propertyParameterOffFadeTime Sets the time that it takes to ramp the light level from its current level to 0% when FullOff is used.

Field is in hundredths of a second where 25 is 0.25s.

Valid values range from 0.25s to 30s. Default value is 1 second (100 hundredths of a second).

Use SecondsToUshort(Single) to convert the time to a ushort value or the UshortToSeconds(UInt16) to convert the ushort value to seconds.


(Inherited from HzDimBase)
Public propertyParameterOnFadeTime Sets the time that it takes to ramp the light level from its current level to 100% when FullOn is used.

Field is in hundredths of a second where 25 is 0.25s.

Valid values range from 0.25s to 30s. Default value is 1 second (100 hundredths of a second).

Use SecondsToUshort(Single) to convert the time to a ushort value or the UshortToSeconds(UInt16) to convert the ushort value to seconds.


(Inherited from HzDimBase)
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 where 25 is 0.25s.

Valid values range from 1 second to 10 seconds. Default value is 3 seconds (300 hundredths of a second).

Use SecondsToUshort(Single) to convert the time to a ushort value or the UshortToSeconds(UInt16) to convert the ushort value to seconds.


(Inherited from HzDimBase)
Public propertyParameterSuppressFeedbackMode Parameter that defines how the SuppressFeedback property will operate when set to 'true'. It may hold of all feedback and only send the latest snapshot when a button is released, or always send with a predetermined delay.
(Inherited from HzDimBase)
Public propertyParameterWaitForDoubleTap Returns and sets the setting that determines whether a "Tap" should be sent immediately. false – Tap is reported at the end of every short press, DoubleTap is reported at the end of the second short press. true – Tap reporting is postponed to see if a second tap comes in. In this case only DoubleTap is reported.
(Inherited from HzDimBase)
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)
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySuppressFeedback When set to 'true', the device will send button feedback information based on the ParameterSuppressFeedbackMode selected.
(Inherited from HzDimBase)
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
See Also