Contents Before you start About this manual 1.1.1 Tips and notes 1.1.2 Registered trademarks 1.1.3 Conformity and use 1.1.4 Supplements Warranty and non-warranty clause Support Introduction Configuring the camera Reading the XML file Bootstrap CoaXPress control Overview Controls 3.2.1 Standard 3.2.2 Revision 3.2.3...
Before you start About this manual This manual contains helpful information to install and operate the described cam- era. It has been produced with care. Nevertheless, information might be erroneous or incomplete. SVS-Vistek GmbH cannot be held responsible for any problems resulting from incomplete or erroneous information.
1.1.3 Conformity and use This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15 of the FCC Rules. These requirements are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment.
Pour les utilisateurs au Canada Cet appareil est conforme aux normes Classe A pour bruits radioélectriques, spé- cifiées dans le Règlement sur le brouillage radioélectrique. Life support applications The products described in this manual are not designed for use in life support appli- ances or devices and systems where malfunction of these products can reasonably be expected to result in personal injury.
Introduction Configuring the camera All CXP cameras are compliant to the CoaXPress specification. CoaXPress stand- ardizes downlink and uplink protocols, interfaces, cables, and connectors used by CoaXPress compliant cameras and frame grabbers. All cameras use GenICam, a standardized generic programming interface. It is used to configure and control the camera and supports five main features: Camera configuration Frame acquisition...
Page 11
Example <Command Name="AcquisitionStart"> <ToolTip>Starts the Acquisition of device.</ToolTip> <Description>Starts the Acquisition of the device.</Description> <DisplayName>Acquisition Start</Dis- playName> <Visibility>Beginner</Visibility> <pValue>AcquisitionStartReg</pValue> <CommandValue>0</CommandValue> </Command> <IntReg Name="AcquisitionStartReg"> <Address>0x8204</Address> <Length>4</Length> <AccessMode>WO</AccessMode> <pPort>Device</pPort> <Endianess>BigEndian</Endianess> </IntReg> </Group> <Port Name="Device"> <ToolTip>Port giving access to the device.</ToolTip> </Port> INFO All integer values are interpreted as 32 bit unsigned integers, if not other mentioned.
Bootstrap CoaXPress control Overview CoaXPress compliant devices have to support a number of bootstrap registers. In con- trast to other camera features each bootstrap register is assigned to a fixed camera address as it is defined in the CoaXPress specification. Bootstrap registers are defined for device information and allow frame grabbers to establish and maintain the connection between host and camera in a standardized way.
3.2.2 Revision This control returns the revision of the CoaXPress specification implemented by this device. Access Read Type Unsigned integer Bits 31 - 16: major revision Bits 15 - 00: minor revision Remark Example: Devices compliant to revision 1.1 of the spe- cification shall return the value 0x00010001.
3.2.5 XmlVersion This control provides the version number for the XML file given in the manifest ref- erenced by the register XmlManifestSelector. Access Read Type Unsigned integer Bits 31 - 24: reserved; shall be 0 Bits 23 - 16: SchemaMajorVersion; major version number of the XML file Bits 15 - 8: SchemaMinorVersion;...
3.2.7 XmlUrlAddress This control indicates the start of the URL string referenced by the register XmlMani- festSelector. INFO SVS-Vistek GmbH does not support strings that reference a XML file located on the vendor's homepage. Access Read Type Unsigned integer — Register address Remarks Reading the returned register returns the name, register...
3.2.8 Iidc2Address This control is meant for devices supporting the IIDC2 protocol (section 2.2 ref. 6) and provides the starting address of the IIDC2 register space. INFO This feature is currently not supported. Access Read Type Unsigned integer 0x00000000 3.2.9 DeviceVendorName This control provides the name of the manufacturer of the device as a string.
3.2.12 DeviceVersion This register contains the string with the version number of the connected device. Access read Type string — version number of the device Offset hex C4 3.2.13 DeviceSerialNumber This control provides the serial number for the device as a NULL-terminated string. Access Read Type...
3.2.16 HeightAddress Manufacturer-specific address of the ROI height. Access Read Type Integer 3.2.17 AcquisitionModeAddress Manufacturer-specific address of the feature AcquisitionMode. Access Read Type Integer 3.2.18 AcquisitionStartAddress Manufacturer-specific address of the feature AcquisitionStart. Access Read Type Integer 3.2.19 AcquisitionStopAddress Manufacturer-specific address of the feature AcquisitionStop. Access Read Type...
3.2.20 PixelFormatAddress Manufacturer-specific address of the feature PixelFormat. Access Read Type Integer 3.2.21 DeviceTapGeometryAddress Manufacturer-specific address of the feature DeviceTapGeometry. Access Read Type Integer 3.2.22 Image1StreamIDAddress Manufacturer-specific address of the feature Image1StreamID. Access Read Type Integer 3.2.23 Image2StreamIDAddress Manufacturer-specific address of the feature Image2StreamID. Access Read Type...
3.2.24 ConnectionReset Writing 0x00000001 into this register will reset the connection of the device. NOTE It is not possible to read this register while it has the value 0x00000001. Access Read / write Type Unsigned integer 0x00000001 0x00000000 Remark A link reset will stop a running image acquisition. A connection reset command via the master connection (no.
3.2.27 ControlPacketSizeMax Provides the maximum control packet size the host can read from the device or write to the device. The size is defined in Bytes and will be a multiple of 4 Bytes. The defined size is that of the entire packet, not only the payload. Access Read Type...
3.2.30 ConnectionConfigDefault This control provides the value of the ConnectionConfig register that allows the Device to operate in default mode. This feature is used to start the camera with the default configuration that is stored in the custom profiles. Access Read Type Unsigned integer...
3.2.33 TestErrorCount This register provides the current connection error count for the connection referred to by the register TestErrorCountSelector. Access Read / write Type Unsigned integer 0x00000000 Error count Remarks Writing 0x00000000 to this register resets the error count for the connector referred to by the register TestEr- rorCountSelector to zero.
3.2.36 CapabilityRegister Indicates which optional features are supported. Access read Type Integer 3.2.37 FeatureControlRegister Enables and disables optional device features. Access read / write Type Integer 3.2.38 VersionsSupported Indicates which CXP versions are supported. Access read Type Integer 3.2.39 VersionUsed Indicates the version of the CoaXPress specification used for communication between device and host.
Acquisition control Overview NOTICE Some settings can only be changed if image acquisition is stopped. The following commands allow to make settings required for image acquisition and to control an external trigger. Display name Access Length [Bytes] Register Interface Acquisition Mode Enumeration Acquisition Start Command...
4.2.2 AcquisitionStart Starts the Acquisition of the device. The number of frames captured is specified by AcquisitionMode. Access Write Type Command 0x00000001 Remark AcquisitionMode defines how frames will be acquired 4.2.3 AcquisitionStop This feature stops acquiring frames after the acquisition of the current frame has been completed.
4.2.5 AcquisitionFrameRate This feature defines the acquisition rate in [Hz] when TriggerMode is OFF. INFO If TriggerMode = ON, AcquisitionFrameRate will be disabled. Access Read / write Type Unsigned integer Lowest to highest possible frame rate For frame rates, refer to the technical data sheet in the User Guide.
4.2.7 TriggerMode This feature activates or deactivates the trigger type selected by the feature Trig- gerSelector. Access Read / write Type Enumeration ON: Enables the selected trigger type; the camera waits for a trigger signal before acquiring a frame. The trigger signal can be a signal from the frame grabber, the 12- pin Hirose connector input, or a software trigger initiated by a software command.
4.2.9 TriggerSource This feature defines the source of the trigger signal. Access Read / write Type Enumeration line0 / line1: CXP cameras offer one trigger input with two physical lines via the 12-pin Hirose connector; the trigger signal can either be sent via line 0 or line 1. Software: if TriggerSoftware is set, the trigger will be gen- erated by the software using the feature Trigger‐...
Access Read / Write Type Integer Min: "0" Max: "0" The number of counted trigger signals Remarks Zero is the only value accepted and is used to reset the trig- ger counter. 4.2.12 TriggerDebouncer In TriggerDebouncer the debounce period is defined. This period starts with the occur- rence of a trigger edge.
4.2.14 ExposureTime If the exposure mode is set to "Timed" or no hardware trigger is defined, this feature defines the duration of exposure [µs]. Access Read / write Type Unsigned integer 1 … highest possible exposure time Current exposure time Remark Incremented by 1 4 Acquisition control...
Transport layer control Overview User sets can be saved into the camera’s internal Flash memory. A user set can be loaded at runtime. If a user set is defined as default, it will be loaded during the start- up of the camera. Display name Access Length [Bytes]...
5.2.2 TLParamsLocked Access Read/write Type Integer 5.2.3 CxpLinkConfigurationStatus Current and active link configuration of the device. Access read Type enumeration CXP3_X1 CXP3_X2 CXP3_X4 CXP6_X1 CXP6_X2 CXP6_X4 CXP12_X1 CXP12_X2 CXP12_X4 5.2.4 CxpLinkConfigurationPreferred Provides the default link configuration of the device. Access Type enumeration CXP3_X1...
5.2.5 CxpLinkConfiguration Specifies the link configuration of the device. Access Type enumeration CXP3_X1 CXP3_X2 CXP3_X4 CXP6_X1 CXP6_X2 CXP6_X4 CXP12_X1 CXP12_X2 CXP12_X4 5.2.6 CxpConnectionSelector Selects the CoaXPress physical connection to the control. Access Type integer 0 ... 3, increment by 1 5.2.7 CxpConnectionTestMode Enables the test mode.
5.2.9 CxpConnectionTestPacketCount Returns the 64bit test packet receive counter, selected by CxpConnectionSelector. Access Type integer Min: 0, representation: linear 5 Transport layer control...
Image format control Overview These commands allow to set the size of the image, the so called region of interest (ROI). A ROI - like the red field in the figure below - defines the part of an image to be scanned.
Controls 7.2.1 SensorWidth Effective width of the sensor in pixels. Access Read only Type Unsigned integer Sensor width 7.2.2 SensorHeight Effective height of the sensor in pixels. Access Read only Type Unsigned integer Sensor height 7.2.3 WidthMax Maximum width (in pixels) of the image. Access Read only Type...
7.2.5 RegionDestination This control selects the destination of the image stream. Access Read / write Type Enumeration stream0 Region destination 7.2.6 Width This feature provides the image width in pixels. Access Read / write Type Unsigned integer Min: 128 px Max: Sensor width Image width Remark...
7.2.9 OffsetY Vertical offset from the origin to the region of interest in pixels. Access Read / write Type Unsigned integer Min.: 0 px Max.: Sensor height -32 px Vertical offset Remark Incremented by 32 px 7.2.10 Binning Enables or disables horizontal and vertical pixel binning of the sensor. Access read / write Type...
7.2.11 PixelFormat This feature returns the bit format the camera uses for acquisition. The default format is 8 bit. It can be changed to 10 bit or 12 bit, respectively. For colourcameras, the order of the Bayer pattern can be selected. Access Read / write Type...
7.2.14 Image2StreamID This feature returns the stream ID of the second image stream of the device. Access Read only Type Unsigned integer 0x00000000 7 Image format control...
Analog control Overview Display name Access Length [Bytes] Interface Enumeration Gain Selector Gain Float Integer Black Level Gamma Float Controls 8.2.1 GainSelector Selects which gain is controlled by the various gain features. After selecting, the set- tings for the corresponding gain can be defined. Access Read / write Type...
8.2.3 BlackLevel Black level defines the brightness in the darkest part of the image. Possible black level settings are values between 0 and 255. If the setting is correct, the sensor will deliver the pixel value 0 for a completely black image. If it is too high, the sensor will deliver a pixel value greater than 0 for black which means a shade of gray.
Digital I/O control Overview Length Display name Access [Bytes] Interface Enumeration Line Selector Enumeration Line Source Enumeration Line Inverter Enumeration User Output Selector Boolean User Output Value Controls 9.2.1 LineSelector This feature selects the physical output line to be configured with the commands LineSource and LineInverter.
9.2.2 LineSource This feature defines which signal will apply at the output selected with LineSelector. Access Read / write Type Enumeration ExposureActive: STRB (0) StreamTransferActive: data transmission state (1) ExtTriggerSignalState: state of the external trigger (2) UserOutput0: state of the user output bit 0 UserOutput1: state of the user output bit 1 Selected signal Remark...
9.2.5 UserOutputValue This feature allows to define the output level of the variable selected by User- OutputSelector. This static output level can be routed to a physical output with the fea- ture LineSource. Access Read / write Type Boolean high = 1 low = 0 Status of the bit Remark...
User set control 10.1 Overview User sets can be saved into the camera’s internal Flash memory. A user set can be loaded at runtime. If a user set is defined as default, it will be loaded during the start- up of the camera. Display name Access Length [Bytes]...
10.2.2 UserSetLoad Loads the user set specified in UserSetSelector from the camera flash memory to the camera registers and activates it. Access Write Type Command Remark If the selected User Set has not been defined previously an error message occurs. The default user set is a set of factory settings.
6. Execute the operation. 7. Close the file. Starting with the access offset, the defined number of bytes will be written into the buf- fer. 11.2 Controls 11.2.1 FileSelector This command selects one of the available files stored in the camera flash memory. Access Read / write Type...
11.2.4 FileOpenMode This feature selects the access mode in which a file is opened. Access Read / write Type Unsigned integer Read: Reads from the file, 0x00000001 Write: Writes into the file, 0x00000002 ReadWrite: Reads from and writes into the file, 0x00000010 11.2.5 FileAccessBuffer...
11.2.7 FileAccessLength Defines the number of bytes to be read from the selected file in the buffer. Access Read / write Type Integer Number of Bytes to be read/written to or from the file Remark access length ≤ file length ‐ access offset 11.2.8 FileOperationStatus This feature displays the file operation execution status of the selected file.
Page 55
Access Read Type Integer File size in bytes Remarks The number of successfully written bytes is only displayed when the values for file length and file offset have been defined. 11 File access control...
Custom features 12.1 Overview Custom features are manufacturer specific camera functions and therefore are not defined in the standard naming convention. Access Length [Bytes] Interface Display name Enumeration Device Information Selector Integer Device Information Boolean Frame Counter Info Enable Boolean Time Stamp Enable Boolean ROI Info Enable...
12.2 Controls 12.2.1 DeviceInformationSelector This feature selects one of the elements from the device information list. Access Read / write Type Enumeration InfoSnr: serial number of the camera (same as feature DeviceID) InfoType: camera type / model InfoSubType: camera sub type InfoHwRevision: camera hardware revision InfoFpgaVersion: camera FPGA program version InfoSwVersion: microcontroller software version...
12.2.2 DeviceInformation This feature returns a value of the device information list selected by feature DeviceIn- foSelector. Access Read / write Type Unsigned integer Device information values: InfoSnr: serial number of the camera (same as feature DeviceID); e.g. 0x00000132 InfoType: camera type/model; e.g.: 0x00001066 for camera model MC1066 InfoSubType: sub type number of the camera model;...
12.2.3 InfoFieldFrameCounterEnable This feature enables or disables the Frame Counter that can be added to the info field in the image. If this option is enabled, a frame counter will be superimposed upon each captured frame or ROI. The frame counter occupies 4 pixels in the upper left corner of each frame starting with pixel number "0".
12.2.5 InfoFieldRoiEnable This feature enables or disables the ROI info field in the image. If this option is enabled, ROI info data will be superimposed upon each captured frame or ROI. The ROI info occupies 8 pixels in the upper left corner of each frame, starting with pixel number 8.
Page 61
12.2.7 NumberOFConnections This feature displays the number of available CXP connections. Access Read/write Type Integer Number of connections 12.2.8 DefectPixelCorrection This feature switches the defect pixel correction on or off. Access Read / write Type Enumeration ON: defect pixel correction is enabled OFF: defect pixel correction is disabled Status (ON/OFF) Remark...
Page 62
12.2.11 FanRpm This feature displays the speed of the camera fan in rotations per minute. INFO This setting only applies to cameras with an attached fan, i.e cameras with an “F” in the model name (“MC1066F”). Access Read Interface Integer Range 0 …...
Need help?
Do you have a question about the SVS-Vistek CoaXPress EoSens 10CXP2 and is the answer not in the manual?
Questions and answers