IHz |
The IHzKpBase type exposes the following members.
| Name | Description | |
|---|---|---|
| BacklightLedSettings |
Backlight LED Settings present on this device.
This property will trigger BaseEvent with event IDs defined in HzKpBase. (Inherited from IHzKpBacklight) | |
| Button |
Collection of buttons supported by the device.
(Inherited from IButton) | |
| Feedbacks | Property to get the collection of feedbacks with on and active indicators on HzKpBase. | |
| ID | Property to get the ID of the device. | |
| IsOnline | Property to get the current online state of the device. | |
| LedBacklightEnabledFeedback |
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) | |
| ParameterActiveFeedbackBlinkRate |
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) | |
| ParameterAlternateColorTheme |
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 IHzKpBacklight) | |
| ParameterCustomColorInputType |
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 IHzKpBacklight) | |
| ParameterDayNightThresholdSetting |
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 IHzKpBacklight) | |
| ParameterDoubleTapSpeed |
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) | |
| ParameterFakeFeedback |
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) | |
| ParameterHoldTime |
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) | |
| ParameterWaitForDoubleTap |
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) | |
| Parent |
The parent that a given object was added to.
(Inherited from IParentInformation) | |
| Registered | Property to get the current registration state of the device. | |
| RegistrationFailureReason | Property to get the Registration Failure Reason, this will match the return value from the call to register. | |
| UnRegistrationFailureReason | Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister. | |
| UserSpecifiedObject |
Can be assigned anything that user wants.
(Inherited from IParentInformation) |