MTC variable objects

A MTC variable object represents an object in the MTC. The connection name of the variable object corresponds to the name of the MTC variable. The MTC line supports predefined variable names. These are not case sensitive.

The data format of the variable object is given by the MTC line and cannot be influenced by the user.

Connection description syntax:

Single and array variables:

/RO=<variable_name>

<variable_name>

Element of an array variable:

/RO=<variable_name>[<index>]

<variable_name>[<index>]

If the variable name is defined as the /RO parameter, the connection description must always be specified in quotation marks ("...") in the object description.

Connection description examples:

CD="/RO=MkeyLedMatrix"
CD=MkeyLedMatrix[12]

Predefined Variable Names:

The MTC line supports the following MTC variables:

Note: The "C" column specifies whether the variable returns a constant value. The "DA" column indicates whether the variable is being accessed using Direct Access Mode, resulting in a shorter access times (on IPC5000C/5600C only).

Variable name	Data format	I/O	C	DA	Description
BatteryState	VT=boolean	R			Status of the CMOS battery in the IPC: 0 = Normal 1 = Empty, broken, or not present
CpuAlarm	VT=boolean	R		v	CPU over-temperature alarm: 0 = Normal, 1 = Alarm On an IPC5000C/5600C, this value is formed from the "CpuAlarmIntern", "CpuAlarmSocket", and "CpuAlarmFan" variables.
CpuAlarmFan 3)	VT=boolean	R		v	CPU fan alarm (fan not running): 0 = Normal, 1 = Alarm
CpuAlarmIntern 3)	VT=boolean	R		v	Internal CPU over-temperature alarm: 0 = Normal, 1 = Alarm
CpuAlarmSocket 3)	VT=boolean	R		v	CPU socket over-temperature alarm: 0 = Normal, 1 = Alarm
CpuTemperature	VT=u8	R		v	Current CPU temperature in degrees Celsius (positive values only). This value corresponds to the "CpuTemperatureSocket" variable on an IPC5000C/5600C.
CpuTemperatureIntern 3)	VT=u8	R		v	Current internal CPU temperature in degrees Celsius (positive values only).
CpuTemperatureSocket 3)	VT=u8	R		v	Current CPU socket area temperature in degrees Celsius (positive values only).
DriverVersion	VT=string VL=80	R	v		Version of the MTC driver. Example: "MTC Driver 1.11 1998-09-25" This string is also returned with the MTC DLL version for the device object and access type VERSION.
FpdAlarm	VT=boolean	R			Display over-temperature alarm: 0 = Normal, 1 = Alarm
FpdBrightness	VT=u8	W			Brightness setting for the display unit in percent: 0 to 100 This variable is initialized by the MTC line with FpdDefaultBrightness.
FpdContrast	VT=u8	W			Contrast setting for the display unit in percent: 0 to 100 This variable is initialized by the MTC line with FpdDefaultContrast.
FpdDefaultBrightness	VT=u8	R/W			Default value for the display unit's brightness (background lighting) given in percent: 0 to 100
FpdDefaultContrast	VT=u8	R/W			Default value for the display unit's contrast given in percent: 0 to 100
FpdMkeyLedRegisters	VT=u8	R	v	v	Number of registers for display unit key LEDs: 0 to 16
FpdMkeyRegisters	VT=u8	R	v	v	Number of registers for display unit keys: 0 to 16
FpdName	VT=string VL=9	R	v		Name of the display unit.
FpdNumber	VT=u16	R	v		ID of the display unit: 0 = no display connected, other values are display-dependent
FpdOperatingHours	VT=u16	R			Number of operating hours for the display unit.
FpdOverTempHours	VT=u16	R			Number of over-temperature operating hours for the display unit.
FpdPowerOnCycles	VT=u16	R			Number of power-ons for the display unit.
FpdTemperature	VT=u8	R		v	Current display unit temperature in degrees Celsius (positive values only).
HardwareDefines	VT=u8	R	v		Reserved for B&R.
IoAlarm	VT=boolean	R		v	Over-temperature alarm in the in the I/O area of the IPC: 0 = Normal, 1 = Alarm
IoTemperature	VT=u8	R		v	Current temperature in the I/O area of the IPC in degrees Celsius (positive values only).
IpcFanHours	VT=u16	R			Number of operating hours for the fan.
IpcFanRpm 3)	VT=u16 VN=2	R		v	Number of IPC fan revolutions per minute.
IpcOperatingHours	VT=u16	R			Number of operating hours for the IPC.
IpcOverTempHours	VT=u16	R			Number of over-temperature operating hours for the IPC.
IpcPowerOnCycles	VT=u16	R			Number of power-ons for the IPC. "Resets" are also counted.
IpcVersion	VT=string VL=80	R	v		IPC version Example: "IPC5000C B&R Industrial Automation GmbH V1.14"
IpcVoltage12 3)	VT=f32	R		v	12 V IPC voltage in volts.
IpcVoltage2_5 3)	VT=f32	R		v	2.5V IPC voltage in volts.
IpcVoltage3_3 3)	VT=f32	R		v	3.3 V IPC voltage in volts.
IpcVoltage5 3)	VT=f32	R		v	5 V IPC voltage in volts.
IpcVoltageBattery 3)	VT=f32	R		v	IPC battery voltage in volts.
IpcVoltageCore 3)	VT=f32	R		v	IPC core voltage in volts.
IpcMkeyLedRegisters	VT=u8	R	v		Number of registers for IPC key LEDs: 0 to 16
IpcMkeyRegisters	VT=u8	R	v		Number of registers for IPC keys: 0 to 16
Jumpers	VT=u8 VN=2	R			Reserved for B&R.
KeySwitches 2)	VT=u8	R		v	State of the key switches. 1 bit per contact: 0 = Closed 1 = Opened Only those bits can be evaluated for which a key switch has also been defined. The state of all other bits is undefined and can therefore be either 0 or 1. A key switch can also occupy several bits.
KeySwitchesOffset 2)	VT=u8	R			Offset of the key switches: 0 to 127
MkeyLedMatrix 2)	VT=u8 VN=32	W			State of the key LEDs in the current key level in "packed" form: byte 0, bit 0+1 = 1st LED byte 0, bit 2+3 = 2nd LED ... byte 1, bit 0+1 = 5th LED ... 2 bits per LED: 00 = off 01 = normal blinking 10 = fast blinking 11 = on
MkeyLeds	VT=u8 VN=128	R/W			State of key LEDs for the current key level. 1 element per LED: 0 = off 1 = normal blinking 2 = fast blinking 3 = on Only the individual elements (LEDs) of the array can be addressed, not the entire array.
MkeyLevel	VT=u8	R/W			Number of key levels: 0 to 3 Key levels have an effect on the "MkeyLeds", "MkeyLedMatrix", "Mkeys", and "MkeyMatrix" variables. If a key level is set to value other than 0, then the MkeyLevelMode variable must be set to 1 (toggle) or 2 (one-shot)!
MkeyLevelMode	VT=u8	R/W		v	Key level operating mode: 0 = default 1 = toggle 2 = one-shot Shift keys for key levels can be defined with the B&R Key Editor.
MkeyMatrix 1)	VT=u8 VN=16	R		v	State of the keys in the current key level in "packed" form: byte 0, bit 0 = 1st key byte 0, bit 1 = 2nd key Etc. byte 1, bit 0 = 9th key ... 1 bit per key: 0 = Pressed, 1 = Not pressed Pressing keys for just a very short time may not be detected.
Mkeys 1)	VT=boolean VN=128	R		v	State of the keys in the current key level. 1 element per key: 0 = Pressed, 1 = Not pressed Pressing keys for just a very short time may not be detected.
MtcVersion	VT=string VL=80	R	v		MTC version Example: "MTC BIOS 1.1 00-04-04"
ScanCodesStateRam	VT=boolean	R			State of scan codes in RAM for the current key level: 0 = Undefined, 1 = OK
ScanCodesStateRom	VT=boolean	R		v	State of scan codes in ROM for the current key level: 0 = Undefined, 1 = OK
UserLed 2)	VT=boolean	R/W			State of the user LED (one of the status LEDs) on the IPC: 0 = Off, 1 = On
Watchdog 2)	VT=u8	W			Variable for acknowledging the watchdog. The watchdog is reset when this variable is written to (regardless of the value). Before this variable is "removed" with PviUnlink or PviDelete, the watchdog must be disabled by writing 0 to the WatchdogTime variable!
WatchdogTime 2)	VT=u32	W			Watchdog timeout in ms: 0 = Off, 1 - 1310700 If the timeout expires without the Watchdog variable having been defined, then the IPC resets. Windows requires the system to be shut down properly. This doesn't happen if a reset occurs. This can lead to data loss which can leave the system or application "paralyzed".

