Product Manuals

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
======SLICE-QTC API======

====Links====
* **Quick-Start Guides**
    * [[slice:quick_start_qt|SLICE-QTC Quick Start]]

*  **Electronics**
    * [[slice:qt|SLICE-QTC Manual]]
    * [[slice:qt:firmware|SLICE-QTC firmware upgrade instructions]]

*  **Websites**
    * [[https://www.vescent.com/products/electronics/slice/slice-qt-four-channel-temperature-controller/|SLICE-QTC web page]]
    * [[https://github.com/Vescent|Github page for SLICE-QTC GUI]]
    * [[https://github.com/Vescent/SLICE-QT-Firmware-Upgrade|Github page for SLICE-QTC firmware revisions]]
=====Implementation Instructions=====

Listed below is the command set for the Application Programming Interface (API). Most operations that can be performed via the touchscreen can be also be performed via the API.

Computer communication to the SLICE instrument occurs by first establishing a Serial COM port via the USB 2.0 physical interface. Computer communication should be platform independent, though appropriate USB drivers may have to be installed. The following table shows the serial port settings:

^ Baud Rate     |  9600  |
^ Data Bits     |  8     |
^ Parity        |  None  |
^ Stop Bits     |  1     |
^ Flow Control  |  None  |


To perform an operation, an ASCII-based text message is first constructed from a command and its arguments, and then the message is transmitted to the SLICE instrument through the COM port. The following rules apply:

  - Syntax is //insensitive// to case.
  - A message is an ASCII string composed of a command followed by zero or more arguments.
  - A command and its arguments are delimited by spaces.
  - Messages are terminated by a carriage return ("\r").
  - All valid messages return an ASCII string value.
  - [Int] refers to an integer argument that has no decimal point.
  - [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}.
  - 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 currents are set and returned in Amperes [A].

----

===== Global SLICE Commands =====
The following commands are operational on all SLICE products.
----
====Firmware Version====
<function=ICEfunc?0=#VERSION？&1=:None;&2=1.62&3=-1>
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====
<function=ICEfunc?0=_FACTORY&1=I:SLOT_NUMBER:1;&2=&3=-1>
Restores "Personality Board" to factory default settings. No return value.  \\
<WRAP center round box 60%>
| {{ :take-note.png?80&nolink }}  | Power cycle the SLICE unit to complete factory reset. |
</WRAP>
----
====Save Settings====
<function=ICEfunc?0=SAVE&1=:None;&2=SUCCESS&3=-1>
Saves "Personality Board" settings into EEPROM.  Unsaved changes will be lost if board is powered off without issuing a SAVE command. The SAVE command saves the entire configuration into non-volatile memory. A single SAVE command can be issued after any number of configuration changes. When changes are made to the SLICE configuration through the touch screen, the new values are automatically saved and it is not necessary to issue a SAVE command.\\ \\
__Slot Number__\\
  * 1 = first slot
  * 2 = second slot
__Possible Responses__\\
  * SUCCESS
  * FAIL

----

===== Temperature Settings =====
==== Query Temperature Set Point ====

<function=ICEfunc?0=TempSet？&1=I:CHANNEL:3&2=26.28&3=-1>
Returns the temperature set point for CHANNEL.
----
==== Set Temperature Set Point ====
<function=ICEfunc?0=TempSet&1=I:CHANNEL:3;F:TEMPERATURE:26.283&2=26.282&-1>
Sets the temperature set point for CHANNEL to TEMPERATURE. Returns **TempSet?**. The temperature set point cannot be set outside the range set by the minimum and maximum allowed temperatures (set by the user). If TEMPERATURE is outside this range, the set point will not be adjusted. Also, the temperature set point will be coerced to a value that has a internal digital representation closest to TEMPERATURE.
----
<function=ICEfunc?0=Temp？?&1=I:CHANNEL:2&2=25.398&-1>
Returns the actual (measured) temperature for CHANNEL.
----
<function=ICEfunc?0=TError?&1=I:CHANNEL:2&2=0.0024&-1>
Returns the temperature error for CHANNEL in degrees Celsius. The error is calculated as the set point temperature minus the actual temperature.
----
<function=ICEfunc?0=TempMin？?&1=I:CHANNEL:2&2=5.000&-1>
Returns the minimum allowed temperature for CHANNEL.
----
<function=ICEfunc?0=TempMin&1=I:CHANNEL:3;F:TEMPERATURE:-5.000&2=-5.000&-1>
Sets the minimum allowed temperature for CHANNEL to TEMPERATURE. Returns **TempMin?**.
----
<function=ICEfunc?0=TempMax？?&1=I:CHANNEL:2&2=55.000&-1>
Returns the maximum allowed temperature for CHANNEL.
----
<function=ICEfunc?0=TempMax&1=I:CHANNEL:3;F:TEMPERATURE:55.000&2=55.000&-1>
Sets the maximum allowed temperature for CHANNEL to TEMPERATURE. Returns **TempMax?**.
----
===== Transducer/Load Settings =====
----
<function=ICEfunc?0=Bipolar？?&1=I:CHANNEL:2&2=1&-1>
Returns whether CHANNEL is configured for either Bipolar operation (for a thermo-electric cooler) or Unipolar operation (for a resistive heater).
  * 1 = On = Bipolar operation, i.e., current is bi-directional through transducer.
  * 0 = Off = Unipolar operation, i.e., current is uni-directional through transducer.

----
<function=ICEfunc?0=Bipolar&1=I:CHANNEL:3;I:STATE:0&2=0&-1>
Sets the operational STATE for CHANNEL to be either Bipolar (for a thermo-electric cooler) or Unipolar (for a resistive heater). Returns **Bipolar?**. STATE can have the following values:
  * 1 = On = Bipolar operation, i.e., current is bi-directional through transducer.
  * 0 = Off = Unipolar operation, i.e., current is uni-directional through transducer.

----
<function=ICEfunc?0=MaxCurr？?&1=I:CHANNEL:2&2=2.000&-1>
Returns the current limit for CHANNEL in Amps [A].
----
<function=ICEfunc?0=MaxCurr&1=I:CHANNEL:1;F:CURRENT:1.500&2=1.500&-1>
Sets the current limit for CHANNEL to CURRENT in Amps [A]. Returns **MaxCurr?**. Allowed values are {0.000 ... 6.000}.
----
<function=ICEfunc?0=Current？?&1=I:CHANNEL:2&2=0.654&-1>
Returns the measured current flowing through the temperature transducer (e.g. TEC or heater) in Amps [A].
----
****************************
<function=ICEfunc?0=Currset&1=I:CHANNEL:1;F:CURRENT:0.654&2=0.654&-1>
Sets the output current to the Channel 1 to 0.654 A
****************************
----
<function=ICEfunc?0=MaxPwr？?&1=I:CHANNEL:2&2=7.000&-1>
Returns the power limit for CHANNEL in Watts [W].
----
<function=ICEfunc?0=MaxPwr&1=I:CHANNEL:1;F:POWER:10.000&2=10.000&-1>
Sets the power limit for CHANNEL to POWER in Watts [W]. Returns **MaxPwr?**. Allowed values are {0.000 ... 20.000}.
----
<function=ICEfunc?0=Power？?&1=I:CHANNEL:2&2=1.582&-1>
Returns the measured power output for CHANNEL in Watts [W].
----
<function=ICEfunc?0=CVolt？?&1=I:CHANNEL:4&2=2.573&-1>
Returns the voltage across the load for CHANNEL in Volts [V].
----

===== Thermistor Settings =====
----
<function=ICEfunc?0=Beta？?&1=I:CHANNEL:1&2=3450.0000&-1>
For the B-parameter thermistor model: Returns the Beta coefficient in Kelvin [K] for CHANNEL.
----
<function=ICEfunc?0=Beta&1=I:CHANNEL:2;F:VALUE:3450&2=3450.0&-1>
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).
----
<function=ICEfunc?0=RefTemp？?&1=I:CHANNEL:1&2=25.0&-1>
For the B-parameter thermistor model: Returns the Reference Temperature in degrees Celsius [˚C] for CHANNEL.
----
<function=ICEfunc?0=RefTemp&1=I:CHANNEL:2;F:VALUE:25.0&2=25.0&-1>
For the B-parameter thermistor model: Sets the Reference Temperature in degrees Celsius [˚C] to VALUE for CHANNEL. Returns **RefTemp?**. When a new Reference Temperature is set, new Steinhart-Hart coefficients are calculated. Execute a TEMPLUT command after setting the Reference Temperature through the API (QC firmware versions 1.14 & lower).
----
<function=ICEfunc?0=RefRes？?&1=I:CHANNEL:1&2=10000.0&-1>
For the B-parameter thermistor model: Returns the Reference Resistance in Ohms [Ω] (at the Reference Temperature) for CHANNEL.
----
<function=ICEfunc?0=RefRes&1=I:CHANNEL:2;F:VALUE:10000.0&2=10000.0&-1>
For the B-parameter thermistor model: Sets the Reference Resistance in Ohms [Ω] to VALUE for CHANNEL. Returns **RefRes?**.
----
<function=ICEfunc?0=TCoefA？?&1=I:CHANNEL:1&2=2.108508173&-1>
For the Steinhart-Hart thermistor model: Returns the A coefficient for CHANNEL.
----
<function=ICEfunc?0=TCoefA&1=I:CHANNEL:1;F:VALUE:2.108508173&2=2.108508173&-1>
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).
----
<function=ICEfunc?0=TCoefB？?&1=I:CHANNEL:1&2=0.797204727&-1>
For the Steinhart-Hart thermistor model: Returns the B coefficient for CHANNEL.
----
<function=ICEfunc?0=TCoefB&1=I:CHANNEL:1;F:VALUE:0.797204727&2=0.797204727&-1>
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).
----
<function=ICEfunc?0=TCoefC？?&1=I:CHANNEL:1&2=6.535076315&-1>
For the Steinhart-Hart thermistor model: Returns the C coefficient for CHANNEL.
----
<function=ICEfunc?0=TCoefC&1=I:CHANNEL:1;F:VALUE:6.535076315&2=6.535076315&-1>
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).
----
<function=ICEfunc?0=TEMPLUT&1=I:CHANNEL:1&2=&-1>
Forces recalculation of T = ƒ(A,B,C) lookup table.  There is no output from this command.  Execute this command after setting any of the Steinhart-Hart coefficients, Beta-parameter, or Reference Temperature via the API (QC firmware versions 1.14 & lower).
----
===== Loop Filter Settings =====
----
<function=ICEfunc?0=Control？?&1=I:CHANNEL:2&2=3&-1>
Returns the control mode for CHANNEL:
  * 0 = Manual Off
  * 1 = Servo Off
  * 2 = Auto Tune Off
  * 3 = Manual On
  * 4 = Servo On
  * 5 = Auto Tune On

----
<function=ICEfunc?0=Control&1=I:CHANNEL:2;I:MODE:3&2=3&-1>
Sets the control MODE for CHANNEL:
  * 0 = Manual Off
  * 1 = Servo Off
  * 3 = Manual On
  * 4 = Servo On

----
<function=ICEfunc?0=PGain？?&1=I:CHANNEL:2&2=1.8&-1>
Returns the proportional gain for CHANNEL.
----
<function=ICEfunc?0=PGain&1=I:CHANNEL:3;F:GAIN:1.8&2=1.8&-1>
Sets the proportional gain for CHANNEL to GAIN. Returns **PGain?**.
----
<function=ICEfunc?0=PGainEn？?&1=I:CHANNEL:2&2=ON&-1>
Returns the On/Off STATE of the proportional gain for CHANNEL.
----
<function=ICEfunc?0=PGainEn&1=I:CHANNEL:4;I:STATE:0&2=OFF&-1>
Sets the On/Off STATE of the proportional gain for CHANNEL. Returns **PGainEn?**.
----
<function=ICEfunc?0=Integ？?&1=I:CHANNEL:1&2=2.000&-1>
Returns the integral time constant for CHANNEL in seconds [s].
----
<function=ICEfunc?0=Integ&1=I:CHANNEL:3;F:TIME_CONSTANT:2.000&2=2.000&-1>
Sets the integral time constant for CHANNEL to TIME_CONSTANT in seconds [s]. Returns **Integ?**.
----
<function=ICEfunc?0=IntegEn？?&1=I:CHANNEL:2&2=ON&-1>
Returns the On/Off STATE of the integral gain for CHANNEL.
----
<function=ICEfunc?0=IntegEn&1=I:CHANNEL:3;I:STATE:0&2=OFF&-1>
Sets the On/Off STATE of the integral gain for CHANNEL. Returns **IntegEn?**.
----
<function=ICEfunc?0=Deriv？?&1=I:CHANNEL:1&2=0.500&-1>
Returns the derivative time constant for CHANNEL in seconds [s].
----
<function=ICEfunc?0=Deriv&1=I:CHANNEL:1;F:TIME_CONSTANT:0.500&2=0.500&-1>
Sets the derivative time constant for CHANNEL to TIME_CONSTANT in seconds [s]. Returns **Deriv?**.
----
<function=ICEfunc?0=DerivEn？?&1=I:CHANNEL:4&2=ON&-1>
Returns the On/Off STATE of the derivative gain for CHANNEL.
----
<function=ICEfunc?0=DerivEn&1=I:CHANNEL:3;I:STATE:1&2=ON&-1>
Sets the On/Off STATE of the derivative gain for CHANNEL. Returns **DerivEn?**.
----
<function=ICEfunc?0=Slew？?&1=I:CHANNEL:1&2=1.5&-1>
Returns the slew rate limit for CHANNEL in degrees Celsius per second [˚C/s].
----
<function=ICEfunc?0=Slew&1=I:CHANNEL:1;F:RATE:1.5&2=1.5&-1>
Sets the slew rate limit for CHANNEL to RATE in degrees Celsius per second [˚C/s]. Returns **Slew?**.
----
<function=ICEfunc?0=SlewEn？?&1=I:CHANNEL:4&2=1&-1>
Returns the On/Off STATE of the slew rate limiter for CHANNEL.
----
<function=ICEfunc?0=SlewEn&1=I:CHANNEL:3;I:STATE:1&2=1&-1>
Sets the On/Off STATE of the slew rate limiter for CHANNEL. Returns **SlewEn?**.
----
===== System Functions =====
----
<function=ICEfunc?0=Save？&1=A:None:&2=Success&-1>
Stores all current settings to the SLICE EEPROM so that they are maintained during power off.  Returns: Success or Failure.
----
===== I/O Channel Settings =====
----
^  Output Function   ^  CHANNEL  ^  FUNCTION  ^  VALUE1      ^  VALUE2      ^
|                    |  [Int]    |  [Int]     |  [Float]     |  [Float]     |
| Temperature Error  |  1 - 4    |  0         | Gain [V/˚C]  | Offset [˚C]  |
| Temperature        |  1 - 4    |  1         | Gain [V/˚C]  | Offset [˚C]  |
| Current Output     |  1 - 4    |  2         | Gain [V/A]   | Offset [A]   |

----
<function=ICEfunc?0=Output1？?&2=2, 3, 0.500, 0.0&-1>
For the front panel Output 1, returns a comma-delimited ASCII string with the following format: "CHANNEL, FUNCTION, VALUE1, VALUE2".
----
<function=ICEfunc?0=Output1&1=I:CHANNEL:1;I:FUNCTION:2;F:VALUE1:1.0;F:VALUE2:0.0&2=1, 2, 1.0, 0.0&-1>
Sets the FUNCTION and CHANNEL for the front panel Output 1 with the settings prescribed by VALUE1 and VALUE2. Returns **Output1?**.
----
<function=ICEfunc?0=Output2？?&2=2, 3, 0.500, 0.0&-1>
For the front panel Output 2, returns a comma-delimited ASCII string with the following format: "CHANNEL, FUNCTION, VALUE1, VALUE2".
----
<function=ICEfunc?0=Output2&1=I:CHANNEL:1;I:FUNCTION:2;F:VALUE1:1.0;F:VALUE2:0.0&2=1, 2, 1.0, 0.0&-1>
Sets the FUNCTION and CHANNEL for the front panel Output 2 with the settings prescribed by VALUE1 and VALUE2. Returns **Output2?**.
----
^  Input Function       ^  CHANNEL  ^  FUNCTION  ^  VALUE1        ^  VALUE2                ^  VALUE3               ^
|                       |  [Int]    |  [Int]     |  [Float]       |  [Float]               |  [Int]               |
| Off                   |  1 - 4    |  0         | N/A            | N/A                    | N/A                  |
| External Setpoint\\ Absolute  |  1 - 4  |  1   | Gain [˚C/V]    | Offset [V]             | N/A                  |          
| External Setpoint\\ Relative  |  1 - 4  |  2   | Gain [˚C/V]    | Offset [V]             | N/A                  | 
| External Temperature\\ Input  |  1 - 4  |  3   | Gain [˚C/V]    | Offset [V              | N/A                  |
| External Error Input  |  1 - 4    |  4         | Gain [A/V]     | Offset [V]             | N/A                  |
| Feedforward           |  1 - 4    |  5         | Gain [A/V]     | Offset [V]             | N/A                  |
| Slow Servo  Input     |  1 - 4    |  6         | Integral Gain  | Set point voltage [V]  | Polarity [0/1 = +/-] |


----
<function=ICEfunc?0=InputA？?&2=2, 3, 0.500, 0.0&-1>
For the front panel Input A, returns a comma-delimited ASCII string with the following format: "CHANNEL, FUNCTION, VALUE1, VALUE2, VALUE3 (if applicable)".
----
<function=ICEfunc?0=InputA&1=I:CHANNEL:1;I:FUNCTION:0;F:VALUE1:1.0;F:VALUE2:0.0;I:VALUE3:0&2=1, 0, 1.0, 0.0, 0&-1>
Sets the FUNCTION and CHANNEL for the front panel Input A with the settings prescribed by VALUE1-3. Returns **InputA?**.
----
<function=ICEfunc?0=InputB？?&2=2, 0, 0.500, 0.0, 1&-1>
For the front panel Input B, returns a comma-delimited ASCII string with the following format: "CHANNEL, FUNCTION, VALUE1, VALUE2, VALUE3 (if applicable)".
----
<function=ICEfunc?0=InputB&1=I:CHANNEL:1;I:FUNCTION:0;F:VALUE1:1.0;F:VALUE2:0.0;I:VALUE3:1&2=1, 0, 1.0, 0.0, 1&-1>
Sets the FUNCTION and CHANNEL for the front panel Input B with the settings prescribed by VALUE1-3. Returns **InputB?**.
----
===== Error Handling =====
----