Tamarisk®640 17 μm 640x480 Long Wave Infrared Camera Software Interface Control Document Document No: 1014844 Revision: C
©Copyright 2013, DRS TECHNOLOGIES, Inc.- All rights reserved. 13532 N. Central Expressway Dallas, TX 75243 877.377.4783 www.drsinfrared.com The contents of this document may not be reproduced in whole or in part without the written consent of the copyright owner. NOTICE ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND.
Tamarisk ® 640 Software ICD TABLE OF CONTENTS Table of Contents.....................................................................................................................i Acronyms and Abbreviations .................................................................................................. ii Reference Documentation ..................................................................................................... iii Safety Instructions ...............................................
Tamarisk ® 640 Software ICD ACRONYMS AND ABBREVIATIONS Abbreviation °C °F AGC BPR CCA CL COMM CSC CSCI CSU dB DSP ESD E-Zoom FOV FPA ft G g GUI H HFOV I/O ICD ICE ID IR IRS km LR LWIR Description Celsius Fahrenheit automatic gain control bad pixel replacement circuit card assembly center line communication Computer Software Component Computer Software Configuration Item Computer Software Unit decibels digital signal processor electrostatic discharge electronic zoom field of view Focal Plane Array feet
Tamarisk ® 640 Software ICD REFERENCE DOCUMENTATION 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.
Tamarisk ® 640 Software ICD SAFETY INSTRUCTIONS NOTIFICATIONS: CAUTION, WARNING AND NOTE Throughout this manual, notifications are used to alert the user’s to potential risks and to minimize the potential for personal injury and or damage to the product. 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.
Tamarisk ® 640 Software ICD 1 SCOPE This document describes the serial protocols and command interface for systems employing the Tamarisk®640 Software Architecture. The Tamarisk®640 Software Architecture is a design for an infrared thermal imaging core that uses an un-cooled focal plane array (UFPA). 1.1 SYSTEMS OVERVIEW A thermal imaging module (TIM) based on the Tamarisk®640 Software Architecture communicates with a connected device via the serial protocol described herein.
Tamarisk ® 640 Software ICD 2 MESSAGE FORMAT - GENERAL 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. Start Character – this is always 0x01. It identifies the start of a new message. Note that the start character is not guaranteed to be unique in the serial data stream.
Tamarisk ® 640 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 ® 640 Software ICD 0xFFF…FFFD2 & 0xFF = 0xD2. 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. The command byte identifies the specific command to be performed.
Tamarisk ® 640 Software ICD Note: to receive a text message, the module must have debug message mode ON.
Tamarisk ® 640 Software ICD 2.3.2 ACK Response The ACK response is a general-purpose acknowledgement that a command has been received. Some commands will result in two ACK messages – one generated upon receipt 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 1 0x01 Start of message. 2 0x02 ACK Response ID.
Tamarisk ® 640 Software ICD commands but are extended to 16 bits in an ERR. 6 checksum Frame check sequence. See paragraph 2.1. Table 8– ERR String Response Format Byte Value/Type Description 1 0x01 Start of message. 2 0x04 ERR Response ID. 3 N 4 to (N+3) ASCII chars (N+4) checksum Number of text bytes to follow. ASCII text string that contains error message. Null termination not required. Frame check sequence. See paragraph 2.1. 2.3.
Tamarisk ® 640 Software ICD 2.4 RESPONSE MESSAGE TIMING An ACK response will nominally be returned within 1 second of the command being sent. However, there are exceptions: 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. ♦ The temperature of the flash.
Tamarisk ® 640 Software ICD TIM CU 0x73 (10) Download Setup 0x02 (2) 0x41 (248) ACK Download Packet 0x47 (0) Complete 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).
Tamarisk ® 640 Software ICD Table 11 – Data Transfer Download Setup Command Format Byte Value Description 1 0x01 Start of message. 2 0x73 Data Transfer Download Setup Command ID. 3 0x0A Parameters length. 4 to 7 unsigned integer Transfer size in bytes. 8, 9 unsigned integer 0x0001 10, 11 unsigned integer 0x001A 12, 13 unsigned integer 0x0000. 14 checksum Frame check sequence.
Tamarisk ® 640 Software ICD There is no response to this command unless packet is corrupted or is the last packet of the transfer. • If this packet is corrupted, the CU should generate a “Data Transfer Download Retry” message (0x46) containing the packet number of the expected packet. • If this packet is the last packet of the transfer, the CU should generate a “Data Transfer Download Complete” message (0x47) that contains success status. 2.6.1.
Tamarisk ® 640 Software ICD There is no response to this command. Upon receipt of this command, the TIM will cease data transfer operations. 2.6.1.5 Data Transfer Abort – 0x43 Description: Abort a data transfer. This command can be used to abort both uploads and downloads. Command Format: Table 16 – Data Transfer Abort Command Format Byte Value Description 1 0x01 Start of message. 2 0x43 Data Transfer Abort command ID. 3 0x00 Parameters length. 4 checksum Frame check sequence.
Tamarisk ® 640 Software ICD Item Length (in bytes) Conversion from raw bytes Mfg date information 1 Day = int(data[7]) Mfg date information 2 Year = int(data[8]) * 256 + int(data[9]) Mfg date information 1 Month = int(data[10]) Mfg date information 1 Day = int(data[11]) Mfg calibration information 6 Chamber = string(data[12:17]) Mfg calibration information 6 Position = string(data[18:23]) Mfg calibration information 10 Version = string(data[24:33]) Mfg software information 10 V
Tamarisk ® 640 Software ICD Figure 2– Upload to TIM Message Sequence Diagram TIM CU 0x74 (18) Upload Setup 0x02 (2) ACK 0x74 (3) Upload Setup Upload Packet 0x72 (244) 0x72 (244) Flash Upload Packet … Sector Upload Packet Pause Resume Upload Packet 0x72 (244) 0x72 (4) Sector Burning (8) 0x72 (4) Burning Complete (9) 0x72 (244) … Flash Sector Upload Packet Upload Packet 0x72 (244) 0x72 (202) 0x72 (4) Sector Burning (8) 0x72 (4) Transfer Complete (10) The TIM checks the size and region para
Tamarisk ® 640 Software ICD 2.7.1 Data Transfer Upload Setup – 0x74 This message is used as both a command to the TIM and a response to the CU. Description: Sets up a transfer from the connected unit to the TIM. Command Format: Table 19 – Data Transfer Upload Setup Command Format Byte Value Description 1 0x01 Start of message. 2 0x74 Data Transfer Upload Setup Command ID. 3 0x12 Parameters length.
Tamarisk ® 640 Software ICD 7 Illegal Size. Size of upload does not agree with expected size. Setup failed. 2.7.2 Data Transfer Upload Packet – 0x72 This message is used as both a command to the TIM and a response to the CU. Description: Carries data to be uploaded to the TIM. The response provides flow control and error notification to CU. Command Format: As a command, this message carries payload data for a data transfer upload to the TIM from the CU.
Tamarisk ® 640 Software ICD Table 24 – Data Transfer Upload Packet Response ID ID Description CU Response 3‡ Packet out of order. Restart transmission from the packet number included in the message. 4 Upload complete. Flash operations underway. CU should cease transmission of packets until follow-up message is received. 5 Transfer CRC error. CU should cease data transfer operations 6 Data length error. CU should cease data transfer operations 8 Flash sector programming underway.
Tamarisk ® 640 Software ICD 3 OPERATIONAL COMMANDS The operational commands are those used by the TIM during normal operations. These commands may also be used during factory calibration and testing. 3.1 SYSTEM COMMANDS 3.1.1 System Version Get – 0x07 Description: This command returns the system version. The response to the command is a series of TXT messages followed by an ACK message.
Tamarisk ® 640 Software ICD 4. FPA Name – “FPA: U6160” 5. X1 Core Libraries Version – “X1 Core Lib Rel: 00.01.44” 6. RTL Logic Version String – This is the version number of the current RTL logic release. Example format: “RTL Rel: 01.00.0052” Note: This is only an example. Some ASCII characters will change according to revision levels in the system. The TXT messages shall be followed by an ACK message.
Tamarisk ® 640 Software ICD Byte Value Description 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x0007 System Version Get Command ID. 6 checksum Frame check sequence. 3.1.2 Customer Non-Volatile Read Command – 0xCA Description: Allows a customer to read up to 252 ASCII characters. This information is read out of non-volatile memory and can be read back with the Customer Non-Volatile Read Command.
Tamarisk ® 640 Software ICD Command Format: Table 31 – Customer Non-Volatile Write Command Format Byte Value Description 1 0x01 Start of message. 2 0xCB Customer Non-Volatile Write Command ID 3 N Parameters length, where 10
Tamarisk ® 640 Software ICD 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x00CC Colorization Enable Command ID. 6 checksum Frame check sequence. 3.1.5 8-Bit Colorization Selection Command– 0xCD Description: Allows the user to select the one of 12 different 8-bit colorization selections. Colorization must be enabled and the output video mode must be set to 8-bit.
Tamarisk ® 640 Software ICD Command Format: Table 35 – 8-Bit Colorization Selection Command Format Byte Value Description 1 0x01 Start of message. 2 0xCD 8-bit Colorization Command ID. 3 0x02 Parameters length. Selects one of 12 possible colorization pallets 0: White Hot 1: Black Hot 2: Red Light 3: Arcus 4: Inferno 4, 5 0x0000 to 0x000B 5: SoftLight 6: Sunset 7: Memoriam 8: Flamma Arcticus 9: Ocean 10: Rain 6 checksum 11: Factory Default Frame check sequence.
Tamarisk ® 640 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 1 0x01 Start of message. 2 0xCF Digital Video Source Select Command ID. 3 0x02 4, 5 0 to 3 6 checksum Parameters length. Video Orientation Selection 0 = Normal Orientation 1 = Vertical Invert 2 = Horizontal Invert 3 = Horizontal and Vertical Invert Frame check sequence.
Tamarisk ® 640 Software 6 ICD checksum Frame check sequence. Table 40 – Digital Video Source IDs Source ID Description 0 Test Pattern Generator 6 14 bit data with no invert/revert, no gray or freeze frame during auto-calibrations 7 14 bit data with 1 frame of latency with invert/revert, gray or freeze frame support during auto-calibrations 8 Output of AGC Module. 9 Output of Symbology Module. All other values reserved.
Tamarisk ® 640 Software ICD Command Format: Table 42 – Baud Rate Set Command Format Byte Value Description 1 0x01 Start of message. 2 0xF1 Baud Rate Set Command ID. 3 0x02 Parameters length. 4, 5 Unsigned integer. See table below. Baud rate ID value. 6 checksum Frame check sequence.
Tamarisk ® 640 Software ICD Table 45 – System Status Get First Response Format Byte Value Description 1 0x01 Start of message. 2 0xF2 ACK Response 3 0x10 Parameters length.
Tamarisk ® 640 Software ICD 3.2 FIELD CALIBRATION COMMANDS Field calibrations may be performed at any time during camera operations to improve image quality. The most common is the 1-point calibration, wherein the shutter is closed, raw pixel samples are collected and averaged for some number of frames (default is 4), new NUC offsets are computed from the averaged samples, and the shutter is opened to resume operations.
Tamarisk ® 640 Software ICD 4, 5 0x0027 Field Calibrate Command ID. 6 checksum Frame check sequence. 3.2.2 Field Calibrate – Shutter Disable Set – 0x81 Description: Enables or disables the TIM shutter. When the shutter is disabled it is forced closed and the shutter will ignore requests to open for field calibrations. When the shutter is enabled, it will open and respond to requests to open or close.
Tamarisk ® 640 Software ICD Command Format: Table 52 – Automatic Calibration Toggle Command Format Byte Value Description 1 0x01 Start of message. 2 0xAC Automatic calibration toggle command ID. 3 0x00 Parameters length. 4 checksum Frame check sequence. Table 53 – Automatic Calibration Toggle Command Format (Option 2) Byte Value Description 1 0x01 Start of message. 2 0xAC Automatic calibration toggle command ID. 3 0x02 Parameters length.
Tamarisk ® 640 Software ICD Byte Value Description 2 0x12 Automatic calibration period set command ID. 3 0x02 Parameters length. 4, 5 Unsigned integer Automatic calibration period in minutes. 6 checksum Frame check sequence. Response Format: Table 56 – Automatic Calibration Period Set Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x0012 Automatic calibration period set command ID.
Tamarisk ® 640 Software ICD Byte Value Description (N+3) text string Example: “AUTOCAL: Interval= 300 sec.” Note trailing null is included in parameters length. (N+4) checksum Frame check sequence. Table 59 – Automatic Calibration Period Get ACK Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x0013 AutoCal Period Get Command ID. 6 checksum Frame check sequence. 3.2.
Tamarisk ® 640 Software ICD Response Format: Table 61 – Automatic Calibration Activity Control ACK Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x0026 AutoCal Activity Control Command ID. 6 checksum Frame check sequence. 3.2.7 Automatic Calibration Pending Activity Query – 0x25 Description: This command queries the camera for pending Automatic Calibration activities, and specifies the type of AutoCal that is pending.
Tamarisk ® 640 Software ICD Table 64 – Automatic Calibration Pending Activity Query ACK Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x0025 AutoCal Pending Activity Query command ID. 6 checksum Frame check sequence. 3.3 AGC COMMANDS The system supports both conventional AGC operation and Image Contrast Enhancement (ICE) operation. These operating modes are mutually exclusive.
Tamarisk ® 640 Software ICD 1 preset value for high strength Response Format: Table 66 – ICE Mode Min-Max Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x0022 ICE Mode Min-Max Command ID. 6 checksum Frame check sequence. 3.3.2 ICE Mode Enable Command – 0x23 Camera RTL Rel version 01.00.3532 or newer is required together with compatible CPU(Rel) version.
Tamarisk ® 640 Software ICD 3.3.1 ICE Mode Strength Command – 0x1E Camera RTL Rel version 01.00.4471 or newer is required. Description: Sets ICE Strength. (ICE Mode must be enabled before this command will have any effect). This command, enables the user to select an ICE strength from 0-7 in 1 unit increments. The lowest setting is 0; the highest setting is 7. Recommend using lower values when looking at lower contrast scenes and higher values when looking at dynamic scenes.
Tamarisk ® 640 Software ICD Response Format: Table 72 – ICE Mode High-Frequency Threshold Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x001F ICE Mode High-Frequency Threshold Command ID. 6 checksum Frame check sequence. 3.3.3 AGC Mode Set – 0x2A Description: Sets the operating mode for Automatic Gain Control. NOTE This command has no effect if ICE is enabled.
Tamarisk ® 640 Software ICD Response Format: Table 75 – AGC Mode Set Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x002A AGC Mode Set Command ID. 6 checksum Frame check sequence. 3.3.4 AGC Black-Hot Polarity Set – 0x28 Description: Commands the system to display hotter objects in the image as darker (blacker) and cooler objects as lighter. The default camera setting is white hot.
Tamarisk ® 640 Software ICD Command Format: Table 78 – AGC White Hot Polarity Set Command Format Byte Value Description 1 0x01 Start of message. 2 0x29 AGC White-Hot Polarity Set Command ID. 3 0x00 Parameters length. 4 checksum Frame check sequence. Response Format: Table 79 – AGC White Hot Polarity Set Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x0029 AGC White-Hot Polarity Set Command ID.
Tamarisk ® 640 Software 6 ICD checksum Frame check sequence. Response Format: Table 81 – AGC Manual Gain Set Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x0032 AGC Manual Gain Set Command ID 6 checksum Frame check sequence. 3.3.7 AGC Manual Level Set – 0x33 Description: Sets level value used by AGC when configured to Manual Mode. NOTE This command has no effect if ICE is enabled.
Tamarisk ® 640 Software ICD Response Format: Table 83 – AGC Manual Level Set Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x0033 AGC Manual Level Set Command ID 6 checksum Frame check sequence. 3.3.8 AGC Gain Bias Set – 0x82 Description: Sets gain bias value. Gain bias is similar to a contrast control. Command Format: Table 84 – AGC Gain Bias Set Command Format Byte Value Description 1 0x01 Start of message.
Tamarisk ® 640 Software ICD The gain factor computed for each bias setting is a two - piece formula. For gain_bias <= 2047, gain_factor = (0.75*gain_bias/2047)+0.25 For gain_bias >= 2048, gain_factor = (3*(gain_bias-2048)/2047)+1 Gain Bias 4.0000 3.7500 3.5000 3.2500 3.0000 2.7500 2.5000 2.2500 2.0000 1.7500 1.5000 1.2500 1.0000 0.7500 0.5000 0.2500 0.0000 4096 3840 3584 3328 3072 2816 2560 2304 2048 1792 1536 1280 1024 768 512 256 0 Gain Bias Parameter Figure 4– Gain Factor Curve 3.
Tamarisk ® 640 Software ICD For level bias <= 2047, level _factor = 255*level_bias/2047-255 For level bias >= 2048, level factor = 255*(level_bias-2047)/2048 256.000 192.000 128.000 0.000 4096 3840 3584 3328 3072 2816 2560 2304 2048 1792 1536 1280 -64.000 1024 768 512 256 0 Level Bias 64.000 Level Bias Parameter -128.000 -192.000 -256.000 Figure 5– Level Bias Chart Response Format: Table 87 – AGC Level Bias Set Response Format Byte Value Description 1 0x01 Start of message.
Tamarisk ® 640 Software ICD allow more sensitivity but will also gain-up any system noise. A larger value will prevent objectionable gaining-up of system noise but will reduce sensitivity in low-contrast scenes. The AGC Gain Limit Noise Reduction Mode (which is an NV parameter) works to limit the pixel-to-pixel difference and thus reducing the effects of noise across the entire scene. This limit has the effect of smoothing out the image and hence the AGC provides a better overall image.
Tamarisk ® 640 Software ICD 3.3.11 AGC Gain Flatten Offset Set – 0xD2 Description: 1. Sets the gain limit offset for AGC histogram processing. The default value is NOTE This command has no effect if ICE is enabled. Command Format: Table 90 – AGC Gain Flatten Offset Set Command Format Byte Value Description 1 0x01 Start of message. 2 0xD2 AGC Gain Flatten Offset Set Command ID. 3 0x02 Parameters length. 4, 5 unsigned integer 0 to 65535 AGC gain flatten offset value.
Tamarisk ® 640 Software ICD Sub Command Format: Table 92 – AGC Region of Interest Sub Command Table ID Description Additional Parameters Response 0 Get ROI None Text String, ACK 1 Get ROI Limit None Text String, ACK 2 Set ROI 4 unsigned integer ACK 3 Burn ROI to NV Param None ACK All other values reserved. Command Format (sub-command 0x0000, Get): Table 93 – AGC ROI Get Command Format Byte Value Description 1 0x01 Start of message. 2 0x84 AGC ROI Get Command ID.
Tamarisk ® 640 Software ICD Command Format (sub-command 0x0001, Get Limit): Table 96 – AGC ROI Get Limit Command Format Byte Value Description 1 0x01 Start of message. 2 0x84 AGC ROI Get Limit Command ID. 3 0x02 Parameters length. 4,5 0x0001 Sub-command Get Internal ROI Limit. 6 checksum Frame check sequence. Response Format: Table 97 – AGC ROI Get Limit Response 1 Format Byte Value Description 1 0x01 Start of message. 2 0x00 Text message.
Tamarisk ® 640 Software ICD 10, 11 Unsigned integer XSTOP, within valid limits (see Get Limit) 12, 13 Unsigned integer YSTOP, within valid limits (see Get Limit) 14 checksum Frame check sequence. Response Format: Table 100 – AGC ROI Set Command ACK Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x84 AGC ROI Set Command ID. 6 checksum Frame check sequence.
Tamarisk ® 640 Software ICD NOTE This command has no effect if ICE is enabled. Command Format: Table 103 – AGC Options Set Command Format Byte Value Description 1 0x01 Start of message. 2 0xA0 AGC Options Set Command ID. 3 0x02 Parameters length. 4, 5 0x000A AGC gain flatten offset value. 6, 7 unsigned integer 0 to 65535 Pixel sum upper bound. 8, 9 unsigned integer 0 to 65535 Pixel sum lower bound. 10 checksum Frame check sequence.
Tamarisk ® 640 Software ICD Command Format: Table 105 – Zoom Magnification Set Command Format Byte Value Description 1 0x01 Start of message. 2 0xA4 Zoom Magnification Set Command ID. 3 0x02 Parameters length. 4, 5 Unsigned integer. See table below. Zoom magnification ID value. 6 checksum Frame check sequence. Table 106 – Zoom Magnification ID Values Zoom Magnification ID Zoom 0 1.00 7 2.75 1 1.25 8 3.00 2 1.50 9 3.25 3 1.75 10 3.50 4 2.00 11 3.75 5 2.25 12 4.
Tamarisk ® 640 Software ICD Command Format: Table 108 – Zoom Pan Set Command Format Byte Value Description 1 0x01 Start of message. 2 0xA5 Zoom Pan Set Command ID. 3 0x04 Parameters length. 4, 5 Signed integer Horizontal offset from the center. Negative values center the zoom to the left of FPA center. Positive values center the zoom to the right of FPA center. 6, 7 Signed integer. Vertical offset from the center. Negative values center the zoom above the FPA center.
Tamarisk ® 640 Software ICD Response Format: Table 111 – Zoom Store Current Settings Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x00A6 Zoom Pan Set Command ID. 6 checksum Frame check sequence. 3.5 NON-VOLATILE PARAMETERS COMMANDS The following table lists the non-volatile commands available to the camera user.
Tamarisk ID ® 640 Software ICD Name Type Values Default Value 7 Video Output Mux Select Unsigned integer 0 = Output of Uploaded Test Pattern 6 = 14 bit data with no invert/revert, no gray or freeze frame during auto-calibrations 7 = 14 bit data with 1 frame of latency with invert/revert, gray or freeze frame support during autocalibrations 8 = AGC 9 = Symbology All other values reserved.
Tamarisk ® 640 Software ICD ID Name 18 Genlock Master Enable 19 34 Genlock Delay Serial Port Baudrate Type Boolean Values 0 = slave mode non-zero = master mode Default Value Notes 0 This value has no effect when GENLOCK is disabled. Unsigned integer 0 to 255 clocks. 0 The number of system clocks to delay the generated Genlock signal when enabled and in master mode. “0” is no delay. This value has no effect when GENLOCK is disabled.
Tamarisk ID ® 640 Software ICD Name Type Values Default Value Notes 45 8-Bit Colorization Selection Unsigned integer 0: White Hot 1: Black Hot 2: Red Light 3: Arcus 4: Inferno 5: SoftLight 6: Sunset 7: Memoriam 8: Flamma Arcticus 9: Ocean 10: Rain 11: Factory Default 46 Enable Colorization Boolean 0: Disable 1: Enable 0 Value is applied only at the time of power up. 47 ICE Mode Enable Boolean 0: Disable 1: Enable 1 Value is applied only at the time of power up.
Tamarisk ID ® 640 Software ICD Name Type Values Default Value Notes 56 Symbology Start Up Time Duration Unsigned integer 0 = Disabled > 0, Enabled duration in seconds 0 Cannot be larger than 0xFFFF. NVParam 52 must also be enabled. 57 Symbology Zoom Enable Boolean 0: Disable 1: Enable 0 NVParam 52 must also be enabled. 58 AGC ROI Starting Column Unsigned integer 0-639 0 Cannot be larger than or equal to Ending Column.
Tamarisk ID ® 640 Software ICD Name Type 67 Zoom Magnification Power on Value Unsigned integer 68 Zoom Horizontal Offset Power On Value Signed Integer 69 Zoom Vertical Offset Power On Value Signed Integer 71 72 ICE Power-On Slope Limit Crosshairs Enable Unsigned Integer Boolean Values 0 = 1.00X 1 = 1.25X 2 = 1.50X 3 = 1.75X 4 = 2.00X 5 = 2.25X 6 = 2.50X 7 = 2.75X 8 = 3.00X 9 = 3.25X 10 = 3.50X 11 = 3.75X 12 = 4.00X Horizontal offset from the center.
Tamarisk ID ® 640 Software ICD Name Type Values Default Value Notes Enabling this parameter does nothing unless parameter 72 is also enabled. 73 Crosshairs Border Enable Boolean 0 = disabled non-zero = enabled 74 Crosshairs X Location Unsigned integer 6 to 632 320 Values outside of allowable range will be truncated to nearest legal value. 75 Crosshairs Y Location Unsigned integer 6 to 472 240 Values outside of allowable range will be truncated to nearest legal value.
Tamarisk ® 640 Software ICD 3. If flash programming fails, this command results in an ERR response containing an informative string. WARNING This command will reset the camera back to factory defaults, any customer non-volatile parameter changes will be lost (this will not effect customer flash sector or customer dead cell map). Command Format: Table 113 – Non-Volatile Parameters Default Set Command Format Byte Value Description 1 0x01 Start of message.
Tamarisk ® 640 Software ICD Response Format: This command generates two response messages. The first is a VALUE message that contains the value of the non-volatile parameter. The second response is an ACK message. Table 116 – Non-Volatile Parameters Get VALUE Response Format Byte Value Description 1 0x01 Start of message. 2 0x45 VALUE Response 3 0x02 Parameters length. 4, 5 Unsigned int Non-volatile parameter value. 6 checksum Frame check sequence.
Tamarisk ® 640 Software 8 ICD checksum Frame check sequence. Parameter Value size and content are dependent on parameter ID. Two types are common: ♦ Boolean – a 16-bit unsigned integer where: • 0 = disabled • 1 = enabled. ♦ Unsigned integer – a 16-bit value whose range is parameter specific. ♦ Response Format: Table 119 – Non-Volatile Parameters Set Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK response 3 0x02 Parameters length.
Tamarisk ® 640 Software ICD Command Format: Table 120 – Defective Pixel Map Cursor Enable Command Format Byte Value Description 1 0x01 Start of message. 2 0x38 Defective Pixel Map Cursor Enable Command ID. 3 0x00 Parameters length. 4, 5 unsigned integer 0 = cursor disable 1 = cursor enable 6 checksum Frame check sequence. Response Format: Table 121 – Defective Pixel Map Cursor Enable Response Format Byte Value Description 1 0x01 Start of message.
Tamarisk ® 640 Software ICD Response Format: Table 123 – Defective Pixel Map Cursor Position Set Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK response 3 0x02 Parameters length. 4, 5 0x003A Defective Pixel Map Cursor Position Set Command ID. 6 checksum Frame check sequence. 3.6.3 Defective Pixel Map Cursor Value Set – 0x37 Description: Selects the value of the defective pixel cursor.
Tamarisk ® 640 Software ICD Command Format: Table 126 – Defective Pixel Map Pixel Add Command Format Byte Value Description 1 0x01 Start of message. 2 0x3B Non-Volatile Parameters Set Default Command ID. 3 0x04 Parameters length. 4, 5 unsigned integer 0 to (FPA rows – 1) Cursor row index. Valid values are 0 to 479. 6, 7 unsigned integer 0 to (FPA cols – 1) Cursor column index. Valid values are 0 to 639. 8 checksum Frame check sequence.
Tamarisk ® 640 Software ICD Response Format: Table 129 – Defective Pixel Map Row Add Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x0034 Defective Pixel Map Row Add Command ID. 6 checksum Frame check sequence. 3.6.6 Defective Pixel Map Column Add – 0x36 Description: defective. Add a column to the defect map.
Tamarisk ® 640 Software ICD Command Format: Table 132 – Defective Pixel Map Remove Item Command Format Byte Value Description 1 0x01 Start of message. 2 0x3B Defective Pixel Map Remove Item Command ID. 3 0x06 Parameters length. 4, 5 unsigned integer See table below. Remove item operation ID. 6, 7 unsigned integer 0 to (FPA rows – 1) Cursor row index. Valid values are 0 to 479. 8, 9 unsigned integer 0 to (FPA cols – 1) Cursor column index. Valid values are 0 to 639.
Tamarisk ® 640 Software ICD Command Format: Table 135 – Defective Pixel Map Remove All Command Format Byte Value Description 1 0x01 Start of message. 2 0x3C Defective Pixel Map Remove All Command ID. 3 0x00 Parameters length. 4 checksum Frame check sequence. Response Format: Table 136 – Defective Pixel Map Remove All Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length.
Tamarisk ® 640 Software ICD 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x00FB Defective Pixel Map Remove All Command ID. 6 checksum Frame check sequence. 3.7 TROUBLESHOOTING COMMANDS The troubleshooting commands are used for troubleshooting hardware and software features of the TIM. 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.
Tamarisk ® 640 Software ICD Table 141 – Serial Echo ACK Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x0006 Serial Echo Command ID. 6 checksum Frame check sequence. 3.7.2 Tcomp Disable – 0x18 Description: Disables or enables TIM temperature compensation (Tcomp). WARNING Disabling temperature compensation should only be used in a debug environment with test patterns.
Tamarisk ® 640 Software 6 ICD checksum Frame check sequence. 3.7.3 Test Pattern Select – 0xF4 Description: Enables and selects a video test pattern. Selecting test pattern <0x0000> disables the test pattern generator. This test pattern replaces the input video stream from the FPA and facilitates testing of downstream processing blocks. This requires a sequence of commands. The current mode of operation can also affect how the test patterns look and the actual pixel values on the digital interfaces.
Tamarisk ® 640 Software ICD Response Format: Table 146 – Test Pattern Select Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x00F4 Test Pattern Select Command ID. 6 checksum Frame check sequence. 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.
Tamarisk ® 640 Software ICD Description: Toggles the display of verbose messaging. Command Format: Table 149 – Verbose Mode Toggle Command Format Byte Value Description 1 0x01 Start of message. 2 0xFF Verbose Mode Toggle Command ID. 3 0x00 Parameters length. 6 checksum Frame check sequence. Table 150 – Verbose Mode Toggle Command Format (Option 2) Byte Value Description 1 0x01 Start of message. 2 0xFF Verbose Mode Toggle Command ID. 3 0x02 Parameters length.
Tamarisk ® 640 Software ICD 4 COMMAND QUICK-REFERENCE In this section a list of commands is provided to aid you in customizing your scripts and camera control. Table 152 – Message Quick Reference Cmd (Hex) Description 0x06 Echo Test 0x07 System Version Get 0x12 Automatic Calibration Period Set 0x13 Automatic Calibration Period Get 0x18 Tcomp Disable 0x1E ICE Strength 0x1F ICE High Frequency Threshold Set 01.00.4189 or newer (Deprecated) 0x22 ICE Mode Min Max 01.00.
Tamarisk ® 640 Software ICD Cmd (Hex) Description RTL Rel version required (needs to be paired with compatible CPU(Rel) version) 0x3C Defective Pixel Map Remove All 0x41 Data Transfer Download Packet 0x43 Data Transfer Abort 0x46 Data Transfer Download Retry 0x47 Data Transfer Download Complete 0x72 Data Transfer Upload Packet 0x73 Data Transfer Download Setup 0x74 Data Transfer Upload Setup 0x81 Field Calibrate - Shutter Disable 0x82 AGC Gain Bias Set 0x83 AGC Level Bias Set 0x
Tamarisk ® 640 Software ICD Cmd (Hex) Description 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 0xFF Verbose Mode Toggle RTL Rel version required (needs to be paired with compatible CPU(Rel) version) 79
