Click or drag to resize

Tpmc8XGASystemReservedSigs Class

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

Namespace: Crestron.SimplSharpPro.UI
Assembly: Crestron.SimplSharpPro.UI (in Crestron.SimplSharpPro.UI.dll) Version: 2.21.121
Syntax
C#
public class Tpmc8XGASystemReservedSigs : Tpmc8BaseSystemReservedSigs

The Tpmc8XGASystemReservedSigs type exposes the following members.

Properties
 NameDescription
Protected propertyBooleanInput Bool Inputs on the device extender.
(Inherited from DeviceExtender)
Protected propertyBooleanOutput Bool Outputs on the device extender.
(Inherited from DeviceExtender)
Public propertyLCDBrightness Sets the LCD backlight brightness.

Valid values range from 0% (minimum brightness) to 100% (maximum brightness).

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
(Inherited from Tpmc8BaseSystemReservedSigs)
Public propertyLCDBrightnessAutoOffFeedback Indicates that the panel is currently in auto-mode. The output remains true for as long as auto-mode is turned on.
Public propertyLCDBrightnessAutoOnFeedback Indicates that auto-mode for LCD backlight brightness is turned on. The output remains true for as long as auto-mode is enabled.
Public propertyLCDBrightnessDown Lowers the LCD backlight brightness by 1% each time the input is true.

If the input remains true for 0.5 seconds, the LCD backlight brightness will decrement every 25ms until the input goes false or until it reaches the minimum value of 0%.


(Inherited from Tpmc8BaseSystemReservedSigs)
Public propertyLCDBrightnessFeedback Reports the LCD backlight brightness.
(Inherited from Tpmc8BaseSystemReservedSigs)
Public propertyLCDBrightnessUp Raises the LCD backlight brightness by 1% each time the input is true.

If the input remains true for 0.5 seconds, the LCD backlight brightness will increment every 25ms until the input goes false or until it reaches the maximum value of 100%.


(Inherited from Tpmc8BaseSystemReservedSigs)
Public propertyLightSensorValueFeedback Reports the ambient brightness level detected by the light sensor, from 0 to 100.

This value is used to adjust the LCD backlight brightness in auto-mode.

Public propertyPowerDownTimeout Sets the power timeout in minutes (1 = 1 minute).

The power timeout function turns off the touchpanel display, shuts off WiFi and puts the processor to sleep when the touchpanel is inactive for the specified period. The power timeout has no effect when AC power is online.

Valid analog values range from 0 (no power timeout) to 120 (120 minutes).

Public propertyPowerDownTimeoutFeedback Reports the current power timeout period.
Public propertyPowerTimeoutDn Decrements the power timeout by one (1) minute with each rising edge of the input.

The power timeout function turns off the touchpanel display, shuts off WiFi and puts the processor to sleep when the touchpanel is inactive for the specified period. The power timeout has no effect when AC power is online.

If the input remains true for 0.5 seconds, then the power timeout period will continue to decrement every 25ms until the input goes false or until it reaches 0 minutes (no power timeout).

Public propertyPowerTimeoutUp Increments the power timeout by one (1) minute with each rising edge of the input.

The power timeout function turns off the touchpanel display, shuts off WiFi and puts the processor to sleep when the touchpanel is inactive for the specified period. The power timeout has no effect when AC power is online.

If the input remains true for 0.5 seconds, then the power timeout period will continue to increment every 25ms until the input goes false or until it reaches the maximum value of 120 minutes.

Public propertyProjectNameFeedback The filename of the VTPro-e project that is currently loaded into the panel.
Public propertyStandbyTimeout Sets the standby timeout in minutes (1 = 1 minute). The standby timeout is the period from the last use of the touchscreen before going into standby mode (screen display is off but power is on).

Valid values range from 0 (no standby timeout) to 120 (120 minutes).


(Inherited from Tpmc8BaseSystemReservedSigs)
Public propertyStandbyTimeoutDown Decrements the standby timeout by one (1) minute each time the input is true.

If the input remains true for 0.5 seconds, then the standby timeout period will continue to decrement every 25ms until the input goes false or until it reaches 0 minutes (no standby timeout).


(Inherited from Tpmc8BaseSystemReservedSigs)
Public propertyStandbyTimeoutFeedback Reports the standby timeout period.
(Inherited from Tpmc8BaseSystemReservedSigs)
Public propertyStandbyTimeoutUp Increments the standby timeout by one (1) minute each time the input is true. The standby timeout is the period from the last use of the touchscreen before going into standby mode (screen display is off but power is on).

If the input remains true for 0.5 seconds, then the standby timeout period will continue to increment every 25ms until the input goes false or until it reaches the maximum value of 120 minutes.


(Inherited from Tpmc8BaseSystemReservedSigs)
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)
Top
Methods
 NameDescription
Public methodEnterSetup Displays the Setup menu.
(Inherited from Tpmc8BaseSystemReservedSigs)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(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 8X System extender
(Overrides Tpmc8BaseSystemReservedSigsInitializeJoins)
Public methodLCDBrightnessAutoOff Turns off auto-mode for LCD backlight brightness control on the rising edge of the input.
Public methodLCDBrightnessAutoOn Turns on auto-mode for LCD backlight brightness control on the rising edge of the input.

This signifies that the LCD backlight brightness will be set to high (as defined in the TPMC-8L System2 Reserved Joins extender) when the light sensor detects that the current brightness level (reported by LightSensorValueFeedback) exceeds the level specified by LCD Brightness Auto Threshold.

Similarly, the LCD brightness will be set to low (as defined in the LCDLevelLow input of the TPMC-8L System2 Reserved Joins extender) when the light sensor detects that the current brightness level (reported by LightSensorValueFeedback) is below the level specified by LCD Brightness Auto Threshold.

Public methodLCDBrightnessHigh Sets the LCD backlight brightness level to High.
(Inherited from Tpmc8BaseSystemReservedSigs)
Public methodLCDBrightnessLow Sets the LCD backlight brightness level to Low.
(Inherited from Tpmc8BaseSystemReservedSigs)
Public methodLCDBrightnessMed Sets the LCD backlight brightness level to Med.
(Inherited from Tpmc8BaseSystemReservedSigs)
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 methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
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)
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