Tamarisk® Software ICD A B L E O F O N T E N T S Table of Contents ........................i Acronyms and Abbreviations ....................ii Reference Documentation ..................... iii Safety Instructions ......................... iv Notifications: Caution, Warning and Note .................. iv Scope ..........................
Tamarisk® Software ICD C R O N Y M S A N D B B R E V I A T I O N S Abbreviation Description Abbreviation Description °C Celsius millimeter °F Fahrenheit milliseconds automatic gain control Most Significant Bit bad pixel replacement Maximum Transfer Unit circuit card assembly...
Tamarisk® Software ICD E F E R E N C E O C U M E N T A T I O N The following documents form part of this specification. In the event of a conflict between documents referenced herein and the contents of this specification, the contents of this specification shall be considered a superseding requirement.
When a notification is present, it is important that the user review and understand all statements related to the notification before proceeding. If questions arise, please contact your authorized dealler or DRS Technologies. Notifications are preceeded by a symbol and followed by highlighted text.
® Tamarisk Software ICD C O P E This document describes the serial protocols and command interface for systems employing the ® ® Tamarisk Software Architecture. The Tamarisk Software Architecture is a design for an infrared thermal imaging core that uses an un-cooled focal plane array (UFPA). 1.1 SYSTEMS OVERVIEW ®...
® Tamarisk Software ICD E S S A G E O R M A T E N E R A L The serial protocol allows the user to control and monitor status of the thermal imaging module. Every message transmitted or received over the serial interface uses the same message format. The message contains the following components: 1.
® Tamarisk Software ICD 2.1 CHECKSUM COMPUTATION Every message has an appended 8-bit checksum. The checksum is computed using all bytes in the message from the start character to the last data byte. ℎ = �� −() � 256 =1 Note that summing the negative byte values must be performed using 2’s-complement math, which is common on most processors.
® Tamarisk Software ICD Note that the bit-wise AND operation ensures the checksum length remains 1 byte. 2.2 COMMAND MESSAGE FORMAT All commands originate from the connected device and are sent to the thermal imaging module (TIM). The TIM does not originate commands but it may send occasional text messages. All commands conform to the general message format.
Page 11
® Tamarisk Software ICD Data filed includes16-bit command ID of the serial Acknowledgement (ACK) 0x02 command that is being acknowledged Data filed includes 16-bit command ID of the serial Not acknowledged (NAK) 0x03 command that is being unacknowledged Data filed include 16-bit command ID of the serial Error (ERR) 0x04 command that is in error...
Page 12
® Tamarisk Software ICD of the command and a second generated upon completion of the command. The ACK message contains the ID of the command being acknowledged. Table 5 –ACK Response Format Byte Value/Type Description 0x01 Start of message. 0x02 ACK Response ID.
® Tamarisk Software ICD Table 8– ERR String Response Format Byte Value/Type Description 0x01 Start of message. 0x04 ERR Response ID. Number of text bytes to follow. 4 to ASCII text string that contains error message. Null termination ASCII chars (N+3) not required.
® Tamarisk Software ICD 1. If the command causes flash memory to be erased or programmed, the command can take somewhat longer before generating an ACK. The time is dependent on a number of factors: ♦ The number of flash sectors being erased or programmed. More sectors will require more time.
Page 15
® Tamarisk Software ICD Figure 1 - Download command sequence 2.6.1 Download from Thermal Imaging Module (TIM) to Connected Unit (CU) A download from the TIM is initiated by the CU with the “Data Transfer Download Setup” message (0x73). This messages has five, 16-bit parameters (10 bytes total). The parameters identify the device;...
Page 16
® Tamarisk Software ICD Response Format: Table 12 – Data Transfer Download Setup Response Format Byte Value Description 0x01 Start of message. 0x02 ACK response. 0x02 Parameters length. 4, 5 0x0073 Data Transfer Download Setup Command ID. Checksum Frame check sequence. 2.6.1.2 Data Transfer Download Packet –...
Page 17
® Tamarisk Software ICD Table 14 – Data Transfer Download Retry Command Format Byte Value Description 0x01 Start of message. 0x46 Data Transfer Download Packet Command ID. 0x02 Parameters length. 4, 5 unsigned integer Packet number of expected packet. Checksum Frame check sequence.
Page 18
® Tamarisk Software ICD 0x00 Parameters length. Checksum Frame check sequence. Response Format: Table 17 – Data Transfer Abort Response Format Byte Value Description 0x01 Start of message. 0x02 ACK response 0x02 Parameters length. 4, 5 0x0043 Data Transfer Abort command ID. Checksum Frame check sequence.
® Tamarisk Software ICD Item Length (in bytes) Conversion from raw bytes Detector Part Number Part Number = string(data[94:113]) Detector Serial Number Serial Number = string(data[114:133]) 2.7 CAMERA DATA UPLOAD ® If the Tamarisk camera is integrated in a system there may be occasions an embedded firmware or embedded hardware programs could require an update.
Page 20
® Tamarisk Software ICD historically been 244 bytes. The packet number is a zero-based, integer count packets. It is used to detect missing packets and to initiate retries. At any time, the TIM may send a “Data Transfer Upload Packet” (0x72) message to the CU to control the flow of packets or to indicate an error condition.
Page 21
® Tamarisk Software ICD 0x74 Data Transfer Upload Setup Command ID. 0x06 Parameters length. 4, 5 0x0000 Always 0. 6, 7 0x0000 Always 0. 7, 8 Unsigned Integer Response ID. See table below. checksum Frame check sequence. Table 21 – Data Transfer Upload Setup Response ID Response ID Description Success, Setup accepted.
Page 22
® Tamarisk Software ICD Response Format: Table 23 – Data Transfer Upload Packet Response Format Byte Value Description 0x01 Start of message. 0x72 Data Transfer Upload Setup Command ID. 0x06 Parameters length. 4, 5 unsigned integer Response ID. See table below. 6, 7 unsigned integer Packet number.
As an example, below are the version strings for ® Tamarisk 1. System Name – “System: Tamarisk-320” 2. CPU Software Version String – This is the version number of the current software release. Example format: “CPU Version: X1.P1.01.01.04” 3. Company Name – “DRS Technologies”...
Page 24
“System: Tamarisk-320” “Rel: X1.P1.01.06.06” 4 to Zero-terminated 9Hz Enabled” “ (N+3) text string “DRS Technologies” “FPA: U3600” “X1 Core Lib Rel: 00.00.00” “RTL Rel: 01.00.0066” (N+4) checksum Frame check sequence. Table 28 – System Version Get ACK Response Format Byte...
Page 25
® Tamarisk Software ICD Byte Value Description 0x02 ACK Response 0x02 Parameters length. 4, 5 0x0007 System Version Get Command ID. checksum Frame check sequence. 3.1.2 Customer Non-Volatile Read Command – 0xCA Camera RTL Rel version 01.00.0080 or newer is required together with compatible CPU(Rel) version.
Page 26
® Tamarisk Software ICD Description: Allows a customer to store up to 252 ASCII characters. This information is stored in non-volatile memory and can be written with the Customer Non-Volatile Write Command. Command Format: Table 31 – Customer Non-Volatile Write Command Format Byte Value Description...
Page 28
® Tamarisk Software ICD Command Format: Table 35 – 8-Bit Colorization Selection Command Format Byte Value Description 0x01 Start of message. 0xCD 8-bit Colorization Command ID. 0x02 Parameters length. Selects one of 12 possible colorization pallets 0: White Hot 1: Black Hot 2: Red Light 3: Arcus 4: Inferno...
Page 29
® Tamarisk Software ICD 3.1.6 Video Orientation Select 0xCF Description: Selects the video display output mode Command Format: Table 37 – Video Orientation Select Command Format Byte Value Description 0x01 Start of message. 0xCF Digital Video Source Select Command ID. 0x02 Parameters length.
Page 30
® Tamarisk Software ICD Table 40 – Digital Video Source IDs (RTL Rel: newer than 01.00.0080) Source ID Description Output of Uploaded Test Pattern 14 bit data with no invert/revert, no gray or freeze frame during auto-calibrations 4 bit data with 1 frame of latency with invert/revert, gray or freeze frame support during auto-calibrations NOTE: ICE mode must be disabled prior to changing to video tap 7 please see section 3.3.2.
Page 31
® Tamarisk Software ICD NOTE Note: the baud rate for the USB port is fixed at 921600. Note: there is no acknowledge of this command, any subsequent commands must be at the new baud rate. The factory default setting is 57600 baud. There is a non-volatile parameter to permanently change this.
Page 32
® Tamarisk Software ICD Command Format: Table 45 – System Status Get Command Format Byte Value Description 0x01 Start of message. 0xF2 System Status Get Command ID. 0x00 Parameters length. checksum Frame check sequence. Response Format: Two responses are generated, a system status get response and an ACK response. Table 46 –...
® Tamarisk Software ICD Table 47 – System Status Get ACK Response Format Byte Value Description 0x01 Start of message. 0x02 ACK response 0x02 Parameters length. 4, 5 0x00F2 System Status Get Command ID. checksum Frame check sequence. Note the gain and level settings in response bytes 8 to 15 may be meaningless, depending on the specific AGC mode in use in byte 5.
Page 34
® Tamarisk Software ICD Table 49 – Field Calibrate Type IDs Description 1-point calibration. 1-point calibration with shutter disabled. All other values reserved. Response Format: Table 50 – Field Calibrate Response Format Byte Value Description 0x01 Start of message. 0x02 ACK Response 0x02 Parameters length.
Page 35
® Tamarisk Software ICD 0x02 Parameters length. 4, 5 0x0081 Field Calibrate Shutter Disable Set Command ID. checksum Frame check sequence. 3.2.3 Automatic Calibration Toggle – 0xAC Description: Toggles the TIM between automatic or manual field calibration modes. In automatic mode, a field calibration operation will occur at regular intervals. In manual mode, a field calibration operation will only occur when commanded, other than range changes.
Page 36
® Tamarisk Software ICD 4, 5 0x00AC Automatic calibration toggle command ID. checksum Frame check sequence. 3.2.4 Automatic Calibration Period Set – 0x12 Description: This command shall set the period between automatic calibrations (autocal period). This command does not store the autocal period in non-volatile storage to be preserved across power cycles.
Page 37
® Tamarisk Software ICD Command Format: Table 58 – Automatic Calibration Period Get Command Format Byte Value Description 0x01 Start of message. 0x13 Automatic calibration period get command ID. 0x00 Parameters length. checksum Frame check sequence. Response Format: Table 59 – Automatic Calibration Period Get TXT Response Format Byte Value Description...
Page 38
® Tamarisk Software ICD Customers disabling automatic field calibrations must use command 0x25 Automatic Calibration Pending Activity Query and allow some calibrations to maintain image and uniformity. Command Format: Table 61 – Automatic Calibration Activity Control Command Format Byte Value Description 0x01 Start of message.
® Tamarisk Software ICD Response Format: Table 64 – Automatic Calibration Pending Activity Query VALUE Response Format Byte Value Description 0x01 Start of message. 0x45 VALUE Response 0x02 Parameters length. Type of Calibration Pending: 0: None. 4, 5 Unsigned int 1: Periodic Time-out.
Page 40
® Tamarisk Software ICD 3.3.1 ICE Mode Min-Max Command – 0x22 (formerly known as ICE Mode Contrast Stabilization – Deprecated, please use command 0x1E for ICE adjustments) Camera RTL Rel version 01.00.3532 or newer is required together with compatible CPU(Rel) version. Description: ICE Mode Min-Max command provides backward compatability with previous ICE version using Indoor and Outdoor mode and sets the ICE strength to its minimum or maximum level.preset.
Page 42
® Tamarisk Software ICD Description: This command is preserved for backward compatibility with previous ICE implementation and maps the 0-1023 input scale to the new ICE strength scale found in cmd 0x1E. Command Format: Table 72 – ICE Mode High-Frequency Threshold Command Format Byte Value Description...
Page 43
® Tamarisk Software ICD Unsigned integer. 4, 5 AGC Mode ID value. See table below. checksum Frame check sequence. Table 75 – AGC Mode ID Values AGC Mode ID AGC Mode AGC Freeze – AGC conversion is frozen at current gain and level. Log2 Histogram Equalization (also called “auto”) Manual Mode All other values reserved...
Page 44
® Tamarisk Software ICD 0x02 ACK Response 0x02 Parameters length. 4, 5 0x0028 AGC Mode Command checksum Frame check sequence. 3.3.7 AGC White-Hot Polarity Set – 0x29 Description: Commands the system to display hotter objects in the image as lighter (whiter) and cooler objects as darker.
Page 45
® Tamarisk Software ICD Command Format: Table 81 – AGC Manual Gain Set Command Format Byte Value Description 0x01 Start of message. 0x32 AGC Manual Gain Set Command ID. 0x02 Parameters length. AGC manual gain value. gain= 256 / (4096 - manual_gain_value) unsigned integer = minimum gain, gain = 1/16 (.0625) 0 to 4095...
Page 46
® Tamarisk Software ICD 0x02 Parameters length. AGC manual level value. unsigned integer = minimum level 0 to 4095 4095 (0x0FFF) = maximum level checksum Frame check sequence. The minimum and maximum pixel values (X0 and X1) that the AGC will display are centered around the manual level value.
Page 47
® Tamarisk Software ICD Response Format: Table 86 – AGC Gain Bias Set Response Format Byte Value Description 0x01 Start of message. 0x02 ACK Response 0x02 Parameters length. 4, 5 0x0082 AGC Gain Bias Set Command ID checksum Frame check sequence. The gain factor computed for each bias setting is a two - piece formula.
Page 48
® Tamarisk Software ICD Command Format: Table 87 – AGC Level Bias Set Command Format Byte Value Description 0x01 Start of message. 0x83 AGC Level Bias Set Command ID. 0x02 Parameters length. AGC gain bias value. unsigned integer = minimum level bias, level factor = -255 0 to 4095 2047 (0x7FF) = unity level bias, gain factor = 0...
Page 49
® Tamarisk Software ICD Byte Value Description 0x02 Parameters length. 4, 5 0x0083 AGC Level Bias Set Command ID. checksum Frame check sequence. 3.3.12 AGC Gain Limit Set – 0xD1 Description: The AGC Gain Limit and the AGC Gain Limit Noise Reduction Mode are two independent blocks which control the AGC gain limit The AGC Gain Limit Set command allows the user to configure the minimum allowable difference between the white limit and black limit for AGC histogram processing.
Page 50
® Tamarisk Software ICD 4095 (0x0FFF) = maximum (not recommended) checksum Frame check sequence. Response Format: Table 90 – AGC Gain Limit Set Response Format Byte Value Description 0x01 Start of message. 0x02 ACK Response 0x02 Parameters length. 4, 5 0x00D1 AGC Gain Limit Set Command ID.
Page 51
® Tamarisk Software ICD 0x02 Parameters length. 4, 5 0x00D2 AGC Gain Flatten Offset Set Command ID. checksum Frame check sequence. 3.3.14 AGC Region of Interest – 0x84 Description: Sets or gets the AGC Region of Interest (ROI). This command also returns the allowable ROI Limit.
Page 52
® Tamarisk Software ICD 0x02 ACK Response 0x02 Parameters length. 4, 5 0x84 AGC ROI Get Command ID. checksum Frame check sequence. Table 96 – AGC ROI Get Response 1 Format Byte Value Description 0x01 Start of message. 0x00 Text message. 0x39 Parameters length.
Page 53
® Tamarisk Software ICD 0x02 ACK Response 0x02 Parameters length. 4, 5 0x84 AGC ROI Get Limit Command ID. checksum Frame check sequence. Command Format (sub-command 0x0002, Set): Table 100 – AGC ROI Set Command Format Byte Value Description 0x01 Start of message.
Page 54
® Tamarisk Software ICD Response Format: Table 103 – AGC ROI Burn to NV Params Command ACK Response Format Byte Value Description 0x01 Start of message. 0x02 ACK Response 0x02 Parameters length. 4, 5 0x84 AGC ROI Burn to NV Params Command ID. checksum Frame check sequence.
® Tamarisk Software ICD 4, 5 0x00A0 AGC Options Set Command ID. checksum Frame check sequence. 3.4 ZOOM COMMANDS 3.4.1 Zoom Magnification Set – 0xA4 Description: Selects zoom magnification. Command Format: Table 106 – Zoom Magnification Set Command Format Byte Value Description 0x01...
Page 56
® Tamarisk Software ICD 3.4.2 Zoom Pan Set – 0xA5 Description: Selects the origin from within the un-zoomed, original image for the zoomed image subset. The origin is the zero-based offset of the center of the zoomed image. The offset [0,0] is the center of the un-zoomed image. Command Format: Table 109 –...
Page 57
® Tamarisk Software ICD 0x00 Parameters length. checksum Frame check sequence. Response Format: Table 112 – Zoom Store Current Settings Response Format Byte Value Description 0x01 Start of message. 0x02 ACK Response 0x02 Parameters length. 4, 5 0x00A6 Zoom Pan Set Command ID. checksum Frame check sequence.
® Tamarisk Software ICD 3.5 NON-VOLATILE PARAMETERS COMMANDS: The following table lists the non-volatile commands available to the camera user. Table 113 – Non-Volatile Parameter IDs Default Name Type Values Notes Value 0=NTSC 1=PAL-M RS170 Mode Integer Select 2=PAL-N 3=PAL-BDGHIN2 RS170 Invert 0=disable Used to vertically invert the...
Page 59
® Tamarisk Software ICD Default Name Type Values Notes Value The output of the selected processing block will be output to all video output ports 4 = 14 bit data, output (RS170, parallel digital video, of zoom module and Camera Link). Video Output Unsigned 5 = AGC...
Page 60
® Tamarisk Software ICD Default Name Type Values Notes Value The number of system clocks to delay the generated Unsigned Genlock signal when enabled Genlock Delay 0 to 255 clocks. integer and in master mode. “0” is no delay. This value has no effect when GENLOCK is disabled.
Page 61
® Tamarisk Software ICD Default Name Type Values Notes Value 0: White Hot 1: Black Hot 2: Red Light 3: Arcus Value is applied only at the 4: Inferno time of power up. 8-Bit 5: SoftLight Unsigned Camera RTL Rel version Colorization integer 6: Sunset...
Page 62
® Tamarisk Software ICD Default Name Type Values Notes Value This must be enabled in conjunction with the specific NV param for the symbology to show on screen. For example, NVParam 52 must be set to 1 and NVParam 55 must be set to 1 for the polarity symbology 0: Disable Symbology...
Page 63
® Tamarisk Software ICD Default Name Type Values Notes Value AGC ROI Unsigned Cannot be larger than or equal Starting 0-319 integer to Ending Column. Column AGC ROI Unsigned Cannot be larger than or equal 0-239 Starting Row integer to Ending Row. Cannot be smaller than or equal to AGC ROI Unsigned...
Page 64
® Tamarisk Software ICD Default Name Type Values Notes Value 0 = 1.00X 1 = 1.25X 2 = 1.50X 3 = 1.75X 4 = 2.00X Zoom Camera RTL Rel version 5 = 2.25X Magnification Unsigned 01.00.3532 or newer is 6 = 2.50X Power on integer required together with...
Page 65
® Tamarisk Software ICD Default Name Type Values Notes Value 1 to 63, where: Camera RTL Rel version 1 = 0.25 01.00.3532 or newer is 2 = 0.50 ICE Power-On Unsigned required together with … Slope Limit Integer compatible CPU(Rel) version. 8 = 2.00 Deprecated, please use parameter 79 …...
Page 66
® Tamarisk Software ICD Default Name Type Values Notes Value Disabling frame buffer reduces system latency by one frame. ICE will not function with frame buffer disabled. 0 = disabled Frame Buffer Boolean Enable non-zero = enabled Camera RTL Rel version 01.00.4189 or newer is required together with compatible CPU(Rel) version.
Page 67
® Tamarisk Software ICD 0x00 Parameters length. checksum Frame check sequence. Response Format: Table 115 – Non-Volatile Parameters Default Set Response Format Byte Value Description 0x01 Start of message. 0x02 ACK Response 0x02 Parameters length. 4, 5 0x00B3 Non-Volatile Parameters Set Default Command ID. checksum Frame check sequence.
Page 68
® Tamarisk Software ICD Table 118 – Non-Volatile Parameters Get ACK Response Format Byte Value Description 0x01 Start of message. 0x02 ACK Response 0x02 Parameters length. 4, 5 0x00B5 Non-volatile parameters get command ID. checksum Frame check sequence. 3.5.3 Non-Volatile Parameters Set – 0xB0 Description: Set a non-volatile parameter.
Page 71
® Tamarisk Software ICD 3.6.3 Defective Pixel Map Cursor Value Set – 0x37 Description: Selects the value of the defective pixel cursor. Command Format: Table 125 – Defective Pixel Map Cursor Value Set Command Format Byte Value Description 0x01 Start of message. 0x37 Defective Pixel Map Cursor Value Set Command ID.
Page 73
® Tamarisk Software ICD 3.6.6 Defective Pixel Map Column Add – 0x36 Description: Add a column to the defect map. All pixels in the column will be marked as defective. Command Format: Table 131 – Defective Pixel Map Column Add Command Format Byte Value Description...
Page 74
® Tamarisk Software ICD unsigned integer 8, 9 0 to Cursor column index. Valid values are 0 to 319. (FPA cols – 1) checksum Frame check sequence. Response Format: Table 134 – Defective Pixel Map Remove Item Response Format Byte Value Description 0x01...
® Tamarisk Software ICD 0x02 ACK Response 0x02 Parameters length. 4, 5 0x003C Defective Pixel Map Remove All Command ID. checksum Frame check sequence. 3.6.9 Defective Pixel Map Flash Burn – 0xFB Description: Permantly store all marked dead pixels into Flash Memory. Command Format: Table 138 –...
Page 76
® Tamarisk Software ICD 3.7.1 Serial Echo – 0x06 Description: Test communications to and from the TIM. The TIM echoes the command message and parameters and generates an ACK message. Command Format: Table 140 – Serial Echo Command Format Byte Value Description 0x01...
Page 77
® Tamarisk Software ICD WARNING Disabling temperature compensation should only be used in a debug environment with test patterns. Disabling temperature compensation will result in severely degraded performance. Command Format: Table 143 – Tcomp Disable Command Format Byte Value Description 0x01 Start of message.
Page 78
® Tamarisk Software ICD 1. 0x01 0x18 0x02 0x00 0x01 0xE4, to disable Tcomp. 2. 0x01 0xAC 0x00 0x53, to disable Autocal. 3. 0x01 0xF4 0x02 0x80 0x0 0x89, to enable horizontal ramp (for example) test pattern. 4. (optional) Please see Table 40 if 14-bit test patterns are desired. Otherwise, test pattern will be 8-bit.
Page 79
® Tamarisk Software ICD 3.7.4 RS170 Test Pattern Enable – 0xD8 Description: Enables RS170 test pattern. The test pattern is a full screen of 16 vertical bars that vary from black on the left to white on the right. When this test pattern is enabled, it does not affect other processing on the TIM.
® Tamarisk Software ICD O M M A N D U I C K E F E R E N C E In this section a list of commands is provided to aid you in customizing your scripts and camera control.
Page 82
® Tamarisk Software ICD RTL Rel version required (needs to be Description (Hex) paired with compatible CPU(Rel) version) 0x3C Defective Pixel Map Remove All 01.00.0080 or newer 0x41 Data Transfer Download Packet 0x43 Data Transfer Abort 0x46 Data Transfer Download Retry 0x47 Data Transfer Download Complete 0x72...
Page 83
® Tamarisk Software ICD RTL Rel version required (needs to be Description (Hex) paired with compatible CPU(Rel) version) 0xD7 Digital Video Source Select 0xD8 RS170 Test Pattern Enable 0xF1 Baud Rate Set 0xF2 System Status Get 0xF4 Test Pattern Select 0xFB Defective Pixel Map Flash Burn 01.00.0080 or newer...
Need help?
Do you have a question about the Tamarisk 320 and is the answer not in the manual?
Questions and answers