slice:qt:api
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
slice:qt:api [2019/02/18 18:21] – [Table] Kurt Vogel | slice:qt:api [2023/12/06 20:29] – [Query Temperature Set Point] Christiana Sasser | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ======SLICE-QT API====== | + | ======SLICE-QTC API====== |
- | [[slice:qt|SLICE-QT Manual]] | + | ====Links==== |
+ | * **Quick-Start Guides** | ||
+ | * [[slice:quick_start_qt|SLICE-QTC Quick Start]] | ||
+ | * **Electronics** | ||
+ | * [[slice: | ||
+ | * [[slice: | ||
+ | |||
+ | * **Websites** | ||
+ | * [[https:// | ||
+ | * [[https:// | ||
+ | * [[https:// | ||
=====Implementation Instructions===== | =====Implementation Instructions===== | ||
Line 19: | Line 29: | ||
- Syntax is // | - Syntax is // | ||
- | - A message is composed of a command followed by zero or more arguments. | + | - A message is an ASCII string |
- A command and its arguments are delimited by spaces. | - A command and its arguments are delimited by spaces. | ||
- Messages are terminated by a carriage return (" | - Messages are terminated by a carriage return (" | ||
- | - Arguments may be of the following types: Integer | + | - All valid messages return an ASCII string value. |
- | - All valid messages return | + | - [Int] refers to an integer argument that has no decimal point. |
- | ===== SLICE-QT Specific Notes ===== | + | - [Float] refers to a floating point argument that has a decimal point in its value. |
+ | ===== SLICE-QTC Specific Notes ===== | ||
- Valid values for the CHANNEL argument are {1, 2, 3, 4}. | - Valid values for the CHANNEL argument are {1, 2, 3, 4}. | ||
+ | - All enable commands use an integer argument to convey the state: 0 = Off, 1 = On. | ||
- All temperatures are set and returned in degrees Celsius [˚C]. | - All temperatures are set and returned in degrees Celsius [˚C]. | ||
- All currents are set and returned in Amperes [A]. | - All currents are set and returned in Amperes [A]. | ||
---- | ---- | ||
- | ===== Temperature Settings | + | |
+ | ===== Global SLICE Commands | ||
+ | The following commands are operational on all SLICE products. | ||
---- | ---- | ||
- | < | + | ====Firmware Version==== |
+ | < | ||
+ | Returns firmware version of System Controller | ||
+ | /*Note: For the Return Question mark, we had to use a slightly different question mark image. This one: ?. Rather than this one: ?. */ | ||
+ | ---- | ||
+ | ====Reset to Factory Default Settings==== | ||
+ | < | ||
+ | Restores " | ||
+ | <WRAP center round box 60%> | ||
+ | | {{ : | ||
+ | </ | ||
+ | ---- | ||
+ | ====Save Settings==== | ||
+ | < | ||
+ | Saves " | ||
+ | __Slot Number__\\ | ||
+ | * 1 = first slot | ||
+ | * 2 = second slot | ||
+ | __Possible Responses__\\ | ||
+ | * SUCCESS | ||
+ | * FAIL | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== Temperature Settings ===== | ||
+ | ==== Query Temperature Set Point ==== | ||
+ | |||
+ | < | ||
Returns the temperature set point for CHANNEL. | Returns the temperature set point for CHANNEL. | ||
---- | ---- | ||
- | < | + | ==== Set Temperature Set Point ==== |
+ | < | ||
Sets the temperature set point for CHANNEL to TEMPERATURE. Returns **TempSet? | Sets the temperature set point for CHANNEL to TEMPERATURE. Returns **TempSet? | ||
---- | ---- | ||
- | < | + | < |
Returns the actual (measured) temperature for CHANNEL. | Returns the actual (measured) temperature for CHANNEL. | ||
---- | ---- | ||
- | < | + | < |
Returns the temperature error for CHANNEL in degrees Celsius. The error is calculated as the set point temperature minus the actual temperature. | Returns the temperature error for CHANNEL in degrees Celsius. The error is calculated as the set point temperature minus the actual temperature. | ||
---- | ---- | ||
- | < | + | < |
Returns the minimum allowed temperature for CHANNEL. | Returns the minimum allowed temperature for CHANNEL. | ||
---- | ---- | ||
- | < | + | < |
Sets the minimum allowed temperature for CHANNEL to TEMPERATURE. Returns **TempMin? | Sets the minimum allowed temperature for CHANNEL to TEMPERATURE. Returns **TempMin? | ||
---- | ---- | ||
- | < | + | < |
Returns the maximum allowed temperature for CHANNEL. | Returns the maximum allowed temperature for CHANNEL. | ||
---- | ---- | ||
- | < | + | < |
Sets the maximum allowed temperature for CHANNEL to TEMPERATURE. Returns **TempMax? | Sets the maximum allowed temperature for CHANNEL to TEMPERATURE. Returns **TempMax? | ||
---- | ---- | ||
===== Transducer/ | ===== Transducer/ | ||
---- | ---- | ||
- | < | + | < |
Returns whether CHANNEL is configured for either Bipolar operation (for a thermo-electric cooler) or Unipolar operation (for a resistive heater). | Returns whether CHANNEL is configured for either Bipolar operation (for a thermo-electric cooler) or Unipolar operation (for a resistive heater). | ||
- | * On = Bipolar operation, i.e., current is bi-directional through transducer. | + | * 1 = On = Bipolar operation, i.e., current is bi-directional through transducer. |
- | * Off = Unipolar operation, i.e., current is uni-directional through transducer. | + | * 0 = Off = Unipolar operation, i.e., current is uni-directional through transducer. |
---- | ---- | ||
- | < | + | < |
Sets the operational STATE for CHANNEL to be either Bipolar (for a thermo-electric cooler) or Unipolar (for a resistive heater). Returns **Bipolar? | Sets the operational STATE for CHANNEL to be either Bipolar (for a thermo-electric cooler) or Unipolar (for a resistive heater). Returns **Bipolar? | ||
- | * On = Bipolar operation, i.e., current is bi-directional through transducer. | + | * 1 = On = Bipolar operation, i.e., current is bi-directional through transducer. |
- | * Off = Unipolar operation, i.e., current is uni-directional through transducer. | + | * 0 = Off = Unipolar operation, i.e., current is uni-directional through transducer. |
---- | ---- | ||
- | < | + | < |
Returns the current limit for CHANNEL in Amps [A]. | Returns the current limit for CHANNEL in Amps [A]. | ||
---- | ---- | ||
- | < | + | < |
Sets the current limit for CHANNEL to CURRENT in Amps [A]. Returns **MaxCurr? | Sets the current limit for CHANNEL to CURRENT in Amps [A]. Returns **MaxCurr? | ||
---- | ---- | ||
- | < | + | < |
Returns the measured current flowing through the temperature transducer (e.g. TEC or heater) in Amps [A]. | Returns the measured current flowing through the temperature transducer (e.g. TEC or heater) in Amps [A]. | ||
---- | ---- | ||
- | < | + | **************************** |
+ | < | ||
+ | Sets the output current to the Channel 1 to 0.654 A | ||
+ | **************************** | ||
+ | ---- | ||
+ | < | ||
Returns the power limit for CHANNEL in Watts [W]. | Returns the power limit for CHANNEL in Watts [W]. | ||
---- | ---- | ||
- | < | + | < |
Sets the power limit for CHANNEL to POWER in Watts [W]. Returns **MaxPwr? | Sets the power limit for CHANNEL to POWER in Watts [W]. Returns **MaxPwr? | ||
---- | ---- | ||
- | < | + | < |
Returns the measured power output for CHANNEL in Watts [W]. | Returns the measured power output for CHANNEL in Watts [W]. | ||
---- | ---- | ||
- | < | + | < |
Returns the voltage across the load for CHANNEL in Volts [V]. | Returns the voltage across the load for CHANNEL in Volts [V]. | ||
---- | ---- | ||
Line 94: | Line 141: | ||
===== Thermistor Settings ===== | ===== Thermistor Settings ===== | ||
---- | ---- | ||
- | < | + | < |
For the B-parameter thermistor model: Returns the Beta coefficient in Kelvin [K] for CHANNEL. | For the B-parameter thermistor model: Returns the Beta coefficient in Kelvin [K] for CHANNEL. | ||
---- | ---- | ||
- | < | + | < |
- | For the B-parameter thermistor model: Sets the Beta coefficient in Kelvin [K] to VALUE for CHANNEL. Returns **Beta?**. | + | For the B-parameter thermistor model: Sets the Beta coefficient in Kelvin [K] to VALUE for CHANNEL. Returns **Beta?**. When a new Beta-parameter is set, new Steinhart-Hart coefficients are calculated. Execute a TEMPLUT command after setting Beta through the API (QC firmware versions 1.14 & lower). |
---- | ---- | ||
- | < | + | < |
For the B-parameter thermistor model: Returns the Reference Temperature in degrees Celsius [˚C] for CHANNEL. | For the B-parameter thermistor model: Returns the Reference Temperature in degrees Celsius [˚C] for CHANNEL. | ||
---- | ---- | ||
- | < | + | < |
- | For the B-parameter thermistor model: Sets the Reference Temperature in degrees Celsius [˚C] to VALUE for CHANNEL. Returns **RefTemp? | + | For the B-parameter thermistor model: Sets the Reference Temperature in degrees Celsius [˚C] to VALUE for CHANNEL. Returns **RefTemp? |
---- | ---- | ||
- | < | + | < |
For the B-parameter thermistor model: Returns the Reference Resistance in Ohms [Ω] (at the Reference Temperature) for CHANNEL. | For the B-parameter thermistor model: Returns the Reference Resistance in Ohms [Ω] (at the Reference Temperature) for CHANNEL. | ||
---- | ---- | ||
- | < | + | < |
For the B-parameter thermistor model: Sets the Reference Resistance in Ohms [Ω] to VALUE for CHANNEL. Returns **RefRes? | For the B-parameter thermistor model: Sets the Reference Resistance in Ohms [Ω] to VALUE for CHANNEL. Returns **RefRes? | ||
---- | ---- | ||
- | < | + | < |
For the Steinhart-Hart thermistor model: Returns the A coefficient for CHANNEL. | For the Steinhart-Hart thermistor model: Returns the A coefficient for CHANNEL. | ||
---- | ---- | ||
- | < | + | < |
- | For the Steinhart-Hart thermistor model: Sets the A coefficient to VALUE for CHANNEL. Returns **TCoefA? | + | For the Steinhart-Hart thermistor model: Sets the A coefficient to VALUE for CHANNEL. Returns **TCoefA?**. Execute a TEMPLUT command after setting any of the Steinhart-Hart coefficients through the API (QC firmware versions 1.14 & lower). |
---- | ---- | ||
- | < | + | < |
For the Steinhart-Hart thermistor model: Returns the B coefficient for CHANNEL. | For the Steinhart-Hart thermistor model: Returns the B coefficient for CHANNEL. | ||
---- | ---- | ||
- | < | + | < |
- | For the Steinhart-Hart thermistor model: Sets the B coefficient to VALUE for CHANNEL. Returns **TCoefB? | + | For the Steinhart-Hart thermistor model: Sets the B coefficient to VALUE for CHANNEL. Returns **TCoefB?**. Execute a TEMPLUT command after setting any of the Steinhart-Hart coefficients through the API (QC firmware versions 1.14 & lower). |
---- | ---- | ||
- | < | + | < |
For the Steinhart-Hart thermistor model: Returns the C coefficient for CHANNEL. | For the Steinhart-Hart thermistor model: Returns the C coefficient for CHANNEL. | ||
---- | ---- | ||
- | < | + | < |
- | For the Steinhart-Hart thermistor model: Sets the C coefficient to VALUE for CHANNEL. Returns **TCoefC? | + | For the Steinhart-Hart thermistor model: Sets the C coefficient to VALUE for CHANNEL. Returns **TCoefC?**. Execute a TEMPLUT command after setting any of the Steinhart-Hart coefficients through the API (QC firmware versions 1.14 & lower). |
+ | ---- | ||
+ | < | ||
+ | Forces recalculation of T = ƒ(A,B,C) lookup table. | ||
---- | ---- | ||
===== Loop Filter Settings ===== | ===== Loop Filter Settings ===== | ||
---- | ---- | ||
- | < | + | < |
Returns the control mode for CHANNEL: | Returns the control mode for CHANNEL: | ||
- | * 0 = Manual | + | * 0 = Manual Off |
- | * 1 = Servo Mode Off | + | * 1 = Servo Off |
- | * 2 = Manual | + | * 2 = Auto Tune Off |
- | * 3 = Servo Mode On | + | * 3 = Manual On |
+ | * 4 = Servo On | ||
+ | * 5 = Auto Tune On | ||
---- | ---- | ||
- | < | + | < |
Sets the control MODE for CHANNEL: | Sets the control MODE for CHANNEL: | ||
- | * 0 = Manual | + | * 0 = Manual Off |
- | * 1 = Servo Mode Off | + | * 1 = Servo Off |
- | * 2 = Manual | + | * 3 = Manual On |
- | * 3 = Servo Mode On | + | * 4 = Servo On |
---- | ---- | ||
- | < | + | < |
Returns the proportional gain for CHANNEL. | Returns the proportional gain for CHANNEL. | ||
---- | ---- | ||
- | < | + | < |
Sets the proportional gain for CHANNEL to GAIN. Returns **PGain?**. | Sets the proportional gain for CHANNEL to GAIN. Returns **PGain?**. | ||
---- | ---- | ||
- | < | + | < |
Returns the On/Off STATE of the proportional gain for CHANNEL. | Returns the On/Off STATE of the proportional gain for CHANNEL. | ||
---- | ---- | ||
- | < | + | < |
Sets the On/Off STATE of the proportional gain for CHANNEL. Returns **PGainEn? | Sets the On/Off STATE of the proportional gain for CHANNEL. Returns **PGainEn? | ||
---- | ---- | ||
- | < | + | < |
Returns the integral time constant for CHANNEL in seconds [s]. | Returns the integral time constant for CHANNEL in seconds [s]. | ||
---- | ---- | ||
- | < | + | < |
Sets the integral time constant for CHANNEL to TIME_CONSTANT in seconds [s]. Returns **Integ?**. | Sets the integral time constant for CHANNEL to TIME_CONSTANT in seconds [s]. Returns **Integ?**. | ||
---- | ---- | ||
- | < | + | < |
Returns the On/Off STATE of the integral gain for CHANNEL. | Returns the On/Off STATE of the integral gain for CHANNEL. | ||
---- | ---- | ||
- | < | + | < |
Sets the On/Off STATE of the integral gain for CHANNEL. Returns **IntegEn? | Sets the On/Off STATE of the integral gain for CHANNEL. Returns **IntegEn? | ||
---- | ---- | ||
- | < | + | < |
Returns the derivative time constant for CHANNEL in seconds [s]. | Returns the derivative time constant for CHANNEL in seconds [s]. | ||
---- | ---- | ||
- | < | + | < |
Sets the derivative time constant for CHANNEL to TIME_CONSTANT in seconds [s]. Returns **Deriv?**. | Sets the derivative time constant for CHANNEL to TIME_CONSTANT in seconds [s]. Returns **Deriv?**. | ||
---- | ---- | ||
- | < | + | < |
Returns the On/Off STATE of the derivative gain for CHANNEL. | Returns the On/Off STATE of the derivative gain for CHANNEL. | ||
---- | ---- | ||
- | < | + | < |
Sets the On/Off STATE of the derivative gain for CHANNEL. Returns **DerivEn? | Sets the On/Off STATE of the derivative gain for CHANNEL. Returns **DerivEn? | ||
---- | ---- | ||
- | < | + | < |
Returns the slew rate limit for CHANNEL in degrees Celsius per second [˚C/s]. | Returns the slew rate limit for CHANNEL in degrees Celsius per second [˚C/s]. | ||
---- | ---- | ||
- | < | + | < |
Sets the slew rate limit for CHANNEL to RATE in degrees Celsius per second [˚C/s]. Returns **Slew?**. | Sets the slew rate limit for CHANNEL to RATE in degrees Celsius per second [˚C/s]. Returns **Slew?**. | ||
---- | ---- | ||
- | < | + | < |
Returns the On/Off STATE of the slew rate limiter for CHANNEL. | Returns the On/Off STATE of the slew rate limiter for CHANNEL. | ||
---- | ---- | ||
- | < | + | < |
Sets the On/Off STATE of the slew rate limiter for CHANNEL. Returns **SlewEn? | Sets the On/Off STATE of the slew rate limiter for CHANNEL. Returns **SlewEn? | ||
+ | ---- | ||
+ | ===== System Functions ===== | ||
+ | ---- | ||
+ | < | ||
+ | Stores all current settings to the SLICE EEPROM so that they are maintained during power off. Returns: Success or Failure. | ||
---- | ---- | ||
===== I/O Channel Settings ===== | ===== I/O Channel Settings ===== | ||
Line 205: | Line 262: | ||
---- | ---- | ||
- | < | + | < |
- | For the front panel Output 1, returns the channel, output function, and settings values in an output data record. | + | For the front panel Output 1, returns |
---- | ---- | ||
- | < | + | < |
Sets the FUNCTION and CHANNEL for the front panel Output 1 with the settings prescribed by VALUE1 and VALUE2. Returns **Output1? | Sets the FUNCTION and CHANNEL for the front panel Output 1 with the settings prescribed by VALUE1 and VALUE2. Returns **Output1? | ||
---- | ---- | ||
- | < | + | < |
- | For the front panel Output 2, returns the channel, output function, and settings values in an output data record. | + | For the front panel Output 2, returns |
---- | ---- | ||
- | < | + | < |
Sets the FUNCTION and CHANNEL for the front panel Output 2 with the settings prescribed by VALUE1 and VALUE2. Returns **Output2? | Sets the FUNCTION and CHANNEL for the front panel Output 2 with the settings prescribed by VALUE1 and VALUE2. Returns **Output2? | ||
---- | ---- | ||
^ Input Function | ^ Input Function | ||
- | | | + | | |
- | | Slow Servo | + | | Off | 1 - 4 | 0 |
- | | External | + | | External |
- | | External | + | | External |
- | | External | + | | External |
- | | Feedforward | + | | External Error Input | 1 - 4 | 4 | Gain [A/V] | Offset [V] |
+ | | Feedforward | ||
+ | | Slow Servo Input | ||
+ | |||
---- | ---- | ||
- | < | + | < |
- | For the front panel Input A, returns the channel, input function, and settings values in an output data record. | + | For the front panel Input A, returns |
---- | ---- | ||
- | < | + | < |
- | Sets the FUNCTION and CHANNEL for the front panel Input B with the settings prescribed by VALUE1-3. Returns **InputA? | + | Sets the FUNCTION and CHANNEL for the front panel Input A with the settings prescribed by VALUE1-3. Returns **InputA? |
---- | ---- | ||
- | < | + | < |
- | For the front panel Input B, returns the channel, input function, and settings values in an output data record. | + | For the front panel Input B, returns |
---- | ---- | ||
- | < | + | < |
Sets the FUNCTION and CHANNEL for the front panel Input B with the settings prescribed by VALUE1-3. Returns **InputB? | Sets the FUNCTION and CHANNEL for the front panel Input B with the settings prescribed by VALUE1-3. Returns **InputB? | ||
---- | ---- | ||
===== Error Handling ===== | ===== Error Handling ===== | ||
---- | ---- |
slice/qt/api.txt · Last modified: 2023/12/06 20:33 by Christiana Sasser