Product Manuals

User Tools

Site Tools

You are here: manuals » slice » qt » api
slice:qt:api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
slice:qt:api [2023/11/30 21:29] – external edit 127.0.0.1slice:qt:api [2023/12/06 20:33] (current) – Christiana Sasser
Line 47: Line 47:
 ---- ----
 ====Firmware Version==== ====Firmware Version====
-<function=ICEfunc?0=#VERSION&1=:None;&2=1.62&3=-1>+<function=ICEfunc?0=#VERSION？&1=:None;&2=1.62&3=-1>
 Returns firmware version of System Controller 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==== ====Reset to Factory Default Settings====
Line 72: Line 73:
 ==== Query Temperature Set Point ==== ==== Query Temperature Set Point ====
  
-<function=ICEfunc?0=TempSet&1=I:CHANNEL:3&2=26.28&3=-1>+<function=ICEfunc?0=TempSet？&1=I:CHANNEL:3&2=26.28&3=-1>
 Returns the temperature set point for CHANNEL. Returns the temperature set point for CHANNEL.
 ---- ----
Line 79: Line 80:
 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. 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>+<function=ICEfunc?0=Temp？?&1=I:CHANNEL:2&2=25.398&-1>
 Returns the actual (measured) temperature for CHANNEL. Returns the actual (measured) temperature for CHANNEL.
 ---- ----
Line 85: Line 86:
 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.
 ---- ----
-<function=ICEfunc?0=TempMin?&1=I:CHANNEL:2&2=5.000&-1>+<function=ICEfunc?0=TempMin？?&1=I:CHANNEL:2&2=5.000&-1>
 Returns the minimum allowed temperature for CHANNEL. Returns the minimum allowed temperature for CHANNEL.
 ---- ----
Line 91: Line 92:
 Sets the minimum allowed temperature for CHANNEL to TEMPERATURE. Returns **TempMin?**. Sets the minimum allowed temperature for CHANNEL to TEMPERATURE. Returns **TempMin?**.
 ---- ----
-<function=ICEfunc?0=TempMax?&1=I:CHANNEL:2&2=55.000&-1>+<function=ICEfunc?0=TempMax？?&1=I:CHANNEL:2&2=55.000&-1>
 Returns the maximum allowed temperature for CHANNEL. Returns the maximum allowed temperature for CHANNEL.
 ---- ----
Line 99: Line 100:
 ===== Transducer/Load Settings ===== ===== Transducer/Load Settings =====
 ---- ----
-<function=ICEfunc?0=Bipolar?&1=I:CHANNEL:2&2=1&-1>+<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). 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.   * 1 = On = Bipolar operation, i.e., current is bi-directional through transducer.
Line 111: Line 112:
  
 ---- ----
-<function=ICEfunc?0=MaxCurr?&1=I:CHANNEL:2&2=2.000&-1>+<function=ICEfunc?0=MaxCurr？?&1=I:CHANNEL:2&2=2.000&-1>
 Returns the current limit for CHANNEL in Amps [A]. Returns the current limit for CHANNEL in Amps [A].
 ---- ----
Line 117: Line 118:
 Sets the current limit for CHANNEL to CURRENT in Amps [A]. Returns **MaxCurr?**. Allowed values are {0.000 ... 6.000}. 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>+<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]. Returns the measured current flowing through the temperature transducer (e.g. TEC or heater) in Amps [A].
 ---- ----
Line 125: Line 126:
 **************************** ****************************
 ---- ----
-<function=ICEfunc?0=MaxPwr?&1=I:CHANNEL:2&2=7.000&-1>+<function=ICEfunc?0=MaxPwr？?&1=I:CHANNEL:2&2=7.000&-1>
 Returns the power limit for CHANNEL in Watts [W]. Returns the power limit for CHANNEL in Watts [W].
 ---- ----
Line 131: Line 132:
 Sets the power limit for CHANNEL to POWER in Watts [W]. Returns **MaxPwr?**. Allowed values are {0.000 ... 20.000}. 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>+<function=ICEfunc?0=Power？?&1=I:CHANNEL:2&2=1.582&-1>
 Returns the measured power output for CHANNEL in Watts [W]. Returns the measured power output for CHANNEL in Watts [W].
 ---- ----
