Device Control
Device Control provides you with device information and allows you to control some device parameters.
General Information
Use Device User ID to enter a unique device name. This information is retained over power cycles.
Use Device Indicator Mode to control the status LED. The LED can be active, inactive, or in error mode.
Bandwidth
Information about the bandwidth usage and link speed is provided.
Use Device Link Throughput Limit to specify what bandwidth is used for the streaming of data. This affects the maximum frame rate. This must be less that the Device Max Throughput.
Timestamp
Use Timestamp Latch to capture the current timestamp of the device.
Power Supply
Use the Device Power Supply Selector to choose a power supply, either External or Sensor (Internal). External power can be either through the device interface or through GPIO.
Device Reset
Use Device Reset to soft reboot the camera. Use Factory Reset to clear any user tables loaded and perform a soft reboot of the camera.
Summary Table
| Name | Interface | Access | Visibility | Description |
|---|---|---|---|---|
| Device Temperature Selector | IEnumeration | Expert | Selects the location within the device, where the temperature will be measured. | |
| Device Scan Type | IEnumeration | RO | Expert | Scan type of the sensor of the device. |
| Device Sensor Chroma | IEnumeration | RO | Guru | Indicates whether the camera is polarized mono, mono or color. |
| Device Vendor Name | IStringReg | Beginner | Name of the manufacturer of the device. | |
| Device Model Name | IStringReg | Beginner | Model name of the device. | |
| Sensor Description | IStringReg | Guru | Returns Sensor Description | |
| Device Version | IStringReg | Beginner | Version of the device. | |
| Device Firmware Version | IStringReg | Beginner | Firmware version of the device. | |
| Device Serial Number | IStringReg | Expert | Device serial number. This string is a unique identifier of the device. | |
| Device User ID | IStringReg | Beginner | User Defined Name. This can be used to enter a unique device name. This information is retained over power cycles. | |
| Device TL Type | IEnumeration | RO | Beginner | Transport Layer type of the device. |
| Device Gen CP Version Major | IInteger | RO | Beginner | Major version of the GenCP protocol supported by the device. |
| Device Gen CP Version Minor | IInteger | RO | Beginner | Minor version of the GenCP protocol supported by the device. |
| Device Max Throughput | IInteger | RO | Expert | Maximum bandwidth(in bps) of the data that can be streamed out of the device. This can be used to estimate if the physical connection(s) can sustain transfer of free-running images from the camera at its maximum speed. |
| Device Link Speed | IInteger | RO | Guru | Link Speed |
| Device Link Throughput Limit | IInteger | RW | Expert | Limits the maximum bandwidth(in bps) of the data that will be streamed out by the device on the selected Link. If necessary, delays will be uniformly inserted between transport layer packets in order to control the peak bandwidth. |
| Device Link Bandwidth Reserve | IFloat | RW | Expert | Percentage of streamed data bandwidth reserved for packet resend. |
| Device Link Current Throughput | IInteger | RO | Expert | Current bandwidth(in bps) of streamed data. |
| Device Reset | ICommand | WO | Guru | This is a command that immediately resets and reboots the device. |
| Device Indicator Mode | IEnumeration | Expert | Controls the LED behaviour: Inactive (off), Active (current status), or Error Status (off unless an error occurs). | |
| Device Temperature [Device Temperature Selector] | IFloat | RO | Expert | Device temperature in degrees Celsius (C). |
| Timestamp Latch | ICommand | WO | Expert | Latches the current timestamp counter into TimestampLatchValue. |
| Timestamp Latch Value | IInteger | RO | Expert | Returns the latched value of the timestamp counter. |
| Timestamp Increment | IInteger | RO | Expert | Indicates the timestamp increment in ns/tick. |
| Device Uptime | IInteger | RO | Expert | Total time since the device was powered up in seconds. |
| Link Uptime | IInteger | RO | Expert | Time since the last phy negotiation (enumeration). |
| Enumeration Count | IInteger | RO | Expert | Number of enumerations since uptime. |
| Factory Reset | ICommand | WO | Guru | Returns all user tables to factory default |
| Max Device Reset Time | IInteger | RO | Expert | Time to wait until device reset complete (ms). |
Device Control Features
Device Temperature Selector
Selects the location within the device, where the temperature will be measured.
| Property | Value |
|---|---|
| Name | DeviceTemperatureSelector |
| Interface | IEnumeration |
| Access | |
| Visibility | Expert |
| Enumeration Values |
|---|
| Mainboard |
| SensorJunction |
Device Scan Type
Scan type of the sensor of the device.
| Property | Value |
|---|---|
| Name | DeviceScanType |
| Interface | IEnumeration |
| Access | RO |
| Visibility | Expert |
| Enumeration Values |
|---|
| Areascan |
Device Sensor Chroma
Indicates whether the camera is polarized mono, mono or color.
| Property | Value |
|---|---|
| Name | DeviceSensorChroma |
| Interface | IEnumeration |
| Access | RO |
| Visibility | Guru |
| Enumeration Values |
|---|
| Mono |
| RGB |
| NIR |
| PolarizationMono |
| PolarizationColor |
Device Vendor Name
Name of the manufacturer of the device.
| Property | Value |
|---|---|
| Name | DeviceVendorName |
| Interface | IStringReg |
| Access | |
| Visibility | Beginner |
Device Model Name
Model name of the device.
| Property | Value |
|---|---|
| Name | DeviceModelName |
| Interface | IStringReg |
| Access | |
| Visibility | Beginner |
Sensor Description
Returns Sensor Description
| Property | Value |
|---|---|
| Name | SensorDescription |
| Interface | IStringReg |
| Access | |
| Visibility | Guru |
Device Version
Version of the device.
| Property | Value |
|---|---|
| Name | DeviceVersion |
| Interface | IStringReg |
| Access | |
| Visibility | Beginner |
Device Firmware Version
Firmware version of the device.
| Property | Value |
|---|---|
| Name | DeviceFirmwareVersion |
| Interface | IStringReg |
| Access | |
| Visibility | Beginner |
Device Serial Number
Device serial number. This string is a unique identifier of the device.
| Property | Value |
|---|---|
| Name | DeviceSerialNumber |
| Interface | IStringReg |
| Access | |
| Visibility | Expert |
Device User ID
User Defined Name. This can be used to enter a unique device name. This information is retained over power cycles.
| Property | Value |
|---|---|
| Name | DeviceUserID |
| Interface | IStringReg |
| Access | |
| Visibility | Beginner |
Device TL Type
Transport Layer type of the device.
| Property | Value |
|---|---|
| Name | DeviceTLType |
| Interface | IEnumeration |
| Access | RO |
| Visibility | Beginner |
| Enumeration Values |
|---|
| GigEVision |
| CameraLink |
| CameraLinkHS |
| CoaXPress |
| USB3Vision |
| Custom |
Device Gen CP Version Major
Major version of the GenCP protocol supported by the device.
| Property | Value |
|---|---|
| Name | DeviceGenCPVersionMajor |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Beginner |
Device Gen CP Version Minor
Minor version of the GenCP protocol supported by the device.
| Property | Value |
|---|---|
| Name | DeviceGenCPVersionMinor |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Beginner |
Device Max Throughput
Maximum bandwidth(in bps) of the data that can be streamed out of the device. This can be used to estimate if the physical connection(s) can sustain transfer of free-running images from the camera at its maximum speed.
| Property | Value |
|---|---|
| Name | DeviceMaxThroughput |
| Interface | IInteger |
| Access | RO |
| Unit | Bps |
| Visibility | Expert |
Device Link Speed
Link Speed
| Property | Value |
|---|---|
| Name | DeviceLinkSpeed |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Guru |
Device Link Throughput Limit
Limits the maximum bandwidth(in bps) of the data that will be streamed out by the device on the selected Link. If necessary, delays will be uniformly inserted between transport layer packets in order to control the peak bandwidth.
| Property | Value |
|---|---|
| Name | DeviceLinkThroughputLimit |
| Interface | IInteger |
| Access | RW |
| Unit | Bps |
| Visibility | Expert |
Device Link Bandwidth Reserve
Percentage of streamed data bandwidth reserved for packet resend.
| Property | Value |
|---|---|
| Name | DeviceLinkBandwidthReserve |
| Interface | IFloat |
| Access | RW |
| Unit | % |
| Visibility | Expert |
Device Link Current Throughput
Current bandwidth(in bps) of streamed data.
| Property | Value |
|---|---|
| Name | DeviceLinkCurrentThroughput |
| Interface | IInteger |
| Access | RO |
| Unit | Bps |
| Visibility | Expert |
Device Reset
This is a command that immediately resets and reboots the device.
| Property | Value |
|---|---|
| Name | DeviceReset |
| Interface | ICommand |
| Access | WO |
| Visibility | Guru |
Device Indicator Mode
Controls the LED behaviour: Inactive (off), Active (current status), or Error Status (off unless an error occurs).
| Property | Value |
|---|---|
| Name | DeviceIndicatorMode |
| Interface | IEnumeration |
| Access | |
| Visibility | Expert |
| Enumeration Values |
|---|
| Inactive |
| Active |
| ErrorStatus |
Device Temperature
Device temperature in degrees Celsius (C).
| Property | Value |
|---|---|
| Name | DeviceTemperature [Device Temperature Selector] |
| Interface | IFloat |
| Access | RO |
| Unit | C |
| Visibility | Expert |
Timestamp Latch
Latches the current timestamp counter into TimestampLatchValue.
| Property | Value |
|---|---|
| Name | TimestampLatch |
| Interface | ICommand |
| Access | WO |
| Visibility | Expert |
Timestamp Latch Value
Returns the latched value of the timestamp counter.
| Property | Value |
|---|---|
| Name | TimestampLatchValue |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Expert |
Timestamp Increment
Indicates the timestamp increment in ns/tick.
| Property | Value |
|---|---|
| Name | TimestampIncrement |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Expert |
Device Uptime
Total time since the device was powered up in seconds.
| Property | Value |
|---|---|
| Name | DeviceUptime |
| Interface | IInteger |
| Access | RO |
| Unit | s |
| Visibility | Expert |
Link Uptime
Time since the last phy negotiation (enumeration).
| Property | Value |
|---|---|
| Name | LinkUptime |
| Interface | IInteger |
| Access | RO |
| Unit | s |
| Visibility | Expert |
Enumeration Count
Number of enumerations since uptime.
| Property | Value |
|---|---|
| Name | EnumerationCount |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Expert |
Factory Reset
Returns all user tables to factory default
| Property | Value |
|---|---|
| Name | FactoryReset |
| Interface | ICommand |
| Access | WO |
| Visibility | Guru |
Max Device Reset Time
Time to wait until device reset complete (ms).
| Property | Value |
|---|---|
| Name | MaxDeviceResetTime |
| Interface | IInteger |
| Access | RO |
| Unit | ms |
| Visibility | Expert |
