Click or drag to resize

Tpmc8XGAWiFiReservedSigs Class

Extender class to provide access to the WiFi Reserved Sigs feature of the TPMC-8X-GA Touch Screen.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProDeviceExtender
    Crestron.SimplSharpPro.UITpmc8BaseWiFiReservedSigs
      Crestron.SimplSharpPro.UITpmc8XGAWiFiReservedSigs

Namespace: Crestron.SimplSharpPro.UI
Assembly: Crestron.SimplSharpPro.UI (in Crestron.SimplSharpPro.UI.dll) Version: 2.21.121
Syntax
C#
public sealed class Tpmc8XGAWiFiReservedSigs : Tpmc8BaseWiFiReservedSigs

The Tpmc8XGAWiFiReservedSigs type exposes the following members.

Properties
 NameDescription
Public propertyACLineStatusFeedback Indicates the status of the AC power line. The output remains true for as long as AC power is on.
(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyBatteryChargingFeedback Indicates that the internal Li-Ion battery is charging. The output remains true for as long as the battery is charging.
(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyBatteryDiscreteLevelFeedback Reports the internal battery level from 0 (no charge) to 9 (full charge).
(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyBatteryLevelFeedback Reports the internal battery level from 0 (no charge) to 100 (full charge).
(Inherited from Tpmc8BaseWiFiReservedSigs)
Protected propertyBooleanInput Bool Inputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyBooleanOutput Bool Outputs on the device extender.
(Inherited from DeviceExtender)
Public propertyDockingStationBSSIDAddressFeedback The BSSID of the docking station (desktop cradle or wallmount docking station).

The BSSID is the name given to the WAP (wireless access point) MAC address.

The BSSID is reported in the format: XX-XX-XX-XX-XX-XX, where XX is a hexadecimal value ranging from 00 to FF (all caps).


(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyDockingStationConnectionStatusFeedback Indicates that the docking station Ethernet link status is online, whether the docking station is the desktop cradle or the wallmount docking station.
(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyDockingStationDockedStatusFeedback Indicates that the panel is currently docked in a docking station, whether the docking station is the desktop cradle or the wallmount docking station.
(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyDockingStationIPAddressFeedback The IP address of the docking station (desktop cradle or wallmount docking station).

The IP address is reported in dotted decimal format: X.X.X.X, where X is a decimal value ranging from 0 to 255, with no leading zeros.


(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyDockingStationMACAddressFeedback The MAC address of the docking station (desktop cradle or wallmount docking station).

The MAC address is reported in the format: XX-XX-XX-XX-XX-XX, where XX is a hexadecimal value ranging from 00 to FF (all caps).


(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyExternalBatteryChargingFeedback Indicates that the external "booster" battery pack is charging. The output remains true for as long as the external battery pack is charging.
Public propertyExternalBatteryConditionDiscreteLevelFeedback Reports the overall useful life left in the external battery from 0 (no battery life) to 9 (full battery life).
Public propertyExternalBatteryConditionLevelFeedback Reports the overall useful life left in the external battery from 0 (no battery life) to 100 (100% battery life). Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyExternalBatteryDiscreteLevelFeedback Reports the internal battery level from 0 (no charge) to 9 (full charge).
Public propertyExternalBatteryLevelFeedback Reports the external battery level from 0 (no charge) to 100 (full charge).
Public propertyExternalBatteryPresentFeedback Indicates that the optional external booster battery pack (TPMC-8X-BTPE) is present. The output remains true for as long as the external battery is detected.

The external pack clips to the rear of the panel and provides up to 20 hours of typical use between charges.

Public propertyInternalBatteryConditionDiscreteLevelFeedback Reports the overall useful life left in the internal battery from 0 (no battery life) to 9 (full battery life).
Public propertyInternalBatteryConditionLevelFeedback Reports the overall useful life left in the internal battery from 0 (no battery life) to 100 (full battery life).
Public propertyInternalWiFiDiscreteSignalStrengthFeedback Reports the WiFi signal strength from 0 (no signal) to 9 (maximum signal).
(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyInternalWiFiIPAddressFeedback The IP Address of the touchpanel.

The IP address is reported in dotted decimal format: X.X.X.X, where X is a decimal value ranging from 0 to 255, with no leading zeros.


(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyInternalWiFiMACAddressFeedback The MAC address of the touchpanel.

The MAC address is reported in the format: XX-XX-XX-XX-XX-XX, where XX is a hexadecimal value ranging from 00 to FF (all caps).


(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyInternalWiFiSignalStrengthFeedback Reports the WiFi signal strength from 0 (no signal) to 100 (maximum signal).
(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyInternalWiFiSSIDFeedback The SSID of the touchpanel. The SSID is a string of ASCII characters.

The SSID is the pre-defined network name.


(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyInternalWiFiWAPConnectionStatusFeedback Indicates a valid connection to a WAP (wireless access point).
(Inherited from Tpmc8BaseWiFiReservedSigs)
Protected propertyStringInput String Inputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyStringOutput String Outputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyUShortInput UShort Inputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyUShortOutput UShort Outputs on the device extender.
(Inherited from DeviceExtender)
Public propertyWallmountDockingStationCarrierClosedStatusFeedback Indicates the status of the carrier, which holds the panel. When the carrier is open, the panel can be removed from the docking station. When closed, the panel is locked into the docking station.
(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyWallmountDockingStationDisableReleasePopupIcon Disables the pop-up icon that is usually displayed whenever the panel is docked in the wallmount docking station, for as long as the input is true. The icon is a button that the user can press to release the panel.

When the input is false, the icon is displayed when the panel is docked.


(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyWallmountDockingStationDisableReleasePopupIconFeedback Indicates that the pop-up icon for releasing the panel from the wallmount docking station is disabled. The output remains true for as long as the pop-up icon is disabled.
(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyWallmountDockingStationDockedStatusFeedback Indicates that the panel is currently docked in the wallmount docking station.
(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyWallmountDockingStationPanelManuallyReleasedFeedback Pulses to indicate that the panel has been manually released from the docking station.

(To manually release the panel, the user sticks a flat key on the top part of the docking station that releases the panel from the docking station.)


(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyWallmountDockingStationPlainTextPasscodeDialog Displays the passcode that the user enters into the Wallmount Passcode Release dialog in plain text rather than asterisks, for as long as the input is true. When the input is false, the passcode is displayed in all asterisks.
(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyWallmountDockingStationPlainTextPasscodeDialogFeedback Indicates that plain text passcode display is turned on. The output remains true for as long as the panel is in this mode.
(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyWallmountDockingStationReleasePasscode Pass code for removing the panel from the docking station when the panel is in secure mode (WallmountDockingStationSecureModeFeedback = true).

The user can enter this pass code or any of the five passcodes that can be set in the Wallmount Docking Station Setup dialog.

The string can be made up of any ASCII characters (251 characters max).


(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyWallmountDockingStationSecureMode Activates secure mode for as long as the input is true.

When in secure mode, this displays the "Wallmount Passcode Release" dialog whenever the user tries to release the panel from the docking station. The user would then need to enter any of the five passcodes set in the "Wallmount Docking Station Setup" dialog, or the passcode set by WallmountDockingStationReleasePasscode.

When the input is false, this puts the panel into standard mode. In standard mode the panel can be removed by anyone.


(Inherited from Tpmc8BaseWiFiReservedSigs)
Public propertyWallmountDockingStationSecureModeFeedback Indicates that the panel is in secure mode. The output remains true for as long as the panel is in secure mode.
(Inherited from Tpmc8BaseWiFiReservedSigs)
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodInitializeJoins Method to initialize the sigs of the 8XGA WiFi extender
(Overrides Tpmc8BaseWiFiReservedSigsInitializeJoins)
Protected methodMapAnalogInputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodMapAnalogOutputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodMapDigitalInputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodMapDigitalOutputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodMapSerialInputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodMapSerialOutputJoins Protected function to map joins to the join collection on the parent device.
(Inherited from DeviceExtender)
Protected methodSendCueEventDataForDeviceExtender Function to trigger the DeviceExtender Sig Change event
(Inherited from DeviceExtender)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodUse Set the extender as usable on the device. Call this method before registration of the device.
(Inherited from DeviceExtender)
Public methodWallmountDockingStationReleasePanel Notify the wallmount docking station to release (unlock) the panel.
(Inherited from Tpmc8BaseWiFiReservedSigs)
Top
Events
 NameDescription
Public eventDeviceExtenderSigChange Event to receive sig information intended for a device extender. When processing this event, it will hold off other sigs from being received from the device. If one desires to continue processing the data and receive more information, launch a new thread and allow this event to exit.
(Inherited from DeviceExtender)
Top
Fields
 NameDescription
Protected field_InUse Bool to determine if the extended is in use by the user.
(Inherited from DeviceExtender)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also