1)	Key can codes must be defined (see the "ScanCodesStatesRom" variable).
2)	Requires MTC version 00.10 or higher.
3)	Only supported on the IPC5000C/5600C.

Access time

Reading and writing variables may take a relatively long time (depending on MTC communication) if an IPC5000C or IPC5600C is not being used. These devices support MTC communication using a FIFO buffer and Direct Access Mode.

If an IPC5000 (or older IPC5000C/5600C without FIFO) is used, MTC communication can be "sped up" in the following way: The "PollingRate" parameter for the MTC driver must be set to a higher value (e.g. 10) in the registry (see also the "Provit MTC Utilities User's Manual").

If many variables should be read, then short refresh rates (RF) for these variables should be specified which can react quickly to data changes (e.g. keys). All other variables should be read with high refresh rates.

Key level operating modes

A key level is only active in "Default" mode as long as the corresponding level key is pressed. The level key must be pressed together with the desired key (corresponds to the function of a SHIFT key).

In "Toggle" mode, a key level can be turned on or off using the level key defined. That means each time this key is pressed, the level is toggled between level 0 and the respective level.

In "One-Shot" mode, pressing the level key only has an effect on the key pressed immediately afterwards. Once the action is complete, it switches back to level 0.

Keys

Reading several keys can be done more effectively by reading the entire key array. For this, only one access to the MTC driver has to be made for all keys. However, the PVI application itself then has to evaluate the necessary keys (= array elements for the Mkeys variable or bits for the MkeyMatrix variable).

