Click or drag to resize

ZumLinkKpKeypad Class

ZUMLINK-KP Rocker Keypad with Bluetooth.

This class will trigger BaseEvent and ButtonStateChange events.

Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.Keypads.ZumWired
Assembly: Crestron.SimplSharpPro.Keypads (in Crestron.SimplSharpPro.Keypads.dll) Version: 2.21.121
Syntax
C#
public sealed class ZumLinkKpKeypad : ZumLinkKpKeypadBase

The ZumLinkKpKeypad type exposes the following members.

Constructors
 NameDescription
Public methodZumLinkKpKeypad(UInt32, CrestronControlSystem) Constructor used to add the device to the controller.
Public methodZumLinkKpKeypad(UInt32, IDeviceBranch) Constructor used to add the device to a CresnetBranch.
Public methodZumLinkKpKeypad(UInt32, ZumNetBridgeBase) Constructor to generate a new ZumLinkKpKeypad. This is used when the ZumLinkKpKeypad is added to a ZUMNET-BRIDGE or ZUMNET-BRIDGE-ROOM.
Top
Properties
 NameDescription
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 propertyDeviceInfoDataFeedback This property reports a string that indicates the device type and what are its capabilities (i.e. Load Controller, Occ Sensor, Photo, Keypad, etc...), and also appends the associated device variant details (i.e. LV dimmer, Phase dimmer, switch, number of buttons)

This property will trigger BaseEvent event with DeviceInfoDataFeedbackEventId.


(Inherited from ZumLinkKpKeypadBase)
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyDoubleTapTime This property is to set the time in 10ms ticks between the end of the first tap and the start of the second tap for a "DoubleTap" to be recognized. Minimum allowed is .1 sec, maximum is 1.0 sec Example: 100 means 1 second
(Inherited from ZumLinkKpKeypadBase)
Public propertyDoubleTapTimeFeedback This property returns the current DoubleTap time in 10ms ticks.

This property will trigger BaseEvent event with DoubleTapTimeFeedbackEventId.


(Inherited from ZumLinkKpKeypadBase)
Public propertyFeedbacks Property to get the collection of feedbacks on the device.
(Inherited from KeypadBase)
Public propertyHoldTime This property is to set the time in 10ms ticks that a button must be held before it is recognized as a "Hold" instead of a "Tap". Minimum allowed is .1 sec, maximum is 1.0 sec Example: 100 means 1 second
(Inherited from ZumLinkKpKeypadBase)
Public propertyHoldTimeFeedback This property is to get the value current Hold time in 10ms ticks.

This property will trigger BaseEvent event with HoldTimeFeedbackEventId.


(Inherited from ZumLinkKpKeypadBase)
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 propertyKeypadDisabledFeedback This property is to indicate if regular and advanced button events are disabled on the keypad.

This property will trigger BaseEvent event with KeypadDisabledFeedbackEventId.


(Inherited from ZumLinkKpKeypadBase)
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 propertyReadyForConfigurationUpdateFeedback When this property is true then the Zum Wired Device is ready to update configuration parameters. When this property is false then the Zum Wired Device will ignore the configuraion parameters.

This property will trigger BaseEvent event with ReadyForConfigUpdateFeedbackEventId.


(Inherited from ZumLinkKpKeypadBase)
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 propertyWaitForDoubleTap This property is to configure whether a "Tap" should be sent immediately on the release of the button, or if the unit should wait until a "DoubleTap" event occurs.
(Inherited from ZumLinkKpKeypadBase)
Public propertyWaitForDoubleTapFeedback This property returns 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 "DoubleTap" event occurs.

This property will trigger BaseEvent event with WaitForDoubleTapFeedbackEventId.


(Inherited from ZumLinkKpKeypadBase)
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 methodGetDeviceInfo This method is to get the device information into DeviceInfoDataFeedback.
(Inherited from ZumLinkKpKeypadBase)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodKeypadDisable This method will disable regular and advanced button events being received from the device.
(Inherited from ZumLinkKpKeypadBase)
Public methodKeypadEnable This method will enable regular and advanced button events being received from the device.
(Inherited from ZumLinkKpKeypadBase)
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)
Top
Example
C#
static ZumLinkKpKeypad _zumLinkKpRw;
static bool _objcreated;
public ControlSystemZumLinkKpKeypad()
{
    //Register console commands
     CrestronConsole.AddNewConsoleCommand(CreateDeviceCmd, "CreateDevice", "This is a ZUMLINK-KP CreateDevice command", ConsoleAccessLevelEnum.AccessOperator);
}

public void CreateDeviceCmd(String args)
{
   if (_objcreated == false)
    {
        //Initialize the ZUMLINK-KP device for Cresnet Communication.
        _zumLinkKpRw = new ZumLinkKpKeypad(0x17, this);
        CrestronConsole.ConsoleCommandResponse("ZUMLINK-KP device successfully created with CresnetID : {0}", _zumLinkKpRw.ID);           

        // Subscribe to the events.
        _zumLinkKpRw.BaseEvent += TestBaseEventHandler;
        _zumLinkKpRw.ButtonStateChange += KeypadButtonChange;

       //Register the ZUMLINK-KP Cresnet keypad with the Control system.
        _zumLinkKpRw.Register();
        _objcreated = true;
    }
    else
    {
        CrestronConsole.ConsoleCommandResponse("ZUMLINK-KP device already created with CresnetID : {0}", _zumLinkKpRw.ID);
    }
}

 public void TestBaseEventHandler(GenericBase device, BaseEventArgs args)
{
    if (args.EventId == ZumLinkKpKeypad.DeviceInfoDataFeedbackEventId)
    {
        CrestronConsole.PrintLine("DeviceInfoData event occurred on ZUMLINK KP");
    }
    else if (args.EventId == ZumLinkKpKeypad.KeypadDisabledFeedbackEventId)
    {
        CrestronConsole.PrintLine("KeypadDisabled event occurred on ZUMLINK KP");
    }
    else if (args.EventId == ZumLinkKpKeypad.ReadyForConfigUpdateFeedbackEventId)
    {
        CrestronConsole.PrintLine("ReadyForConfigUpdate event occurred on ZUMLINK KP");
    }
}

// Sig callback for handling ZUMLINK-KP button events.
static void KeypadButtonChange(GenericBase currentDevice, ButtonEventArgs args)
{
    for (uint i = 1; i <= 8; i++)
    {
        if (args.Button.Number == _zumLinkKpRw.Button[i].Number)
        {
            //This means Bool "sig" changed on the zumlink - kp
            //Just print some information for now.
            CrestronConsole.PrintLine("Button{0}'s state is {1}\r\n", i, args.Button.State);
       }
    }
}

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also