|
<< Click to Display Table of Contents >> Navigation: »No topics above this level« Variable names for panel devices |
The ADI line supports the following variables for a panel device:
Note: The "C" column indicates whether the variable returns a constant value.
Variable name |
Data format |
I/O |
C |
Devices |
Description |
Address |
VT=u8 |
R |
ü |
APC510 APC511 APC620 APC810 APC820 APC910 APC2100 PP500 PPC700 PPC800 PPC900 PPC2100 |
Panel address: 0 to 15 |
BacklightOnCycles |
VT=u16 |
R |
|
APC510 APC511 APC620 APC810 APC820 APC910 APC2100 PP500 PPC300 PPC700 1 PPC800 1 PPC900 PPC2100 |
Number of backlight power-ons for the display unit. |
BacklightOnHours |
VT=u16 |
R |
|
APC510 APC511 APC620 APC810 APC820 APC910 APC2100 PP500 PPC300 PPC700 1 PPC800 1 PPC900 PPC2100 |
Number of backlight operating hours for the display unit. |
VT=u8 |
R |
ü |
MP100/200 PP100/200 PP300/400 |
Default value for the display brightness (raw value). |
|
BrightnessMax |
VT=u8 |
R |
ü |
MP40/50 MP100/200 PP100/200 PP300/400 |
Maximum value for the display brightness (raw value). |
BrightnessMin |
VT=u8 |
R |
ü |
MP40/50 MP100/200 PP100/200 PP300/400 |
Minimum value for the display brightness (raw value). |
CompatibilityId |
VT=u16 |
R |
|
APC510 APC511 APC620 APC810 APC820 APC910 APC2100 PP500 19 PPC300 PPC700 1 PPC800 1 PPC900 PPC2100 |
Panel compatibility ID. |
VT=u8 |
R |
ü |
MP100/200 PP100/200 PP300/400 |
Default value for the display contrast (raw value). |
|
ContrastMax |
VT=u8 |
R |
ü |
MP40/50 MP100/200 PP100/200 PP300/400 |
Maximum value for the display contrast (raw value). |
ContrastMin |
VT=u8 |
R |
ü |
MP40/50 MP100/200 PP100/200 PP300/400 |
Minimum value for the display contrast (raw value). |
Detected |
VT=boolean |
R |
ü |
APC510 APC511 APC620 APC810 APC820 APC910 APC2100 PP300/400 PP500 PPC300 PPC700 PPC800 PPC900 PPC2100 |
Code for whether the panel has been detected: 0 = Not detected 1 = Detected |
DeviceId |
VT=u32 |
R |
2 |
APC510 APC511 APC620 APC810 APC820 APC910 APC2100 PP500 19 PPC300 PPC700 1 PPC800 1 PPC900 PPC2100 |
Panel device ID. |
VT=u8 |
R/W |
|
All 3 |
Brightness of the display (backlighting) in percent: 0 to 100 |
|
VT=u8 |
R/W |
|
MP40/50 MP100/200 3 PP100/200 3 PP300/400 |
Contrast of the display in percent: 0 to 100 |
|
VT=u8 |
R/W |
|
All 3 12 13 |
Default brightness value of the display (backlighting) in percent: 0 to 100 |
|
VT=u8 |
R/W |
|
MP40/50 MP100/200 3 PP100/200 3 PP300/400 12 13 |
Default contrast value of the display in percent: 0 to 100 |
|
VT=u8 |
R/W |
|
APC510 APC511 APC620 4 APC810 APC820 APC910 APC2100 PP500 19 PPC700 1 4 PPC800 1 PPC900 1 PPC2100 1 |
Equalizer setting of the display: 0 (strong) to 15 (weak) 18 Automatic mode is automatically activated when writing to a variable (see the DisplayEqualizerAuto variable). |
|
DisplayEqualizerAuto |
VT=boolean |
R/W |
|
APC510 APC511 APC620 4 APC810 APC820 APC910 APC2100 PP500 19 PPC700 1 4 PPC800 1 PPC900 1 PPC2100 1 |
Automatic mode of the equalizer setting of the display. 18 If 0 (off), a user-specific equalizer value is used (see the DisplayEqualizer variable). If 1 (on), the predefined equalizer value is used (see the DisplayEqualizerAutoValue variable). |
VT=u8 |
R |
|
APC510 APC511 APC620 4 18 APC810 APC820 APC910 APC2100 PP500 19 PPC700 1 4 18 PPC800 1 18 PPC900 1 PPC2100 1 |
Automatic value of the equalizer setting of the display. 0 (strong) to 15 (weak) 18 |
|
DisplayHResolution |
VT=u16 |
R |
2 |
All |
Horizontal resolution of the display in pixels, e.g. 640 for VGA or 1024 for XGA. |
DisplayId |
VT=u8 |
R |
ü |
APC510 APC511 MP100/200 PP100/200 PP500 20 |
|
DisplayVResolution |
VT=u16 |
R |
2 |
All |
Vertical resolution of the display in pixels, e.g. 480 for VGA or 768 for XGA. |
FactoryData |
VT=u8 VN=256 |
R |
2 |
|
obsolete - replaced by FactorySettings |
VT=u8 VN=256 |
R |
2 |
APC510 APC511 APC620 APC810 APC820 APC910 APC2100 PP500 19 PPC300 PPC700 1 PPC800 1 PPC900 PPC2100 |
Panel factory settings. For B&R-internal use only! |
|
FanSpeed |
VT=u16 |
R |
|
APC510 APC511 APC620 APC810 APC820 APC910 APC2100 PP500 19 PPC300 PPC700 1 PPC800 1 PPC900 1 PPC2100 1 |
Fan speed in rpm. |
HardwareRevision |
VT=string VL=5 |
R |
2 |
APC510 APC511 APC620 APC810 APC820 APC910 APC2100 PP500 19 PPC300 PPC700 1 PPC800 1 PPC900 PPC2100 |
Hardware revision of the panel. |
KeyCount |
VT=u8 |
R |
2 |
All |
Number of maximum supported keys: 0 to 128 |
KeyEnable |
VT=boolean |
R/W |
|
All 7 |
Key locking status: 0 = Locked, 1 = Unlocked |
VT=u8 VN=16 |
R |
|
All |
State of the keys in the current key layer in "packed" form: Byte 0, Bit 0 = 1. Key Byte 0, Bit 1 = 2. Key ... Byte 1, Bit 0 = 9. Key ... 1 bit per key: 0 = Not pressed 1 = Pressed |
|
VT=boolean VN=128 |
R |
|
All |
State of the keys in the current key layer. 1 element per key: 0 = Not pressed, 1 = Pressed |
|
VT=boolean VN=8 |
R |
|
All 8 9 11 15 |
State of the key switches. 1 element per contact: 0 = Open, 1 = Closed |
|
LedCount |
VT=u8 |
R |
2 |
All |
Number of maximum supported LEDs: 0 to 128 |
VT=u8 |
R/W |
|
All |
Number of current LED layers: 0 to 3 |
|
VT=u8 VN=32 |
R/W 16 |
|
All |
State of the LEDs in the current LED layer in "packed" form: Byte 0, Bit 0+1 = 1. LED Byte 0, Bit 2+3 = 2. LED ... Byte 1, Bit 0+1 = 5. LED ... 2 bits per LED: 00 = Off 01 = Normal blinking 10 = Fast blinking 14 11 = On |
|
|
|
VT=u8 VN=128
|
R/W 16 |
|
All 7 |
State of the LEDs in the current LED layer. 1 element per LED: 0 = Off 1 = Normal blinking 2 = Fast blinking 14 3 = On |
Linked |
VT=boolean |
R |
|
APC510 APC511 APC620 APC810 APC820 APC910 APC2100 PP300/400 PP500 PPC300 PPC700 PPC800 PPC900 PPC2100 |
Code for whether the panel is connected: 0 = Not connected 1 = Connected |
LinkFpgaVersion |
VT=string VL=16 |
R |
2 |
APC510 APC511 APC620 APC810 APC820 APC910 APC2100 PP500 19 PPC700 1 PPC800 1 PPC900 1 PPC2100 1 |
Version of the AP Link FPGA firmware. Example: "0.03" |
LinkType |
VT=string VL=5 |
R |
2 |
APC510 APC511 APC620 APC810 APC820 APC910 APC2100 PP500 19 PPC700 1 PPC800 1 PPC900 1 PPC2100 1 |
Type of AP Link insert: "SDLR" = AP900 SDL receiver / transceiver) "AP8H" = AP800 SDL receiver 10 "SDL8" = AP800/AP830 SDL receiver 22 "SDL9" = AP9x3/AP9xD SDL receiver 23 "SR3D" = AP9x3/AP9xD SDL3 receiver 24 "SR3E" = AP900 SDL3 receiver 24
|
Locked |
VT=boolean |
R/W |
|
APC510 APC511 APC620 5 APC810 APC820 APC910 APC2100 PP300/400 12 PP500 PPC300 PPC700 5 PPC800 PPC900 PPC2100 |
Code for whether the panel is locked: 0 = Not locked 1 = Locked - input from keys and touch screen 17 not processed |
ModelNumber |
VT=string VL=41 |
R |
2 |
APC510 APC511 APC620 APC810 APC820 APC910 APC2100 PP500 19 PPC300 PPC700 1 PPC800 1 PPC900 PPC2100 |
Model number of the panel. |
PowerOnCycles |
VT=u16 |
R |
ü |
PPC900 21 PPC2100 21 |
Number of power-ons of the panel |
PowerOnHours |
VT=u16 |
R |
|
PPC900 21 PPC2100 21 |
Number of operating hours of the panel |
SerialNumber |
VT=string VL=12 |
R |
2 |
APC510 APC511 APC620 APC810 APC820 APC910 APC2100 PP500 19 PPC300 PPC700 1 PPC800 1 PPC900 PPC2100 |
Panel serial number. |
Temperature |
VT=i8 |
R |
|
APC510 APC511 APC620 APC810 APC820 APC910 APC2100 PP500 19 PPC300 PPC700 1 PPC800 1 PPC900 PPC2100 |
Temperature of the panel (ambient temperature of the display) in degrees Celsius (positive values only). |
VendorId |
VT=u32 |
R |
2 |
APC510 APC511 APC620 APC810 APC820 APC910 APC2100 PP500 19 PPC300 PPC700 1 PPC800 1 PPC900 PPC2100 |
Panel vendor ID. |
1 |
Not available for Panel 15 on PPCs. |
2 |
The value can be changed on the APC620, PPC700, APC810, PPC800 and APC820 when connecting another Automation Panel. |
3 |
Requires BIOS version 1.00 or higher on the PP100/200. |
4 |
Requires MTCX PX32 version 1.54 or higher on the APC620 and PPC700. |
5 |
Requires MTCX PX32 version 1.30 or higher on the APC620 and PPC700. |
6 |
Requires MTCX PX32 version 1.22 or higher on the APC620 and PPC700 when accessing individual LEDs (array elements). |
7 |
Requires MTCX PX32 version 1.21 or higher on the APC620 and PPC700. |
8 |
Requires ADI driver version 1.11 or higher on the APC620 and PPC700. |
9 |
Requires MTCX PX32 version 1.59 or higher on the APC620 and PPC700. |
10 |
AP Link type "AP8H" requires ADI driver version 1.50 or higher on the APC620 and PPC700. |
11 |
Requires ADI driver version 2.00 or higher on the PP100/200 and MP100/200. |
12 |
Requires MTCX PX32 version 1.11 or higher on the PP300/400. |
13 |
Requires ADI driver version 1.20 or higher on the PP300/400. |
14 |
MP40/50 devices do not support a fast blink. With ADI driver version 1.21 or higher on the MP40/50, fast blinking is handled like slow blinking. |
15 |
Requires ADI driver version 1.10 or higher on the MP40/50. With older versions, the key switch status is returned inverted. |
16 |
Requires ADI driver version 1.20 or higher on the MP40/50 when writing the LED matrix. |
17 |
On PP300/400 and PPC300 devices, the touch screen cannot be locked. |
18 |
Requires AP Link FPGA version 1.04 or higher on the AP900. |
19 |
Not available for Panel 0 on the PP500. |
20 |
Requires ADI driver version 1.4 or higher on the PP500. |
21 |
Only available for Panel 15. |
22 |
"SDL8" is only supported on APC810/PPC800 devices with ADI driver version 1.70 or higher, on APC910/PPC900 devices with ADI driver version 0.6 or higher and on APC2100 devices. |
23 |
"SDL9" is only supported on APC910/PPC900 devices with ADI driver version 2.2 or higher and on APC2100 devices. |
24 |
"SR3D" and "SR3E" are only supported on APC2100/PPC2100 devices with ADI driver version 3.1 or higher. |
BIOS uses this ID to initialize the display with the appropriate display parameters.
Possible values on APC510, APC511:
FFh = no display
Possible values on PP100/200, MP100/200 devices:
00h = Display parameters not read from the factory settings
10h = Passive display (STN)
11h = LCD B/W QVGA
12h = LCD COL QVGA
20h = Active QVGA display (TFT)
30h = Active VGA display (TFT)
40h = Active SVGA display (TFT)
50h = Active XGA display (TFT)
Possible values on PP500:
00h = 640 x 480, 5.7"
01h = 800 x 600, 8.4"
02h = 800 x 600, 12"
03h = 640 x 480, 10.4"
04h = 800 x 480, 7"
07h = 1024 x 768, 15"
The DisplayBrightness setting is only applied until the next time the system is started (except on MP40/50, see below). In order for the brightness to be retained after the next system start you must set the default value using the DisplayDefaultBrightness variable.
The default value for the brightness is automatically set by the ADI driver when the system is started.
The first time the system is started, a fixed value (e.g. 50% or 100%) or the factory setting (see BrightnessDef variable) is used as the default value, depending on the device.
On PP100/200 and MP100/200 devices, the factory setting is also used in service mode (mode/node switches set to 0/0).
On the PP300/400 (with ADI driver version 1.20 or higher and MTCX PX32 version 1.11 or higher) and the PPC300, the default brightness value is used when the PC is booted if the brightness is set to AUTO in BIOS.
MP40/50 devices do not differentiate between the default value and the current value of the brightness. Both DisplayDefaultBrightness and DisplayBrightness read and change the current brightness.
On PP500, APC620, PPC700, APC810, PPC800, APC820, PP100/200 and MP100/200 devices, on PP300/400 devices with an ADI driver version lower than 1.20, and on PPC300 devices with an ADI driver version lower than 1.10, the default brightness value is stored in the Windows registry. In order for the modified value to be present after a restart, in Windows CE the information is saved by the ADI driver under HKEY_LOCAL_MACHINE in the registry.
Contrast settings can only be configured on passive displays.
The DiaplayContrast setting is only applied until the next time the system is started (except on MP40/50, see below). In order for the contrast to be retained after the next system start you must set the default value using the DisplayDefaultContrast variable.
The default value for the contrast is automatically set by the ADI driver when the system is started.
The default value for the contrast is the value that is automatically set by the ADI driver when the system is started. The first time the system is started, a fixed value (e.g. 50% or 100%) or the factory setting (see ContrastDef variable) is used as the default value, depending on the device.
On PP100/200 and MP100/200 devices, the factory setting is also used in service mode (mode/node switches set to 0/0).
On the PP300/400 (with ADI version 1.20 or higher and MTCX PX32 version 1.11 or higher), the default contrast value is used when the PC is booted if the brightness is set to AUTO in BIOS.
MP40/50 devices do not differentiate between the default value and the current value of the contrast. Both DisplayDefaultContrast and DisplayContrast read and change the current contrast.
On PP100/200 and MP100/200 devices, and on PP300/400 devices with an ADI version before 1.20, the default contrast value is stored in the Windows Registry. In order for the modified value to be present after a restart, in Windows CE the information is saved by the ADI driver under HKEY_LOCAL_MACHINE in the registry.
The equalizer is integrated into Automation Panel devices and adapts the DVI signal to different cable lengths. The equalizer value is automatically calculated based on the cable length. You can use the DisplayEqualizer variable to set a different equalizer value in order to obtain the best possible display quality (e.g. with low-quality cables or poor DVI signal quality).
You can read the automatically predefined equalizer value with the DisplayEqualizerAutoValue variable regardless of the equalizer value currently being used.
A panel device supports up to 128 keys in four layers.
For technical reasons, all B&R devices that are able to support keys currently report the number of keys as 128. This does not necessarily mean that the device actually has 128 keys. There may in fact be fewer or no keys at all present on the device. It can only be assumed that the device does not support keys if the number of keys returned is 0.
Key states can also be read if the system doesn't have a valid key configuration.
PP100/200, MP100/200, MP40/50 (with ADI driver version 1.10 or lower): In Windows CE, the key states are not returned until GWES (the Graphics, Windows, and Event Subsystem) has started.
MP40/50: The status of the optional key switch or pushbutton is always returned in bit 0 and 1 of the 9th byte.
Prior to ADI driver version 1.10 on MP40/50 devices, bits 0 and 1 of the 9th byte are returned inverted.
Reading several keys can be done more effectively by reading the entire key array. For this, only one access to the ADI driver has to be made for all keys. However, the PVI application itself then has to evaluate the necessary keys (array elements for the Keys variable or bits for the KeyMatrix variable).
Only the current key states are provided by ADI and not, as with a standard keyboard, the sequence of the keys pressed. This means that pressing keys for only a short duration may not be detected depending on the scan times of the ADI driver, the ADI line, and the PVI application. The ADI line scan time is influenced by the number and refresh rates of the registered variables. Key states should therefore only be read for diagnostic purposes!
Switch key states can only be read if a valid key configuration with key switch specifications is present in the system. The key configuration must be created with B&R Key Editor version 2.50 or higher.
PP100/200, MP100/200, MP40/50 (with ADI driver version 1.10 or lower): In Windows CE, the key states are not returned until GWES (the Graphics, Windows, and Event Subsystem) has started.
If key locking is turned off, then the key codes assigned with the key configuration are sent to the operating system when a key is pressed.
If key locking is enabled, the operating system doesn't receive the key codes. In this case, only the states of the keys can be read using the Keys and KeyMatrix variables.
Key locking can be used e.g. to lock the scan codes when the key matrix is read for testing purposes using the KeyMatrix variable and the operating system should not react to keystrokes during that time.
A panel device supports up to 128 LEDs in four layers.
For technical reasons, all B&R devices that are able to support LEDs currently report the number of LEDs as 128. This does not necessarily mean that the device actually has 128 LEDs. There may in fact be fewer or no LEDs at all present on the device. It can only be assumed that the device does not support LEDs if the number of LEDs returned is 0.
Like keys, LEDs can be operated in four different layers.
The LED layer only affects the LEDs and LedMatrix variables for the respective panel device.