User manual

ManualsBrandsDRS Technologies ManualsDigital CameraTamarisk 320

Tamarisk

320

17 μm 320x240 Long Wave Infrared Camera

Software Interface Control Document

Document No: 1012819

Revision: E

Summary of content (83 pages)

PAGE 1
Tamarisk®320 17 μm 320x240 Long Wave Infrared Camera Software Interface Control Document Document No: 1012819 Revision: E
PAGE 2
©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.
PAGE 3
Tamarisk®320 Software ICD TABLE OF CONTENTS Table of Contents.....................................................................................................................i Acronyms and Abbreviations .................................................................................................. ii Reference Documentation ..................................................................................................... iii Safety Instructions ....................................................
PAGE 4
Tamarisk®320 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 gravi
PAGE 5
Tamarisk®320 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.
PAGE 6
Tamarisk®320 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.
PAGE 7
Tamarisk ® 320 Software ICD 1 SCOPE This document describes the serial protocols and command interface for systems employing the Tamarisk®320 Software Architecture. The Tamarisk®320 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®320 Software Architecture communicates with a connected device via the serial protocol described herein.
PAGE 8
Tamarisk ® 320 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.
PAGE 9
Tamarisk ® 320 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.
PAGE 10
Tamarisk ® 320 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. The command byte identifies the specific command to be performed. Additional data bytes are included in the command as required.
PAGE 11
Tamarisk ® 320 Software ICD Acknowledgement (ACK) 0x02 Data filed includes16-bit command ID of the serial command that is being acknowledged Not acknowledged (NAK) 0x03 Data filed includes 16-bit command ID of the serial command that is being unacknowledged Error (ERR) 0x04 Data filed include 16-bit command ID of the serial command that is in error 16-bit integer return value (VALUE) 0x45 16-bit integer value broken up into 2 bytes CMD Cmd Returns command code with response data 2.3.
PAGE 12
Tamarisk ® 320 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 1 0x01 Start of message. 2 0x02 ACK Response ID. 3 0x02 ACK responses always have 2 parameter bytes. 4, 5 Command ID 6 checksum ID of command that is being ACK’d. Command IDs are 8 bits in commands but are extended to 16 bits in an ACK. Frame check sequence.
PAGE 13
Tamarisk ® 320 Software ICD 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.5 VALUE Response The VALUE response is generated when a command returns a single 16-bit integer value.
PAGE 14
Tamarisk ® 320 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. ♦ The temperature of the flash. Colder flash parts require more time to erase and program. 2. The response time for non-ACK response (ERR, NAK, etc) types depends on the type of command. 2.
PAGE 15
Tamarisk ® 320 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; region, range, and size of the download (see Figure 1) The TIM checks the size and region parameters and, if acceptable, responds with an ACK (0x02).
PAGE 16
Tamarisk ® 320 Software ICD Response Format: Table 12 – Data Transfer Download Setup Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK response. 3 0x02 Parameters length. 4, 5 0x0073 Data Transfer Download Setup Command ID. 6 Checksum Frame check sequence. 2.6.1.2 Data Transfer Download Packet – 0x41 Description: Carries payload bytes for the data transfer download.
PAGE 17
Tamarisk ® 320 Software ICD Table 14 – Data Transfer Download Retry Command Format Byte Value Description 1 0x01 Start of message. 2 0x46 Data Transfer Download Packet Command ID. 3 0x02 Parameters length. 4, 5 unsigned integer Packet number of expected packet. 6 Checksum Frame check sequence. Response Format: There is no response to this command other than to resume packet transmission at the packet number of the expected packet.
PAGE 18
Tamarisk ® 320 Software ICD 3 0x00 Parameters length. 4 Checksum Frame check sequence. Response Format: Table 17 – Data Transfer Abort Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK response 3 0x02 Parameters length. 4, 5 0x0043 Data Transfer Abort command ID. 6 Checksum Frame check sequence. 2.6.2 Non-volatile Camera System Information.
PAGE 19
Tamarisk ® 320 Software ICD Item Length (in bytes) Conversion from raw bytes Detector Part Number 20 Part Number = string(data[94:113]) Detector Serial Number 20 Serial Number = string(data[114:133]) 2.7 CAMERA DATA UPLOAD If the Tamarisk®320 camera is integrated in a system there may be occasions an embedded firmware or embedded hardware programs could require an update.
PAGE 20
Tamarisk ® 320 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. This flow control message includes 2, 16-bit parameters. The first is a response ID and the second is a packet number.
PAGE 21
Tamarisk ® 320 Software ICD 2 0x74 Data Transfer Upload Setup Command ID. 3 0x06 Parameters length. 4, 5 0x0000 Always 0. 6, 7 0x0000 Always 0. 7, 8 Unsigned Integer Response ID. See table below. 9 checksum Frame check sequence. Table 21 – Data Transfer Upload Setup Response ID Response ID Description 1 Success, Setup accepted. Upload can proceed. 3 Error in Device ID, Region ID, or Range ID. Setup failed. 7 Illegal Size. Size of upload does not agree with expected size.
PAGE 22
Tamarisk ® 320 Software ICD Response Format: Table 23 – Data Transfer Upload Packet Response Format Byte Value Description 1 0x01 Start of message. 2 0x72 Data Transfer Upload Setup Command ID. 3 0x06 Parameters length. 4, 5 unsigned integer Response ID. See table below. 6, 7 unsigned integer Packet number. First packet is 0. 8 checksum Frame check sequence. Table 24 – Data Transfer Upload Packet Response ID ID Description CU Response 3‡ Packet out of order.
PAGE 23
Tamarisk ® 320 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.
PAGE 24
Tamarisk ® 320 Software ICD 4. FPA Name – “FPA: U3600” 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.
PAGE 25
Tamarisk ® 320 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 Camera RTL Rel version 01.00.0080 or newer is required together with compatible CPU(Rel) version. Description: Allows a customer to read up to 252 ASCII characters.
PAGE 26
Tamarisk ® 320 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 1 0x01 Start of message. 2 0xCB Customer Non-Volatile Write Command ID 3 NN Parameters length, where 10
PAGE 27
Tamarisk ® 320 Software ICD Byte Value Description 6 checksum Frame check sequence. Response Format: Table 34 – Enable Colorization Response Format Byte Value Description 1 0x01 Start of message. 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 Camera RTL Rel version 01.00.3532 or newer is required together with compatible CPU(Rel) version.
PAGE 28
Tamarisk ® 320 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.
PAGE 29
Tamarisk ® 320 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 Parameters length.
PAGE 30
Tamarisk ® 320 Software ICD Table 40 – Digital Video Source IDs (RTL Rel: newer than 01.00.0080) Source ID Description 0 Output of Uploaded Test Pattern 6 14 bit data with no invert/revert, no gray or freeze frame during auto-calibrations 7 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. 8 Output of AGC Module. 9 Output of Symbology Module.
PAGE 31
Tamarisk ® 320 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. If a different baud rate is desired, there must be an initial command to change the baud rate at 57600 baud. Or the non-volatile-parameter (#34) must be set to the desired baud rate.
PAGE 32
Tamarisk ® 320 Software ICD Command Format: Table 45 – System Status Get Command Format Byte Value Description 1 0x01 Start of message. 2 0xF2 System Status Get Command ID. 3 0x00 Parameters length. 4 checksum Frame check sequence. Response Format: Two responses are generated, a system status get response and an ACK response. Table 46 – System Status Get First Response Format Byte Value Description 1 0x01 Start of message. 2 0xF2 ACK Response 3 0x10 Parameters length.
PAGE 33
Tamarisk ® 320 Software ICD Table 47 – System Status Get ACK Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK response 3 0x02 Parameters length. 4, 5 0x00F2 System Status Get Command ID. 6 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. 3.
PAGE 34
Tamarisk ® 320 Software ICD Table 49 – Field Calibrate Type IDs ID Description 3 1-point calibration. 4 1-point calibration with shutter disabled. All other values reserved. Response Format: Table 50 – Field Calibrate Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x0027 Field Calibrate Command ID. 6 checksum Frame check sequence. 3.2.
PAGE 35
Tamarisk ® 320 Software ICD 3 0x02 Parameters length. 4, 5 0x0081 Field Calibrate Shutter Disable Set Command ID. 6 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 ® 320 Software ICD 4, 5 0x00AC Automatic calibration toggle command ID. 6 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. A setting of zero (0) is will prevent only periodic automatic calibrations, not all automatic calibrations.
PAGE 37
Tamarisk ® 320 Software ICD Command Format: Table 58 – Automatic Calibration Period Get Command Format Byte Value Description 1 0x01 Start of message. 2 0x13 Automatic calibration period get command ID. 3 0x00 Parameters length. 4 checksum Frame check sequence. Response Format: Table 59 – Automatic Calibration Period Get TXT Response Format Byte Value Description 1 0x01 Start of message. 2 0x00 TXT Response 3 N Parameters length.
PAGE 38
Tamarisk ® 320 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 1 0x01 Start of message. 2 0x26 AutoCal Activity Control command ID. 3 0x02 Parameters length.
PAGE 39
Tamarisk ® 320 Software ICD Response Format: Table 64 – Automatic Calibration Pending Activity Query VALUE Response Format Byte Value Description 1 0x01 Start of message. 2 0x45 VALUE Response 3 0x02 Parameters length. 4, 5 Unsigned int Type of Calibration Pending: 0: None. 1: Periodic Time-out. 2: Range Change. 6 checksum Frame check sequence. Table 65 – Automatic Calibration Pending Activity Query ACK Response Format Byte Value Description 1 0x01 Start of message.
PAGE 40
Tamarisk ® 320 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 41
Tamarisk ® 320 Software ICD 1 enables ICD mode. 6 checksum Frame check sequence. Response Format: Table 69 – ICE Mode Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x0023 ICE Enable Command ID. 6 checksum Frame check sequence. 3.3.3 ICE Mode Strength Command – 0x1E Camera RTL Rel version 01.00.4471 or newer is required. Description: Sets ICE Strength.
PAGE 42
Tamarisk ® 320 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 1 0x01 Start of message. 2 0x1F ICE Mode High-Frequency Threshold Command ID. 3 0x02 Parameters length. 4, 5 0 to 1023 ICE high-frequency threshold value.
PAGE 43
Tamarisk ® 320 Software ICD 4, 5 Unsigned integer. See table below. AGC Mode ID value. 6 checksum Frame check sequence. Table 75 – AGC Mode ID Values AGC Mode ID AGC Mode 0 AGC Freeze – AGC conversion is frozen at current gain and level. 1 Log2 Histogram Equalization (also called “auto”) 2 Manual Mode All other values reserved Response Format: Table 76 – AGC Mode Set Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length.
PAGE 44
Tamarisk ® 320 Software ICD 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x0028 AGC Mode Command 6 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. This is the default. Command Format: Table 79 – AGC White Hot Polarity Set Command Format Byte Value Description 1 0x01 Start of message. 2 0x29 AGC White-Hot Polarity Set Command ID.
PAGE 45
Tamarisk ® 320 Software ICD Command Format: Table 81 – AGC Manual Gain Set Command Format Byte Value Description 1 0x01 Start of message. 2 0x32 AGC Manual Gain Set Command ID. 3 0x02 4,5 unsigned integer 0 to 4095 Parameters length. AGC manual gain value. gain= 256 / (4096 - manual_gain_value) 0 = minimum gain, gain = 1/16 (.0625) 3840 (4095 – 255) = unity gain, gain = 1.0 4095 (0x0FFF) = maximum gain, gain = 256 6 checksum Frame check sequence.
PAGE 46
Tamarisk ® 320 Software ICD 3 0x02 4,5 unsigned integer 0 to 4095 6 checksum Parameters length. AGC manual level value. 0 = minimum level 4095 (0x0FFF) = maximum level Frame check sequence. The minimum and maximum pixel values (X0 and X1) that the AGC will display are centered around the manual level value. The separation between X0 and X1 is determined by the manual gain value.
PAGE 47
Tamarisk ® 320 Software ICD Response Format: Table 86 – AGC Gain Bias Set Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x0082 AGC Gain Bias Set Command ID 6 checksum Frame check sequence. 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.
PAGE 48
Tamarisk ® 320 Software ICD Command Format: Table 87 – AGC Level Bias Set Command Format Byte Value Description 1 0x01 Start of message. 2 0x83 AGC Level Bias Set Command ID. 3 0x02 Parameters length. 4,5 unsigned integer 0 to 4095 AGC gain bias value. 0 = minimum level bias, level factor = -255 2047 (0x7FF) = unity level bias, gain factor = 0 4095 (0x0FFF) = maximum level bias, gain factor = 255 6 checksum Frame check sequence.
PAGE 49
Tamarisk ® 320 Software ICD Byte Value Description 3 0x02 Parameters length. 4, 5 0x0083 AGC Level Bias Set Command ID. 6 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 ® 320 Software ICD 4095 (0x0FFF) = maximum (not recommended) 6 checksum Frame check sequence. Response Format: Table 90 – AGC Gain Limit Set Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x00D1 AGC Gain Limit Set Command ID. 6 checksum Frame check sequence. 3.3.13 AGC Gain Flatten Offset Set – 0xD2 Description: 1. Sets the gain limit offset for AGC histogram processing.
PAGE 51
Tamarisk ® 320 Software ICD 3 0x02 Parameters length. 4, 5 0x00D2 AGC Gain Flatten Offset Set Command ID. 6 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. This command also provides ability to burn all of the ROI to flash NV Param. NOTE This command has no effect if ICE is enabled.
PAGE 52
Tamarisk ® 320 Software ICD 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x84 AGC ROI Get Command ID. 6 checksum Frame check sequence. Table 96 – AGC ROI Get Response 1 Format Byte Value Description 1 0x01 Start of message. 2 0x00 Text message. 3 0x39 4-56 Zero-terminated string. Parameters length. Example: “AGC ROI (x0,y0,x1,y1): ( 57 checksum 0, 0, 319,239)” (Each coordinate value takes up 3 characters). Frame check sequence.
PAGE 53
Tamarisk ® 320 Software ICD 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x84 AGC ROI Get Limit Command ID. 6 checksum Frame check sequence. Command Format (sub-command 0x0002, Set): Table 100 – AGC ROI Set Command Format Byte Value Description 1 0x01 Start of message. 2 0x84 AGC ROI Set Command ID. 3 0x0A Parameters length. 4, 5 0x0002 Sub-command Set ROI.
PAGE 54
Tamarisk ® 320 Software ICD Response Format: Table 103 – AGC ROI Burn to NV Params 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 Burn to NV Params Command ID. 6 checksum Frame check sequence. 3.3.15 AGC Options Set – 0xA0 Description: Sets AGC LUT limits. NOTE This command has no effect if ICE is enabled.
PAGE 55
Tamarisk ® 320 Software ICD 4, 5 0x00A0 AGC Options Set Command ID. 6 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 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.
PAGE 56
Tamarisk ® 320 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 – Zoom Pan Set Command Format Byte Value Description 1 0x01 Start of message. 2 0xA5 Zoom Pan Set Command ID. 3 0x04 Parameters length.
PAGE 57
Tamarisk ® 320 Software ICD 3 0x00 Parameters length. 4 checksum Frame check sequence. Response Format: Table 112 – 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.
PAGE 58
Tamarisk ® 320 Software ICD 3.5 NON-VOLATILE PARAMETERS COMMANDS: The following table lists the non-volatile commands available to the camera user.
PAGE 59
Tamarisk ID 7 ® 320 Software ICD Name Video Output Mux Select Type Unsigned integer Values Default Value 4 = 14 bit data, output of zoom module 5 = AGC All other values reserved. 5 AGC Gain Limit Unsigned integer 0 to 4095 0 9 AGC Gain Flatten Offset Unsigned integer 0 to 65535 3 11 AGC Upper/Lower Bounds Percent Unsigned integer 0 to 100 (%).
PAGE 60
Tamarisk ID 19 34 ® 320 Software ICD Name Genlock Delay Serial Port Baudrate Type Values Default Value Notes 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. Unsigned integer See Serial Baudrate command in Section 3.1.9 for complete listing of selectable baudrates. 2 Default power-on serial communication baudrate.
PAGE 61
Tamarisk ID 45 ® 320 Software ICD Name 8-Bit Colorization Selection Type Unsigned integer Values 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 Default Value Notes Value is applied only at the time of power up. 0 Camera RTL Rel version 01.00.3532 or newer is required together with compatible CPU(Rel) version. Value is applied only at the time of power up.
PAGE 62
Tamarisk ID 52 ® 320 Software ICD Name Symbology Enable Type Boolean Values 0: Disable 1: Enable Default Value 0 Notes 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 to show. If either is set to 0, then the polarity symbology is not displayed. Camera RTL Rel version 01.00.3532 or newer is required together with compatible CPU(Rel) version.
PAGE 63
Tamarisk ® 320 Software ICD Name 58 AGC ROI Starting Column Unsigned integer 0-319 0 Cannot be larger than or equal to Ending Column. 59 AGC ROI Starting Row Unsigned integer 0-239 0 Cannot be larger than or equal to Ending Row.
PAGE 64
Tamarisk ID ® 320 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 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. - Negative values center the zoom to the left of FPA center.
PAGE 65
Tamarisk ID 71 72 73 74 ® 320 Software ICD Name ICE Power-On Slope Limit Crosshairs Enable Crosshairs Border Enable Crosshairs X Location 75 Crosshairs Y Location 76 YUV Output Enable (Superframe) 77 ICE HighFrequency Threshold Type Unsigned Integer Boolean Boolean Unsigned integer Values 1 to 63, where: 1 = 0.25 2 = 0.50 … 8 = 2.00 … 63 = 15.
PAGE 66
Tamarisk ID ® 320 Software ICD Name Type Frame Buffer Enable 78 79 ICE Strength Boolean Unsigned Integer Values Default Value 0 = disabled non-zero = enabled 0-7 Notes 1 Disabling frame buffer reduces system latency by one frame. ICE will not function with frame buffer disabled. Camera RTL Rel version 01.00.4189 or newer is required together with compatible CPU(Rel) version. 4 ICE must be enabled for this parameter to have any effect. ICE can be enabled at powerup with parameter 47.
PAGE 67
Tamarisk ® 320 Software ICD 3 0x00 Parameters length. 4 checksum Frame check sequence. Response Format: Table 115 – Non-Volatile Parameters Default Set Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x00B3 Non-Volatile Parameters Set Default Command ID. 6 checksum Frame check sequence. 3.5.
PAGE 68
Tamarisk ® 320 Software ICD Table 118 – Non-Volatile Parameters Get ACK Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x00B5 Non-volatile parameters get command ID. 6 checksum Frame check sequence. 3.5.3 Non-Volatile Parameters Set – 0xB0 Description: Set a non-volatile parameter. The parameter will effect camera operation immediately – it is not necessary to cycle the TIM’s power. Please note: 1.
PAGE 69
Tamarisk ® 320 Software ICD Table 120 – Non-Volatile Parameters Set Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK response 3 0x02 Parameters length. 4, 5 0x00B0 Non-volatile parameters set command ID. 6 checksum Frame check sequence. 3.6 PIXEL MAP COMMANDS The defective pixel map identifies Focal Plane Array (FPA) pixels that are stuck high, stuck low, flashing, or otherwise defective.
PAGE 70
Tamarisk ® 320 Software ICD 4, 5 unsigned integer 0 = cursor disable 1 = cursor enable 6 checksum Frame check sequence. Response Format: Table 122 – Defective Pixel Map Cursor Enable Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK response 3 0x02 Parameters length. 4, 5 0x0038 Defective Pixel Map Cursor Enable Command ID. 6 checksum Frame check sequence. 3.6.
PAGE 71
Tamarisk ® 320 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 1 0x01 Start of message. 2 0x37 Defective Pixel Map Cursor Value Set Command ID. 3 0x02 Parameters length. 4, 5 6 Unsigned integer 0 to 0x3FFF checksum Cursor value.
PAGE 72
Tamarisk ® 320 Software ICD (FPA cols – 1) 8 checksum Frame check sequence. Response Format: Table 128 – Defective Pixel Map Pixel Add Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x003B Non-Volatile Parameters Set Default Command ID. 6 checksum Frame check sequence. 3.6.5 Defective Pixel Map Row Add – 0x34 Description: This command adds a row to the defect map. All pixels on the row will be marked as defective.
PAGE 73
Tamarisk ® 320 Software ICD 3.6.6 Defective Pixel Map Column Add – 0x36 Description: defective. Add a column to the defect map. All pixels in the column will be marked as Command Format: Table 131 – Defective Pixel Map Column Add Command Format Byte Value Description 1 0x01 Start of message. 2 0x36 Defective Pixel Map Column Add Command ID. 3 0x02 Parameters length. 4, 5 unsigned integer 0 to (FPA cols – 1) Cursor column index. Valid values are 0 to 319.
PAGE 74
Tamarisk ® 320 Software ICD 8, 9 unsigned integer 0 to (FPA cols – 1) Cursor column index. Valid values are 0 to 319. 10 checksum Frame check sequence. Response Format: Table 134 – Defective Pixel Map Remove Item Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x0035 Defective Pixel Map Remove Item Command ID. 6 checksum Frame check sequence.
PAGE 75
Tamarisk ® 320 Software ICD 2 0x02 ACK Response 3 0x02 Parameters length. 4, 5 0x003C Defective Pixel Map Remove All Command ID. 6 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 – Defective Pixel Map Flash Burn Command Format Byte Value Description 1 0x01 Start of message. 2 0xFB Defective Pixel Map Flash Burn Command ID. 3 0x04 Parameters length.
PAGE 76
Tamarisk ® 320 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 1 0x01 Start of message. 2 0x06 Serial Echo Command ID. 3 N Parameters length. 4 to (N+3) Null-terminated string. String to be echoed. String length is arbitrary but total message size must be less than MTU size.
PAGE 77
Tamarisk ® 320 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 1 0x01 Start of message. 2 0x18 Tcomp Disable Command ID. 3 0x02 Parameters length. 4 to 5 0 = enable 1 = disable. Disable/enable. Note value of 1 disables Tcomp. 6 checksum Frame check sequence.
PAGE 78
Tamarisk ® 320 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. When test pattern is no longer used, it is best to power cycle the camera to restore to normal operation.
PAGE 79
Tamarisk ® 320 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. The RS170 test pattern overrides normal RS170 output. RS170 output must be enabled or test pattern will not be output.
PAGE 80
Tamarisk ® 320 Software ICD Table 151 – 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. 4, 5 0x0000 0x0001 0 disables verbose mode. 1 enables verbose mode. 6 checksum Frame check sequence. Response Format: Table 152 – Verbose Mode Toggle Response Format Byte Value Description 1 0x01 Start of message. 2 0x02 ACK Response 3 0x02 Parameters length.
PAGE 81
Tamarisk ® 320 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 153 – Command 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.
PAGE 82
Tamarisk ® 320 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
PAGE 83
Tamarisk ® 320 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) 01.00.