Only the current key states are provided by MTC 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 MTC driver, the MTC line, and the PVI application. The MTC 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!

Key switch

Key switches can be defined with the B&R Key Editor.

Operating hours

Operating hours are only updated every full hour. In other words, if a power failure occurs after 55 minutes, then the value of the counter is not raised by an hour.

Temperature Alarms

When an alarm occurs, the temperature LED lights up on the IPC or the display unit (if connected).

Temperature values which trigger an alarm are described in the "Provit 5000 User's Manual".

Temperature alarms depend on the display unit being used.

Contrast and brightness

Values for contrast and brightness are not absolute values. Instead, they are relative to the technically allowed minimum and maximum values. Contrast and brightness settings are lost when the device is switched off.

Contrast and brightness must be set together depending on the MTC interface. For this reason, writing to FpdContrast or FpdBrightness always sends the values of both variables to the MTC. If a variable has not been set by the user, then the corresponding default value is sent in its place.

Default values for contrast and brightness are permanently saved and are not lost when the device is turned off.

Contrast can only be set for LCD displays.

Default values are only set by the display unit when the system is restarted and "FPD Contrast" and "FPD Brightness" are set to "AUTO" under "Additional Peripherals" in BIOS.

Register

A register has a width of 8 bits = 8 LEDs or keys. The number of registers specifies the max. number of possible LEDs or keys which may exist. The actual existing amount depends on the connected keypad modules or the display unit being used.