CONTENTS 1 WELCOME!.......................... 4 2 SAFETY AND PRECAUTIONS ....................5 2.1 Definitions and Symbols ..................... 5 2.2 General Safety Notices ......................6 3 INSTALLING THE CAMERA HARDWARE ................. 7 3.1 Mounting ..........................7 3.2 Connector ..........................7 3.3 GigE Cable ..........................8 3.4 GPIO Cable ...........................
Page 3
5.4.3 Non-isolated Input - GPIO Line 2 ................19 5.4.4 Non-isolated Output - GPIO Line 2 ................20 5.4.5 Non-isolated Input - GPIO Line 3 ................20 5.4.6 Non-isolated Output - GPIO Line 3 ................20 5.4.7 2.5V Output ......................21 5.5 LED Status .........................
Page 4
7 DEVICE NODES ........................42 7.1 Acquisition Control ......................42 7.1.1 Acquisition Modes ....................42 7.1.2 Auto Exposure AOI ....................46 7.2 Action Control ........................47 7.3 Analog Control ........................47 7.4 Chunk Data Control ......................49 7.5 Color Transformation Control ................... 50 7.6 Counter and Timer Control ....................
WELCOME! The CAM-CIC-12-9 is a ruggedized camera designed for industrial environments where dirt, dust or water are present. Its lightweight, dust-proof, and water-resistant 29 x 29 mm camera enclosure and lens tube makes this camera the smallest IP67-rated camera in the world. Its robust M12 and M8 connectors and Sony Pregius CMOS sensor make this camera ideal for a wide variety of industrial applications.
SAFETY AND PRECAUTIONS Follow these guidelines carefully before using your CAM-CIC-12-9. Definitions and Symbols Below are some warning, safety, and/or tips icons used in this document. The Warning icon indicates a potentially hazardous situation. If not avoided, the situation can result in damage to the product.
General Safety Notices Powering the Camera • The camera may not work, may be damaged, or may exhibit unintended behavior if powered out- side of the specified power range. • When using Power over Ethernet, the power sup- ply must comply with IEEE 802.3af.
THREE INSTALLING THE CAMERA HARDWARE Mounting The camera is equipped with seven M3 mounting holes and six M2 mounting holes. One pair of M2 and one pair of M3 holes are present on opposite sides of the lens mount surface. Two more M2 holes are located on the bottom side of the camera towards the center.
The CAM-CIC-12-9 camera is equipped with an 8-pin General Purpose Input/Output (GPIO) connector at the back. • Cognex cameras are designed to use shielded or unshielded Ethernet cables. • When using a shielded GPIO cable in an industrial setting, care must be taken to prevent ground loops from forming between the camera chassis, Ethernet PoE power sourcing equipment, IT infrastructure, and devices connected to GPIO.
Consult the GPIO Characteristics section for a GPIO pinout diagram. Lens Your camera has the lens mount shown below. 3.5.1 C mount lens C mount lenses can be used on a C mount camera. According to the standard, the C mount flange back distance is 17.53 mm.
3.6.3 Lens Tube Without a lens tube, the CAM-CIC-12-9 achieves the IP50 rating, which is protection against dust but not water. With a lens tube from Cognex, the CAM-CIC-12-9 achieves the IP67 rating, which is dust proof and water resistant.
CONFIGURING THE CAMERA & HOST SYSTEM Installing the Ethernet Driver Cognex recommends updating to the latest version of your Ethernet adapter’s driver before connecting your camera. You may need to navigate to the manufacturer’s website to find the latest version of the driver.
Out of the box, the camera first attempts to connect using DHCP. If the camera is unable to connect using DHCP, it will use Link-Local Addressing. 4.2.2 Setting Up Persistent IP The following pseudocode demonstrates how to set up persistent IP:...
Bandwidth Management 4.3.1 Jumbo Frames Cognex recommends enabling jumbo frames on your Ethernet adapter. A jumbo frame is an Ethernet frame that is larger than 1500 bytes. Most Ethernet adapters support jumbo frames, but it is usually turned off by default.
User Sets, Streamables, and File Access 4.4.1 User Sets The CAM-CIC-12-9 features two customizable user sets to load or save user-defined settings on the camera. Accessing the user set named Default will allow loading or saving of factory default settings. The CAM-CIC-12-9 will load the user set selected in UserSetDefault when powering up or when reset.
Page 16
The following pseudocode demonstrates how to read from the camera using file access: // Connect to camera // Get device node map FileSelector UserFile1; FileOpenMode Read; FileOperationSelector Open; FileOperationExecute(); // Device sets FileOperationSelector = Close // Read custom file from camera FileOperationExecute();...
CAMERA SPECIFICATIONS Power The CAM-CIC-12-9 can be powered via the Ethernet cable using Power over Ethernet (PoE) or the GPIO using the pins described in the GPIO Characteristics section. When using PoE, the power supply must comply with IEEE 802.3af. You can find recommended parts to power the camera in our web store.
GPIO Characteristics 5.3.1 GPIO Pinout Diagram The GPIO connector as seen from the rear of the CAM-CIC-12-9. Pin Number Pin Description (12-24V DC Power Input) Non-isolated bi-directional GPIO channel (Line 2) GPIO (2.5V Power Output) (Line 4) Non-isolated bi-directional GPIO channel (Line 3) GND (Camera GND) OPTO GND (Opto-isolated Reference) OPTO OUT (Opto-isolated Output) (Line 1)
GPIO Schematics 5.4.1 Opto-isolated Input – GPIO Line 0 Opto-isolated Input Measurements: Volt- Max Rise Max Fall Max Rise Max Fall Time Min Pulse age (V) Delay (us) Delay (us) Time (us) (us) Input (us) Input Input High (V) Low (V) Sample values measured at room temperature.
1.8k 1.8k 2.7k 4.7k 1.8k 2.7k 4.7k 6.8k Sample values measured at room temperature. Results may vary with the temperature and setup. 5.4.3 Non-isolated Input - GPIO Line 2 Non-isolated Input Measurements: Voltage Max Rise Max Fall Max Rise Max Fall Min Pulse Min Input Min Input Low...
5.4.4 Non-isolated Output - GPIO Line 2 Non-isolated Output Measurements: Voltage External Max Rise Max Fall Max Rise Max Fall Time Current (mA) Low Level (V) Resistor () Delay (us) Delay (us) Time (us) (us) 1.8k 1.8k 2.7k 4.7k 1.8k 2.7k 4.7k 6.8k...
• Active: LED indicates camera status according to the above table. IR Filter Color cameras from Cognex are equipped with an IR filter that is installed under the gasket of the mount. Mono cameras are equipped with a transparent glass window instead of an IR filter. The...
Model Size Thickness 29 x 29 mm IP67 camera C-Mount 18 x 14.5 mm 1 mm The IR filter and transparent glass window have anti-reflective coating on both sides. Shock and Vibration To ensure the camera’s stability, the CAM-CIC-12-9 camera is tested under the following shock/vibration conditions.
Users are advised that any changes or modifications not approved by Cognex will void the FCC compliance. The product is intended to be used as a component of a larger system; hence users...
5.8.2 RoHS, REACH, and WEEE Cognex declares the CAM-CIC-12-9 camera is in conformity with the following directives: • RoHS 2015/863/EU • REACH 1907/2006/EC • WEEE 2012/19/EC 5.8.3 CE Cognex declares the CAM-CIC-12-9 meets requirements necessary for CE marking. The product complies with the requirements of the directives listed below: •...
CAMERA FEATURES Image Processing Controls The following is a typical image processing control flow for cameras like CAM-CIC-12-9. However, the color-related image processing controls (i.e., Debayering, Color Correction Matrix, and Color Space Conversion Conversion) are not available for monochrome cameras. The details of each of the image processing controls are described below.
camera is not exposed to light by covering it with a lens cap and placing in a dark box. 3. Fire the DefectCorrectionGetNewDefect command. 4. Enter the X-coordinate noted in step 2 into DefectCorrectionPositionX. 5. Enter the Y-coordinate noted in step 2 into DefectCorrectionPositionY. 6.
Digital Gain refers to amplification of the signal after digitization. The following pseudocode demonstrates how to set Gain to 12dB: // Connect to camera // Get device node map GainAuto Off; Gain Conversion Gain Switching Sony’s third-generation Pregius sensor line offers a feature called Conversion Gain Switching. The Conversion Gain Switching feature lets you select between High Conversion Gain (HCG) for maximum sensitivity and minimum read noise in low light, and Low Conversion Gain (LCG) for greatly increased saturation capacity and higher dynamic range under bright light.
The White Balance module aims to change the balance between the Red, Green, and Blue channels such that a white object appears white in the acquired images. Cognex cameras allow for manual white balance adjustment by the user, or automatic white balance adjustment based on statistics of previously acquired frames.
LUTSave(); 6.1.6 Gamma The gamma control allows the optimization of brightness for display. Cognex implements Gamma using the GenICam standard as shown below. • X = New pixel value; 0 <= X <=1 • Y = Old pixel value; 0 <= Y <=1 •...
6.1.7 Color Space Conversion and Correction The Color Space Conversion control allows you to convert from RGB color space to another color space such as YUV. The conversion is done in a linear manner as shown in the following equation. The color correction function lets you select from several preset values or configure your own matrix values.
// Connect to camera // Get device node map OffsetX 250; OffsetY 150; Width 200; Height 200; If the camera is acquiring images, AcquisitionStop must be called before changing region of interest settings. 6.2.2 Binning The CAM-CIC-12-9 camera supports binning, which is a feature that combines columns and/or rows of pixels to reduce the overall image size without changing the image’s field of view.
If the camera is acquiring images, AcquisitionStop must be called before adjusting binning settings. 6.2.3 Decimation The CAM-CIC-12-9 camera supports decimation, which is a feature that skips columns and/or rows of pixels to reduce the overall image size without changing the image’s field of view. This feature is also known as “subsampling”...
If the camera is acquiring images, AcquisitionStop must be called before changing horizontal or vertical flip. 6.2.5 Test Pattern The camera is able to output one of several FPGA-generated test patterns that you can choose. Digital IO The CAM-CIC-12-9’s Digital IO controls input and output lines that can be utilized with external circuitry for synchronization with other devices.
TriggerActivation FallingEdge; Camera will trigger on the falling edge of the input signal ˓ AcquisitionStart(); // Acquire images by sending pulses to line0 It is also possible to set software as the input source. This will enable the camera to trigger upon a software signal.
6.3.3 Configuring an Output Line When a Digital IO line is set to Output, the line can fire pulses. The following pseudocode demonstrates how to set Line1 as the output source. This sets up the camera to fire a pulse when the camera is acquiring an image. // Connect to camera // Get device node map // Choose Line1 and set it to Output...
Chunk Data Chunk data is additional tagged data that can be used to identify individual images. The chunk data is appended after the image data. For more details on chunk data, see the Device Nodes section. 6.4.1 Extracting the Image CRC checksum with ChunkCRC When the CRC chunk data property is enabled, the camera tags a cyclic-redundancy check (CRC) checksum that is calculated against the image payload, which is useful for error detection.
Page 38
Using Continuous TransferOperationMode is similar to when Transfer Control is not enabled, except the host application can stop data transmission without stopping image acquisition on the device. The following pseudocode demonstrates how to enable Automatic Transfer Control mode on the camera.
6.5.2 UserControlled Transfer Control When using UserControlled Transfer Control mode, the transfer of blocks to the host is controlled by the host application. Using MultiBlock TransferOperationMode with UserControlled Transfer Control allows the host application to specify when to transmit data from the device. The following pseudocode demonstrates how to enable UserControlled Transfer Control mode with MultiBlock TransferOperationMode on the camera.
In UserControlled Transfer Control mode, the following commands are available: • TransferPause to pause transfer of blocks without executing TransferStop or AcquisitionStop. • TransferResume to resume transfer of blocks af- ter TransferPause has been called. • TransferAbort to abort transfer of blocks. •...
// Encounter event from camera // De-register event callback within host software Events available on CAM-CIC-12-9 are as follows: 6.6.1 Exposure Start The Exposure Start event occurs when the camera starts exposing the sensor to capture a frame. When this event occurs, the following data is sent by the camera in an Exposure Start event: •...
6.7.1 Updating your Camera Firmware 1. Navigate to your camera’s firmware update page in your web browser (http://{your- camera-ip-address}/firmware- update.html). 2. Click Choose a file on the Firmware Update page and select your fwa file. 3. Click Submit on the Firmware Update page. This will start the firmware update process. The Firmware Update page will show the progress of the update.
DEVICE NODES Acquisition Control Acquisition Control contains features related to image acquisition. Triggering and exposure control functionalities are included in this section. 7.1.1 Acquisition Modes There are 3 main types of acquisition modes - SingleFrame acquisition, MultiFrame acquisition, and Continuous acquisition. SingleFrame Acquisition In SingleFrame acquisition mode, one frame is acquired after AcquisitionStart is called.
Page 44
In MultiFrame acquisition mode, frames are acquired once AcquisitionStart is called. The number of frames acquired is dictated by the parameter AcquisitionFrameCount. During the acquisition process, all Transport Layer parameters are locked and cannot be modified. AcquisitionStop is optional in MultiFrame acquisition mode. MultiFrame with FrameBurstStart A burst of frames is defined as a capture of a group of one or many frames within an acquisition.
Page 45
If AcquisitionStop is called during the last frame then the acquisition sequence will stop after the current frame finishes. The following pseudocode demonstrates how to configure the camera to Continuous acquisition mode: // Connect to camera // Get device node map AcquisitionMode Continuous;...
Page 46
Node Name Description Specifies the rate (in Hertz) at which frames are TransmissionFrameRate transmitted. Controls if the AcquisitionFrameRate feature is writable AcquisitionFrameRateEnable and used to control the acquisition rate. Controls the rate (in Hertz) at which the Lines in a AcquisitionLineRate Frame are captured.
Node Name Description ExposureTimeRaw Reports the device raw exposure time value. ShortExposureEnable Sets to Short Exposure Mode. ExposureAuto Sets the automatic exposure mode. Specifies usage of ExposureAutoLowerLimit and ExposureAutoLimitAuto ExposureAutoUpperLimit. ExposureAutoLowerLimit Specifies the lower limit of ExposureAuto algorithm. ExposureAutoUpperLimit Specifies the upper limit of ExposureAuto algorithm. TargetBrightness Sets the target brightness in 8-bit.
Node Name Description AOI. Action Control Node Name Description Enables the unconditional action command mode where ActionUnconditionalMode action commands are processed even when the primary control channel is closed. Determines whether or not PTP needs to be synchronized ActionPTPSyncRequired to launch an action command. Indicates the size of the scheduled action commands ActionQueueSize queue.
Page 49
Node Name Description GainAuto Sets the automatic gain control mode. GainAutoLowerLimit Specifies the lower limit of GainAuto algorithm. GainAutoUpperLimit Specifies the upper limit of GainAuto algorithm. Selects which BlackLevel is controlled by the BlackLevelSelector various Black Level features. Controls the BlackLevel as an absolute physical BlackLevel value.
Node Name Description SharpeningEnable Controls if the sharpening feature is enabled. SharpeningAmount Controls the sharpening amount. Controls the minimal brightness change that will be sharpened.The threshold setting can be used to SharpeningThreshold sharpen more pronounced edges, while leaving subtler edges untouched. Chunk Data Control Node Name Description...
Node Name Description ChunkPixelDynamicRangeMin Chunk Pixel Dynamic Range Min chunk data. ChunkPixelDynamicRangeMax Chunk Pixel Dynamic Range Max chunk data. ChunkGain Chunk Gain chunk data. ChunkBlackLevel Chunk Black Level chunk data. ChunkExposureTime Chunk Exposure Time chunk data. Color Transformation Control Color Transformation Control contains features that describe how to color transformation features of an image, such as RGB to YUV conversion.
Node Name Description CounterTriggerSource Selects the source to start the Counter. Selects the Activation mode of the trigger to start the CounterTriggerActivation Counter. Select the signals that will be the source to reset the CounterResetSource Counter. Selects the Activation mode of the Counter Reset Source CounterResetActivation signal.
Node Name Description DefectCorrectionCount The number of defect corrected pixels. DefectCorrectionIndex The index of the defect corrected pixel to access. The column index of the defect corrected pixel DefectCorrectionPositionX selected by DefectCorrectionIndex. The row index of the defect corrected pixel selected DefectCorrectionPositionY by DefectCorrectionIndex.
Page 54
Node Name Description DeviceFirmwareVersion Version of the firmware in the device. DeviceSerialNumber Device’s unique serial number. DeviceUserID A device ID string that is user-programmable. Major version of the Standard Features DeviceSFNCVersionMajor Naming Convention (SFNC) that was used to create the device’s GenICam XML. Minor version of the Standard Features DeviceSFNCVersionMinor Naming Convention (SFNC) that was used to...
Page 55
Node Name Description Sub minor version of the Transport Layer of DeviceTLVersionSubMinor the device. Maximum bandwidth of the data that can be DeviceMaxThroughput streamed out of the device. Selects which Link of the device to control. In DeviceLinkSelector general, the device only has one link. Indicates speed transmission...
Page 56
Node Name Description device. DeviceReset Resets the device to its power up state. DeviceFactoryReset Resets device to factory defaults. FirmwareUpdate Starts a firmware update. Indicate to the device and GenICam XML to DeviceFeaturePersistenceStart get ready for persisting of all streamable features.
Node Name Description Time the device has been powered in DeviceUpTime seconds. Time the device link has been established in LinkUpTime seconds. ChipID Chip ID of the device. Digital IO Control Node Name Description LineConfiguration Reports the configuration of the Digital IO Lines. Selects the physical line (or pin) of the external LineSelector device connector to configure.
Node Name Description ExposureActive LineSource. Selects which bit of the User Output register will UserOutputSelector be set by UserOutputValue. Sets value selected UserOutputValue UserOutputSelector. Sets the value of all the bits of the User Output UserOutputValueAll register. subject UserOutputValueAllMask. Sets the write mask to apply to the value specified by UserOutputValueAll before writing it User Output...
Node Name Description Category that contains all the data features EventEncoder0StoppedData related to the Encoder0Stopped Event. Category that contains all the data features EventEncoder0RestartedData related to the Encoder0Restarted Event. Category that contains all the data features EventFrameDroppedData related to the FrameDropped Event. Category that contains all the data features EventTemperatureOutOfRangeData related to the TemperatureOutOfRange Event.
Node Name Description Returns unique identifier EventEncoder0Stopped Encoder0Stopped type of Event. Returns the Timestamp of the Encoder0Stopped EventEncoder0StoppedTimestamp Event. 7.10.4 Event Exposure End Data Node Name Description Returns the unique identifier of the ExposureEnd type EventExposureEnd of Event. EventExposureEndTimestamp Returns the Timestamp of the ExposureEnd Event. Returns the unique Identifier of the Frame (or image) EventExposureEndFrameID that generated the ExposureEnd Event.
Node Name Description Returns unique identifier EventFrameTriggerMissed EventFrameTriggerMissed type of Event. Returns Timestamp EventFrameTriggerMissedTimestamp EventFrameTriggerMissed Event. 7.10.8 Event Temperature Out Of Range Data Node Name Description EventTemperatureOutOfRange Returns the unique identifier of the TemperatureOutOfRange type of Event. EventTemperatureOutOfRangeTimestamp Returns Timestamp TemperatureOutOfRange Event.
Node Name Description Defines the intermediate access buffer that allows the exchange of FileAccessBuffer data between the device file storage and the application. Controls the offset of the mapping between the device file FileAccessOffset storage and the FileAccessBuffer. Controls the length of the mapping between the device file FileAccessLength storage and the FileAccessBuffer.
Node Name Description Controls the register data length used for the I2C I2CRegisterDataLength communication. Controls the number of words to transfer to or from I2CAccessLength the I2CAccessBuffer. I2COperationStatus Represents the I2COperationExecute status. Represents the number of successfully read/written I2COperationResult bytes for the I2C operation. I2CSlaveDeviceAddress Controls the device address for the slave.
Page 64
Node Name Description WidthMax Maximum width of the image in pixels. HeightMax Maximum height of the image in pixels. Reports the physical size of an individual pixel on the PhysicalPixelSize sensor. ADCBitDepth Reports the bit depth of the sensor’s ADC. Width of the sensor image after binning and ImagerWidth decimation.
Node Name Description Minimum value that can be returned during the PixelDynamicRangeMin digitization process. Maximum value that can be returned during the PixelDynamicRangeMax digitization process. Selects which binning engine is controlled by the BinningSelector BinningHorizontal and BinningVertical features. BinningHorizontalMode Selects how to combine the horizontal pixels together. BinningVerticalMode Selects how to combine the vertical pixels together.
Node Name Description LUTEnable Actives the saved LUT. LUTToneMapping Selects which tone mapping curve to apply. LUTSelector Selects which LUT to control. Control the index (offset) of the coefficient to access in the selected LUTIndex LUT. Access the value at entry LUT Index of the LUT selected by LUT LUTValue Selector.
Page 67
Ensure that SequencerFeatureSelector is set to “ExposureTime”. By default, SequencerSetSelector is set to “0”. This means that we can set a exposure time for set “0” under AcquisitionControl (the ExposureAuto node is already forced Off at this point). Under the Acquisition Control group, set an ExposureTime of 100 us.
Page 68
// Configuring set 1 SequencerSetSelector SequencerFeatureSelector "ExposureTime"; ExposureTime 100; SequencerPathSelector SequencerSetNext SequencerTriggerSource FrameStart; SequencerSetSave; // Configuring set 2 SequencerSetSelector SequencerFeatureSelector "ExposureTime"; ExposureTime 50000; SequencerPathSelector SequencerSetNext SequencerTriggerSource FrameStart; SequencerSetSave; SequencerSetStart SequencerConfigurationMode "Off" SequencerMode "On" Node Name Description SequencerMode Controls if the sequencer mechanism is active. Controls if the sequencer configuration mode is SequencerConfigurationMode active.
Node Name Description applies. SequencerSetNext Specifies the next sequencer set. Specifies the internal signal or physical input line to SequencerTriggerSource use as the sequencer trigger source. Specifies the activation mode of the sequencer SequencerTriggerActivation trigger. Specifies the number of frames a particular SequencerSetFrameCount sequencer set will apply.
Node Name Description This feature controls parity used serial SerialParity communication. This feature controls the number of stop bits used for serial SerialStopBits communication. This feature controls the number of data bits used for serial SerialDataBits communication. This feature controls the flow control used for serial SerialFlowControl communication.
Node Name Description Selects which stream transfers are currently TransferSelector controlled by the selected Transfer features. TransferControlMode Selects the control method for the transfers. TransferOperationMode Selects the operation mode of the transfer. Specifies the number of data Blocks that the device TransferBlockCount should stream before stopping.
Node Name Description Category that contains the features pertaining to GigEVision the GigE Vision transport layer of the device. Number of frames in the packet resend window PacketResendWindowFrameCount used to calculate the total number of packets that can be resent in that period. Returns the number of received packet resend ReceivedPacketResendCount commands.
Page 73
Node Name Description generated on the given logical link. Controls whether the Link Local Address IP GevCurrentIPConfigurationLLA configuration scheme is activated on the given logical link. Controls whether DHCP GevCurrentIPConfigurationDHCP configuration scheme is activated on the given logical link. Controls whether Persistent GevCurrentIPConfigurationPersistentIP...
Page 74
Node Name Description GevGVCPPendingAck Enables the generation of PENDING_ACK. Controls the key to use to authenticate GevPrimaryApplicationSwitchoverKey primary application switchover requests. GevGVSPExtendedIDMode Enables the extended IDs mode. Controls the device access privilege of an GevCCP application. Returns the UDP source port of the GevPrimaryApplicationSocket primary application.
Node Name Description a GVSP transmitter or specifies the maximum packet size supported by a GVSP receiver. Controls the delay (in GEV timestamp GevSCPD counter unit) to insert between each packet for this stream channel. Controls the destination IP address of the selected stream channel to which a GVSP GevSCDA transmitter must send data stream or the...
Node Name Description Returns the latched offset from the PTP master clock in PtpOffsetFromMaster nanoseconds. If PtpOffsetFromMaster returns -1 then the synchronization has not started. PtpClockID Returns the latched clock ID of the PTP device. PtpParentClockID Returns the latched parent clock ID of the PTP device. PtpGrandmasterClockID Returns the latched grandmaster clock ID of the PTP device.
Need help?
Do you have a question about the CAM-CIC-12-9M-IP67 and is the answer not in the manual?
Questions and answers