Click or drag to resize

HttB10Ex Class

Battery-operated table-top, ten-button keypad for lighting, climate, and audio control that communicates using the infiNET EX wireless protocol

This class will trigger BaseEvent and ButtonStateChange events.

Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.Keypads
Assembly: Crestron.SimplSharpPro.Keypads (in Crestron.SimplSharpPro.Keypads.dll) Version: 2.21.121
Syntax
C#
public sealed class HttB10Ex : HTTB2exBatt

The HttB10Ex type exposes the following members.

Constructors
 NameDescription
Public methodHttB10Ex Constructor for HttB10Ex devices.
Top
Properties
 NameDescription
Public propertyAmbientLightLevelFeedback Property to report the ambient light level as a percentage from 0% to 100%, as determined by the internal light sensor. The value will be refreshed every 5 seconds if changed. This is only enabled when ReportLightLevel is "true". Light level reporting on battery mode is only enabled during wake/active periods.

The BaseEvent event will trigger with AmbientLightLevelFeedbackEventId.

Public propertyBacklightIntensity Property to set the backlight brightness level. This is only active when ManualBacklight is "true".
Public propertyBatteryLow Returns a BoolOutputSig that has a bool value of true when the battery level is low and a bool value of false when the battery level is not low.

The BaseEvent event will trigger with BatteryLowEventId.


(Inherited from HTTB2exBatt)
Public propertyButton Collection of buttons supported by the device.
(Inherited from KeypadBase)
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 propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyEnableLogging Property to enable logging of device status messages. When "true", device status message logging is enabled, when "false" there is no effect.
Public propertyFeedbacks Property to get the collection of feedbacks on the device.
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIndicatorIntensity Property to set the LED brightness level when the LED feedback is active (above 0%). This is only active when ManualIndicatorIntensity is "true".
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyLeftBargraph Property to get the left bar graph analog value that will be displayed on the corresponding LED indicators in bargraph format.

The Left bargraph is formed by the LEDs on the left side of the unit; the Right bargraph, by the LEDs on the right side.

ParameterBargraphTimeout parameter shall specify the amount of time a bargraph is displayed. A value of 0 shall indicate no timeout such that indicators shall always function in bargraph mode.

The LEDs will display the ramping value as it changes, and then remain in bargraph mode for the additional period given by the ParameterBargraphTimeout parameter.

If no change occurs to the analog value before the ParameterBargraphTimeout expires, the LEDs revert to standard behavior.

The 5-segment bargraph displays the analog values as follows:

  • Segment 1 (top) LED is ON when analog value = 100%.
  • Segment 2 LED is ON when analog value > 75%.
  • Segment 3 LED is ON when analog value > 50%.
  • Segment 4 LED is ON when analog value > 25%.
  • Segment 5 (bottom) LED is ON when analog value > 0%.
Public propertyManualBacklight Property to enable manual adjustment of the backlight via the BacklightIntensity on Brightness and Bargraph Functions SubClass.
Public propertyManualIndicatorIntensity Property to enable manual adjustment of the LED brightness via the IndicatorIntensity on Brightness and Bargraph Functions SubClass.
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyOnBatteryPowerFeedback Property to indicate when the device is running on battery power (wallpack is not connected).

The BaseEvent event will trigger with OnBatteryPowerFeedbackEventId.

Public propertyParameterAutoBacklightPreset Parameter to access the auto backlight preset number. Refer HttB10ExeBacklightPresets for the Backlight Preset numbers.
Remarks
The valid values are 0 to 2.
Public propertyParameterBacklightTimeout Parameter to access the back light timeout when operating on the power pack Dimmed Manner Mode.

Valid values range from 10s through 300s(5 minutes) and default is 120s(2 minutes).

Public propertyParameterBargraphTimeout Parameter to access the bargraph timeout value on the LED indicators in bargraph format.

The LED indicators will enter bargraph mode as soon as a new value is seen on ParameterBargraphTimeout.

The LEDs will adjust as the analog value is ramping and then remain in bargraph mode for the additional ParameterBargraphTimeout period.

Valid values range from 0s to 10s and default is 3s.

