Click or drag to resize

ClwiKplex Class

European Cameo In Wall Wireless lighting keypad.

This class will trigger ButtonStateChange and LearnableButtonEvent.

Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.Keypads
Assembly: Crestron.SimplSharpPro.Keypads (in Crestron.SimplSharpPro.Keypads.dll) Version: 2.21.121
Syntax
C#
public sealed class ClwiKplex : ClwiKeypad, 
	ISendParameters

The ClwiKplex type exposes the following members.

Constructors
 NameDescription
Public methodClwiKplex Constructor for ClwiKplex device
Top
Properties
 NameDescription
Public propertyButton Property to get the collection of buttons on the device.
(Inherited from ClwiKeypad)
Public propertyCLWIUISettings Class to specify the parameters of the user interface of this unit.
(Inherited from ClwiKeypad)
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 on the device.
(Inherited from ClwiKeypad)
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyInNightlightMode Returns the input Sig that can be used to enable or disable nightlight mode. When the input Sig is set to true it enables nightlight mode when it is set to false it disables nightlight mode.
(Inherited from ClwiKeypad)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyLeftRemoteBargraph Sets the left bargraph to the designated percentage. If > 0 enables bargraph mode and sets bargraph to the designated value. Setting to 0 disables bargraph mode. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage
(Inherited from ClwiKeypad)
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyParameterRemoteDoubleTapTime The time between the end of the first tap and the start of the second tap for a double tap to be recognized. Valid values range from 0.20 to 1.00 second. Use the SimplSharpDeviceHelper.SecondsToUShort to convert the time to a ushort value or the SimplSharpDeviceHelper.UShortToSeconds to convert the ushort value to seconds
(Inherited from ClwiKeypad)
Public propertyParameterRemoteHoldTime The time that a button must be held before it is recognized as a "Hold" instead of a "Tap". Valid values range from 0.20 to 1.00 second. Use the SimplSharpDeviceHelper.SecondsToUShort to convert the time to a ushort value or the SimplSharpDeviceHelper.UShortToSeconds to convert the ushort value to seconds
(Inherited from ClwiKeypad)
Public propertyParameterRemoteWaitForDoubleTap Determines whether a "Tap" should be sent immediately on the release of the button, or if the unit should wait until a Double Tap event occurs.
(Inherited from ClwiKeypad)
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 propertyRightRemoteBargraph Sets the Right bargraph to the designated percentage. If > 0 enables bargraph mode and sets bargraph to the designated value. Setting to 0 disables bargraph mode. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage
(Inherited from ClwiKeypad)
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)
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 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. It requires firmware support on the device. Not Currently implemented. This will throw a NotSupportedException
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 eventLearnableButtonEvent Event triggered when a learning event occurs on the device.
(Inherited from ClwiKeypad)
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

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also