Click or drag to resize

BlackNovaKeypad Class

The Black Nova ARIA®, ALBA® and ANY® Collections Keypads are Cresnet-based keypads that provide interoperability with Crestron Smart Home Systems. The ARIA®, ALBA® and ANY® Collections Keypads are available in customizable button layouts and include proximity, gesture, ambient light, color, and temperature sensors (available layouts and sensors may vary by Collection line).

This class will trigger and BaseEvent and ButtonStateChange events.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpPro.DeviceSupportKeypadBase
        Crestron.SimplSharpPro.KeypadsBlackNovaKeypad

Namespace: Crestron.SimplSharpPro.Keypads
Assembly: Crestron.SimplSharpPro.Keypads (in Crestron.SimplSharpPro.Keypads.dll) Version: 2.21.121
Syntax
C#
public sealed class BlackNovaKeypad : KeypadBase, 
	IBlackNovaKeypadButton, IButton

The BlackNovaKeypad type exposes the following members.

Constructors
 NameDescription
Public methodBlackNovaKeypad(UInt32, CrestronControlSystem) Constructor to generate an object for BLACKNOVA-KEYPAD Connected to Control System.
Public methodBlackNovaKeypad(UInt32, IDeviceBranch) Constructor to generate an object for BLACKNOVA-KEYPAD on IDeviceBranch.
Top
Properties
 NameDescription
Public propertyAlarmDateTime Property to set the value to be shown on the display as alarm time and week days. It is visible on the screen when DisplaySelection is set from AlarmSetupDayPlusHoursPlusMinutes24HoursFormat to AlarmSetupDayPlusHoursPlusMinutes12HoursFormat.
Public propertyAlarmSetupState Property to show/hide Alarm icon. true = Alarm icon is shown; false = Alarm icon is hidden
Public propertyAlarmTrigger Property to turn On/Off Alarm mode. true = Alarm mode is turned On; false = Alarm mode is turned Off The default value (on device power up) is false.
Public propertyAnalogValue Property to set the analog value, this value to be shown on the display as an integer number. It is visible on the screen when DisplaySelection is set to 3. The valid values range is from 0 to 999. The default value is 0.
Public propertyButton Collection of BLACKNOVA-KEYPAD Keypad buttons

This property will trigger ButtonStateChange event.

Public propertyCardStateFeedback Property to indicates the card presence for the devices equipped with cardholder. true = Card is present; false = No card detected.

This property will trigger BaseEvent event with CardStateEventId.

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 propertyCursorPositionOnAlarmSetupScreen Property to show active element on the Alarm setup screen. It is visible on the screen when DisplaySelection is set from Saturday to Sunday. The default value is Nothing.
Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDisplayBrightness Property to set the level of LED/OLED screen brightness. The valid values range is from 10 to 100. The default value is 80. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyDisplaySelection Property to select the source of value to be shown on the display. The values from different sources are stored in the device memory and ready to be shown any time. The default value is TurnOffTheDisplay.
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyFanSpeed Property to set Fan speed and for thermostat devices it displays fan speed. The default value is Off.
Public propertyFeedbacks Property to get the collection of feedbacks on the device.
(Inherited from KeypadBase)
Public propertyHoldTime Property to set the time in milliseconds after which the button state Held became active. The value should be in the range from 300 to 5000 milliseconds. Out of the range values are ignored. The default value is 500. Use the SecondsToUshort(Single) to convert the seconds to a ushort value or the UshortToSeconds(UInt16) to convert the ushort value to seconds.
Public propertyHumiditySensorOutputFeedback Property to indicate the level of sensed humidity in the room for the devices equipped with humidity sensor. The updated value is coming every time when the measured humidity is changed by more than 1%. Output values range is from 0 to 100. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.

This property will trigger BaseEvent event with HumiditySensorOutputFeedbackEventId.

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 propertyLayoutSelector Property used for selecting layout of the keypad. The valid values range is from 0 to 255. Out of range values are ignored. The default value is 0.
Public propertyLockPanel Property to block button and slider events from keypad from sending to other devices. true = Keypad is blocked; false = Keypad is not blocked. The default value (on device power up) is false
Public propertyModeSelection Property to select Thermostat mode, for thermostat devices it displays the selected mode.

Out of range values are ignored

The default value is None.

Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyPercentageValue Property to set the value to be shown on the display as an integer number. It is visible on the screen when DisplaySelection is set to 4. The valid values range is from 0 to 100. The default value is 0. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyProximitySensorFeedback Property to indicate proximity sensor detection near the keypad true = detected; false = not detected

This property will trigger BaseEvent event with ProximitySensorEventId.

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 propertyRemoteWakeUp Property to set the Active mode from Sleep mode on a keypad without pressing buttons on the keypad. true = Switch keypad to active mode; false = No actions.
Public propertyRfIdCardIdFeedback Property to report the ID of attached RFID card as a string of HEX values for devices with RFID reader. For example: A1B2C3D4FF0055AA

This property will trigger BaseEvent event with RfIdCardIdFeedbackEventId.

Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySleepModeBacklight Property to set the brightness level of buttons backlight when the device is in sleep mode. The valid values range is from 0 to 100. Out of range values are ignored. The default value is 20. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertySleepModeBrightness Property to set the brightness level of LED/OLED screen when the device is in sleep mode. The valid values range is from 0 to 100. Out of range values are ignored. The default value is 20. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertySliders Property to return the collection of sliders.
Public propertyTemperatureCentigrade Property to set the temperature value in degrees Celsius multiplied by 10 to be shown on the display. It is visible on the screen when DisplaySelection is set to 5. The valid values range is from 0 to 999, that represents 0.0C...99.9C degrees. The default value is 0.
Public propertyTemperaturefFahrenheit Property to set the temperature value in degrees Fahrenheit multiplied by 10 to be shown on the display. It is visible on the screen when DisplaySelection is set to 6. The valid values range is from 0 to 999, that represents 0.0F...99.9F degrees. The default value is 0.
Public propertyTemperatureSensorOutputFeedback Property to indicate the room temperature measured by a built-in sensor [°C] multiplied by 10. The value is coming every time when the temperature is changing by more than 0.5°C. Output values range is from 0 to 999, that is equal to temperatures from 0.0°C to 99.9°C

This property will trigger BaseEvent event with TemperatureSensorOutputFeedbackEventId.

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)
Public propertyWaitForSleep Property to set the time in seconds after which the device is switching to the Sleep mode the SleepModeBacklight value applied for all button's backlight. The valid values range is from 2 to 999 seconds. Out of range values are ignored. The default value is 20. Use the SecondsToUshort(Single) to convert the seconds to a ushort value or the UshortToSeconds(UInt16) to convert the ushort value to seconds.
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 methodDispose Clean up of resources.
(Inherited from GenericBase)
Protected methodDispose(Boolean) Method to perform the actual disposing of the device.
(Inherited from GenericDevice)
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 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 memberCardStateEventId The state of CardStateFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberHumiditySensorOutputFeedbackEventId The value of HumiditySensorOutputFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberProximitySensorEventId The state of ProximitySensorFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberRfIdCardIdFeedbackEventId The value of RfIdCardIdFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberSliderPositionFeedbackEventId The state of PositionFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTemperatureSensorOutputFeedbackEventId The value of TemperatureSensorOutputFeedback 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