.. _BeckhoffAnalogInput:

===================
BeckhoffAnalogInput
===================

Commands
++++++++

No additional commands

Properties
++++++++++

+---------------------------+-----------------+--------------------------------------------------+--------------+-------+-------------+---------------+---------------+
|Key                        |Displayed Name   |Description                                       |Alias         |Type   |Access Level |Access Mode    |Allowed States |
+===========================+=================+==================================================+==============+=======+=============+===============+===============+
|semiRawValue               |SemiRawValue     | | Semi raw value of analog input, i.e. the       |AValueSemiRaw |Float  |OBSERVER     |READONLY       |               |
|                           |                 | | voltage.                                       |              |       |             |               |               |
+---------------------------+-----------------+--------------------------------------------------+--------------+-------+-------------+---------------+---------------+
|value                      |Value            | | Analog input of ADC.                           |AValue        |Float  |OBSERVER     |READONLY       |               |
+---------------------------+-----------------+--------------------------------------------------+--------------+-------+-------------+---------------+---------------+
|epsSemiRaw                 |Epsilon SemiRaw  | | Epsilon of the SemiRawValue.                   |AEpsSemiRaw   |Float  |USER         |RECONFIGURABLE |               |
+---------------------------+-----------------+--------------------------------------------------+--------------+-------+-------------+---------------+---------------+
|calibration.expbase        |Exp Base         | | Exp. Base valid in formula type 2.             |AExpBase      |Float  |EXPERT       |RECONFIGURABLE |               |
+---------------------------+-----------------+--------------------------------------------------+--------------+-------+-------------+---------------+---------------+
|calibration.formulaType    |Formula Type     | | Type of formula to calculate value from raw    |AFormelTyp    |UInt8  |EXPERT       |RECONFIGURABLE |               |
|                           |                 | | value (1: linear, 2: exponential, 3:           |              |       |             |               |               |
|                           |                 | | reciprocal).                                   |              |       |             |               |               |
+---------------------------+-----------------+--------------------------------------------------+--------------+-------+-------------+---------------+---------------+
|calibration.offset         |Offset           | | Linear offset for analog value.                |AOffset       |Float  |EXPERT       |RECONFIGURABLE |               |
+---------------------------+-----------------+--------------------------------------------------+--------------+-------+-------------+---------------+---------------+
|calibration.rawValue       |ADC Output       | | Digital output of ADC. This value is updated   |AValueRaw     |UInt32 |EXPERT       |READONLY       |               |
|                           |                 | | only on request!                               |              |       |             |               |               |
+---------------------------+-----------------+--------------------------------------------------+--------------+-------+-------------+---------------+---------------+
|calibration.scale          |Scale            | | Scaling factor for analog value.               |AFactor       |Float  |EXPERT       |RECONFIGURABLE |               |
+---------------------------+-----------------+--------------------------------------------------+--------------+-------+-------------+---------------+---------------+
|calibration.terminalFactor |Terminal Factor  | | Terminal factor used in calibration.           |AFactorT      |Float  |ADMIN        |READONLY       |               |
+---------------------------+-----------------+--------------------------------------------------+--------------+-------+-------------+---------------+---------------+
|calibration.terminalOffset |Terminal Offset  | | Terminal offset used in calibration.           |AOffsetT      |Float  |ADMIN        |READONLY       |               |
+---------------------------+-----------------+--------------------------------------------------+--------------+-------+-------------+---------------+---------------+
|relativeEpsilon            |Relative Epsilon | | Flag to define epsilon mode: true means        |AEpsRelAbs    |Bool   |ADMIN        |RECONFIGURABLE |               |
|                           |                 | | relative epsilon calculation, false means      |              |       |             |               |               |
|                           |                 | | absolute epsilon calculation.                  |              |       |             |               |               |
+---------------------------+-----------------+--------------------------------------------------+--------------+-------+-------------+---------------+---------------+