User Tools

Site Tools


slice:qt:api

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
slice:qt:api [2019/05/02 17:58]
Michael Radunsky [Links]
slice:qt:api [2020/05/22 16:38] (current)
Michael Radunsky [SLICE-QTC Specific Notes]
Line 1: Line 1:
-======SLICE-QT API======+======SLICE-QTC API======
  
 ====Links==== ====Links====
Line 6: Line 6:
  
 *  **Electronics** *  **Electronics**
-    * [[slice:​qt|SLICE-QT Manual]]+    * [[slice:​qt|SLICE-QTC Manual]]
     * [[slice:​qt:​firmware|SLICE-QTC firmware upgrade instructions]]     * [[slice:​qt:​firmware|SLICE-QTC firmware upgrade instructions]]
  
 *  **Websites** *  **Websites**
-    * [[https://​www.vescent.com/​products/​electronics/​slice/​slice-qt-four-channel-temperature-controller/​|SLICE-QT web page]]+    * [[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|Github page for SLICE-QTC GUI]]
     * [[https://​github.com/​Vescent/​SLICE-QT-Firmware-Upgrade|Github page for SLICE-QTC firmware revisions]]     * [[https://​github.com/​Vescent/​SLICE-QT-Firmware-Upgrade|Github page for SLICE-QTC firmware revisions]]
Line 35: Line 35:
   - [Int] refers to an integer argument that has no decimal point.   - [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.   - [Float] refers to a floating point argument that has a decimal point in its value.
-===== SLICE-QT Specific Notes =====+===== 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 enable commands use an integer argument to convey the state: 0 = Off, 1 = On.
Line 42: Line 42:
  
 ---- ----
-===== Temperature Settings ​=====+ 
 +===== Global SLICE Commands ​===== 
 +The following commands are operational on all SLICE products.
 ---- ----
 +====Firmware Version====
 +<​function=ICEfunc|0=#​VERSION&​1=:​None;&​2=1.62&​-1>​
 +Returns firmware version of System Controller.
 +----
 +====Reset to Factory Default Settings====
 +<​function=ICEfunc|0=_FACTORY&​1=I:​SLOT_NUMBER:​1;&​2=&​-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>​
 +----
 +<​function=ICEfunc|0=SAVE&​1=:​None;&​2=SUCCESS&​-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&​-1>​ <​function=ICEfunc|0=TempSet?&​1=I:​CHANNEL:​3&​2=26.28&​-1>​
 Returns the temperature set point for CHANNEL. 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>​ <​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. 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.
Line 110: Line 138:
 ---- ----
 <​function=ICEfunc|0=Beta&​1=I:​CHANNEL:​2;​F:​VALUE:​3450&​2=3450.0&​-1>​ <​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?**.+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>​
Line 116: Line 144:
 ---- ----
 <​function=ICEfunc|0=RefTemp&​1=I:​CHANNEL:​2;​F:​VALUE:​25.0&​2=25.0&​-1>​ <​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?​**.+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>​
Line 128: Line 156:
 ---- ----
 <​function=ICEfunc|0=TCoefA&​1=I:​CHANNEL:​1;​F:​VALUE:​2.108508173&​2=2.108508173&​-1>​ <​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?​**.+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>​
Line 134: Line 162:
 ---- ----
 <​function=ICEfunc|0=TCoefB&​1=I:​CHANNEL:​1;​F:​VALUE:​0.797204727&​2=0.797204727&​-1>​ <​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?​**.+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>​
Line 140: Line 168:
 ---- ----
 <​function=ICEfunc|0=TCoefC&​1=I:​CHANNEL:​1;​F:​VALUE:​6.535076315&​2=6.535076315&​-1>​ <​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?​**.+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 ===== ===== Loop Filter Settings =====
Line 208: Line 239:
 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?​**.
 ---- ----
-===== I/O Channel Settings ​(Not yet implemented 27 Feb, 2019) =====+===== 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 ​     ^ ^  Output Function ​  ​^ ​ CHANNEL ​ ^  FUNCTION ​ ^  VALUE1 ​     ^  VALUE2 ​     ^
Line 242: Line 278:
 ---- ----
 <​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>​ <​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 with the settings prescribed by VALUE1-3. Returns **InputA?​**.+Sets the FUNCTION and CHANNEL for the front panel Input 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>​
slice/qt/api.1556845090.txt.gz · Last modified: 2019/05/02 17:58 by Michael Radunsky