Inet |
public sealed class InetCbdexP : InetCbdex, IAmbientLightSensor, IBrightnessAndBargraphSettings
The InetCbdexP type exposes the following members.
| Name | Description | |
|---|---|---|
| InetCbdexP | Constructor to generate a new InetCbdexP keypad device. |
| Name | Description | |
|---|---|---|
| AboveThreshold | 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). | |
| AboveThresholdFeedback | 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. | |
| BacklightIntensity | Property that returns a reference to the BacklightIntensity UShortInputSig. | |
| BargraphValue |
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) | |
| BrightnessSettings | Returns a BrightnessSettings instance that can be used to get and set brightness settings. | |
| Button |
Collection of buttons supported by the device.
(Inherited from KeypadBase) | |
| ConnectedIpList |
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) | |
| Description |
Get/Set the description of this device.
(Inherited from GenericBase) | |
| Disposed |
Property to indicate if the device has been disposed.
(Inherited from GenericDevice) | |
| EnableExtThreshold | When EnableExtThreshold is true, this puts the keypad into slave mode. | |
| Feedbacks |
Property to get the collection of feedbacks on the device.
(Inherited from InetCbdex) | |
| ID |
Property to get the ID of the device.
(Inherited from GenericDevice) | |
| IndicatorIntensity |
Property to get or set the current intensity of the bargraph on the device.
(Inherited from InetCbdex) | |
| IsOnline |
Property to get the current online state of the device.
(Inherited from GenericDevice) | |
| LightSensorValue | Updated with the ambient light level. ReportLightLevel must be set to true. | |
| ManualBacklight | Enables manual adjustment of the backlight via the BacklightIntensity input for as long as the input is true. | |
| ManualIndicatorIntensity | Enables manual adjustment of the LED brightness via the IndicatorIntensity input for as long as the input is true. | |
| Name |
Get the name of this device.
(Inherited from GenericBase) | |
| ParameterBargraphTimeout |
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) | |
| ParameterDblTapSpeed |
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) | |
| ParameterHoldTime |
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) | |
| ParameterWaitForDoubleTap |
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) | |
| Parent |
The parent that a given object was added to.
(Inherited from GenericBase) | |
| Registerable |
Property to indicate that this device can be registered.
(Inherited from GenericDevice) | |
| Registered |
Property to get the current registration state of the device.
(Inherited from GenericDevice) | |
| RegistrationFailureReason |
Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice) | |
| ReportLightLevel | 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. | |
| SIMPLDeviceImplementation |
Internal protected member used for actual device control.
(Inherited from GenericDevice) | |
| Type |
Property to determine to type of device this is.
(Inherited from GenericDevice) | |
| UnRegistrationFailureReason |
Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice) | |
| UserSpecifiedObject |
Can be assigned anything that user wants.
(Inherited from GenericBase) | |
| XioEndpointStubSIMPLDevice |
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) |
| Name | Description | |
|---|---|---|
| CancelActiveBargraph |
Cancels active bargraph.
(Inherited from InetCbdex) | |
| DisableBargraph |
Disables the bargraph functionality.
(Inherited from InetCbdex) | |
| Dispose |
Clean up of resources.
(Inherited from GenericBase) | |
| Dispose(Boolean) |
Method to perform the actual disposing of the device.
(Inherited from GenericDevice) | |
| EnableBargraph |
Enables the bargraph functionality.
(Inherited from InetCbdex) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize |
Destructor of the device.
(Inherited from GenericDevice) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| OnBaseEvent(Int32) |
Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase) | |
| OnBaseEvent(Int32, UInt16) |
Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase) | |
| Register |
Register this device with the system.
(Inherited from GenericDevice) | |
| SendParameters |
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
(Inherited from InetCbdex) | |
| ToString |
Return the name of the device.
(Inherited from GenericDevice) | |
| UnRegister |
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) |
| Name | Description | |
|---|---|---|
| BaseEvent |
Generic base event, triggered when the there are no other handlers available
for a specific EventID.
(Inherited from GenericBase) | |
| ButtonStateChange |
Event fired when a button state change was received from the device.
(Inherited from KeypadBase) | |
| IpInformationChange |
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) | |
| LightSensorChange | Reports the ambient light level as a percentage from 0% to 100%, as determined by the internal light sensor. ReportLightLevel must be true. | |
| OnlineStatusChange |
Event triggered when the Online status of the device changes.
(Inherited from GenericDevice) | |
| ThresholdStateChange | Reports when ambient light is at or below or above the threshold. This event is only raised when EnableExtThreshold is set to false. |
| Name | Description | |
|---|---|---|
| _Buttons |
Collection that contains button objects.
(Inherited from KeypadBase) |