Click or drag to resize

C2niCb Properties

The C2niCb type exposes the following members.

Properties
 NameDescription
Public propertyAboveThreshold This input is driven by the AboveThreshold_FB output on the master keypad. This input is only active when EnableExtThreshold is set to true, which signifies that the current button is operating in slave mode. When the input goes true, this sets the backlight to the specified Day level (either custom or preset). When the input goes false, it goes to the specified Night level (custom or preset).
(Inherited from C2nCbdPBase)
Public propertyAboveThresholdFeedback Updated to indicate the level of the ambient light in relation to the threshold. This field is only updated when EnableExtThreshold is set to false.
(Inherited from C2nCbdPBase)
Public propertyBacklightIntensity Property that returns a reference to the BacklightIntensity UShortInputSig.
(Inherited from C2nCbdPBase)
Public propertyBargraphValue Property to get or set the current bargraph value of the device. On the C2niCb this property is the same as the LeftBargraphValue
(Inherited from InetCbdex)
Public propertyBrightnessSettings Returns a BrightnessSettings instance that can be used to get and set brightness settings.
(Inherited from C2nCbdPBase)
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 propertyDigitalInputPorts Collection of Digital inputs on the device.
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyEnableExtThreshold When EnableExtThreshold is true, this puts the keypad into slave mode.
(Inherited from C2nCbdPBase)
Public propertyFeedbacks Property to get the collection of feedbacks on the device.
(Inherited from InetCbdex)
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIndicatorIntensity Property to get or set the current intensity of the bargraph on the device.
(Inherited from InetCbdex)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyLeftBargraphValue Property to get or set the left bargraph value of the device.
Public propertyLightSensorValue Updated with the ambient light level. ReportLightLevel must be set to true.
(Inherited from C2nCbdPBase)
Public propertyManualBacklight Enables manual adjustment of the backlight via the BacklightIntensity input for as long as the input is true.
(Inherited from C2nCbdPBase)
Public propertyManualIndicatorIntensity Enables manual adjustment of the LED brightness via the IndicatorIntensity input for as long as the input is true.
(Inherited from C2nCbdPBase)
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNumberOfDigitalInputPorts Number of digital inputs this device supports.
Public propertyParameterBargraphTimeout Sets and gets the BargraphTimeout parameter. Valid values are between 0 to 10 seconds 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 InetCbdex)
Public propertyParameterDblTapSpeed Returns and sets the time between the end of the first tap and the start of the second tap for a "DblTap" to be recognized. Use the SimplSharpDeviceHelper.SecondsToUShort to convert the seconds to a ushort value or the SimplSharpDeviceHelper.UShortToSeconds to convert the ushort value to seconds.
(Inherited from InetCbdex)
Public propertyParameterHoldTime Returns and sets the time in seconds that a button must be held before it is recognized as a "Hold" instead of a "Tap". Use the SimplSharpDeviceHelper.SecondsToUShort to convert the seconds to a ushort value or the SimplSharpDeviceHelper.UShortToSeconds to convert the ushort value to seconds.
(Inherited from InetCbdex)
Public propertyParameterWaitForDoubleTap Returns and sets 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 "DblTap" event occurs.
(Inherited from InetCbdex)
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 propertyReportLightLevel Enables the LightSensorValue property and the LightSensorChange event output to report the current light level for as long as the input is true. When the input is false the light level isn't reported.
(Inherited from C2nCbdPBase)
Public propertyRightBargraphValue Property to get or set the right bargraph value of the device.
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
See Also