-<function=ICEfunc?0=CVolt?&1=I:CHANNEL:4&2=2.573&-1>+<function=ICEfunc?0=CVolt？?&1=I:CHANNEL:4&2=2.573&-1>
 Returns the voltage across the load for CHANNEL in Volts [V]. Returns the voltage across the load for CHANNEL in Volts [V].
 ---- ----
Line 140: Line 141:
 ===== Thermistor Settings ===== ===== Thermistor Settings =====
 ---- ----
-<function=ICEfunc?0=Beta?&1=I:CHANNEL:1&2=3450.0000&-1>+<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. For the B-parameter thermistor model: Returns the Beta coefficient in Kelvin [K] for CHANNEL.
 ---- ----
Line 146: Line 147:
 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: 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>+<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. For the B-parameter thermistor model: Returns the Reference Temperature in degrees Celsius [˚C] for CHANNEL.
 ---- ----
Line 152: Line 153:
 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). 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>+<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. For the B-parameter thermistor model: Returns the Reference Resistance in Ohms [Ω] (at the Reference Temperature) for CHANNEL.
 ---- ----
Line 158: Line 159:
 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?**.
 ---- ----
-<function=ICEfunc?0=TCoefA?&1=I:CHANNEL:1&2=2.108508173&-1>+<function=ICEfunc?0=TCoefA？?&1=I:CHANNEL:1&2=2.108508173&-1>
 For the Steinhart-Hart thermistor model: Returns the A coefficient for CHANNEL. For the Steinhart-Hart thermistor model: Returns the A coefficient for CHANNEL.
 ---- ----
Line 164: Line 165:
 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: 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>+<function=ICEfunc?0=TCoefB？?&1=I:CHANNEL:1&2=0.797204727&-1>
 For the Steinhart-Hart thermistor model: Returns the B coefficient for CHANNEL. For the Steinhart-Hart thermistor model: Returns the B coefficient for CHANNEL.
 ---- ----
Line 170: Line 171:
 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: 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>+<function=ICEfunc?0=TCoefC？?&1=I:CHANNEL:1&2=6.535076315&-1>
 For the Steinhart-Hart thermistor model: Returns the C coefficient for CHANNEL. For the Steinhart-Hart thermistor model: Returns the C coefficient for CHANNEL.
 ---- ----
Line 181: Line 182:
 ===== Loop Filter Settings ===== ===== Loop Filter Settings =====
 ---- ----
-<function=ICEfunc?0=Control?&1=I:CHANNEL:2&2=3&-1>+<function=ICEfunc?0=Control？?&1=I:CHANNEL:2&2=3&-1>
 Returns the control mode for CHANNEL: Returns the control mode for CHANNEL:
   * 0 = Manual Off   * 0 = Manual Off
Line 199: Line 200:
  
 ---- ----
-<function=ICEfunc?0=PGain?&1=I:CHANNEL:2&2=1.8&-1>+<function=ICEfunc?0=PGain？?&1=I:CHANNEL:2&2=1.8&-1>
 Returns the proportional gain for CHANNEL. Returns the proportional gain for CHANNEL.
 ---- ----
Line 205: Line 206:
 Sets the proportional gain for CHANNEL to GAIN. Returns **PGain?**. Sets the proportional gain for CHANNEL to GAIN. Returns **PGain?**.
 ---- ----
-<function=ICEfunc?0=PGainEn?&1=I:CHANNEL:2&2=ON&-1>+<function=ICEfunc?0=PGainEn？?&1=I:CHANNEL:2&2=ON&-1>
 Returns the On/Off STATE of the proportional gain for CHANNEL. Returns the On/Off STATE of the proportional gain for CHANNEL.
 ---- ----
Line 211: Line 212:
 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?**.
 ---- ----
