Table of Contents:
Page Status
Date | Initials | Change |
---|---|---|
June 23, 2021 | SG | Engineering modes updated, and device set up parameters (and mode settings) spreadsheet now included. |
Relevant Devices
Description | Qty | Source | Part Number | IP Address Link |
---|---|---|---|---|
Green CCD Cold Head | 1 | Instec | mK2000 | |
Red CCD Cold Head | 1 | Instec | mK2000 | |
Green LN2 Pump | 1 | Instec | LN2-SYS | N/A |
Red LN2 Pump | 1 | Instec | LN2-SYS | N/A |
Relevant Functional Block Diagram
Software Actions
Action | Notes | |
---|---|---|
1 | Read telemetry (Green) | Continuously running |
2 | Read telemetry (Red) | |
3 | Operational Mode: Cold (Green) | Operational mode of CCD temperature maintained at cold temperature set point. |
4 | Operational Mode: Cold (Red) | |
5 | Engineering Mode: Warm (Idle) (Green) | Engineering mode for idle case of warm CCD under no temperature control. |
6 | Engineering Mode: Warm (Idle) (Red) | |
7 | Engineering Mode: Cool Down (Green) | Engineering and maintenance only. Controlled ramp of cold head temperature from warm to cold. |
8 | Engineering Mode: Cool Down (Red) | |
9 | Engineering Mode: Warm Up (Green) | Engineering and maintenance only. Controlled ramp of cold head temperature from cold to warm. |
10 | Engineering Mode: Warm Up (Red) | |
11 | Engineering Mode: Set PID (Green) | Engineering and maintenance only. Uploads a PID parameter table to the device. |
12 | Engineering Mode: Set PID (Red) |
Operational Modes
Link to Instec tab within KPF Operational and Engineering Modes Spreadsheet
Required Adjustable Settings
Setting | When Needed | Notes | ||
---|---|---|---|---|
Green Channel Instec | ||||
Build | Observing | Maintenance | ||
Green PID Parameters | YES | NO | MAYBE | Instec app can save PID parameters to a .csv file. Likely convenient to use same format. Used with this command: TEMP:SPID Verified with this command: TEMP:GPID |
Green Heating/cooling status | YES | NO | MAYBE | Values: 0=Heating Only, 1=Heating and Cooling, 2=Cooling Only Change between different modes with TEMP:CHSW command. |
Green Cold Temperature Set Point | YES | NO | MAYBE | Temperature in degrees C. Used for the following commands: TEMP:HOLD TEMP:RAMP |
Green Warm Temperature Set Point | YES | NO | MAYBE | Temperature in degrees C. Used for the following commands: TEMP:HOLD TEMP:RAMP |
Green Cool-down Rate | YES | NO | MAYBE | Temperature change rate of degrees C per minute. Note this value is positive-only and the mK2000 infers the direction based on current and desired temperature. Used for the RAMP command: TEMP:RAMP |
Green Warm-up Rate | YES | NO | MAYBE | Temperature change rate of degrees C per minute Note this value is positive-only and the mK2000 infers the direction based on current and desired temperature. Used for the RAMP command: TEMP:RAMP |
Green Power Percentage Value | YES | NO | MAYBE | Power setting in percent. NOTE: the power percentage value on the Instec screen is in percent. However, power values passed through software are ratios. i.e., to set power to 5% the command would be: TEMP:RPP 0.05 and a following query TEMP:POW? would return 0.050. Screen would say 5%. Suggest using ‘units’ of percent for this variable to match display screen; and have software convert it to a ratio behind the scenes for commanding the Instec. |
Red Channel Instec | ||||
Build | Observing | Maintenance | ||
Red PID Parameters | YES | NO | MAYBE | See notes above for Green counterpart. |
Red Heating/cooling status | YES | NO | MAYBE | See notes above for Green counterpart. |
Red Cold Temperature Set Point | YES | NO | MAYBE | Temperature in degrees C. See notes above for Green counterpart. |
Red Warm Temperature Set Point | YES | NO | MAYBE | Temperature in degrees C. See notes above for Green counterpart. |
Red Cool-down Rate | YES | NO | MAYBE | Temperature change rate of degrees C per minute. See notes above for Green counterpart. |
Red Warm-up Rate | YES | NO | MAYBE | Temperature change rate of degrees C per minute See notes above for Green counterpart. |
Red Power Percentage Value | YES | NO | MAYBE | Power setting in percent. See notes above for Green counterpart. |
Device Set-up Parameters
Annotated command list with KPF settings. Covers device start-up and also settings for the various modes.
Required Telemetry
Parameter | Report Frequency | Purpose | Notes | |
---|---|---|---|---|
1 | Green Channel Instec | |||
2 | Device Serial Number? | At startup | Include in log just in case device is swapped out in future | *IDN? (third field of reply) |
3 | Device Rev Number | At startup | Include in log just in case device is swapped out in future | *IDN? (fourth field of reply) |
4 | Cold Head Temperature Value | 1 Hz TBC | Monitor CCD temperature | TEMP:CTEM? |
5 | Heating/cooling enabled status | On change? TBC | Current mode; outputs are: 0=Heating only, 1=Heating&Cooling; 2=Cooling only. | TEMP:CHSW? |
6 | System status | On change? TBC | Current status; outputs are: 0=Stop, 1=Hold Run, 2=Ramp Run, 3=Pause, 4=Profile Run, 5=PP Run, 6=Purge | TEMP:STAT? |
7 | Temperature set point | On change? TBC | Temperature in deg C. | TEMP:SPO? |
8 | Power value | 1 Hz TBC | Power value | TEMP:POW? |
9 | Rate value | On change? TBC | Rate value (for ramp mode) | TEMP:RAT? |
10 | Red Channel Instec | |||
11 | Device Serial Number? | At startup | Include in log just in case device is swapped out in future | *IDN? (third field of reply) |
12 | Device Rev Number | At startup | Include in log just in case device is swapped out in future | *IDN? (fourth field of reply) |
13 | Cold Head Temperature Value | 1 Hz TBC | Monitor CCD temperature | TEMP:CTEM? |
14 | Heating/cooling enabled status | On change? TBC | Current mode; outputs are: 0=Heating only, 1=Heating&Cooling; 2=Cooling only. | TEMP:CHSW? |
15 | System status | On change? TBC | Current status; outputs are: 0=Stop, 1=Hold Run, 2=Ramp Run, 3=Pause, 4=Profile Run, 5=PP Run, 6=Purge | TEMP:STAT? |
16 | Temperature set point | On change? TBC | Temperature in deg C. | TEMP:SPO? |
17 | Power value | 1 Hz TBC | Power value | TEMP:POW? |
18 | Rate value | On change? TBC | Rate value (for ramp mode) | TEMP:RAT? |
Required Alarms
Parameter | Threshold | Notes | |
---|---|---|---|
1 | Cold Head Temperature Value Low (Green) | TBC | |
2 | Cold Head Temperature Value High (Green) | TBC | |
3 | Cold Head Temperature Value Low (Red) | TBC | |
4 | Cold Head Temperature Value High (Red) | TBC |
Relevant Datasheets & Manuals
Description | File | Source | |
---|---|---|---|
1 | mK2000 User Manual | email from Instec | |
2 | mK2000 Command Reference | email from Instec | |
3 | LN2-SYS Pump Manual | email from Instec |
Relevant Software
Description | File | Source | |
---|---|---|---|
1 | Instec said: “While we do have sample code for Python, it is based on a USB connection, not Ethernet. Our documentation on Ethernet programming is limited because it isn’t very frequently used for custom applications. This ZIP file contains example code for python using a USB connection. It could serve as the basis for an ethernet version.” | email from Instec | |
2 | Ethernet communication setup from Instec. Mainly describes how to write code to find Instec devices on a network. Note PacketSender image within, which shows correct port to use for ethernet communication. | email from Instec | |
3 | PacketSender connection example | Screengrab of SG’s successful connection to device through PacketSender. Note port is 50292. | |
4 | Instec App for Windows | email from Instec | |
5 | Steve’s python code that uploads a PID table from a .csv file (in Instec format) to the device over USB. Example PID tables also included (one with actual values, and one with integers that was useful for testing code). | Code: PID files: | Steve’s test of parsing and uploading Instec .csv file |
6 | Calibration table decoder ring |
| email from Instec |
7 | Calibration file example. Filename structure is: “cold_head_SN & mK2000B_SN cal.clb” |
Dispatcher Implementation
Keyword | Value | Type |
---|---|---|
CTEM | 25.0 - current temperature | Double - read only |
TEMPSET | -95.0 - temperature set point If the STAT value is Hold or Ramp, changes the temperature set point and issues a new Hold or Ramp command at the new temperature. | Double |
CHSW | 0 - Heating Only 1 - Both 2 - Cooling Only This determines which PID loop is used. See the manual for details | Enumerated list |
RATE | 1.000 Value of the change in temperature in time as said by the device. This value is used by the Ramp command. | Double - deg / min |
POW | 0.01 Power output on a scale of 0 to 1. | Double - read only |
POWPCT | 1 Power output on a scale of 0 to 100% | Double - read only |
STAT | 0 - Stop 1 - Hold Run 2 - Ramp Run State of the controller. Changing the value uses the appropriate TEMPSET and RATE keywords to send a new command to the controller. | Enumerated |
LCK | 0 - Locked 1 - Unlocked If Locked, no write commands will be accepted at the dispatcher level. To command the device it must be Unlocked. | Enumerated |
INSTALLPATH | The location of the file that will be installed if the TRANSFER install command is run. A csv file with the a header that contains: type,index,T,P,I,D Where type is the mode the table will be used in, index is the temperature index, T defines the temperature range, and P, I and D are the usual PID control loop parameters. | String - must contain full path, but can be relative |
GETPATH | The location where a file will be written if the current PID table is downloaded from the controller. Output of a TRANSFER Get command. In the format listed for the INSTALLPATH keyword. | String - must contain full path but can be relative |
TRANSFER_MSG | Contains error message related to transfer of files containing PID parameters. | String - read only |
TRANSFER | Commands transfers to and from the device. 0 - Ready - a command can be sent to transfer a file 1 - Get - get the tables and put in OUTPUTFILE 2 - Install - install the file containing the tables in INPUTFILE | Enumerated |
SERIAL |
| String - read only |
REV | String - read only | |
DISP#XXXX | The usual dispatcher keywords | Strings and read only except when an int and read only. Set by configuration file. |
DISP#STOP | Stop the dispatcher. 0 - run 1 - stop | Boolean keyword |
Configuration File
Configuration | Value | Explanation |
---|---|---|
dispnum | 1 | Dispatcher number |
address | 192.168.23.145 | IP address of the Instec |
port | 50292 | Port number of the Instec |
model | MK2000B | model of the Instec, used to find the serial number |
poll_time | 10 | how often in seconds the various values are queried |
calfile | @RELDIR@/data/@KTLSERVICE@/KCPE2006054_KSE48Sm22001147_cal.clb | calibration file for the controller, on connection the table is read in and then compared with the values in the Instec controller |
0 Comments