Ft |
This class will trigger ButtonStateChange and BaseEvent events.
public sealed class Ft2aCblr1t : GenericDevice, IButton, ISendParameters
The Ft2aCblr1t type exposes the following members.
| Name | Description | |
|---|---|---|
| Ft2aCblr1t(UInt32, CrestronControlSystem) | Constructor to generate a new Ft2aCblr1t device connected to control system. | |
| Ft2aCblr1t(UInt32, IDeviceBranch) | Constructor to generate a new Ft2aCblr1t device on IDeviceBranch. |
| Name | Description | |
|---|---|---|
| BacklightState | Property to set the state of the LED backlight. When this property value is false the button backlight is forced off during normal operation; when true, the backlight stays on when idle and blinks for cable retractions and fault conditions. Note that the backlight will also blink in setup mode regardless of the value of BacklightState property. | |
| BacklightStateFeedback |
Property to report the current state of the LED backlight.
true = Backlight is On; false = Backlight is Off
This property will trigger BaseEvent event with BacklightStateEventId. | |
| Button | Collection of buttons supported by the device. | |
| CableRetractedFeedback |
Property to report if the cable is retracted to original position.
true = Cable is retracted; false = Cable is not retracted
This property will trigger BaseEvent event with CableRetractedEventId. | |
| ClutchEngagedFeedback |
Property to report whether the clutch is engaged or dis-engaged.
true = Clutch is engaged; false = Clutch is dis-engaged
This property will trigger BaseEvent event with ClutchEngagedEventId. | |
| ClutchFaultFeedback |
Property to report the clutch fault state.
true = Clutch fault detected; false = No fault detected
This property will trigger BaseEvent event with ClutchFaultEventId. | |
| 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) | |
| ID |
Property to get the ID of the device.
(Inherited from GenericDevice) | |
| IsOnline |
Property to get the current online state of the device.
(Inherited from GenericDevice) | |
| Name |
Get the name of this device.
(Inherited from GenericBase) | |
| ParameterDoubleTapSpeed | Returns and sets the time between the end of the first tap and the start of the second tap for a "DoubleTap" 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. Valid values are 20 (0.2s) to 100 (1.0s), 50 (0.5s) is default | |
| 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. Valid values are 20 (0.2s) to 100 (1.0s), 50 (0.5s) is default | |
| ParameterRetractHoldTime | Time value in seconds for retraction to start after hold. Use the SimplSharpDeviceHelper.SecondsToUShort to convert the seconds to a ushort value or the SimplSharpDeviceHelper.UShortToSeconds to convert the ushort value to seconds. If less than ParameterHoldTime, retraction happens on every button press. Otherwise retracts when held for specified time. Valid values range from 1 to 10 seconds. | |
| 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 "DoubleTap" event occurs. True = Tap reporting is postponed to see if a second tap comes in. In this case only "DoubleTap" is reported. False = Tap is reported at the end of every short press, "DoubleTap" is reported at the end of the second short press. | |
| 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) | |
| RetractCountFeedback |
Property to report the number of retractions since the last reset.
Valid values range from 0 to 65535.
This property will trigger BaseEvent event with RetractCountFeedbackEventId. | |
| 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 | |
|---|---|---|
| Dispose |
Clean up of resources.
(Inherited from GenericBase) | |
| Dispose(Boolean) |
Method to perform the actual disposing of the device.
(Inherited from GenericDevice) | |
| 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) | |
| GetResetRetractCount | Method to set the current retraction count to 0. | |
| 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) | |
| RetractCable | Method to release the clutch to let cable retract. | |
| 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 | |
| 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. | |
| 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) | |
| OnlineStatusChange |
Event triggered when the Online status of the device changes.
(Inherited from GenericDevice) |
| Name | Description | |
|---|---|---|
| BacklightStateEventId |
The state of BacklightStateFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| CableRetractedEventId |
The state of CableRetractedFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| ClutchEngagedEventId |
The state of ClutchEngagedFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| ClutchFaultEventId |
The state of ClutchFaultFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| RetractCountFeedbackEventId |
The value of RetractCountFeedback has changed.
The BaseEvent event will trigger for this event id. |