.. _BeckhoffEncoder:

===============
BeckhoffEncoder
===============

Commands
++++++++

No additional commands

Properties
++++++++++

+--------------------+------------------------+--------------------------------------------------+---------------+-------+-------------+---------------+---------------------+
|Key                 |Displayed Name          |Description                                       |Alias          |Type   |Access Level |Access Mode    |Allowed States       |
+====================+========================+==================================================+===============+=======+=============+===============+=====================+
|adcValue            |ADC Value               | | The integer value read out by the encoder      |AValueRaw      |UInt32 |OBSERVER     |READONLY       |                     |
+--------------------+------------------------+--------------------------------------------------+---------------+-------+-------------+---------------+---------------------+
|value               |Value                   | | Encoder read value                             |AValue         |Float  |OBSERVER     |READONLY       |                     |
+--------------------+------------------------+--------------------------------------------------+---------------+-------+-------------+---------------+---------------------+
|enableLatchExternal |enable External Latch   | | Enables the storage of the value of the scale  |AEnLatchExt    |Bool   |EXPERT       |RECONFIGURABLE |ON, INTERLOCK_BROKEN |
|                    |                        | | latched to the external reference              |               |       |             |               |                     |
+--------------------+------------------------+--------------------------------------------------+---------------+-------+-------------+---------------+---------------------+
|enableLatchInternal |enable Internal Latch   | | Enables the storage of the value of the scale  |AEnLatchC      |Bool   |EXPERT       |RECONFIGURABLE |ON, INTERLOCK_BROKEN |
|                    |                        | | latched to the internal reference              |               |       |             |               |                     |
+--------------------+------------------------+--------------------------------------------------+---------------+-------+-------------+---------------+---------------------+
|factor              |Factor                  | | Calibration factor to target unit              |AFactor        |Float  |EXPERT       |RECONFIGURABLE |                     |
+--------------------+------------------------+--------------------------------------------------+---------------+-------+-------------+---------------+---------------------+
|offset              |Offset                  | | Linear offset for analog value.                |AOffset        |Float  |EXPERT       |RECONFIGURABLE |                     |
+--------------------+------------------------+--------------------------------------------------+---------------+-------+-------------+---------------+---------------------+
|setCounter16        |Set Enc. value (16 bit) | | Set value for 16 bit encoder.                  |ASetCounter16  |UInt16 |EXPERT       |RECONFIGURABLE |                     |
+--------------------+------------------------+--------------------------------------------------+---------------+-------+-------------+---------------+---------------------+
|setCounter32        |Set Enc. value (32 bit) | | Set value for 32 bit encoder.                  |ASetCounter32  |UInt32 |EXPERT       |RECONFIGURABLE |                     |
+--------------------+------------------------+--------------------------------------------------+---------------+-------+-------------+---------------+---------------------+
|ssiCoding           |SSI Coding              | | Binary coding or grey coding. False - Binary;  |ASSICoding     |Bool   |EXPERT       |RECONFIGURABLE |                     |
|                    |                        | | True - Grey                                    |               |       |             |               |                     |
+--------------------+------------------------+--------------------------------------------------+---------------+-------+-------------+---------------+---------------------+
|ssiDataLength       |SSI Data length         | | Not documented.                                |ASSIDataLength |UInt16 |EXPERT       |RECONFIGURABLE |                     |
+--------------------+------------------------+--------------------------------------------------+---------------+-------+-------------+---------------+---------------------+
|ssiFrameSize        |SSI FrameSize           | | Not documented.                                |ASSIFrameSize  |UInt16 |EXPERT       |RECONFIGURABLE |                     |
+--------------------+------------------------+--------------------------------------------------+---------------+-------+-------------+---------------+---------------------+
|ssiFrameType        |SSI FrameType           | | Length of the SSI data frame.                  |ASSIFrameType  |UInt8  |EXPERT       |RECONFIGURABLE |                     |
+--------------------+------------------------+--------------------------------------------------+---------------+-------+-------------+---------------+---------------------+