Device Vendor Name
Name | DeviceVendorName | Standard |
|---|---|---|
Description | Name of the manufacturer of the device. | |
Interface | String | |
String length | 32 | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | Chromasens GmbH | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Model Name
Name | DeviceModelName | Standard |
|---|---|---|
Description | Model of the device. | |
Interface | String | |
String length | 32 | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | - | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Manufacturer Info
Name | DeviceManufacturerInfo | Standard |
|---|---|---|
Description | Manufacturer information about the device. | |
Interface | String | |
String length | 48 | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | - | |
Default value | “Email: support@chromasens.de” | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Version
Name | DeviceVersion | Standard |
|---|---|---|
Description | Version of the device. | |
Interface | String | |
String length | 32 | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | - | |
Default value | "SX-MX-TX-P1XX-P2XX" | |
Availability | ALL | |
Notes | String contains hardware version of Sensor, Mainboard, Transport layer interface, Power1 and Power2 | |
Error behavior | - | |
Device User ID
Name | DeviceUserID | Standard |
|---|---|---|
Description | User-programmable device identifier. | |
Interface | String | |
String length | 16 | |
Access mode | Read/Write | |
Adjustable while grabbing | Yes | |
Value range | - | |
Default value | Empty String | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Scan Type
Name | DeviceScanType | Standard |
|---|---|---|
Description | Scan type of the sensor. | |
Interface | Enumeration | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | See enum entry table below. | |
Default value | - | |
Availability | ALL | |
Notes | Even though the camera is a line scan device, this feature is set to Areascan. | |
Error behavior | - | |
Device Scan Type Enum Entries:
Name | Description |
|---|---|
Areascan | The camera is operating in area scan mode |
Linescan | The camera is operating in line scan mode |
Device Package Version
Name | DevicePackageVersion | Custom |
|---|---|---|
Description | Version of the software package of the camera. The version is defined in the package description file. By querying the DevicePackageConsistency feature you can check whether a package is consistent. | |
Interface | String | |
String length | 16 | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | - | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Package Description
Name | DevicePackageDescription | Custom |
|---|---|---|
Description | Description of the device’s software package. | |
Interface | String | |
String length | 64 | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | - | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Package Consistency
Name | DevicePackageConsistency | Custom |
|---|---|---|
Description | Executes a package consistency check. Is set to True if the package is consistent otherwise it is set to False. A package is consistent if the files on the camera correspond to the files in the package description file. | |
Interface | Boolean | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | False: Package is not consistent True: Package is consistent | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Sensor File Version
Name | DeviceSensorFileVersion | Custom |
|---|---|---|
Description | Version of the sensor file in the device. | |
Interface | String | |
String length | 40 | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | - | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Hardware Calibration File Version
Name | DeviceHWCalibFileVersion | Custom |
|---|---|---|
Description | Version of the Hardware Calibration File in the device. | |
Interface | String | |
String length | 16 | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | - | |
Default value | - | |
Availability | ALL | |
Notes | Returns -NA- if the file is not available in the camera. | |
Error behavior | - | |
Device Firmware Version
Name | DeviceFirmwareVersion | Standard |
|---|---|---|
Description | Version of the firmware in the device. | |
Interface | String | |
String length | 64 | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | - | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device FPGA Version
Name | DeviceFPGAVersion | Custom |
|---|---|---|
Description | Version of the FPGA in the device. | |
Interface | String | |
String length | 16 | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | - | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Product Number
Name | DeviceProductNumber | Custom |
|---|---|---|
Description | Product number of the device. | |
Interface | String | |
String length | 32 | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | - | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Serial Number
Name | DeviceSerialNumber | Standard |
|---|---|---|
Description | Serial number of the device. | |
Interface | String | |
String length | 32 | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | - | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device SFNC Version Major
Name | DeviceSFNCVersionMajor | Standard |
|---|---|---|
Description | Major version of the Standard Features Naming Convention that was used to create the device’s GenICam XML. | |
Interface | Integer | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | >0 | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device SFNC Version Minor
Name | DeviceSFNCVersionMinor | Standard |
|---|---|---|
Description | Minor version of the Standard Features Naming Convention that was used to create the device’s GenICam XML. | |
Interface | Integer | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | ≥0 | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Device SFNC Version SubMinor
Name | DeviceSFNCVersionSubMinor | Standard |
|---|---|---|
Description | Sub-minor version of the Standard Features Naming Convention that was used to create the device’s GenICam XML. | |
Interface | Integer | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | ≥0 | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Device Manifest XML Major Version
Name | DeviceManifestXMLMajorVersion | Standard |
|---|---|---|
Description | Indicates the major version number of the GenICam XML file of the selected manifest entry. | |
Interface | Integer | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | - | |
Default value | ≥0 | |
Availability | ALL | |
Notes | - | |
Error behavior | The XML version should match the DeviceFirmwareVersion. | |
Device Manifest XML Minor Version
Name | DeviceManifestXMLMinorVersion | Standard |
|---|---|---|
Description | Indicates the minor version number of the GenICam XML file of the selected manifest entry. | |
Interface | Integer | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | ≥0 | |
Default value | - | |
Availability | ALL | |
Notes | The XML version should match the DeviceFirmwareVersion. | |
Device Manifest XML Sub Minor Version
Name | DeviceManifestXMLSubMinorVersion | Standard |
|---|---|---|
Description | Indicates the sub-minor version number of the GenICam XML file of the selected manifest entry. | |
Interface | Integer | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | ≥0 | |
Default value | - | |
Availability | ALL | |
Notes | The XML version should match the DeviceFirmwareVersion. | |
Device Manifest XML Extra Version
Name | DeviceManifestXMLExtraVersion | Standard |
|---|---|---|
Description | Indicates the extra version (pre-relase/build metadata) of the GenICam XML file of the selected manifest entry. | |
Interface | String | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | String | |
Default value | - | |
Availability | ALL | |
Notes | The XML version should match the DeviceFirmwareVersion. | |
Device Temperature Selector
Name | DeviceTemperatureSelector | Standard |
|---|---|---|
Description | Selects the location within the device, where the temperature will be measured. | |
Interface | Enumeration | |
Access mode | Read/Write | |
Adjustable while grabbing | - | |
Value range | See enum entry table below. | |
Default value | Mainboard | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Temperature Selector Enum Entries:
Name | Description |
|---|---|
Mainboard | Temperature of the mainboard |
FPGA | Temperature of the FPGA. This is only available for EVO |
Power1 | Temperature of the power module 1 |
Power2 | Temperature of the power module 2 |
Sensor | Temperature of the sensor |
Device Temperature
Name | DeviceTemperature[DeviceTemperatureSelector] | Standard |
|---|---|---|
Description | Device temperature in degrees Celsius. | |
Interface | Float | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | ||
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Voltage Selector
Name | DeviceVoltageSelector | Custom |
|---|---|---|
Description | Selects a voltage source. | |
Interface | Enumeration | |
Access mode | Read/Write | |
Adjustable while grabbing | - | |
Value range | See enum entry table below. | |
Default value | Channel1 | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
allPIXA evo
Device Voltage Selector Enum Entries:
Name | Description |
|---|---|
Channel1 | Channel1 is 1V0_FPGA |
Channel2 | Channel2 is 1V8_FPGA |
Channel3 | Channel3 is 2V5_FPGA |
Channel4 | Channel4 is 3V3_VCC_FPGA |
Channel5 | Channel5 is 1V35_GTX |
Channel6 | Channel6 is 1V8_CIS (Sensor voltage varies for each sensor) |
Channel7 | Channel7 is 3V3_CIS (Sensor voltage varies for each sensor) |
Channel8 | Channel8 is 3V3_INTERF |
Channel9 | Channel9 is VCCINT at FPGA. |
Channel10 | Channel10 is VCCAUX at FPGA |
Channel11 | Channel11 is VCCBRAM at FPGA |
allPIXA neo
Device Voltage Selector Enum Entries:
Name | Description |
|---|---|
Channel1 | Channel1 is VCCINT at FPGA |
Channel2 | Channel2 is VCCAUX at FPGA |
Channel3 | Channel3 is VP_VN. Currently not valid |
Channel4 | Channel4 is VCCBRAM at FPGA |
Channel5 | Channel5 is +5V at power multiplexer |
Channel6 | Channel6 is 1V5_CIS (Sensor Voltage) at FPGA |
Channel7 | Channel7 is +24V voltage at input main power (power cable) |
Channel8 | Channel8 is 3V5_CIS (Sensor Voltage) at FPGA |
Channel9 | Channel9 is VCCAUX at pmic |
Channel10 | Channel10 is MGTAVCC at pmic |
Channel11 | Channel11 is MGTVCCAUX at pmic |
Channel12 | Channel12 is MGTAVTT at pmic |
Channel13 | Channel13 is SENS_3V5 at pmic |
Channel14 | Channel14 is SENS_1V5 at pmic |
Channel15 | Channel15 is IO_1V5 at pmic |
Channel16 | Channel16 is IO_3V3 at pmic |
Device Voltage
Name | DeviceVoltage[DeviceVoltageSelector] | Custom |
|---|---|---|
Description | Displays the voltage for the selected element. | |
Interface | Integer | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | - | |
Default value | - | |
Availability | ALL | |
Notes | The unit of this feature is mV. | |
Error behavior | - | |
Device Fan Enable
Name | DeviceFanEnable | Custom |
|---|---|---|
Description | Enables the camera's fan. | |
Interface | Boolean | |
Access mode | Read/Write | |
Adjustable while grabbing | Yes | |
Value range | True – Enables the output of an IO to activate a fan connected to the device. False – Disables the output of an IO to disable a fan connected to the device. | |
Default value | False | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Identify
Name | DeviceIdentify | Custom |
|---|---|---|
Description | Increases heartbeat speed for a short time to identify the camera. | |
Interface | Command | |
Access mode | Write only | |
Adjustable while grabbing | Yes | |
Value range | 1 | |
Default value | 1 | |
Availability | ALL | |
Notes | While grabbing images you will not see the heartbeat. Therefore, this only takes effect if the acquisition is not active. | |
Error behavior | - | |
Device Reset
Name | DeviceReset | Standard |
|---|---|---|
Description | Resets the device to its power-up state. | |
Interface | Command | |
Access mode | Write only | |
Adjustable while grabbing | Yes | |
Value range | 1 | |
Default value | 1 | |
Availability | ALL | |
Notes | This command always returns success. If you execute this command, the camera performs a power cycle. Afterwards you must reconnect to the camera. | |
Error behavior | - | |
Device Error Code
Name | DeviceErrorCode | Custom |
|---|---|---|
Description | Most recent error status of the camera. | |
Interface | Integer | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | See Device Error Code section for possible values. | |
Default value | 0x00000000 | |
Availability | ALL | |
Notes | Reads the most recent error. Zero indicates no error. Any other value indicates an error. If a write access to any register is performed (except bootstrap registers), the device error code is cleared. The DeviceErrorMessage feature holds the corresponding error description. | |
Error behavior | - | |
Device Error Message
Name | DeviceErrorMessage | Custom |
|---|---|---|
Description | Device error messages to the corresponding device error codes. | |
Interface | Enumeration | |
Access mode | Read Only | |
Adjustable while grabbing | - | |
Value range | See enum entry table below. | |
Default value | Success | |
Availability | ALL | |
Notes | This feature is “Invisible” The device error message consists of the tool tip and display name of the enum entry. Please check section Device Error Code too. There you will find the description of the enum entries. | |
Error behavior | - | |
Device Status
Name | DeviceStatus | Custom |
|---|---|---|
Description | Device status to the corresponding device status codes. | |
Interface | Enumeration | |
Access mode | Read Only | |
Adjustable while grabbing | - | |
Value range | See enum entry table below. | |
Default value | OK | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Status Enum Entries:
Name | Description |
|---|---|
DEV_STATUS_WARNING_TEMPERATURE_TOO_HIGH | Warning: Device temperature high. |
DEV_STATUS_ERROR_TEMPERATURE_TOO_HIGH | Error: Device temperature too high. |
DEV_STATUS_ERROR_ILLUM_TEMPERATURE_TOO_HIGH | Error: Illumination temperature too high. |
DEV_STATUS_ERROR_ILLUM_LED_ERROR | Error: Illumination Error. |
SENSOR_STATUS_G8_PGOOD_ERROR | Error: G8 sensor PGOOD error. |
SENSOR_STATUS_G8_TRAINING_DONE_ERROR | Error: G8 sensor training done error. |
TL_STATUS_WARNING_CXP_LINK_CONFIGURATION | Warning: Cxp link configuration invalid. |
TL_STATUS_WARNING_LICENSING_AUTHENTICATION_FAILED | Warning: License authentication failed. It is in evaluation mode, the stream channel will be closed after 20-30min. |
Device Log Level
Name | DeviceLogLevel | Standard |
|---|---|---|
Description | Selects the current log level. | |
Interface | Enumeration | |
Access mode | Read/Write | |
Adjustable while grabbing | - | |
Value range | See enum entry table below. | |
Default value | Info | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Log Level Enum Entries:
Name | Description |
|---|---|
Error | Only Error logging will be shown. |
Warning | Only Warning logging will be shown. |
Info | Only Info logging will be shown. |
Verbose | Only Verbose logging will be shown. |
Debug | Only Dedug logging will be shown. |
Device TL Type
Name | DeviceTLType | Standard |
|---|---|---|
Description | Transport Layer type of the device. | |
Interface | Enumeration | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | See enum entry table below. | |
Default value | GigEVision | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device TL Type Enum Entries:
Name | Description |
|---|---|
GigEVision | GigE Vision |
Device Link Selector
Name | DeviceLinkSelector | Standard |
|---|---|---|
Description | Selects which link of the device to control. | |
Interface | Integer | |
Access mode | Read/Write | |
Adjustable while grabbing | - | |
Value range | 0 | |
Default value | 0 | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Link Connection Count
Name | DeviceLinkConnectionCount[DeviceLinkSelector] | Standard |
|---|---|---|
Description | Returns the number of physical connections of the device used by a particular Link. | |
Interface | Integer | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | ≥0 | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Link Speed
Name | DeviceLinkSpeed[DeviceLinkSelector] | Standard |
|---|---|---|
Description | Indicates the speed of transmission negotiated on the specified link. | |
Interface | Integer | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | ≥0 | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device TL Version Major
Name | DeviceTLVersionMajor | Standard |
|---|---|---|
Description | Major version of the Transport Layer of the device. | |
Interface | Integer | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | ≥0 | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device TL Version Minor
Name | DeviceTLVersionMinor | Standard |
|---|---|---|
Description | Minor version of the Transport Layer of the device. | |
Interface | Integer | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | ≥0 | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device TL Version Sub Minor
Name | DeviceTLVersionSubMinor | Standard |
|---|---|---|
Description | Sub-minor version of the Transport Layer of the device. | |
Interface | Integer | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | ≥0 | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Registers Endianness
Name | DeviceRegistersEndianness | Standard |
|---|---|---|
Description | Endianness of the registers of the device. | |
Interface | Enumeration | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | See enum entry table below. | |
Default value | Big | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Registers Endianness Enum Entries:
Name | Description |
|---|---|
Little | Device’s registers are little Endian |
Big | Device’s registers are big Endian |
Device Character Set
Name | DeviceCharacterSet | Standard |
|---|---|---|
Description | Character set used by the strings of the device’s bootstrap registers. | |
Interface | Enumeration | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | See enum entry table below. | |
Default value | UTF8 | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Character Set Enum Entries:
Name | Description |
|---|---|
UTF8 | UTF 8 |
Device Event Channel Count
Name | DeviceEventChannelCount | Standard |
|---|---|---|
Description | Indicates the number of event channels supported by the device. | |
Interface | Integer | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | ≥0 | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Stream Channel Count
Name | DeviceStreamChannelCount | Standard |
|---|---|---|
Description | Indicates the number of streaming channels supported by the device. | |
Interface | Integer | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | ≥0 | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Link Heartbeat Timeout
Name | DeviceLinkHeartbeatTimeout | Standard |
|---|---|---|
Description | Controls the current heartbeat timeout of the specific Link. | |
Interface | Float | |
Access mode | Read/Write | |
Adjustable while grabbing | Yes | |
Value range | ≥500000.0 | |
Default value | - | |
Availability | ALL | |
Notes | The unit is micro-seconds (μs) | |
Error behavior | - | |
Device Stream Channel Endianness
Name | DeviceStreamChannelEndianness | Standard |
|---|---|---|
Description | Endianness of multi-pixel data for this stream. | |
Interface | Enumeration | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | See enum entry table below. | |
Default value | Little | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Device Stream Channel Endianness Enum Entries:
Name | Description |
|---|---|
Little | Stream channel data is little Endian. |
Big | Stream channel data is big Endian. |
Timestamp Reset
Name | TimestampReset | Standard |
|---|---|---|
Description | Resets the current value of the device timestamp counter. | |
Interface | Command | |
Access mode | Write only | |
Adjustable while grabbing | Yes | |
Value range | 1 | |
Default value | 1 | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Timestamp Latch
Name | TimestampLatch | Standard |
|---|---|---|
Description | Latches current timestamp counter into TimestampLatchValue. | |
Interface | Command | |
Access mode | Write only | |
Adjustable while grabbing | Yes | |
Value range | 1 | |
Default value | 1 | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |
Timestamp Latch Value
Name | TimestampLatchValue | Standard |
|---|---|---|
Description | Returns the latched value of the timestamp counter. | |
Interface | Integer | |
Access mode | Read only | |
Adjustable while grabbing | - | |
Value range | ≥0 | |
Default value | - | |
Availability | ALL | |
Notes | - | |
Error behavior | - | |