.. _BeckhoffTrainTrigger:

====================
BeckhoffTrainTrigger
====================

Commands
++++++++

+-------------+---------------+---------------------+---------------+-------------+---------------+
|Key          |Displayed Name |Description          |Alias          |Access Level |Allowed States |
+=============+===============+=====================+===============+=============+===============+
|clearBuffer  |Clear Buffer   | | Deletes all       |CClearBuffer   |USER         |               |
|             |               | | entries of buffer |               |             |               |
+-------------+---------------+---------------------+---------------+-------------+---------------+

Properties
++++++++++

+-------------------+------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|Key                |Displayed Name          |Description                                       |Alias                |Type   |Access Level |Access Mode    |Allowed States |
+===================+========================+==================================================+=====================+=======+=============+===============+===============+
|bufferCapacity     |Buffer Capacity         | | The capacity of the internal buffer storing    |ABufferCapacity      |UInt32 |EXPERT       |READONLY       |               |
|                   |                        | | the trainIDs of the softdevice (the number of  |                     |       |             |               |               |
|                   |                        | | trainIDs that fit into the buffer)             |                     |       |             |               |               |
+-------------------+------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|bufferLevel        |Buffer Level            | | Number of trainID's currently stored in the    |ABufferLevel         |UInt32 |EXPERT       |READONLY       |               |
|                   |                        | | internal buffer                                |                     |       |             |               |               |
+-------------------+------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|trainIdToAppend    |Append TrainId          | | Takes a trainID and appends it at the end      |AWriteTrainId        |UInt32 |USER         |RECONFIGURABLE |               |
|                   |                        | | of the internal buffer                         |                     |       |             |               |               |
+-------------------+------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|operationMode      |Operation Mode          | | Defines the mode of softdevice operation       |AOpMode              |String |USER         |RECONFIGURABLE |               |
+-------------------+------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|triggerDelay       |Trigger Delay           | | Delay in milliseconds until the actual         |ATriggerDelay        |UInt32 |USER         |RECONFIGURABLE |               |
|                   |                        | | trigger will be set after it trips.            |                     |       |             |               |               |
|                   |                        | | Can be used in buffer mode and modulo mode     |                     |       |             |               |               |
+-------------------+------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|triggerDuration    |Trigger Duration        | | the time in milliseconds the triggers          |ATriggerDuration     |UInt32 |USER         |RECONFIGURABLE |               |
|                   |                        | | stays on after tripping                        |                     |       |             |               |               |
+-------------------+------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|moduloDivisor      |Modulo Divisor          | | The divisor of the modulo operation            |AModuloDivisor       |UInt32 |USER         |RECONFIGURABLE |               |
|                   |                        | | in modulo mode                                 |                     |       |             |               |               |
+-------------------+------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|moduloRemainder    |Modulo Remainder        | | The remainder of the modulo operation in modulo|AModuloRemainder     |UInt32 |USER         |RECONFIGURABLE |               |
|                   |                        | | mode. The action occurs when the remainder of  |                     |       |             |               |               |
|                   |                        | | 'AModuloDivisor' is equal to 'AModuloRemainder'|                     |       |             |               |               |
+-------------------+------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+