Click or drag to resize

Hz2Kpcn Class

Horizon version 2 keypad cresnet class.
Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.Keypads
Assembly: Crestron.SimplSharpPro.Keypads (in Crestron.SimplSharpPro.Keypads.dll) Version: 2.21.121
Syntax
C#
public sealed class Hz2Kpcn : Hz2KpBase, 
	IIOPorts

The Hz2Kpcn type exposes the following members.

Constructors
 NameDescription
Public methodHz2Kpcn(UInt32, CrestronControlSystem) Constructor to generate a new Hz2Kpcn object connected to Control system.
Public methodHz2Kpcn(UInt32, IDeviceBranch) Constructor to generate a new Hz2Kpcn object on IDeviceBranch.
Top
Properties
 NameDescription
Public propertyBacklightLedSettings Property returns the backlight Led settings for version 2.
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 propertyFeedbacks Property to get the collection of feedbacks with on and active indicators on HzKpBase.
(Inherited from Hz2KpBase)
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 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 Hz2KpBase)
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNumberOfVersiPorts Number of versiports this device supports.
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 Hz2KpBase)
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 Hz2KpBaseeCustomColorInputType enum for valid values.
(Inherited from Hz2KpBase)
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 Hz2KpBaseeDayNightThresholdSetting enum for valid values.
(Inherited from Hz2KpBase)
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 Hz2KpBase)
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 Hz2KpBase)
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 Hz2KpBase)
Public propertyParameterIsLargeRockerButtonInstalled Returns and sets the setting that tells the keypad if a large rocker button is installed false – LEDs on row 2 and 4 are enabled true – LEDs on row 2 and 4 are disabled
(Inherited from Hz2KpBase)
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 Hz2KpBase)
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)
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
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 propertyVersiPorts Collection of versiports on the control system.
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 methodDisableLedBacklight Method to disable all LED functionality and keeps them off.
(Inherited from Hz2KpBase)
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 methodEnableLedBacklight Method to enable all LED normal functionality for all operating modes.
(Inherited from Hz2KpBase)
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 methodSendParameters This will send the parameters fields (if any) to the device. It allows the parameters to be modified and resent without unregistering and re-registering a device.
(Inherited from Hz2KpBase)
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)
Top
Example
C#
using System;
using Crestron.SimplSharp;                              // For Basic SIMPL# Classes
using Crestron.SimplSharpPro;                           // For Basic SIMPL#Pro classes
using Crestron.SimplSharpPro.CrestronThread;            // For Threading
using Crestron.SimplSharpPro.DeviceSupport;             // For Generic Device Support
using Crestron.SimplSharpPro.Keypads;
namespace Hz2KpcnSSPProgram
{
    public class ControlSystemHz2Kpcn : CrestronControlSystem
    {
        static Hz2Kpcn _Hz2Kpcn;
        // Constructor of the Control System Class. Make sure the constructor always exists.
        // If it doesn't exit, the code will not run on your 3-Series processor.
        public ControlSystemHz2Kpcn()
        {
            CrestronConsole.AddNewConsoleCommand(CreateDeviceCmd, "CreateDevice", "HZ2-KPCN CreateDevice Command", ConsoleAccessLevelEnum.AccessProgrammer);
            CrestronConsole.AddNewConsoleCommand(EnableDayTimeCmd, "EnableDayTime", "HZ2-KPCN EnableDayTime Command", ConsoleAccessLevelEnum.AccessProgrammer);
            CrestronConsole.AddNewConsoleCommand(EnableNightTimeCmd, "EnableNightTime", "HZ2-KPCN EnableNightTime Command", ConsoleAccessLevelEnum.AccessProgrammer);
            CrestronConsole.AddNewConsoleCommand(EnableManualDayNightTimeCmd, "EnableManDayNightTime", "HZ2-KPCN EnableManualDayNightTime Command", ConsoleAccessLevelEnum.AccessProgrammer);
            CrestronConsole.AddNewConsoleCommand(SetActiveFeedbackCmd, "SetActiveFeedback", "HZ2-KPCN SetActiveFeedback Command", ConsoleAccessLevelEnum.AccessProgrammer);
            CrestronConsole.AddNewConsoleCommand(SetAltBacklightColorCmd, "SetAltBacklightColor", "HZ2-KPCN SetAltBacklightColor Command", ConsoleAccessLevelEnum.AccessProgrammer);
            SetAltBacklightColor
        }
        //Method to enable/disable the active feedback
        public void SetActiveFeedbackCmd(string args)
        {
            var str = args.Split(' ');
            _Hz2Kpcn.Feedbacks[Convert.ToUInt16(str[0])].Active.BoolValue = Convert.ToBoolean(str[1]);
        }
        //Method to handle the button state change events
        public void Hz2KpcnButtonStateChange(GenericBase device, ButtonEventArgs args)
        {
            CrestronConsole.PrintLine("Button{0} name is {1} state is {2} horiz loc {3} vert loc {4}", args.Button.Number, args.Button.Name, args.Button.State, args.Button.HorizontalLocation, args.Button.VerticalLocation);
           //To determine Horizon V2 button events based on Button.Number use the following values
           if (args.Button.Number == 2)
             CrestronConsole.PrintLine("Button #1 Event");
           else if (args.Button.Number == 5)
             CrestronConsole.PrintLine("Button #2 Event");
           else if (args.Button.Number == 8)
             CrestronConsole.PrintLine("Button #3 Event");
           else if (args.Button.Number == 10)
             CrestronConsole.PrintLine("Button #4 Left Event");
           else if (args.Button.Number == 11)
             CrestronConsole.PrintLine("Button #4 Center Event");
           else if (args.Button.Number == 12)
             CrestronConsole.PrintLine("Button #4 Right Event");
           else if (args.Button.Number == 13)
             CrestronConsole.PrintLine("Button #5 Left Event");
           else if (args.Button.Number == 14)
             CrestronConsole.PrintLine("Button #5 Center Event");
           else if (args.Button.Number == 15)
             CrestronConsole.PrintLine("Button #5 Right Event");
        }
        //Method to create the device object for HZ2-KPCN
        public void CreateDeviceCmd(string args)
        {
            try
            {
                _Hz2Kpcn = new Hz2Kpcn(0x25, this);
                Thread.MaxNumberOfUserThreads = 20;
                _Hz2Kpcn.ButtonStateChange += Hz2KpcnButtonStateChange;
                _Hz2Kpcn.BaseEvent += Hz2KpcnBacklightLedSettingsChange;
                _Hz2Kpcn.VersiPorts[1].VersiportChange += Hz2KpcnVersiportStateChange_EventHandler;
                _Hz2Kpcn.VersiPorts[2].VersiportChange += Hz2KpcnVersiportStateChange_EventHandler;
                _Hz2Kpcn.VersiPorts[1].SetVersiportConfiguration(eVersiportConfiguration.DigitalInput);
                _Hz2Kpcn.VersiPorts[1].DisablePullUpResistor = false;
                _Hz2Kpcn.VersiPorts[2].SetVersiportConfiguration(eVersiportConfiguration.DigitalInput);
                _Hz2Kpcn.VersiPorts[2].DisablePullUpResistor = true;
                //Register HZ2-KPCN
                if (_Hz2Kpcn.Register() != eDeviceRegistrationUnRegistrationResponse.Success)
                    ErrorLog.Error("Error Registering the HZ2-KPCN at {0}: {1}", _Hz2Kpcn.ID, _Hz2Kpcn.RegistrationFailureReason);
            }
            catch (Exception e)
            {
                ErrorLog.Error("Error in the constructor: {0}", e.Message);
            }
        }
        //Method to handle the Backlight LED Setting slot sig change events
        static void Hz2KpcnBacklightLedSettingsChange(GenericBase device, BaseEventArgs args)
        {
            if (args.EventId == Hz2Kpcn.InDayTimeEventId)
            {
                CrestronConsole.PrintLine("In Day Time Feedback Event received, state is {0}", ((Hz2Kpcn)device).BacklightLedSettings.InDayTimeFeedback.BoolValue);
            }
        }
        // Sig callback for handling HZ2-KPCN Versiport State change events.
        static void Hz2KpcnVersiportStateChange_EventHandler(Versiport vport, VersiportEventArgs args)
        {
            switch (args.Event)
            {
                case eVersiportEvent.AnalogInChange:
                    CrestronConsole.Print("AnalogInChange event for Versiport{0} received, State is {1}\r\n", vport.ID, vport.DigitalIn);
                    break;
                case eVersiportEvent.DigitalInChange:
                    CrestronConsole.Print("DigitalInChange event for Versiport{0} received, Value is {1}\r\n", vport.ID, vport.AnalogIn);
                    break;
            }
        }
        //Method to enable the DayTime Mode
        public void EnableDayTimeCmd(string args)
        {
            _Hz2Kpcn.BacklightLedSettings.EnableDayTime();
        }
        //Method to enable the NightTime Mode
        public void EnableNightTimeCmd(string args)
        {
            _Hz2Kpcn.BacklightLedSettings.EnableNightTime();
        }
        //Method to enable the Manual Day Night Time Mode
        public void EnableManualDayNightTimeCmd(string args)
        {
            _Hz2Kpcn.BacklightLedSettings.EnableManualDayNightTime.BoolValue = Convert.ToBoolean(args);
        }
        //Set the alternate backlight color for the first button
        public void SetAltBacklightColorCmd(string args)
        {
            _Hz2Kpcn.BacklightLedSettings.ButtonAlternateFeedback[1].BoolValue = true;
            _Hz2Kpcn.BacklightLedSettings.SetAlternateColorSelectPosition(1, Hz2KpBase.eLedAlternateColorTheme.Pink);
        }
    }
}

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also