This document describes the interface between the downloadable DSP code and the detector host software that observers and engineers use to control the detector. "Detector host" refers to the Unix computer directly connected to the "detector controller" (a leach controller). The "detector controller" runs the "DSP code" and the "detector host software" is a Unix C program such as DetI or detcom.Previous incarnations of detector host software relied on setup files to give hardcoded addresses in DSP code for things like exposure time and option bits. The New Way uses only symbol names taken by the detector host software directly from an unstripped DSP "lod" file. If a particular symbol does not exist the detector host software will either decide that the feature is not supported, or will fail if the feature is a required one.
Commands listed here should not be confused with the commands entered at the detector host. While many may be similar (such as the DSP command `RDM' and the detector host command `rdmem'), this document is only concerned with the commands that the detector host is sending to the detector controller, and not with the command set available to the user.
| Section | Board | Cmd | Args | Response | When Used | Required? | Description |
|---|---|---|---|---|---|---|---|
| DSP Memory Operations | lub/ltb | WRM | addr data | DON/ERR | Download Pre-exp | Required. | Set memory at addr to data |
| lub/ltb | RDM | addr | data | Download Pre-exp Post-exp | Get memory at addr | ||
| lub/ltb | RM2 | addr | (data & 0xFF0000) >>16, (data & 0x00FFFF) | Download Pre-exp Post-exp | Required if using "fpbox" fiber/parallel converter. | Get 24-bit memory at addr as 2 16-bit words | |
| Detector Power Control | lub | PON | (none) | DON/ERR | Initialization | Required. | Turn on +/-16.5, +36V, etc. at lub |
| lub | POF | (none) | DON/ERR | Engineering/ Shutdown | Recommended. | Turn off +/-16.5, +36V, etc. at lub | |
| lub | PTS | (none) | DON/ERR | Pre-exp | Recommended, or incorporate into CLR/RDC commands. | Power test to check PON before clearing | |
| Detector Cleaning | ltb | CLR | (none) | DON/ERR | Pre-exp | If missing, no "etype FOCUS" and no "clean" command and assumes "SEX" always does CLR automatically. | Clean ccds and wait for finish |
| ltb | CLN | (none) | DON/ERR | Pre-exp | Hack for master/slave mode. | Clean ccds, but return immediately | |
| Exposure Sequencing | lubM | SEX | (none) | EIP... wait... DON or ERRor EIP...ERR | Exposure | Required by "etype OBJECT, DARK, FLAT, COMP" | Start exposure (See also addr TGT_TIM) Normally returns EIP at start (Exposure In Progress) and DON at end of exposure time. |
| lubM | STE | (none) | DON | Exposure | Recommended (If missing, stop is ignored.) | Stop exposure (usually followed by readout) | |
| lubM | AEX | (none) | DON | Exp/readout | Recommended (If missing, abort is ignored.) | Abort exposure or readout | |
| Readout | ltb | RDC | (none) | Pixels or ERR | Readout | Required. | Start flow of pixels (See NSR,NPR,etc.) |
| ACE/Shutter | lubM | OSH | (none) | DON/ERR | Engineering | Recommended. | For manual "shutter open" |
| lubM | CSH | (none) | DON/ERR | Engineering | Recommended. | For manual "shutter close" | |
| lubM | RCK | (none) | DON/ERR | Focus sequences | If missing, assumes shutter recocks automatically. | Host controlled "shutter recock" | |
| lubM | ARS | (none) | DON/ERR | Error recovery | If missing, "shutter reset" command ignored. | Used with RRS in "shutter reset" | |
| lubM | RRS | (none) | DON/ERR | Error recovery | Sent 1 second after ARS in "shutter reset" | ||
| Section | Board | Symbol | typ | rw | When Used | Required? | Description |
|---|---|---|---|---|---|---|---|
| ID Numbers | lub/ltb | DSPID_V | N | D | Download | If these missing, re-download is required if problems with DSP occur or detector host software is restarted. | Unique DSP code identification |
| lub/ltb | DSPID | A | R | Download | Address where DSPID_V appears after download | ||
| lub/ltb | SERNO_V | N | D | Download | DSP code compilation serial number | ||
| lub/ltb | SERNO | A | R | Download | Address where SERNO_V appears after download | ||
| Option Bits | lub | OPTIONS | A | W | Pre-exp | Required for OPT_SH and/or OPT_LED | Utility board option bits |
| lub | OPT_SH | NB | D | Pre-exp | If missing, no "etype DARK" | In lub OPTIONS, selects shutter operation | |
| lub | OPT_LED | NB | D | Pre-exp | If missing, no "etype LED" | In lub OPTIONS, selects LED on during exposure | |
| ltb | OPTIONS | A | W | Pre-exp | Required for TSTPAT and CNTPAT | Timing board option bits | |
| ltb | TSTPAT | NB | D | Pre-exp | If missing, no "etype TSTPAT" | In ltb OPTIONS, select incrementing test pattn | |
| ltb | CNTPAT | NB | D | Pre-exp | If missing, no "etype CNTPAT" | In ltb OPTIONS, select counter test pattn | |
| Exposure and Shutter Timing | lubM | TGT_MIN | N | D | Download | If missing, defaults are 0.1 seconds to 4 hours with 0.1 second increments. | Sets minimum supported etime in milliseconds |
| lubM | TGT_MAX | N | D | Download | Sets maximum supported etime in milliseconds | ||
| lubM | TGT_STP | N | D | Download | Sets step size for exposure time in milliseconds | ||
| lubM | TGT_H0 | A | R | Post-exp | If missing, H0/H1 FITS headers omitted | Stores time in milliseconds of ??? | |
| lubM | TGT_H1 | A | R | Post-exp | Stores time in milliseconds of ??? | ||
| lubM | TGT_TIM | A | W/ R | W:Pre-exp R:Post-exp | Required. | Set etime in milliseconds before exposure. At end of exposure, value is read back for actual measure time. | |
| Mosaic geom, Rasters and Binning | ltbM | NCTL | N | D | Download | If missing, must be hardcoded in host software | Number of controllers, including this one (the master) |
| ltbM | NAMP | N | D | Download | If missing, must be hardcoded in host software | Number of amplifier readouts per controller | |
| ltb | NXPX | N | D | Download | Required. | Number of pixels along x-axis in full detector readout (not including overscan) | |
| ltb | NYPX | N | D | Download | Number of pixels along y-axis in full detector readout (not including overscan) | ||
| ltb | NXOV | N | D | Download | Number of overscan pixels along x-axis | ||
| ltb | NYOV | N | D | Download | Number of overscan pixels along y-axis | ||
| ltb | NSR | A | W | Pre-exp | If missing, raster command disabled. | Number of columns to read, not including overscan (pixels per line) | |
| ltb | NPR | A | W | Pre-exp | Number of lines to read, not including overscan lines | ||
| ltb | NPSKIP | A | W | Pre-exp | Number of lines to skip before read | ||
| ltb | NSSKIP | A | W | Pre-exp | Number of columns to skip before read | ||
| ltb | NSSKIP2 | A | W | Pre-exp | Number of columns to skip after read | ||
| ltb | NSOVR | A | W | Pre-exp | Number of columns of overscan to read | ||
| ltb | NPOVR | A | W | Pre-exp | Number of lines of overscan to read | ||
| ltb | NSBIN | A | W | Pre-exp | If missing, raster won't do binning factors. | Column binning parameter (serial) | |
| ltb | NPBIN | A | W | Pre-exp | Line binning parameter (parallel) | ||
| Detector Power Control | lub | T_HV | A | R | Status | If missing, no high voltage feedback. | Scaled target voltages for +36 +15 and -15. |
| lub | T_P15 | A | R | Status | |||
| lub | T_M15 | A | R | Status | |||
| lub | K_HV | A | R | Status | Scaled tolerance values for +36 +15 and -15. | ||
| lub | K_P15 | A | R | Status | |||
| lub | K_M15 | A | R | Status | |||
| lub | I_HV | A | R | Status | Scaled initial (PON) values for +36 +15 and -15. | ||
| lub | I_P15 | A | R | Status | |||
| lub | I_M15 | A | R | Status | |||
| lub | C_HV | A | R | Status | Scaled current voltages for +36 +15 -15 and +5. | ||
| lub | C_P15 | A | R | Status | |||
| lub | C_M15 | A | R | Status | |||
| lub | C_P5 | A | R | Status | |||
| Detector Temperature | lubM | A_CCDT | A | R | Status | If missing, no detector temperature is calculated | Raw detector temperature value (used to calculate DETTEM) |
| lubM | DETTEM_C1 | N | D | Status | If missing, built-in defaults are used. | Constants for temperature formula: DETTEM = DETTEM_C1/1000 + DETTEM_C2/1000 * A_CCDT | |
| lubM | DETTEM_C2 | N | D | Status | |||
| lubM | DETTEM_MIN | N | D | Status | If missing, built-in defaults are used. | Sets DETTEM range = DETTEM_MIN/1000 .. DETTEM_MAX/1000 | |
| lubM | DETTEM_MAX | N | D | Status | |||
| CFH12K ACE Only | lubM | DIG_IN | A | R | Pre-exp | If missing, no shutter command or shutter status. | Shutter state bits. |
| lubM | ACE_SVS | A | R | Pre-exp | |||
| lubS | DIG_IN | A | R | Pre-exp | If missing, no filter wheel control. | Filter wheel status bits. | |