Click or drag to resize

IHzKpBase Interface

Common interface for Crestron Horizon V1 devices with keypad functionality.

Namespace: Crestron.SimplSharpPro.Keypads.Horizon
Assembly: Crestron.SimplSharpPro.DeviceSupport (in Crestron.SimplSharpPro.DeviceSupport.dll) Version: 2.21.121
Syntax
C#
public interface IHzKpBase : IHzKpBacklight, 
	IHzButton, IHzAdvButton, ISendParameters, IFeedback, IButton, 
	IParentInformation, IDisposable

The IHzKpBase 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 IHzKpBacklight)
Public propertyButton Collection of buttons supported by the device.
(Inherited from IButton)
Public propertyFeedbacks Property to get the collection of feedbacks with on and active indicators on HzKpBase.
Public propertyID Property to get the ID of the device.
Public propertyIsOnline Property to get the current online state of the device.
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 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 IHzKpBacklight)
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 IHzKpBacklight)
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 IHzKpBacklight)
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 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.
Public propertyRegistrationFailureReason Property to get the Registration Failure Reason, this will match the return value from the call to register.
Public propertyUnRegistrationFailureReason Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from IParentInformation)
Top
Methods
 NameDescription
Public methodDisableLedBacklight Method to disable all LED functionality and keeps them off.
(Inherited from IHzButton)
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable)
Public methodEnableLedBacklight Method to enable all LED normal functionality for all operating modes.
(Inherited from IHzButton)
Public methodRegister Register this device with the system.
Public methodSendParameters Function for sending parameters on the fly. Not Currently implemented. This will throw a NotSupportedException
(Inherited from ISendParameters)
Public methodUnRegister 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.

Top
Events
 NameDescription
Public eventBaseEvent Generic base event, triggered when the there are no other handlers available for a specific EventID.
Public eventButtonStateChange Event fired when a button state change was received from the device.
(Inherited from IButton)
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also