.. _BeckhoffAgilentIonPump: ====================== BeckhoffAgilentIonPump ====================== Commands ++++++++ +------+---------------+--------------------------------------------------+------+-------------+---------------+ |Key |Displayed Name |Description |Alias |Access Level |Allowed States | +======+===============+==================================================+======+=============+===============+ |hvOff |hvOff | | Turn the pump module OFF. This is done either |COff |EXPERT | | | | | | via serial command or digital output depending | | | | | | | | on the firmware configuration. No channel | | | | | | | | selection required as configured in the | | | | | | | | firmware. | | | | +------+---------------+--------------------------------------------------+------+-------------+---------------+ |hvOn |hvOn | | Turn the pump module ON. This is done either |COn |EXPERT | | | | | | via serial command or digital output depending | | | | | | | | on the firmware configuration. No channel | | | | | | | | selection required as configured in the | | | | | | | | firmware. | | | | +------+---------------+--------------------------------------------------+------+-------------+---------------+ Properties ++++++++++ +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |Key |Displayed Name |Description |Alias |Type |Access Level |Access Mode |Allowed States | +=============================+===========================+==================================================+===================+=======+=============+===============+===============+ |controller.interlockStatus |Interlock status | | Interlock status of the controller. |AInterlockStatus0 |String |OBSERVER |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |controller.setPointStatus |Setpoint status | | Setpoint status of the controller. |ASetpointStatus0 |String |OBSERVER |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |currentCh1 |Current Ch.1 | | Current for channel 1. |ACurrent1 |Float |OBSERVER |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |currentCh2 |Current Ch.2 | | Current for channel 2. |ACurrent2 |Float |OBSERVER |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |currentCh3 |Current Ch.3 | | Current for channel 3. |ACurrent3 |Float |OBSERVER |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |currentCh4 |Current Ch.4 | | Current for channel 4. |ACurrent4 |Float |OBSERVER |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |currentSerial |Current | | Current for the selected channel. | |Float |OBSERVER |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |isSwitchedOn |isSwitchedOn | | Boolean indicating if the high voltage was | |Bool |OBSERVER |READONLY | | | | | | switched ON/OFF (valueBit 12) with the slot | | | | | | | | | | calls hvOn and hvOff. | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |onSetpoint |On Setpoint | | Boolean indicating if the pump has reached the | |Bool |OBSERVER |READONLY | | | | | | setpoint. | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |pressure |Analog pressure | | Pressure read out from analog input. NOT |AAnalogPressure |Float |OBSERVER |READONLY | | | | | | available in slim mode. | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |pressureCh1 |Pressure Ch.1 | | Pressure for channel 1. This is a serial |APressure1 |Float |OBSERVER |READONLY | | | | | | readout. | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |pressureCh2 |Pressure Ch.2 | | Pressure for channel 2. This is a serial |APressure2 |Float |OBSERVER |READONLY | | | | | | readout. | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |pressureCh3 |Pressure Ch.3 | | Pressure for channel 3. This is a serial |APressure3 |Float |OBSERVER |READONLY | | | | | | readout. | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |pressureCh4 |Pressure Ch.4 | | Pressure for channel 4. This is a serial |APressure4 |Float |OBSERVER |READONLY | | | | | | readout. | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |pressureSerial |Pressure (serial) | | Presssure of the selected channel; this is a | |Float |OBSERVER |READONLY | | | | | | serial readout. | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |slimInterface |Slim Interface | | True: Slim interface with setpoint DI only. | |Bool |OBSERVER |READONLY | | | | | | False: Full interface as in IO struct. | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |voltage |Analog voltage | | Voltage read out from analog input. NOT |AAnalogVoltage |Float |OBSERVER |READONLY | | | | | | available in slim mode. | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |voltageCh1 |Voltage Ch.1 | | Voltage for channel 1. |AVoltage1 |Int16 |OBSERVER |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |voltageCh2 |Voltage Ch.2 | | Voltage for channel 2. |AVoltage2 |Int16 |OBSERVER |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |voltageCh3 |Voltage Ch.3 | | Voltage for channel 3. |AVoltage3 |Int16 |OBSERVER |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |voltageCh4 |Voltage Ch.4 | | Voltage for channel 4. |AVoltage4 |Int16 |OBSERVER |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |voltageSerial |Voltage (serial) | | Voltage for the selected channel; this is a | |Int16 |OBSERVER |READONLY | | | | | | serial Property | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |channelSelection |Channel Controller | | Channel on the controller for the pump. | |Int16 |EXPERT |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |controller.baudRate |Baudrate | | Baudrate: 1-4 => 1200-2400-4200-9600. This is a|ABaudrateHW0 |Int16 |EXPERT |RECONFIGURABLE | | | | | | controller only property. | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |controller.command |Serial Command | | Send serial protocol command. |ASerial |String |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |controller.controlMode |Control Mode | | Set the control mode. 0: Serial, 1: Remote, 2: |AControlMode0 |Int16 |EXPERT |RECONFIGURABLE | | | | | | Local. This is a controller only property. | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |controller.errorCode |Error code | | Error code from the serial interface (hex). |AErrorcodeHW0 |Int16 |EXPERT |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |controller.errorString |Hardware error description | | The actual translated error state of the | |String |EXPERT |READONLY | | | | | | hardware. This is a serial property. | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |controller.fixedStep |Fixed step | | Fixed step setting of the controller. |AFixedStep0 |String |EXPERT |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |controller.hwStatus |Status | | Hardware status of the controller. |AStatusHW0 |Int16 |EXPERT |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |controller.measurementUnit |Measurement unit | | Measurement unit of the controller. |AMeasurementUnit0 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |controller.modelNo |Model no. | | Model Number |AModelNo0 |String |EXPERT |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |controller.operatingMode |Operating Mode | | Set the operating mode of the controller. |AOperatingMode0 |String |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |controller.operatingModeRead |Operating mode dummy | | Operating mode: 0000000000 auto OFF; 0000000001|AOperatingMode0 |String |EXPERT |READONLY | | | | | | auto ON. This is serial read only property. | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |controller.protectMode |Protect mode | | Protect mode of the controller. |AProtectMode0 |String |EXPERT |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |controller.serialNo |Serial No. | | Serial number of the controller. |ASerialNo0 |String |EXPERT |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |controller.tempFan |Temperature at fan | | Temperature measured at fan. |ATemperatureAtFan0 |Int16 |EXPERT |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |deviceInSlot |Device in Slot (serial) | | Device in the selected channel; this is a | |Int16 |EXPERT |RECONFIGURABLE | | | | | | serial Property | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |deviceInSlot1 |Device in slot 1 | | Device in slot 1. |ADeviceInSlot1 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |deviceInSlot2 |Device in slot 2 | | Device in slot 2. |ADeviceInSlot2 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |deviceInSlot3 |Device in slot 3 | | Device in slot 3. |ADeviceInSlot3 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |deviceInSlot4 |Device in slot 4 | | Device in slot 4. |ADeviceInSlot4 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |highVoltageOn |HighVoltage On | | Turn on high voltage of the selected channel; | |Bool |EXPERT |RECONFIGURABLE | | | | | | this is a serial Property | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |highVoltageOn1 |HighVoltage 1 On | | Turn on high voltage of channel 1. |AHighVoltageOn1 |Bool |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |highVoltageOn2 |HighVoltage 2 On | | Turn on high voltage of channel 2. |AHighVoltageOn2 |Bool |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |highVoltageOn3 |HighVoltage 3 On | | Turn on high voltage of channel 3. |AHighVoltageOn3 |Bool |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |highVoltageOn4 |HighVoltage 4 On | | Turn on high voltage of channel 4. |AHighVoltageOn4 |Bool |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |maximumPower |Max. Power | | Maximum power for the selected channel; this is| |Int16 |EXPERT |RECONFIGURABLE | | | | | | a serial Property | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |maximumPower1 |Max. Power Ch.1 | | Maximum power for channel 1 |AMaximumPower1 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |maximumPower2 |Max. Power Ch.2 | | Maximum power for Channel 2 |AMaximumPower2 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |maximumPower3 |Max. Power Ch.3 | | Maximum power for Channel 3 |AMaximumPower3 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |maximumPower4 |Max. Power Ch.4 | | Maximum power for Channel 4 |AMaximumPower4 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |protectCurrent |Protect current | | Protect current for the selected channel; this | |Int16 |EXPERT |RECONFIGURABLE | | | | | | is a serial Property | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |protectCurrent1 |Protect current Ch.1 | | Protect current for channel 1. |AProtectCurrent1 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |protectCurrent2 |Protect current Ch.2 | | Protect current for channel 2. |AProtectCurrent2 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |protectCurrent3 |Protect current Ch.3 | | Protect current for channel 3. |AProtectCurrent3 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |protectCurrent4 |Protect current Ch.4 | | Protect current for channel 4. |AProtectCurrent4 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |setPoint |Setpoint | | Setpoint for the selected channel; this is a | |Float |EXPERT |RECONFIGURABLE | | | | | | serial Property | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |setPoint1 |Setpoint Ch.1 | | Setpoint for channel 1. |ASetpoint1 |Float |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |setPoint2 |Setpoint Ch.2 | | Setpoint for channel 2. |ASetpoint2 |Float |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |setPoint3 |Setpoint Ch.3 | | Set Point for channel 3. |ASetpoint3 |Float |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |setPoint4 |Setpoint Ch.4 | | Setpoint for channel 4. |ASetpoint4 |Float |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |targetVoltage |Target Voltage | | Target Voltage for the selected channel; this | |Int16 |EXPERT |RECONFIGURABLE | | | | | | is a serial Property | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |targetVoltage1 |Target Voltage Ch.1 | | Target Voltage Channel 1 |ATargetVoltage1 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |targetVoltage2 |Target Voltage Ch.2 | | Target voltage for channel 2 |ATargetVoltage2 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |targetVoltage3 |Target Voltage Ch.3 | | Target voltage for channel 3 |ATargetVoltage3 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |targetVoltage4 |Target Voltage Ch.4 | | Target voltage for channel 4. |ATargetVoltage4 |Int16 |EXPERT |RECONFIGURABLE | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |temperatureHV |Temperature HV | | Temperature for HV end for the selected | |Int16 |EXPERT |READONLY | | | | | | channel; this is a serial Property | | | | | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |temperatureHV1 |Temperature HV Ch.1 | | Temperature HV for channel 1. |ATemperatureHV1 |Int16 |EXPERT |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |temperatureHV2 |Temperature HV Ch.2 | | Temperature HV for channel 2. |ATemperatureHV2 |Int16 |EXPERT |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |temperatureHV3 |Temperature HV Ch.3 | | Temperature HV for channel 3. |ATemperatureHV3 |Int16 |EXPERT |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+ |temperatureHV4 |Temperature HV Ch.4 | | Temperature HV for channel 4. |ATemperatureHV4 |Int16 |EXPERT |READONLY | | +-----------------------------+---------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+