Click or drag to resize

IHz2SwDimex Properties

The IHz2SwDimex 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 IHz2KpBacklight)
Public propertyButton Collection of buttons supported by the device.
(Inherited from IButton)
Public propertyDefeatLocalAuxButtonLogic When this property is set 'false', the device will control the slave output line wire to another dimmer or switch. If set to 'true', the device will operate the buttons only as a remote logic (send button state information only). If the ParameterLocalAuxButton is set to None, this property has no effect.
(Inherited from IHz2Kpex)
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).
Public propertyFeedbacks Property to get the collection of feedbacks with on and active indicators on HzKpBase.
(Inherited from IHz2KpBase)
Public propertyID Property to get the ID of the device.
(Inherited from IHz2KpBase)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from IHz2KpBase)
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 IHzButton)
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 IHzButton)
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 IHz2KpBacklight)
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 IHz2KpBacklight)
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 IHzAdvButton)
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 IHzButton)
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 IHzAdvButton)
Public propertyParameterLocalAuxButton Parameter to specify which button combination/mode this keypad is set to.
(Inherited from IHz2Kpex)
Public propertyParameterLocalButton Parameter to specify which button combination/mode this device is set to. This device does not support None.
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 IHz2Kpex)
Public propertyParameterLocalButtonStatusFeedback Parameter to define what LED(s) are turned on when the load is on (level above zero percent) or off.
(Inherited from IHz2Kpex)
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.
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 IHzAdvButton)
Public propertyParent The parent that a given object was added to.
(Inherited from IParentInformation)
Public propertyRegistered Property to get the current registration state of the device.
(Inherited from IHz2KpBase)
Public propertyRegistrationFailureReason Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from IHz2KpBase)
Public propertySuppressFeedback When set to 'true', the device will send button feedback information based on the ParameterSuppressFeedbackMode selected.
Public propertyUnRegistrationFailureReason Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from IHz2KpBase)
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from IParentInformation)
Top
See Also