Public propertyParameterCustomBacklightThreshold Parameter to access the threshold value as percentage from 0% to 100% that is compared to the ambient light level (reported by AmbientLightLevelFeedback when ReportLightLevel is "true" to determine the brightness level of the backlight. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyParameterCustomDayBacklight Parameter to access the day backlight level as percentage from 0% to 100%, when the ambient light level is above ParameterCustomBacklightThreshold, the day level is applied and when it is below the threshold, the night level is applied. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyParameterCustomNightBacklight Parameter to access the night backlight level as percentage from 0% to 100%, when the ambient light level is above ParameterCustomBacklightThreshold, the day level is applied and when it is below the threshold, the night level is applied. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyParameterDblTapSpeed Returns and sets the time between the end of the first tap and the start of the second tap for a "DblTap" to be recognized. Use the SimplSharpDeviceHelper.SecondsToUShort to convert the seconds to a ushort value or the SimplSharpDeviceHelper.UShortToSeconds to convert the ushort value to seconds. Valid values are 20 (0.2s) to 100 (1.0s) and default is 50(0.5s).
Public propertyParameterHoldTime Returns and sets the time in seconds that a button must be held before it is recognized as a "Hold" instead of a "Tap". Use the SimplSharpDeviceHelper.SecondsToUShort to convert the seconds to a ushort value or the SimplSharpDeviceHelper.UShortToSeconds to convert the ushort value to seconds. Valid values are 20 (0.2s) to 100 (1.0s) and default is 50(0.5s).
Public propertyParameterIndicatorTimeout Parameter to access the indicator timeout when operating on the power pack Dimmed Manner Mode.

Valid values range from 10s through 300s(5 minutes) and default is 120s(2 minutes).

Public propertyParameterMaximumAutoIndicatorIntensity Parameter to access the maximum brightness level of the LED feedback indicators as percentage from 1% to 100%, when controlled by the ambient light sensor (ManualIndicatorIntensity is "false"). Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyParameterMinimumAutoIndicatorIntensity Parameter to access the minimum brightness level of the LED feedback indicators as percentage from 1% to 100%, when controlled by the ambient light sensor (ManualIndicatorIntensity is "false"). Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyParameterWaitForDoubleTap Returns and sets the setting that determines whether a "Tap" should be sent immediately on the release of the button, or if the unit should wait until a "DblTap" event occurs.

When set to 'true', the user will incur a slight delay before seeing the Tap, but when a DblTap occurs, there will be no Tap event.

When set to 'false'(default), the user will see the quickest response from the Tap event, but will also see a Tap event prior to each DblTap event.

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)
Public propertyReportLightLevel Property to enable the AmbientLightLevelFeedback to report the current light level when the value is "true". When the value is "false", this suppresses AmbientLightLevelFeedback.
Public propertyRightBargraph Property to get the right bar graph value that will be displayed on the corresponding LED indicators in bargraph format.

The Right bargraph is formed by the LEDs on the left side of the unit; the Right bargraph, by the LEDs on the right side.

The LEDs will display the ramping value as it changes, and then remain in bargraph mode for the additional period given by the ParameterBargraphTimeout parameter.

If no change occurs to the analog value before the ParameterBargraphTimeout expires, the LEDs revert to standard behavior.

The 5-segment bargraph displays the analog values as follows:

  • Segment 1 (top) LED is ON when analog value = 100%.
  • Segment 2 LED is ON when analog value > 75%.
  • Segment 3 LED is ON when analog value > 50%.
  • Segment 4 LED is ON when analog value > 25%.
  • Segment 5 (bottom) LED is ON when analog value > 0%.
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertyStatusMessagesFeedback Property to return the log messages.

The BaseEvent event will trigger with StatusMessagesFeedbackEventId.

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
Methods
 NameDescription
Public methodDisableBargraph Disables the bargraph functionality.
Public methodDispose Clean up of resources.
(Inherited from GenericBase)
Protected methodDispose(Boolean) Method to perform the actual disposing of the device.
(Inherited from GenericDevice)
Public methodEnableBargraph Enables the bargraph functionality.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Destructor of the device.
(Inherited from GenericDevice)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodInitializeButtons Method to initialize HttB10Ex buttons and sigs.
(Overrides HTTB2exBattInitializeButtons)
Protected methodInitializeFeedbacks Method to initialize the feedbacks.
(Overrides HTTB2exBattInitializeFeedbacks)
Protected methodOnBaseEvent(Int32) Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase)
Protected methodOnBaseEvent(Int32, UInt16) Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase)
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodToString Return the name of the device.
(Inherited from GenericDevice)
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.


(Inherited from GenericDevice)
Top
Events
 NameDescription
Public eventBaseEvent Generic base event, triggered when the there are no other handlers available for a specific EventID.
(Inherited from GenericBase)
Public eventButtonStateChange Event fired when a button state change was received from the device.
(Inherited from KeypadBase)
Public eventIpInformationChange Event that tells what IP Address is connected/disconnected from an IP ID for a non-UDP device. This is only valid for an Ethernet device. An exception will be thrown if it is not.
(Inherited from GenericDevice)
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Inherited from GenericDevice)
Top
Fields
 NameDescription
Protected field_Buttons Collection that contains button objects.
(Inherited from KeypadBase)
Public fieldStatic memberAmbientLightLevelFeedbackEventId The value of AmbientLightLevelFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberOnBatteryPowerFeedbackEventId The value of OnBatteryPowerFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberStatusMessagesFeedbackEventId The value of StatusMessagesFeedback has changed.

The BaseEvent event will trigger for this event id.

Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also