-<function=ICEfunc?0=Integ?&1=I:CHANNEL:1&2=2.000&-1>+<function=ICEfunc?0=Integ？?&1=I:CHANNEL:1&2=2.000&-1>
 Returns the integral time constant for CHANNEL in seconds [s]. Returns the integral time constant for CHANNEL in seconds [s].
 ---- ----
Line 217: Line 218:
 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?**.
 ---- ----
-<function=ICEfunc?0=IntegEn?&1=I:CHANNEL:2&2=ON&-1>+<function=ICEfunc?0=IntegEn？?&1=I:CHANNEL:2&2=ON&-1>
 Returns the On/Off STATE of the integral gain for CHANNEL. Returns the On/Off STATE of the integral gain for CHANNEL.
 ---- ----
Line 223: Line 224:
 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?**.
 ---- ----
-<function=ICEfunc?0=Deriv?&1=I:CHANNEL:1&2=0.500&-1>+<function=ICEfunc?0=Deriv？?&1=I:CHANNEL:1&2=0.500&-1>
 Returns the derivative time constant for CHANNEL in seconds [s]. Returns the derivative time constant for CHANNEL in seconds [s].
 ---- ----
Line 229: Line 230:
 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?**.
 ---- ----
-<function=ICEfunc?0=DerivEn?&1=I:CHANNEL:4&2=ON&-1>+<function=ICEfunc?0=DerivEn？?&1=I:CHANNEL:4&2=ON&-1>
 Returns the On/Off STATE of the derivative gain for CHANNEL. Returns the On/Off STATE of the derivative gain for CHANNEL.
 ---- ----
Line 235: Line 236:
 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?**.
 ---- ----
-<function=ICEfunc?0=Slew?&1=I:CHANNEL:1&2=1.5&-1>+<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]. Returns the slew rate limit for CHANNEL in degrees Celsius per second [˚C/s].
 ---- ----
Line 241: Line 242:
 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?**.
 ---- ----
-<function=ICEfunc?0=SlewEn?&1=I:CHANNEL:4&2=1&-1>+<function=ICEfunc?0=SlewEn？?&1=I:CHANNEL:4&2=1&-1>
 Returns the On/Off STATE of the slew rate limiter for CHANNEL. Returns the On/Off STATE of the slew rate limiter for CHANNEL.
 ---- ----
Line 249: Line 250:
 ===== System Functions ===== ===== System Functions =====
 ---- ----
-<function=ICEfunc?0=Save&1=A:None:&2=Success&-1>+<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. Stores all current settings to the SLICE EEPROM so that they are maintained during power off.  Returns: Success or Failure.
 ---- ----
Line 261: Line 262:
  
 ---- ----
-<function=ICEfunc?0=Output1?&2=2, 3, 0.500, 0.0&-1>+<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". For the front panel Output 1, returns a comma-delimited ASCII string with the following format: "CHANNEL, FUNCTION, VALUE1, VALUE2".
 ---- ----
Line 267: Line 268:
 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?**.
 ---- ----
-<function=ICEfunc?0=Output2?&2=2, 3, 0.500, 0.0&-1>+<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". For the front panel Output 2, returns a comma-delimited ASCII string with the following format: "CHANNEL, FUNCTION, VALUE1, VALUE2".
 ---- ----
Line 285: Line 286:
  
 ---- ----
-<function=ICEfunc?0=InputA?&2=2, 3, 0.500, 0.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)". For the front panel Input A, returns a comma-delimited ASCII string with the following format: "CHANNEL, FUNCTION, VALUE1, VALUE2, VALUE3 (if applicable)".
 ---- ----
Line 291: Line 292:
 Sets the FUNCTION and CHANNEL for the front panel Input A 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?**.
 ---- ----
-<function=ICEfunc?0=InputB?&2=2, 0, 0.500, 0.0, 1&-1>+<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)". For the front panel Input B, returns a comma-delimited ASCII string with the following format: "CHANNEL, FUNCTION, VALUE1, VALUE2, VALUE3 (if applicable)".
 ---- ----
slice/qt/api.1701379740.txt.gz · Last modified: 2023/11/30 21:29 by 127.0.0.1