.. _BeckhoffPeltier:

===============
BeckhoffPeltier
===============

Commands
++++++++

No additional commands

Properties
++++++++++

+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|Key                    |Displayed Name             |Description                                       |Alias             |Type   |Access Level |Access Mode    |Allowed States |
+=======================+===========================+==================================================+==================+=======+=============+===============+===============+
|current1               |Current Ctrl. 1            | | Current for controller 1.                      |ACurrent1         |Float  |OPERATOR     |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|current2               |Current Ctrl. 2            | | Current for controller 2.                      |ACurrent2         |Float  |OPERATOR     |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|eepromError            |EEPROM Error State         | | Device is in an EEPROM error state             |                  |Bool   |OPERATOR     |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|info                   |Information                | |                                                |AInfo             |String |OPERATOR     |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|isCtrl1TempAtSetPoint  |Ctrl. 1 Temp at Setpoint   | | Temperature of Controller 1 is at setpoint     |                  |Bool   |OPERATOR     |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|isCtrl1TempOutOfBounds |Ctrl. 1 Temp out of Bounds | | Temperature of Controller 1 is out of bounds   |                  |Bool   |OPERATOR     |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|isCtrl2TempAtSetPoint  |Ctrl2 Temp at Setpoint     | | Temperature of Controller 2 is at setpoint     |                  |Bool   |OPERATOR     |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|isCtrl2TempOutOfBounds |Ctrl2 Temp out of Bounds   | | Temperature of Controller 2 is out of bounds   |                  |Bool   |OPERATOR     |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|pidKd1                 |pidKd1                     | |                                                |APID_Kd1          |Float  |OPERATOR     |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|pidKd2                 |pidKd2                     | |                                                |APID_Kd2          |Float  |OPERATOR     |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|pidKi1                 |pidKi1                     | |                                                |APID_Ki1          |Float  |OPERATOR     |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|pidKi2                 |pidKi2                     | |                                                |APID_Ki2          |Float  |OPERATOR     |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|pidKp1                 |pidKp1                     | |                                                |APID_Kp1          |Float  |OPERATOR     |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|pidKp2                 |pidKp2                     | |                                                |APID_Kp2          |Float  |OPERATOR     |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|runController1         |Run Ctrl. 1                | | Runs or stops the controller 1.                |ARun1             |Bool   |OPERATOR     |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|runController2         |Run Ctrl. 2                | | Runs or stops the controller 2.                |ARun2             |Bool   |OPERATOR     |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|supplyVoltage          |Supply Voltage             | |                                                |ASupplyVoltage    |Float  |OPERATOR     |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|temp1                  |Temperature Ctrl. 1        | | Temperature for controller 1.                  |ATemp1            |Float  |OPERATOR     |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|temp2                  |Temperature Ctrl. 2        | | Temperature for controller 2.                  |ATemp2            |Float  |OPERATOR     |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|tempDuration1          |Temp Duration Ctrl. 1      | | Temperature duration for controller 1.         |ATempDuration1    |UInt32 |OPERATOR     |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|tempDuration2          |Temp Duration Ctrl. 2      | | Temperature duration for controller 2.         |ATempDuration2    |UInt32 |OPERATOR     |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|tempMax1               |Max Temp Ctrl. 1           | | Maximum temperature for controller 1.          |ATempMax1         |Float  |OPERATOR     |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|tempMax2               |Max Temp Ctrl. 2           | | Maximum temperature for controller 2.          |ATempMax2         |Float  |OPERATOR     |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|tempMin1               |Min Temp Ctrl. 1           | | Minimum temperature for controller 1.          |ATempMin1         |Float  |OPERATOR     |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|tempMin2               |Min Temp Ctrl. 2           | | Minimum temperature for controller 2.          |ATempMin2         |Float  |OPERATOR     |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|temperatureSetPoint1   |Ctrl. 1 Temp Setpoint      | | Desired temperature setpoint for the controller|APID_SP1          |Float  |OPERATOR     |RECONFIGURABLE |               |
|                       |                           | | 1                                              |                  |       |             |               |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|temperatureSetPoint2   |Ctrl. 2 Temp Setpoint      | | Desired temperature setpoint for the controller|APID_SP2          |Float  |OPERATOR     |RECONFIGURABLE |               |
|                       |                           | | 2                                              |                  |       |             |               |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|voltage1               |Voltage Ctrl. 1            | | Voltage for controller 1.                      |AVoltage1         |Float  |OPERATOR     |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|voltage2               |Voltage Ctrl. 2            | | Voltage for controller 2.                      |AVoltage2         |Float  |OPERATOR     |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|voltageMax1            |Max Voltage Ctrl. 1        | | Maximum voltage for controller 1.              |AVoltageMax1      |Float  |OPERATOR     |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|voltageMax2            |Max Voltage Ctrl. 2        | | Maximum voltage for controller 2.              |AVoltageMax2      |Float  |OPERATOR     |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|dataFrame              |Data Frame                 | |                                                |ADataFrame        |Int8   |EXPERT       |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|enableXOnXOffRx        |Enable XOn/XOff Rx         | | Enable XOn/XOff supported Rx data              |AEnableXOnXOffRx  |Bool   |EXPERT       |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|enableXOnXOffTx        |Enable XOn/XOff Tx         | | Enable XOn/XOff supported Rx data              |AEnableXOnXOffTx  |Bool   |EXPERT       |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|halfDuplex             |Half-Duplex                | | Enable half-duplex communication.              |AHalfDuplex       |Bool   |EXPERT       |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|rxBufferFull           |Buffer Full                | | Buffer Full Notification.                      |ARxBufferFull     |UInt16 |EXPERT       |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|sendFIFODataCont       |sendFIFODataCont           | |                                                |ASendFIFODataCont |Int8   |EXPERT       |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|transferRateOpt        |Enable Transfer Rate Opt.  | | Enable transfer rate optimization              |ATransferRateOpt  |Bool   |EXPERT       |READONLY       |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|deviceID               |Device ID                  | |                                                |ADeviceID         |UInt16 |ADMIN        |RECONFIGURABLE |               |
+-----------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+