Click or drag to resize

ZumLinkKpKeypad Properties

The ZumLinkKpKeypad type exposes the following members.

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
See Also