.. _BeckhoffPlcMonitor:

==================
BeckhoffPlcMonitor
==================

Commands
++++++++

No additional commands

Properties
++++++++++

+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|Key                      |Displayed Name             |Description                                       |Alias                    |Type   |Access Level |Access Mode    |Allowed States           |
+=========================+===========================+==================================================+=========================+=======+=============+===============+=========================+
|ABootCount               |Boot Count                 | | Boot count.                                    |ABootCount               |UInt32 |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|ACpuFrequency            |CPU Frequency              | | Frequency of the CPU.                          |ACpuFrequency            |UInt32 |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|ACurrentCpuTemperature   |Current CPU Temperature    | | Current temperature of the CPU.                |ACurrentCpuTemperature   |Int16  |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|ACurrentCpuUsage         |Current CPU Usage          | |  Current CPU usage.                            |ACurrentCpuUsage         |UInt16 |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|ADhcpServerEnabled       |DHCP Server Enabled        | | True if the DHCP-Server is enabled.            |ADhcpServerEnabled       |Bool   |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|ADhcpServerIpv4Address   |DHCP Server IPv4 Address   | | IP-Address of the DHCP-Server in dotted        |ADhcpServerIpv4Address   |String |OBSERVER     |READONLY       |                         |
|                         |                           | | notation (15 char string).                     |                         |       |             |               |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|AIpv4Address             |IPv4 Address               | | Current IPv4 Address of the PLC in dotted      |AIpv4Address             |String |OBSERVER     |READONLY       |                         |
|                         |                           | | notation (15 char string).                     |                         |       |             |               |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|AIpv4SubnetMask          |IPv4 Subnet Mask           | | IPv4 subnet mask of the PLC in dotted notation |AIpv4SubnetMask          |String |OBSERVER     |READONLY       |                         |
|                         |                           | | (15 char string).                              |                         |       |             |               |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|AMacAddess               |MAC-Address                | | MAC-Address of the PLC (17 char string).       |AMacAddess               |String |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|AMainboardType           |Mainboard Type             | | Type of the main-board.                        |AMainboardType           |String |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|AMaxBoardTemperature     |Max Board Temperature      | | Maximum temperature of the main-board.         |AMaxBoardTemperature     |Int32  |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|AMemoryDivision          |Memory Division            | | MemoryDivision. Available on Windows CE.       |AMemoryDivision          |UInt32 |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|AMinBoardTemperature     |Min Board Temperature      | | Minimum temperature of the main-board.         |AMinBoardTemperature     |Int32  |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|AOperatingTimeInMinutes  |Operating Time             | | Operating time of the main-board.              |AOperatingTimeInMinutes  |UInt32 |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|APLCCycleTime            |PLC Cycle Time             | | PLC Cycle Time                                 |APLCCycleTime            |Float  |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|APlcProjectVersion       |PLC Project Version        | | PLC Project Version                            |APlcProjectVersion       |String |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|AProductionDate          |Production Date            | | Production date of the main-board.             |AProductionDate          |String |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|AProgramMemoryAllocated  |Program Memory Allocated   | | Allocated program memory.                      |AProgramMemoryAllocated  |UInt32 |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|AProgramMemoryAllocated2 |Program Memory Allocated 2 | | Allocated program memory.                      |AProgramMemoryAllocated2 |UInt64 |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|AProgramMemoryAvailable  |Program Memory Available   | | Available program memory.                      |AProgramMemoryAvailable  |UInt32 |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|AProgramMemoryAvailable2 |Program Memory Available 2 | | Available program memory.                      |AProgramMemoryAvailable2 |UInt64 |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|AProjectGeneratorVersion |Project Generator Version  | | Project Generator Version                      |AProjectGeneratorVersion |String |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|ASerialNumber            |Serial Number              | | Serial number.                                 |ASerialNumber            |String |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|AStorageMemoryAllocated  |Storage Memory Allocated   | | Allocated storage-memory. Available on Windows |AStorageMemoryAllocated  |UInt32 |OBSERVER     |READONLY       |                         |
|                         |                           | | CE.                                            |                         |       |             |               |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|AStorageMemoryAvailable  |Storage Memory Available   | | Available storage-memory. Available on Windows |AStorageMemoryAvailable  |UInt32 |OBSERVER     |READONLY       |                         |
|                         |                           | | CE.                                            |                         |       |             |               |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|ATCPBufferSize           |TCP Buffer Size            | | TCP/IP buffer size.                            |ATCPBufferSize           |UInt32 |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|ATCPInputBufLvlMax       |TCP Input Buf Lvl Max      | | TCP Input Buf Lvl Max                          |ATCPInputBufLvlMax       |Float  |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|ATCPInputDataRate        |TCP Input Data Rate        | | TCP Input Data Rate                            |ATCPInputDataRate        |Float  |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|ATCPOutputBufLvlMax      |TCP Output Buf Lvl Max     | | TCP Output Buf Lvl Max                         |ATCPOutputBufLvlMax      |Float  |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|ATCPOutputDataRate       |TCP Output Data Rate       | | TCP Output Data Rate                           |ATCPOutputDataRate       |Float  |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|MainboardTemperature     |Main-board Temperature     | | Current temperature of the main-board.         |AMainboardTemperature    |Int16  |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|MaxInputVoltage          |Max Input Voltage          | | Maximum input voltage of the main-board.       |AMaxInputVoltage         |Int32  |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|MinInputVoltage          |Min Input Voltage          | | Minimum input voltage of the main-board.       |AMinInputVoltage         |Int32  |OBSERVER     |READONLY       |                         |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|ABeamModes               |Beam Modes                 | | Beam Modes                                     |ABeamModes               |UInt32 |USER         |RECONFIGURABLE |NORMAL, INTERLOCK_BROKEN |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+
|ATrainID                 |Train ID                   | | Train ID                                       |ATrainID                 |UInt32 |USER         |RECONFIGURABLE |NORMAL, INTERLOCK_BROKEN |
+-------------------------+---------------------------+--------------------------------------------------+-------------------------+-------+-------------+---------------+-------------------------+