Camera nodes

Lists all the pre-listed nodes of the Camera.

Classes:

CameraNodes

Lists all the pre-listed nodes of the Camera.

TLDevNodes

Lists all the pre-listed nodes of the Camera transport layer device.

TLStreamNodes

Lists all the pre-listed nodes of the Camera transport layer stream.

class CameraNodes(camera)

Bases: object

Lists all the pre-listed nodes of the Camera.

Warning

Do not create a CameraNodes manually, rather get it from camera_nodes that is automatically created when the camera is instantiated.

Warning

Once the associated camera is freed, the nodes are not valid anymore.

Note

Even though the nodes are pre-listed, it is simply a convenience and the same nodes can be gotten by name through NodeMap. Additionally, you must check that the node is actually available, readable etc, even if it’s pre-listed.

Some nodes are available before init_cam(), but other nodes, even those pre-listed, become available only after init_cam().

Attributes:

AasRoiEnable

Controls whether a user-specified ROI is used for auto algorithm that is currently selected by the AutoAlgorithmSelector feature.

AasRoiHeight

Controls the width of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature.

AasRoiOffsetX

Controls the x-offset of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature.

AasRoiOffsetY

Controls the y-offset of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature.

AasRoiWidth

Controls the width of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature.

AcquisitionAbort

Aborts the Acquisition immediately.

AcquisitionArm

Arms the device before an AcquisitionStart command.

AcquisitionBurstFrameCount

This feature is used only if the FrameBurstStart trigger is enabled and the FrameBurstEnd trigger is disabled.

AcquisitionFrameCount

Number of images to acquire during a multi frame acquisition.

AcquisitionFrameRate

User controlled acquisition frame rate in Hertz

AcquisitionFrameRateEnable

If enabled, AcquisitionFrameRate can be used to manually control the frame rate.

AcquisitionLineRate

Controls the rate (in Hertz) at which the Lines in a Frame are captured.

AcquisitionMode

Sets the acquisition mode of the device.

AcquisitionResultingFrameRate

Resulting frame rate in Hertz.

AcquisitionStart

This command starts the acquisition of images.

AcquisitionStatus

Reads the state of the internal acquisition signal selected using AcquisitionStatusSelector.

AcquisitionStatusSelector

Selects the internal acquisition signal to read using AcquisitionStatus.

AcquisitionStop

This command stops the acquisition of images.

ActionDeviceKey

Provides the device key that allows the device to check the validity of action commands.

ActionGroupKey

Provides the key that the device will use to validate the action on reception of the action protocol message.

ActionGroupMask

Provides the mask that the device will use to validate the action on reception of the action protocol message.

ActionQueueSize

Indicates the size of the scheduled action commands queue.

ActionSelector

Selects to which Action Signal further Action settings apply.

ActionUnconditionalMode

Enables the unconditional action command mode where action commands are processed even when the primary control channel is closed.

AdaptiveCompressionEnable

Controls whether lossless compression adapts to the image content.

AdcBitDepth

Selects which ADC bit depth to use.

AutoAlgorithmSelector

Selects which Auto Algorithm is controlled by the RoiEnable, OffsetX, OffsetY, Width, Height features.

AutoExposureControlLoopDamping

It controls how fast the exposure and gain get settled.

AutoExposureControlPriority

Selects whether to adjust gain or exposure first.

AutoExposureEVCompensation

The EV compensation value used in the exposure compensation.

AutoExposureExposureTimeLowerLimit

The smallest exposure time that auto exposure can set.

AutoExposureExposureTimeUpperLimit

The largest exposure time that auto exposure can set.

AutoExposureGainLowerLimit

The smallest gain that auto exposure can set.

AutoExposureGainUpperLimit

The largest gain that auto exposure can set.

AutoExposureGreyValueLowerLimit

The lowest value in percentage that the target mean may reach.

AutoExposureGreyValueUpperLimit

The highest value in percentage that the target mean may reach.

AutoExposureLightingMode

Selects a lighting mode: Backlight, Frontlight or Normal (default).

AutoExposureMeteringMode

Selects a metering mode: average, spot, or partial metering.

AutoExposureTargetGreyValue

This is the user-specified target grey level (image mean) to apply to the current image.

AutoExposureTargetGreyValueAuto

This indicates whether the target image grey level is automatically set by the camera or manually set by the user.

BalanceRatio

Controls the balance ratio of the selected color relative to green.

BalanceRatioSelector

Selects a balance ratio to configure once a balance ratio control has been selected.

BalanceWhiteAuto

White Balance compensates for color shifts caused by different lighting conditions.

BalanceWhiteAutoDamping

Controls how quickly 'BalanceWhiteAuto' adjusts the values for Red and Blue BalanceRatio in response to changing conditions.

BalanceWhiteAutoLowerLimit

Controls the minimum value Auto White Balance can set for the Red/Blue BalanceRatio.

BalanceWhiteAutoProfile

Selects the profile used by BalanceWhiteAuto.

BalanceWhiteAutoUpperLimit

Controls the maximum value Auto White Balance can set the Red/Blue BalanceRatio.

BinningHorizontal

Number of horizontal photo-sensitive cells to combine together.

BinningHorizontalMode

Property type

SpinEnumDefNode.

BinningSelector

Selects which binning engine is controlled by the BinningHorizontal and BinningVertical features.

BinningVertical

Number of vertical photo-sensitive cells to combine together.

BinningVerticalMode

Property type

SpinEnumDefNode.

BlackLevel

Controls the offset of the video signal in percent.

BlackLevelAuto

Controls the mode for automatic black level adjustment.

BlackLevelAutoBalance

Controls the mode for automatic black level balancing between the sensor color channels or taps.

BlackLevelClampingEnable

Enable the black level auto clamping feature which performing dark current compensation.

BlackLevelRaw

Controls the offset of the video signal in camera specific units.

BlackLevelSelector

Selects which black level to control.

ChunkBlackLevel

Returns the black level used to capture the image.

ChunkBlackLevelSelector

Selects which black level to retrieve

ChunkCRC

Returns the CRC of the image payload.

ChunkCompressionMode

Returns the compression mode of the last image payload.

ChunkCompressionRatio

Returns the compression ratio of the last image payload.

ChunkCounterSelector

Selects which counter to retrieve data from.

ChunkCounterValue

Returns the value of the selected Chunk counter at the time of the FrameStart event.

ChunkEnable

Enables the inclusion of the selected Chunk data in the payload of the image.

ChunkEncoderSelector

Selects which Encoder to retrieve data from.

ChunkEncoderStatus

Returns the motion status of the selected encoder.

ChunkEncoderValue

Returns the counter's value of the selected Encoder at the time of the FrameStart in area scan mode or the counter's value at the time of the LineStart selected by ChunkScanLineSelector in LineScan mode.

ChunkExposureEndLineStatusAll

Returns the status of all the I/O lines at the end of exposure event.

ChunkExposureTime

Returns the exposure time used to capture the image.

ChunkExposureTimeSelector

Selects which exposure time is read by the ChunkExposureTime feature.

ChunkFrameID

Returns the image frame ID.

ChunkGain

Returns the gain used to capture the image.

ChunkGainSelector

Selects which gain to retrieve

ChunkHeight

Returns the height of the image included in the payload.

ChunkImage

Returns the image payload.

ChunkImageComponent

Returns the component of the payload image.

ChunkInferenceBoundingBoxResult

Returns the chunk inference bounding box result data.

ChunkInferenceConfidence

Returns the chunk data inference confidence percentage.

ChunkInferenceFrameId

Returns the frame ID associated with the most recent inference result.

ChunkInferenceResult

Returns the chunk data inference result.

ChunkLinePitch

Returns the LinePitch of the image included in the payload.

ChunkLineStatusAll

Returns the status of all the I/O lines at the time of the FrameStart internal event.

ChunkModeActive

Activates the inclusion of Chunk data in the payload of the image.

ChunkOffsetX

Returns the Offset X of the image included in the payload.

ChunkOffsetY

Returns the Offset Y of the image included in the payload.

ChunkPartSelector

Selects the part to access in chunk data in a multipart transmission.

ChunkPixelDynamicRangeMax

Returns the maximum value of dynamic range of the image included in the payload.

ChunkPixelDynamicRangeMin

Returns the minimum value of dynamic range of the image included in the payload.

ChunkPixelFormat

Format of the pixel provided by the camera

ChunkRegionID

Returns the identifier of Region that the image comes from.

ChunkScan3dAxisMax

Returns the Maximum Axis value for the selected coordinate axis of the image included in the payload.

ChunkScan3dAxisMin

Returns the Minimum Axis value for the selected coordinate axis of the image included in the payload.

ChunkScan3dCoordinateOffset

Returns the Offset for the selected coordinate axis of the image included in the payload.

ChunkScan3dCoordinateReferenceSelector

Selector to read a coordinate system reference value defining the transform of a point from one system to the other.

ChunkScan3dCoordinateReferenceValue

Reads the value of a position or pose coordinate for the anchor or transformed coordinate systems relative to the reference point.

ChunkScan3dCoordinateScale

Returns the Scale for the selected coordinate axis of the image included in the payload.

ChunkScan3dCoordinateSelector

Selects which Coordinate to retrieve data from.

ChunkScan3dCoordinateSystem

Returns the Coordinate System of the image included in the payload.

ChunkScan3dCoordinateSystemReference

Returns the Coordinate System Position of the image included in the payload.

ChunkScan3dCoordinateTransformSelector

Selector for transform values.

ChunkScan3dDistanceUnit

Returns the Distance Unit of the payload image.

ChunkScan3dInvalidDataFlag

Returns if a specific non-valid data flag is used in the data stream.

ChunkScan3dInvalidDataValue

Returns the Invalid Data Value used for the image included in the payload.

ChunkScan3dOutputMode

Returns the Calibrated Mode of the payload image.

ChunkScan3dTransformValue

Returns the transform value.

ChunkScanLineSelector

Index for vector representation of one chunk value per line in an image.

ChunkSelector

Selects which chunk data to enable or disable.

ChunkSequencerSetActive

Returns the index of the active set of the running sequencer included in the payload.

ChunkSerialData

Returns the serial data that was received.

ChunkSerialDataLength

Returns the length of the received serial data that was included in the payload.

ChunkSerialReceiveOverflow

Returns the status of the chunk serial receive overflow.

ChunkSourceID

Returns the identifier of Source that the image comes from.

ChunkStreamChannelID

Returns identifier of the stream channel used to carry the block.

ChunkTimerSelector

Selects which Timer to retrieve data from.

ChunkTimerValue

Returns the value of the selected Timer at the time of the FrameStart internal event.

ChunkTimestamp

Returns the Timestamp of the image.

ChunkTimestampLatchValue

Returns the last Timestamp latched with the TimestampLatch command.

ChunkTransferBlockID

Returns the unique identifier of the transfer block used to transport the payload.

ChunkTransferQueueCurrentBlockCount

Returns the current number of blocks in the transfer queue.

ChunkTransferStreamID

Returns identifier of the stream that generated this block.

ChunkWidth

Returns the width of the image included in the payload.

ClConfiguration

This Camera Link specific feature describes the configuration used by the camera.

ClTimeSlotsCount

This Camera Link specific feature describes the time multiplexing of the camera link connection to transfer more than the configuration allows, in one single clock.

ColorTransformationEnable

Enables/disables the color transform selected with ColorTransformationSelector.

ColorTransformationSelector

Selects which Color Transformation module is controlled by the various Color Transformation features

ColorTransformationValue

Represents the value of the selected Gain factor or Offset inside the Transformation matrix in floating point precision.

ColorTransformationValueSelector

Selects the Gain factor or Offset of the Transformation matrix to access in the selected Color Transformation module

CompressionRatio

Reports the ratio between the uncompressed image size and compressed image size.

CompressionSaturationPriority

When FrameRate is enabled, camera drops frames if datarate is saturated.

CounterDelay

Sets the delay (or number of events) before the CounterStart event is generated.

CounterDuration

Sets the duration (or number of events) before the CounterEnd event is generated.

CounterEventActivation

Selects the activation mode of the event to increment the Counter.

CounterEventSource

Selects the event that will increment the counter

CounterReset

Does a software reset of the selected Counter and starts it.

CounterResetActivation

Selects the Activation mode of the Counter Reset Source signal.

CounterResetSource

Selects the signal that will be the source to reset the counter.

CounterSelector

Selects which counter to configure

CounterStatus

Returns the current status of the counter.

CounterTriggerActivation

Selects the activation mode of the trigger to start the counter.

CounterTriggerSource

Selects the source of the trigger to start the counter

CounterValue

Current counter value

CounterValueAtReset

Value of the selected Counter when it was reset by a trigger.

CxpConnectionSelector

Selects the CoaXPress physical connection to control.

CxpConnectionTestErrorCount

Reports the current connection error count for test packets recieved by the device on the connection selected by CxpConnectionSelector.

CxpConnectionTestMode

Enables the test mode for an individual physical connection of the Device.

CxpConnectionTestPacketCount

Reports the current count for test packets recieved by the device on the connection selected by CxpConnectionSelector.

CxpLinkConfiguration

This feature allows specifying the Link configuration for the communication between the Receiver and Transmitter Device.

CxpLinkConfigurationPreferred

Provides the Link configuration that allows the Transmitter Device to operate in its default mode.

CxpLinkConfigurationStatus

This feature indicates the current and active Link configuration used by the Device.

CxpPoCxpAuto

Activate automatic control of the Power over CoaXPress (PoCXP) for the Link.

CxpPoCxpStatus

Returns the Power over CoaXPress (PoCXP) status of the Device.

CxpPoCxpTripReset

Reset the Power over CoaXPress (PoCXP) Link after an over-current trip on the Device connection(s).

CxpPoCxpTurnOff

Disable Power over CoaXPress (PoCXP) for the Link.

DecimationHorizontal

Horizontal decimation of the image.

DecimationHorizontalMode

The mode used to reduce the horizontal resolution when DecimationHorizontal is used.

DecimationSelector

Selects which decimation layer is controlled by the DecimationHorizontal and DecimationVertical features.

DecimationVertical

Vertical decimation of the image.

DecimationVerticalMode

The mode used to reduce the vertical resolution when DecimationVertical is used.

DefectCorrectStaticEnable

Enables/Disables table-based defective pixel correction.

DefectCorrectionMode

Controls the method used for replacing defective pixels.

DefectTableApply

Applies the current defect table, so that any changes made affect images captured by the camera.

DefectTableCoordinateX

Returns the X coordinate of the defective pixel at DefectTableIndex within the defective pixel table.

DefectTableCoordinateY

Returns the Y coordinate of the defective pixel at DefectTableIndex within the defective pixel table.

DefectTableFactoryRestore

Restores the Defective Pixel Table to its factory default state, which was calibrated during manufacturing.

DefectTableIndex

Controls the offset of the element to access in the defective pixel location table.

DefectTablePixelCount

The number of defective pixel locations in the current table.

DefectTableSave

Saves the current defective pixel table non-volatile memory, so that it is preserved when the camera boots up.

Deinterlacing

Controls how the device performs de-interlacing.

DeviceCharacterSet

Character set used by the strings of the device`s bootstrap registers.

DeviceClockFrequency

Returns the frequency of the selected Clock.

DeviceClockSelector

Selects the clock frequency to access from the device.

DeviceConnectionSelector

Selects which Connection of the device to control.

DeviceConnectionSpeed

Indicates the speed of transmission of the specified Connection

DeviceConnectionStatus

Indicates the status of the specified Connection.

DeviceEventChannelCount

Indicates the number of event channels supported by the device.

DeviceFamilyName

Identifier of the product family of the device.

DeviceFeaturePersistenceEnd

Indicate to the device the end of feature persistence.

DeviceFeaturePersistenceStart

Indicate to the device and GenICam XML to get ready for persisting of all streamable features.

DeviceFirmwareVersion

Version of the firmware on the device.

DeviceGenCPVersionMajor

Major version of the GenCP protocol supported by the device.

DeviceGenCPVersionMinor

Minor version of the GenCP protocol supported by the device.

DeviceID

Device identifier (serial number).

DeviceIndicatorMode

Controls the LED behaviour: Inactive (off), Active (current status), or Error Status (off unless an error occurs).

DeviceLinkBandwidthReserve

Percentage of streamed data bandwidth reserved for packet resend.

DeviceLinkCommandTimeout

Indicates the command timeout of the specified Link.

DeviceLinkConnectionCount

Returns the number of physical connection of the device used by a particular Link.

DeviceLinkCurrentThroughput

Current bandwidth of streamed data.

DeviceLinkHeartbeatMode

Activate or deactivate the Link's heartbeat.

DeviceLinkHeartbeatTimeout

Controls the current heartbeat timeout of the specific Link.

DeviceLinkSelector

Selects which Link of the device to control.

DeviceLinkSpeed

Indicates the speed of transmission negotiated on the specified Link.

DeviceLinkThroughputLimit

Limits the maximum bandwidth of the data that will be streamed out by the device on the selected Link.

DeviceLinkThroughputLimitMode

Controls if the DeviceLinkThroughputLimit is active.

DeviceManifestEntrySelector

Selects the manifest entry to reference.

DeviceManifestPrimaryURL

Indicates the first URL to the GenICam XML device description file of the selected manifest entry.

DeviceManifestSchemaMajorVersion

Indicates the major version number of the schema file of the selected manifest entry.

DeviceManifestSchemaMinorVersion

Indicates the minor version number of the schema file of the selected manifest entry.

DeviceManifestSecondaryURL

Indicates the second URL to the GenICam XML device description file of the selected manifest entry.

DeviceManifestXMLMajorVersion

Indicates the major version number of the GenICam XML file of the selected manifest entry.

DeviceManifestXMLMinorVersion

Indicates the minor version number of the GenICam XML file of the selected manifest entry.

DeviceManifestXMLSubMinorVersion

Indicates the subminor version number of the GenICam XML file of the selected manifest entry.

DeviceManufacturerInfo

Manufacturer information about the device.

DeviceMaxThroughput

Maximum bandwidth of the data that can be streamed out of the device.

DeviceModelName

Model of the device.

DevicePowerSupplySelector

Selects the power supply source to control or read.

DeviceRegistersCheck

Perform the validation of the current register set for consistency.

DeviceRegistersEndianness

Endianness of the registers of the device.

DeviceRegistersStreamingEnd

Announce the end of registers streaming.

DeviceRegistersStreamingStart

Prepare the device for registers streaming without checking for consistency.

DeviceRegistersValid

Returns if the current register set is valid and consistent.

DeviceReset

This is a command that immediately resets and reboots the device.

DeviceSFNCVersionMajor

Major version of the Standard Features Naming Convention that was used to create the device's GenICam XML.

DeviceSFNCVersionMinor

Minor version of the Standard Features Naming Convention that was used to create the device's GenICam XML.

DeviceSFNCVersionSubMinor

Sub minor version of Standard Features Naming Convention that was used to create the device's GenICam XML.

DeviceScanType

Scan type of the sensor of the device.

DeviceSerialNumber

Device's serial number.

DeviceSerialPortBaudRate

This feature controls the baud rate used by the selected serial port.

DeviceSerialPortSelector

Selects which serial port of the device to control.

DeviceStreamChannelCount

Indicates the number of streaming channels supported by the device.

DeviceStreamChannelEndianness

Endianness of multi-byte pixel data for this stream.

DeviceStreamChannelLink

Index of device's Link to use for streaming the specifed stream channel.

DeviceStreamChannelPacketSize

Specifies the stream packet size, in bytes, to send on the selected channel for a Transmitter or specifies the maximum packet size supported by a receiver.

DeviceStreamChannelSelector

Selects the stream channel to control.

DeviceStreamChannelType

Reports the type of the stream channel.

DeviceTLType

Transport Layer type of the device.

DeviceTLVersionMajor

Major version of the Transport Layer of the device.

DeviceTLVersionMinor

Minor version of the Transport Layer of the device.

DeviceTLVersionSubMinor

Sub minor version of the Transport Layer of the device.

DeviceTapGeometry

This device tap geometry feature describes the geometrical properties characterizing the taps of a camera as presented at the output of the device.

DeviceTemperature

Device temperature in degrees Celsius (C).

DeviceTemperatureSelector

Selects the location within the device, where the temperature will be measured.

DeviceType

Returns the device type.

DeviceUptime

Total time since the device was powered up in seconds.

DeviceUserID

User-programmable device identifier.

DeviceVendorName

Name of the manufacturer of the device.

DeviceVersion

Version of the device.

EncoderDivider

Sets how many Encoder increment/decrements that are needed generate an Encoder output pulse signal.

EncoderMode

Selects if the count of encoder uses FourPhase mode with jitter filtering or the HighResolution mode without jitter filtering.

EncoderOutputMode

Selects the conditions for the Encoder interface to generate a valid Encoder output signal.

EncoderReset

Does a software reset of the selected Encoder and starts it.

EncoderResetActivation

Selects the Activation mode of the Encoder Reset Source signal.

EncoderResetSource

Selects the signals that will be the source to reset the Encoder.

EncoderSelector

Selects which Encoder to configure.

EncoderSourceA

Selects the signal which will be the source of the A input of the Encoder.

EncoderSourceB

Selects the signal which will be the source of the B input of the Encoder.

EncoderStatus

Returns the motion status of the encoder.

EncoderTimeout

Sets the maximum time interval between encoder counter increments before the status turns to static.

EncoderValue

Reads or writes the current value of the position counter of the selected Encoder.

EncoderValueAtReset

Reads the value of the of the position counter of the selected Encoder when it was reset by a signal or by an explicit EncoderReset command.

EnumerationCount

Number of enumerations since uptime.

EventAcquisitionEnd

Returns the unique Identifier of the Acquisition End type of Event.

EventAcquisitionEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Acquisition End Event.

EventAcquisitionEndTimestamp

Returns the Timestamp of the Acquisition End Event.

EventAcquisitionError

Returns the unique Identifier of the Acquisition Error type of Event.

EventAcquisitionErrorFrameID

Returns the unique Identifier of the Frame (or image) that generated the Acquisition Error Event.

EventAcquisitionErrorTimestamp

Returns the Timestamp of the Acquisition Error Event.

EventAcquisitionStart

Returns the unique Identifier of the Acquisition Start type of Event.

EventAcquisitionStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Acquisition Start Event.

EventAcquisitionStartTimestamp

Returns the Timestamp of the Acquisition Start Event.

EventAcquisitionTransferEnd

Returns the unique Identifier of the Acquisition Transfer End type of Event.

EventAcquisitionTransferEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Acquisition Transfer End Event.

EventAcquisitionTransferEndTimestamp

Returns the Timestamp of the Acquisition Transfer End Event.

EventAcquisitionTransferStart

Returns the unique Identifier of the Acquisition Transfer Start type of Event.

EventAcquisitionTransferStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Acquisition Transfer Start Event.

EventAcquisitionTransferStartTimestamp

Returns the Timestamp of the Acquisition Transfer Start Event.

EventAcquisitionTrigger

Returns the unique Identifier of the Acquisition Trigger type of Event.

EventAcquisitionTriggerFrameID

Returns the unique Identifier of the Frame (or image) that generated the Acquisition Trigger Event.

EventAcquisitionTriggerTimestamp

Returns the Timestamp of the Acquisition Trigger Event.

EventActionLate

Returns the unique Identifier of the Action Late type of Event.

EventActionLateFrameID

Returns the unique Identifier of the Frame (or image) that generated the Action Late Event.

EventActionLateTimestamp

Returns the Timestamp of the Action Late Event.

EventCounter0End

Returns the unique Identifier of the Counter 0 End type of Event.

EventCounter0EndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Counter 0 End Event.

EventCounter0EndTimestamp

Returns the Timestamp of the Counter 0 End Event.

EventCounter0Start

Returns the unique Identifier of the Counter 0 Start type of Event.

EventCounter0StartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Counter 0 Start Event.

EventCounter0StartTimestamp

Returns the Timestamp of the Counter 0 Start Event.

EventCounter1End

Returns the unique Identifier of the Counter 1 End type of Event.

EventCounter1EndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Counter 1 End Event.

EventCounter1EndTimestamp

Returns the Timestamp of the Counter 1 End Event.

EventCounter1Start

Returns the unique Identifier of the Counter 1 Start type of Event.

EventCounter1StartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Counter 1 Start Event.

EventCounter1StartTimestamp

Returns the Timestamp of the Counter 1 Start Event.

EventEncoder0Restarted

Returns the unique Identifier of the Encoder 0 Restarted type of Event.

EventEncoder0RestartedFrameID

Returns the unique Identifier of the Frame (or image) that generated the Encoder 0 Restarted Event.

EventEncoder0RestartedTimestamp

Returns the Timestamp of the Encoder 0 Restarted Event.

EventEncoder0Stopped

Returns the unique Identifier of the Encoder 0 Stopped type of Event.

EventEncoder0StoppedFrameID

Returns the unique Identifier of the Frame (or image) that generated the Encoder 0 Stopped Event.

EventEncoder0StoppedTimestamp

Returns the Timestamp of the Encoder 0 Stopped Event.

EventEncoder1Restarted

Returns the unique Identifier of the Encoder 1 Restarted type of Event.

EventEncoder1RestartedFrameID

Returns the unique Identifier of the Frame (or image) that generated the Encoder 1 Restarted Event.

EventEncoder1RestartedTimestamp

Returns the Timestamp of the Encoder 1 Restarted Event.

EventEncoder1Stopped

Returns the unique Identifier of the Encoder 1 Stopped type of Event.

EventEncoder1StoppedFrameID

Returns the unique Identifier of the Frame (or image) that generated the Encoder 1 Stopped Event.

EventEncoder1StoppedTimestamp

Returns the Timestamp of the Encoder 1 Stopped Event.

EventError

Returns the unique identifier of the Error type of Event.

EventErrorCode

Returns the error code for the error that happened

EventErrorFrameID

Returns the unique Identifier of the Frame (or image) that generated the Error Event.

EventErrorTimestamp

Returns the Timestamp of the Error Event.

EventExposureEnd

Returns the unique identifier of the Exposure End type of Event.

EventExposureEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Exposure End Event.

EventExposureEndTimestamp

Returns the Timestamp of the Exposure End Event.

EventExposureStart

Returns the unique Identifier of the Exposure Start type of Event.

EventExposureStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Exposure Start Event.

EventExposureStartTimestamp

Returns the Timestamp of the Exposure Start Event.

EventFrameBurstEnd

Returns the unique Identifier of the Frame Burst End type of Event.

EventFrameBurstEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Frame Burst End Event.

EventFrameBurstEndTimestamp

Returns the Timestamp of the Frame Burst End Event.

EventFrameBurstStart

Returns the unique Identifier of the Frame Burst Start type of Event.

EventFrameBurstStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Frame Burst Start Event.

EventFrameBurstStartTimestamp

Returns the Timestamp of the Frame Burst Start Event.

EventFrameEnd

Returns the unique Identifier of the Frame End type of Event.

EventFrameEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Frame End Event.

EventFrameEndTimestamp

Returns the Timestamp of the Frame End Event.

EventFrameStart

Returns the unique Identifier of the Frame Start type of Event.

EventFrameStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Frame Start Event.

EventFrameStartTimestamp

Returns the Timestamp of the Frame Start Event.

EventFrameTransferEnd

Returns the unique Identifier of the Frame Transfer End type of Event.

EventFrameTransferEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Frame Transfer End Event.

EventFrameTransferEndTimestamp

Returns the Timestamp of the Frame Transfer End Event.

EventFrameTransferStart

Returns the unique Identifier of the Frame Transfer Start type of Event.

EventFrameTransferStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Frame Transfer Start Event.

EventFrameTransferStartTimestamp

Returns the Timestamp of the Frame Transfer Start Event.

EventFrameTrigger

Returns the unique Identifier of the FrameTrigger type of Event.

EventFrameTriggerFrameID

Returns the unique Identifier of the Frame (or image) that generated the FrameTrigger Event.

EventFrameTriggerTimestamp

Returns the Timestamp of the FrameTrigger Event.

EventLine0AnyEdge

Returns the unique Identifier of the Line 0 Any Edge type of Event.

EventLine0AnyEdgeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Line 0 Any Edge Event.

EventLine0AnyEdgeTimestamp

Returns the Timestamp of the Line 0 Any Edge Event.

EventLine0FallingEdge

Returns the unique Identifier of the Line 0 Falling Edge type of Event.

EventLine0FallingEdgeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Line 0 Falling Edge Event.

EventLine0FallingEdgeTimestamp

Returns the Timestamp of the Line 0 Falling Edge Event.

EventLine0RisingEdge

Returns the unique Identifier of the Line 0 Rising Edge type of Event.

EventLine0RisingEdgeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Line 0 Rising Edge Event.

EventLine0RisingEdgeTimestamp

Returns the Timestamp of the Line 0 Rising Edge Event.

EventLine1AnyEdge

Returns the unique Identifier of the Line 1 Any Edge type of Event.

EventLine1AnyEdgeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Line 1 Any Edge Event.

EventLine1AnyEdgeTimestamp

Returns the Timestamp of the Line 1 Any Edge Event.

EventLine1FallingEdge

Returns the unique Identifier of the Line 1 Falling Edge type of Event.

EventLine1FallingEdgeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Line 1 Falling Edge Event.

EventLine1FallingEdgeTimestamp

Returns the Timestamp of the Line 1 Falling Edge Event.

EventLine1RisingEdge

Returns the unique Identifier of the Line 1 Rising Edge type of Event.

EventLine1RisingEdgeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Line 1 Rising Edge Event.

EventLine1RisingEdgeTimestamp

Returns the Timestamp of the Line 1 Rising Edge Event.

EventLinkSpeedChange

Returns the unique Identifier of the Link Speed Change type of Event.

EventLinkSpeedChangeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Link Speed Change Event.

EventLinkSpeedChangeTimestamp

Returns the Timestamp of the Link Speed Change Event.

EventLinkTrigger0

Returns the unique Identifier of the Link Trigger 0 type of Event.

EventLinkTrigger0FrameID

Returns the unique Identifier of the Frame (or image) that generated the Link Trigger 0 Event.

EventLinkTrigger0Timestamp

Returns the Timestamp of the Link Trigger 0 Event.

EventLinkTrigger1

Returns the unique Identifier of the Link Trigger 1 type of Event.

EventLinkTrigger1FrameID

Returns the unique Identifier of the Frame (or image) that generated the Link Trigger 1 Event.

EventLinkTrigger1Timestamp

Returns the Timestamp of the Link Trigger 1 Event.

EventNotification

Enables/Disables the selected event.

EventSelector

Selects which Event to enable or disable.

EventSequencerSetChange

Returns the unique Identifier of the Sequencer Set Change type of Event.

EventSequencerSetChangeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Sequencer Set Change Event.

EventSequencerSetChangeTimestamp

Returns the Timestamp of the Sequencer Set Change Event.

EventSerialData

Returns the serial data that was received.

EventSerialDataLength

Returns the length of the received serial data that was included in the event payload.

EventSerialPortReceive

Returns the unique identifier of the Serial Port Receive type of Event.

EventSerialPortReceiveTimestamp

Returns the Timestamp of the Serial Port Receive Event.

EventSerialReceiveOverflow

Returns the status of the event serial receive overflow.

EventStream0TransferBlockEnd

Returns the unique Identifier of the Stream 0 Transfer Block End type of Event.

EventStream0TransferBlockEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Block End Event.

EventStream0TransferBlockEndTimestamp

Returns the Timestamp of the Stream 0 Transfer Block End Event.

EventStream0TransferBlockStart

Returns the unique Identifier of the Stream 0 Transfer Block Start type of Event.

EventStream0TransferBlockStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Block Start Event.

EventStream0TransferBlockStartTimestamp

Returns the Timestamp of the Stream 0 Transfer Block Start Event.

EventStream0TransferBlockTrigger

Returns the unique Identifier of the Stream 0 Transfer Block Trigger type of Event.

EventStream0TransferBlockTriggerFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Block Trigger Event.

EventStream0TransferBlockTriggerTimestamp

Returns the Timestamp of the Stream 0 Transfer Block Trigger Event.

EventStream0TransferBurstEnd

Returns the unique Identifier of the Stream 0 Transfer Burst End type of Event.

EventStream0TransferBurstEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Burst End Event.

EventStream0TransferBurstEndTimestamp

Returns the Timestamp of the Stream 0 Transfer Burst End Event.

EventStream0TransferBurstStart

Returns the unique Identifier of the Stream 0 Transfer Burst Start type of Event.

EventStream0TransferBurstStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Burst Start Event.

EventStream0TransferBurstStartTimestamp

Returns the Timestamp of the Stream 0 Transfer Burst Start Event.

EventStream0TransferEnd

Returns the unique Identifier of the Stream 0 Transfer End type of Event.

EventStream0TransferEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer End Event.

EventStream0TransferEndTimestamp

Returns the Timestamp of the Stream 0 Transfer End Event.

EventStream0TransferOverflow

Returns the unique Identifier of the Stream 0 Transfer Overflow type of Event.

EventStream0TransferOverflowFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Overflow Event.

EventStream0TransferOverflowTimestamp

Returns the Timestamp of the Stream 0 Transfer Overflow Event.

EventStream0TransferPause

Returns the unique Identifier of the Stream 0 Transfer Pause type of Event.

EventStream0TransferPauseFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Pause Event.

EventStream0TransferPauseTimestamp

Returns the Timestamp of the Stream 0 Transfer Pause Event.

EventStream0TransferResume

Returns the unique Identifier of the Stream 0 Transfer Resume type of Event.

EventStream0TransferResumeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Resume Event.

EventStream0TransferResumeTimestamp

Returns the Timestamp of the Stream 0 Transfer Resume Event.

EventStream0TransferStart

Returns the unique Identifier of the Stream 0 Transfer Start type of Event.

EventStream0TransferStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Start Event.

EventStream0TransferStartTimestamp

Returns the Timestamp of the Stream 0 Transfer Start Event.

EventTest

Returns the unique identifier of the Test type of Event.

EventTestTimestamp

Returns the Timestamp of the Test Event.

EventTimer0End

Returns the unique Identifier of the Timer 0 End type of Event.

EventTimer0EndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Timer 0 End Event.

EventTimer0EndTimestamp

Returns the Timestamp of the Timer 0 End Event.

EventTimer0Start

Returns the unique Identifier of the Timer 0 Start type of Event.

EventTimer0StartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Timer 0 Start Event.

EventTimer0StartTimestamp

Returns the Timestamp of the Timer 0 Start Event.

EventTimer1End

Returns the unique Identifier of the Timer 1 End type of Event.

EventTimer1EndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Timer 1 End Event.

EventTimer1EndTimestamp

Returns the Timestamp of the Timer 1 End Event.

EventTimer1Start

Returns the unique Identifier of the Timer 1 Start type of Event.

EventTimer1StartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Timer 1 Start Event.

EventTimer1StartTimestamp

Returns the Timestamp of the Timer 1 Start Event.

ExposureActiveMode

Control sensor active exposure mode.

ExposureAuto

Sets the automatic exposure mode

ExposureMode

Sets the operation mode of the Exposure.

ExposureTime

Exposure time in microseconds when Exposure Mode is Timed.

ExposureTimeMode

Sets the configuration mode of the ExposureTime feature.

ExposureTimeSelector

Selects which exposure time is controlled by the ExposureTime feature.

FactoryReset

Returns all user tables to factory default

FileAccessBuffer

Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.

FileAccessLength

Controls the Length of the mapping between the device file storage and the FileAccessBuffer.

FileAccessOffset

Controls the Offset of the mapping between the device file storage and the FileAccessBuffer.

FileOpenMode

The mode of the file when it is opened.

FileOperationExecute

This is a command that executes the selected file operation on the selected file.

FileOperationResult

Represents the file operation result.

FileOperationSelector

Sets operation to execute on the selected file when the execute command is given.

FileOperationStatus

Represents the file operation execution status.

FileSelector

Selects which file is being operated on.

FileSize

Represents the size of the selected file in bytes.

Gain

Controls the amplification of the video signal in dB.

GainAuto

Sets the automatic gain mode.

GainAutoBalance

Sets the mode for automatic gain balancing between the sensor color channels or taps.

GainSelector

Selects which gain to control.

Gamma

Controls the gamma correction of pixel intensity.

GammaEnable

Enables/disables gamma correction.

GevActiveLinkCount

Indicates the current number of active logical links.

GevCCP

Controls the device access privilege of an application.

GevCurrentDefaultGateway

Reports the default gateway IP address to be used on the given logical link.

GevCurrentIPAddress

Reports the IP address for the given logical link.

GevCurrentIPConfigurationDHCP

Controls whether the DHCP IP configuration scheme is activated on the given logical link.

GevCurrentIPConfigurationLLA

Controls whether the Link Local Address IP configuration scheme is activated on the given logical link.

GevCurrentIPConfigurationPersistentIP

Controls whether the PersistentIP configuration scheme is activated on the given logical link.

GevCurrentPhysicalLinkConfiguration

Indicates the current physical link configuration of the device.

GevCurrentSubnetMask

Reports the subnet mask of the given logical link.

GevDiscoveryAckDelay

Indicates the maximum randomized delay the device will wait to acknowledge a discovery command.

GevFirstURL

The first choice of URL for the XML device description file.

GevGVCPExtendedStatusCodes

Enables the generation of extended status codes.

GevGVCPExtendedStatusCodesSelector

Selects the GigE Vision version to control extended status codes for.

GevGVCPHeartbeatDisable

Disables the GVCP heartbeat.

GevGVCPPendingAck

Enables the generation of PENDING_ACK.

GevGVCPPendingTimeout

Indicates the longest GVCP command execution time before the device returns a PENDING_ACK in milliseconds.

GevGVSPExtendedIDMode

Enables the extended IDs mode.

GevHeartbeatTimeout

Indicates the current heartbeat timeout in milliseconds.

GevIEEE1588

Enables the IEEE 1588 Precision Time Protocol to control the timestamp register.

GevIEEE1588ClockAccuracy

Indicates the expected accuracy of the device clock when it is the grandmaster, or in the event it becomes the grandmaster.

GevIEEE1588Mode

Provides the mode of the IEEE 1588 clock.

GevIEEE1588Status

Provides the status of the IEEE 1588 clock.

GevIPConfigurationStatus

Reports the current IP configuration status.

GevInterfaceSelector

Selects which logical link to control.

GevMACAddress

MAC address of the logical link.

GevMCDA

Controls the destination IP address of the message channel

GevMCPHostPort

The port to which the device must send messages

GevMCRC

Indicates the number of retries of the message channel.

GevMCSP

Indicates the source port of the message channel.

GevMCTT

Indicates the transmission timeout of the message channel.

GevNumberOfInterfaces

Indicates the number of physical network interfaces supported by this device.

GevPAUSEFrameReception

Controls whether incoming PAUSE Frames are handled on the given logical link.

GevPAUSEFrameTransmission

Controls whether PAUSE Frames can be generated on the given logical link.

GevPersistentDefaultGateway

Controls the persistent default gateway for this logical link.

GevPersistentIPAddress

Controls the Persistent IP address for this logical link.

GevPersistentSubnetMask

Controls the Persistent subnet mask associated with the Persistent IP address on this logical link.

GevPhysicalLinkConfiguration

Controls the principal physical link configuration to use on next restart/power-up of the device.

GevPrimaryApplicationIPAddress

Returns the address of the primary application.

GevPrimaryApplicationSocket

Returns the UDP source port of the primary application.

GevPrimaryApplicationSwitchoverKey

Controls the key to use to authenticate primary application switchover requests.

GevSCCFGAllInTransmission

Enables the selected GVSP transmitter to use the single packet per data block All-in Transmission mode.

GevSCCFGExtendedChunkData

Enables cameras to use the extended chunk data payload type for this stream channel.

GevSCCFGPacketResendDestination

Enables the alternate IP destination for stream packets resent due to a packet resend request.

GevSCCFGUnconditionalStreaming

Enables the camera to continue to stream, for this stream channel, if its control channel is closed or regardless of the reception of any ICMP messages (such as destination unreachable messages).

GevSCDA

Controls the destination IP address of the selected stream channel to which a GVSP transmitter must send data stream or the destination IP address from which a GVSP receiver may receive data stream.

GevSCPD

Controls the delay (in GEV timestamp counter unit) to insert between each packet for this stream channel.

GevSCPDirection

Transmit or Receive of the channel

GevSCPHostPort

Controls the port of the selected channel to which a GVSP transmitter must send data stream or the port from which a GVSP receiver may receive data stream.

GevSCPInterfaceIndex

Index of the logical link to use.

GevSCPSBigEndian

Endianness of multi-byte pixel data for this stream.

GevSCPSDoNotFragment

The state of this feature is copied into the "do not fragment" bit of the IP header of each stream packet.

GevSCPSFireTestPacket

Sends a test packet.

GevSCPSPacketSize

Specifies the stream packet size (in bytes) to send on this channel.

GevSCSP

Indicates the source port of the stream channel.

GevSCZoneConfigurationLock

Controls whether the selected stream channel multi-zone configuration is locked.

GevSCZoneCount

Reports the number of zones per block transmitted on the selected stream channel.

GevSCZoneDirectionAll

Reports the transmission direction of each zone transmitted on the selected stream channel.

GevSecondURL

The second choice of URL to the XML device description file.

GevStreamChannelSelector

Selects the stream channel to control.

GevSupportedOption

Returns if the selected GEV option is supported.

GevSupportedOptionSelector

Selects the GEV option to interrogate for existing support.

GevTimestampTickFrequency

Indicates the number of timestamp ticks in 1 second (frequency in Hz).

GuiXmlManifestAddress

Location of the GUI XML manifest table.

Height

Height of the image provided by the device (in pixels).

HeightMax

Maximum height of the image (in pixels).

ImageComponentEnable

Controls if the selected component streaming is active.

ImageComponentSelector

Selects a component to activate data streaming from.

ImageCompressionBitrate

Control the rate of the produced compressed stream.

ImageCompressionJPEGFormatOption

When JPEG is selected as the compression format, a device might optionally offer better control over JPEG-specific options through this feature.

ImageCompressionMode

Property type

SpinEnumDefNode.

ImageCompressionQuality

Control the quality of the produced compressed stream.

ImageCompressionRateOption

Two rate controlling options are offered: fixed bit rate or fixed quality.

IspEnable

Controls whether the image processing core is used for optional pixel format mode (i.e.

LUTEnable

Activates the selected LUT.

LUTIndex

Control the index (offset) of the coefficient to access in the selected LUT.

LUTSelector

Selects which LUT to control.

LUTValue

Returns the Value at entry LUTIndex of the LUT selected by LUTSelector.

LUTValueAll

Accesses all the LUT coefficients in a single access without using individual LUTIndex.

LineFilterWidth

Filter width in microseconds for the selected line and filter combination

LineFormat

Displays the current electrical format of the selected physical input or output Line.

LineInputFilterSelector

Selects the kind of input filter to configure: Deglitch or Debounce.

LineInverter

Controls the inversion of the signal of the selected input or output line.

LineMode

Controls if the physical Line is used to Input or Output a signal.

LinePitch

Total number of bytes between 2 successive lines.

LineSelector

Selects the physical line (or pin) of the external device connector to configure

LineSource

Selects which internal acquisition or I/O source signal to output on the selected line.

LineStatus

Returns the current status of the selected input or output Line

LineStatusAll

Returns the current status of all the line status bits in a hexadecimal representation (Line 0 status corresponds to bit 0, Line 1 status with bit 1, etc).

LinkErrorCount

Counts the number of error on the link.

LinkUptime

Time since the last phy negotiation (enumeration).

LogicBlockLUTInputActivation

Selects the activation mode of the Logic Input Source signal.

LogicBlockLUTInputSelector

Controls which LogicBlockLUT Input Source & Activation to access.

LogicBlockLUTInputSource

Selects the source for the input into the Logic LUT.

LogicBlockLUTOutputValue

Controls the output column of the truth table for the selected LogicBlockLUTRowIndex.

LogicBlockLUTOutputValueAll

Sets the value of all the output bits in the selected LUT.

LogicBlockLUTRowIndex

Controls the row of the truth table to access in the selected LUT.

LogicBlockLUTSelector

Selects which LogicBlock LUT to configure

LogicBlockSelector

Selects which LogicBlock to configure

MaxDeviceResetTime

Time to wait until device reset complete (ms).

OffsetX

Horizontal offset from the origin to the ROI (in pixels).

OffsetY

Vertical offset from the origin to the ROI (in pixels).

PacketResendRequestCount

Counts the number of resend requests received from the host.

PayloadSize

Provides the number of bytes transferred for each image or chunk on the stream channel.

PixelColorFilter

Type of color filter that is applied to the image.

PixelDynamicRangeMax

Maximum value that can be returned during the digitization process.

PixelDynamicRangeMin

Minimum value that can be returned during the digitization process.

PixelFormat

Format of the pixel provided by the camera.

PixelFormatInfoID

Returns the value used by the streaming channels to identify the selected pixel format.

PixelFormatInfoSelector

Select the pixel format for which the information will be returned.

PixelSize

Total size in bits of a pixel of the image.

PowerSupplyCurrent

Indicates the output current of the selected power supply (A).

PowerSupplyVoltage

Indicates the current voltage of the selected power supply (V).

RegionDestination

Control the destination of the selected region.

RegionMode

Controls if the selected Region of interest is active and streaming.

RegionSelector

Selects the Region of interest to control.

ReverseX

Horizontally flips the image sent by the device.

ReverseY

Vertically flips the image sent by the device.

RgbTransformLightSource

Used to select from a set of RGBtoRGB transform matricies calibrated for different light sources.

Saturation

Controls the color saturation.

SaturationEnable

Enables/disables Saturation adjustment.

Scan3dAxisMax

Maximum valid transmitted coordinate value of the selected Axis.

Scan3dAxisMin

Minimum valid transmitted coordinate value of the selected Axis.

Scan3dCoordinateOffset

Offset when transforming a pixel from relative coordinates to world coordinates.

Scan3dCoordinateReferenceSelector

Sets the index to read a coordinate system reference value defining the transform of a point from the current (Anchor or Transformed) system to the reference system.

Scan3dCoordinateReferenceValue

Returns the reference value selected.

Scan3dCoordinateScale

Scale factor when transforming a pixel from relative coordinates to world coordinates.

Scan3dCoordinateSelector

Selects the individual coordinates in the vectors for 3D information/transformation.

Scan3dCoordinateSystem

Specifies the Coordinate system to use for the device.

Scan3dCoordinateSystemReference

Defines coordinate system reference location.

Scan3dCoordinateTransformSelector

Sets the index to read/write a coordinate transform value.

Scan3dDistanceUnit

Specifies the unit used when delivering calibrated distance data.

Scan3dInvalidDataFlag

Enables the definition of a non-valid flag value in the data stream.

Scan3dInvalidDataValue

Value which identifies a non-valid pixel if Scan3dInvalidDataFlag is enabled.

Scan3dOutputMode

Controls the Calibration and data organization of the device, naming the coordinates transmitted.

Scan3dTransformValue

Specifies the transform value selected.

SensorDescription

Returns Sensor Description

SensorDigitizationTaps

Number of digitized samples outputted simultaneously by the camera A/D conversion stage.

SensorHeight

Effective height of the sensor in pixels.

SensorShutterMode

Sets the shutter mode of the device.

SensorTaps

Number of taps of the camera sensor.

SensorWidth

Effective width of the sensor in pixels.

SequencerConfigurationMode

Controls whether or not a sequencer is in configuration mode.

SequencerConfigurationValid

Display whether the current sequencer configuration is valid to run.

SequencerFeatureEnable

Enables the selected feature and makes it active in all sequencer sets.

SequencerMode

Controls whether or not a sequencer is active.

SequencerPathSelector

Selects branching path to be used for subsequent settings.

SequencerSetActive

Displays the currently active sequencer set.

SequencerSetLoad

Loads currently selected sequencer to the current device configuration.

SequencerSetNext

Specifies the next sequencer set.

SequencerSetSave

Saves the current device configuration to the currently selected sequencer set.

SequencerSetSelector

Selects the sequencer set to which subsequent settings apply.

SequencerSetStart

Sets the first sequencer set to be used.

SequencerSetValid

Displays whether the currently selected sequencer set's register contents are valid to use.

SequencerTriggerActivation

Specifies the activation mode of the sequencer trigger.

SequencerTriggerSource

Specifies the internal signal or physical input line to use as the sequencer trigger source.

SerialPortBaudRate

This feature controls the baud rate used by the selected serial port.

SerialPortDataBits

This feature controls the number of data bits used by the selected serial port.

SerialPortParity

This feature controls the parity used by the selected serial port.

SerialPortSelector

Selects which serial port of the device to control.

SerialPortSource

Specifies the physical input Line on which to receive serial data.

SerialPortStopBits

This feature controls the number of stop bits used by the selected serial port.

SerialReceiveFramingErrorCount

Returns the number of framing errors that have occurred on the serial port.

SerialReceiveParityErrorCount

Returns the number of parity errors that have occurred on the serial port.

SerialReceiveQueueClear

This is a command that clears the device serial port receive queue.

SerialReceiveQueueCurrentCharacterCount

Returns the number of characters currently in the serial port receive queue.

SerialReceiveQueueMaxCharacterCount

>Returns the maximum number of characters in the serial port receive queue.

SerialTransmitQueueCurrentCharacterCount

Returns the number of characters currently in the serial port transmit queue.

SerialTransmitQueueMaxCharacterCount

>Returns the maximum number of characters in the serial port transmit queue.

Sharpening

Controls the amount to sharpen a signal.

SharpeningAuto

Enables/disables the auto sharpening feature.

SharpeningEnable

Enables/disables the sharpening feature.

SharpeningThreshold

Controls the minimum intensity gradient change to invoke sharpening.

SoftwareSignalPulse

Generates a pulse signal that can be used as a software trigger.

SoftwareSignalSelector

Selects which Software Signal features to control.

SourceCount

Controls or returns the number of sources supported by the device.

SourceSelector

Selects the source to control.

TLParamsLocked

Property type

SpinIntNode.

Test0001

For testing only.

TestEventGenerate

This command generates a test event and sends it to the host.

TestPattern

Selects the type of test pattern that is generated by the device as image source.

TestPatternGeneratorSelector

Selects which test pattern generator is controlled by the TestPattern feature.

TestPendingAck

Tests the device's pending acknowledge feature.

TimerDelay

Sets the duration (in microseconds) of the delay to apply at the reception of a trigger before starting the Timer.

TimerDuration

Sets the duration (in microseconds) of the Timer pulse.

TimerReset

Does a software reset of the selected timer and starts it.

TimerSelector

Selects which Timer to configure.

TimerStatus

Returns the current status of the Timer.

TimerTriggerActivation

Selects the activation mode of the trigger to start the Timer.

TimerTriggerSource

Selects the source of the trigger to start the Timer.

TimerValue

Reads or writes the current value (in microseconds) of the selected Timer.

Timestamp

Reports the current value of the device timestamp counter.

TimestampLatch

Latches the current timestamp counter into TimestampLatchValue.

TimestampLatchValue

Returns the latched value of the timestamp counter.

TimestampReset

Resets the current value of the device timestamp counter.

TransferAbort

Aborts immediately the streaming of data block(s).

TransferBlockCount

Specifies the number of data blocks (images) that the device should stream before stopping.

TransferBurstCount

Number of Block(s) to transfer for each TransferBurstStart trigger.

TransferComponentSelector

Selects the color component for the control of the TransferStreamChannel feature.

TransferControlMode

Selects the control method for the transfers.

TransferOperationMode

Selects the operation mode of the transfer.

TransferPause

Pauses the streaming of data Block(s).

TransferQueueCurrentBlockCount

Returns number of data blocks (images) currently in the transfer queue.

TransferQueueMaxBlockCount

Returns the maximum number of data blocks (images) in the transfer queue

TransferQueueMode

Specifies the operation mode of the transfer queue.

TransferQueueOverflowCount

Returns number of images that have been lost before being transmitted because the transmit queue hasn't been cleared fast enough.

TransferResume

Resumes a data Blocks streaming that was previously paused by a TransferPause command.

TransferSelector

Selects which stream transfers are currently controlled by the selected Transfer features.

TransferStart

Starts the streaming of data blocks (images) out of the device.

TransferStatus

Reads the status of the Transfer module signal selected by TransferStatusSelector.

TransferStatusSelector

Selects which status of the transfer module to read.

TransferStop

Stops the streaming of data block (images).

TransferStreamChannel

Selects the streaming channel that will be used to transfer the selected stream of data.

TransferTriggerActivation

Specifies the activation mode of the transfer control trigger.

TransferTriggerMode

Controls if the selected trigger is active.

TransferTriggerSelector

Selects the type of transfer trigger to configure.

TransferTriggerSource

Specifies the signal to use as the trigger source for transfers.

TriggerActivation

Specifies the activation mode of the trigger.

TriggerDelay

Specifies the delay in microseconds (us) to apply after the trigger reception before activating it.

TriggerDivider

Specifies a division factor for the incoming trigger pulses.

TriggerEventTest

This command generates a test event and sends it to the host.

TriggerMode

Controls whether or not trigger is active.

TriggerMultiplier

Specifies a multiplication factor for the incoming trigger pulses.

TriggerOverlap

Specifies the overlap mode of the trigger.

TriggerSelector

Selects the type of trigger to configure.

TriggerSoftware

Generates an internal trigger if Trigger Source is set to Software.

TriggerSource

Specifies the internal signal or physical input line to use as the trigger source.

UserOutputSelector

Selects which bit of the User Output register is set by UserOutputValue.

UserOutputValue

Value of the selected user output, either logic high (enabled) or logic low (disabled).

UserOutputValueAll

Returns the current status of all the user output status bits in a hexadecimal representation (UserOutput 0 status corresponds to bit 0, UserOutput 1 status with bit 1, etc).

UserOutputValueAllMask

Sets the write mask to apply to the value specified by UserOutputValueAll before writing it in the User Output register.

UserSetDefault

Selects the feature User Set to load and make active by default when the device is restarted.

UserSetFeatureEnable

Whether or not the selected feature is saved to user sets.

UserSetLoad

Loads the User Set specified by UserSetSelector to the device and makes it active.

UserSetSave

Saves the User Set specified by UserSetSelector to the non-volatile memory of the device.

UserSetSelector

Selects the feature User Set to load, save or configure.

V3_3Enable

Internally generated 3.3V rail.

WhiteClip

Controls the maximal intensity taken by the video signal before being clipped as an absolute physical value.

WhiteClipSelector

Selects which White Clip to control.

Width

Width of the image provided by the device (in pixels).

WidthMax

Maximum width of the image (in pixels).

aPAUSEMACCtrlFramesReceived

Reports the number of received PAUSE frames.

aPAUSEMACCtrlFramesTransmitted

Reports the number of transmitted PAUSE frames.

bool_nodes

bool_nodes: list A list of all the names of the bool nodes.

command_nodes

command_nodes: list A list of all the names of the command nodes.

enum_nodes

enum_nodes: list A list of all the names of the enum nodes.

float_nodes

float_nodes: list A list of all the names of the float nodes.

int_nodes

int_nodes: list A list of all the names of the integer nodes.

register_nodes

register_nodes: list A list of all the names of the register nodes.

str_nodes

str_nodes: list A list of all the names of the string nodes.

AasRoiEnable

Controls whether a user-specified ROI is used for auto algorithm that is currently selected by the AutoAlgorithmSelector feature.

Property type

SpinBoolNode.

Visibility

default.

AasRoiHeight

Controls the width of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature.

Property type

SpinIntNode.

Visibility

default.

AasRoiOffsetX

Controls the x-offset of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature.

Property type

SpinIntNode.

Visibility

default.

AasRoiOffsetY

Controls the y-offset of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature.

Property type

SpinIntNode.

Visibility

default.

AasRoiWidth

Controls the width of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature.

Property type

SpinIntNode.

Visibility

default.

AcquisitionAbort

Aborts the Acquisition immediately. This will end the capture without completing the current Frame or waiting on a trigger. If no Acquisition is in progress, the command is ignored.

Property type

SpinCommandNode.

Visibility

default.

AcquisitionArm

Arms the device before an AcquisitionStart command. This optional command validates all the current features for consistency and prepares the device for a fast start of the Acquisition.

Property type

SpinCommandNode.

Visibility

default.

AcquisitionBurstFrameCount

This feature is used only if the FrameBurstStart trigger is enabled and the FrameBurstEnd trigger is disabled. Note that the total number of frames captured is also conditioned by AcquisitionFrameCount if AcquisitionMode is MultiFrame and ignored if AcquisitionMode is Single.

Property type

SpinIntNode.

Visibility

default.

AcquisitionFrameCount

Number of images to acquire during a multi frame acquisition.

Property type

SpinIntNode.

Visibility

default.

AcquisitionFrameRate

User controlled acquisition frame rate in Hertz

Property type

SpinFloatNode.

Visibility

default.

AcquisitionFrameRateEnable

If enabled, AcquisitionFrameRate can be used to manually control the frame rate.

Property type

SpinBoolNode.

Visibility

default.

AcquisitionLineRate

Controls the rate (in Hertz) at which the Lines in a Frame are captured.

Property type

SpinFloatNode.

Visibility

default.

AcquisitionMode

Sets the acquisition mode of the device. Continuous: acquires images continuously. Multi Frame: acquires a specified number of images before stopping acquisition. Single Frame: acquires 1 image before stopping acquisition.

Property type

SpinEnumDefNode.

Enum entries

AcquisitionMode_names.

Visibility

default.

AcquisitionResultingFrameRate

Resulting frame rate in Hertz. If this does not equal the Acquisition Frame Rate it is because the Exposure Time is greater than the frame time.

Property type

SpinFloatNode.

Visibility

default.

AcquisitionStart

This command starts the acquisition of images.

Property type

SpinCommandNode.

Visibility

default.

AcquisitionStatus

Reads the state of the internal acquisition signal selected using AcquisitionStatusSelector.

Property type

SpinBoolNode.

Visibility

default.

AcquisitionStatusSelector

Selects the internal acquisition signal to read using AcquisitionStatus.

Property type

SpinEnumDefNode.

Enum entries

AcquisitionStatusSelector_names.

Visibility

default.

AcquisitionStop

This command stops the acquisition of images.

Property type

SpinCommandNode.

Visibility

default.

ActionDeviceKey

Provides the device key that allows the device to check the validity of action commands. The device internal assertion of an action signal is only authorized if the ActionDeviceKey and the action device key value in the protocol message are equal.

Property type

SpinIntNode.

Visibility

default.

ActionGroupKey

Provides the key that the device will use to validate the action on reception of the action protocol message.

Property type

SpinIntNode.

Visibility

default.

ActionGroupMask

Provides the mask that the device will use to validate the action on reception of the action protocol message.

Property type

SpinIntNode.

Visibility

default.

ActionQueueSize

Indicates the size of the scheduled action commands queue. This number represents the maximum number of scheduled action commands that can be pending at a given point in time.

Property type

SpinIntNode.

Visibility

default.

ActionSelector

Selects to which Action Signal further Action settings apply.

Property type

SpinIntNode.

Visibility

default.

ActionUnconditionalMode

Enables the unconditional action command mode where action commands are processed even when the primary control channel is closed.

Property type

SpinEnumDefNode.

Enum entries

ActionUnconditionalMode_names.

Visibility

default.

AdaptiveCompressionEnable

Controls whether lossless compression adapts to the image content. If disabled, a fixed encoding table is used.

Property type

SpinBoolNode.

Visibility

default.

AdcBitDepth

Selects which ADC bit depth to use. A higher ADC bit depth results in better image quality but slower maximum frame rate.

Property type

SpinEnumDefNode.

Enum entries

AdcBitDepth_names.

Visibility

default.

AutoAlgorithmSelector

Selects which Auto Algorithm is controlled by the RoiEnable, OffsetX, OffsetY, Width, Height features.

Property type

SpinEnumDefNode.

Enum entries

AutoAlgorithmSelector_names.

Visibility

default.

AutoExposureControlLoopDamping

It controls how fast the exposure and gain get settled. If the value is too small, it may cause the system to be unstable. Range is from 0.0 to 1.0. Default = 0.2.

Property type

SpinFloatNode.

Visibility

default.

AutoExposureControlPriority

Selects whether to adjust gain or exposure first. When gain priority is selected, the camera fixes the gain to 0 dB, and the exposure is adjusted according to the target grey level. If the maximum exposure is reached before the target grey level is hit, the gain starts to change to meet the target. This mode is used to have the minimum noise. When exposure priority is selected, the camera sets the exposure to a small value (default is 5 ms). The gain is adjusted according to the target grey level. If maximum gain is reached before the target grey level is hit, the exposure starts to change to meet the target. This mode is used to capture fast motion.

Property type

SpinEnumDefNode.

Enum entries

AutoExposureControlPriority_names.

Visibility

default.

AutoExposureEVCompensation

The EV compensation value used in the exposure compensation. This allows you to adjust the resultant image intensity with one control. A positive value makes the image brighter. A negative value makes the image darker. Range from -3 to 3 with a step of 1/3. Default = 0.

Property type

SpinFloatNode.

Visibility

default.

AutoExposureExposureTimeLowerLimit

The smallest exposure time that auto exposure can set.

Property type

SpinFloatNode.

Visibility

default.

AutoExposureExposureTimeUpperLimit

The largest exposure time that auto exposure can set.

Property type

SpinFloatNode.

Visibility

default.

AutoExposureGainLowerLimit

The smallest gain that auto exposure can set.

Property type

SpinFloatNode.

Visibility

default.

AutoExposureGainUpperLimit

The largest gain that auto exposure can set.

Property type

SpinFloatNode.

Visibility

default.

AutoExposureGreyValueLowerLimit

The lowest value in percentage that the target mean may reach.

Property type

SpinFloatNode.

Visibility

default.

AutoExposureGreyValueUpperLimit

The highest value in percentage that the target mean may reach.

Property type

SpinFloatNode.

Visibility

default.

AutoExposureLightingMode

Selects a lighting mode: Backlight, Frontlight or Normal (default). a. Backlight compensation: used when a strong light is coming from the back of the object. b. Frontlight compensation: used when a strong light is shining in the front of the object while the background is dark. c. Normal lighting: used when the object is not under backlight or frontlight conditions. When normal lighting is selected, metering modes are available.

Property type

SpinEnumDefNode.

Enum entries

AutoExposureLightingMode_names.

Visibility

default.

AutoExposureMeteringMode

Selects a metering mode: average, spot, or partial metering. a. Average: Measures the light from the entire scene uniformly to determine the final exposure value. Every portion of the exposed area has the same contribution. b. Spot: Measures a small area (about 3%) in the center of the scene while the rest of the scene is ignored. This mode is used when the scene has a high contrast and the object of interest is relatively small. c. Partial: Measures the light from a larger area (about 11%) in the center of the scene. This mode is used when very dark or bright regions appear at the edge of the frame. Note: Metering mode is available only when Lighting Mode Selector is Normal.

Property type

SpinEnumDefNode.

Enum entries

AutoExposureMeteringMode_names.

Visibility

default.

AutoExposureTargetGreyValue

This is the user-specified target grey level (image mean) to apply to the current image. Note that the target grey level is in the linear domain before gamma correction is applied.

Property type

SpinFloatNode.

Visibility

default.

AutoExposureTargetGreyValueAuto

This indicates whether the target image grey level is automatically set by the camera or manually set by the user. Note that the target grey level is in the linear domain before gamma correction is applied.

Property type

SpinEnumDefNode.

Enum entries

AutoExposureTargetGreyValueAuto_names.

Visibility

default.

BalanceRatio

Controls the balance ratio of the selected color relative to green. Used for white balancing.

Property type

SpinFloatNode.

Visibility

default.

BalanceRatioSelector

Selects a balance ratio to configure once a balance ratio control has been selected.

Property type

SpinEnumDefNode.

Enum entries

BalanceRatioSelector_names.

Visibility

default.

BalanceWhiteAuto

White Balance compensates for color shifts caused by different lighting conditions. It can be automatically or manually controlled. For manual control, set to Off. For automatic control, set to Once or Continuous.

Property type

SpinEnumDefNode.

Enum entries

BalanceWhiteAuto_names.

Visibility

default.

BalanceWhiteAutoDamping

Controls how quickly ‘BalanceWhiteAuto’ adjusts the values for Red and Blue BalanceRatio in response to changing conditions. Higher damping means the changes are more gradual.

Property type

SpinFloatNode.

Visibility

default.

BalanceWhiteAutoLowerLimit

Controls the minimum value Auto White Balance can set for the Red/Blue BalanceRatio.

Property type

SpinFloatNode.

Visibility

default.

BalanceWhiteAutoProfile

Selects the profile used by BalanceWhiteAuto.

Property type

SpinEnumDefNode.

Enum entries

BalanceWhiteAutoProfile_names.

Visibility

default.

BalanceWhiteAutoUpperLimit

Controls the maximum value Auto White Balance can set the Red/Blue BalanceRatio.

Property type

SpinFloatNode.

Visibility

default.

BinningHorizontal

Number of horizontal photo-sensitive cells to combine together. This reduces the horizontal resolution (width) of the image. A value of 1 indicates that no horizontal binning is performed by the camera. This value must be 1 for decimation to be active.

Property type

SpinIntNode.

Visibility

default.

BinningHorizontalMode
Property type

SpinEnumDefNode.

Enum entries

BinningHorizontalMode_names.

Visibility

default.

BinningSelector

Selects which binning engine is controlled by the BinningHorizontal and BinningVertical features.

Property type

SpinEnumDefNode.

Enum entries

BinningSelector_names.

Visibility

default.

BinningVertical

Number of vertical photo-sensitive cells to combine together. This reduces the vertical resolution (height) of the image. A value of 1 indicates that no vertical binning is performed by the camera. This value must be 1 for decimation to be active.

Property type

SpinIntNode.

Visibility

default.

BinningVerticalMode
Property type

SpinEnumDefNode.

Enum entries

BinningVerticalMode_names.

Visibility

default.

BlackLevel

Controls the offset of the video signal in percent.

Property type

SpinFloatNode.

Visibility

default.

BlackLevelAuto

Controls the mode for automatic black level adjustment. The exact algorithm used to implement this adjustment is device-specific.

Property type

SpinEnumDefNode.

Enum entries

BlackLevelAuto_names.

Visibility

default.

BlackLevelAutoBalance

Controls the mode for automatic black level balancing between the sensor color channels or taps. The black level coefficients of each channel are adjusted so they are matched.

Property type

SpinEnumDefNode.

Enum entries

BlackLevelAutoBalance_names.

Visibility

default.

BlackLevelClampingEnable

Enable the black level auto clamping feature which performing dark current compensation.

Property type

SpinBoolNode.

Visibility

default.

BlackLevelRaw

Controls the offset of the video signal in camera specific units.

Property type

SpinIntNode.

Visibility

default.

BlackLevelSelector

Selects which black level to control. Only All can be set by the user. Analog and Digital are read-only.

Property type

SpinEnumDefNode.

Enum entries

BlackLevelSelector_names.

Visibility

default.

ChunkBlackLevel

Returns the black level used to capture the image.

Property type

SpinFloatNode.

Visibility

default.

ChunkBlackLevelSelector

Selects which black level to retrieve

Property type

SpinEnumDefNode.

Enum entries

ChunkBlackLevelSelector_names.

Visibility

default.

ChunkCRC

Returns the CRC of the image payload.

Property type

SpinIntNode.

Visibility

default.

ChunkCompressionMode

Returns the compression mode of the last image payload.

Property type

SpinIntNode.

Visibility

default.

ChunkCompressionRatio

Returns the compression ratio of the last image payload.

Property type

SpinFloatNode.

Visibility

default.

ChunkCounterSelector

Selects which counter to retrieve data from.

Property type

SpinEnumDefNode.

Enum entries

ChunkCounterSelector_names.

Visibility

default.

ChunkCounterValue

Returns the value of the selected Chunk counter at the time of the FrameStart event.

Property type

SpinIntNode.

Visibility

default.

ChunkEnable

Enables the inclusion of the selected Chunk data in the payload of the image.

Property type

SpinBoolNode.

Visibility

default.

ChunkEncoderSelector

Selects which Encoder to retrieve data from.

Property type

SpinEnumDefNode.

Enum entries

ChunkEncoderSelector_names.

Visibility

default.

ChunkEncoderStatus

Returns the motion status of the selected encoder.

Property type

SpinEnumDefNode.

Enum entries

ChunkEncoderStatus_names.

Visibility

default.

ChunkEncoderValue

Returns the counter’s value of the selected Encoder at the time of the FrameStart in area scan mode or the counter’s value at the time of the LineStart selected by ChunkScanLineSelector in LineScan mode.

Property type

SpinIntNode.

Visibility

default.

ChunkExposureEndLineStatusAll

Returns the status of all the I/O lines at the end of exposure event.

Property type

SpinIntNode.

Visibility

default.

ChunkExposureTime

Returns the exposure time used to capture the image.

Property type

SpinFloatNode.

Visibility

default.

ChunkExposureTimeSelector

Selects which exposure time is read by the ChunkExposureTime feature.

Property type

SpinEnumDefNode.

Enum entries

ChunkExposureTimeSelector_names.

Visibility

default.

ChunkFrameID

Returns the image frame ID.

Property type

SpinIntNode.

Visibility

default.

ChunkGain

Returns the gain used to capture the image.

Property type

SpinFloatNode.

Visibility

default.

ChunkGainSelector

Selects which gain to retrieve

Property type

SpinEnumDefNode.

Enum entries

ChunkGainSelector_names.

Visibility

default.

ChunkHeight

Returns the height of the image included in the payload.

Property type

SpinIntNode.

Visibility

default.

ChunkImage

Returns the image payload.

Property type

SpinIntNode.

Visibility

default.

ChunkImageComponent

Returns the component of the payload image. This can be used to identify the image component of a generic part in a multipart transfer.

Property type

SpinEnumDefNode.

Enum entries

ChunkImageComponent_names.

Visibility

default.

ChunkInferenceBoundingBoxResult

Returns the chunk inference bounding box result data.

Property type

SpinRegisterNode.

Visibility

default.

ChunkInferenceConfidence

Returns the chunk data inference confidence percentage.

Property type

SpinFloatNode.

Visibility

default.

ChunkInferenceFrameId

Returns the frame ID associated with the most recent inference result.

Property type

SpinIntNode.

Visibility

default.

ChunkInferenceResult

Returns the chunk data inference result.

Property type

SpinIntNode.

Visibility

default.

ChunkLinePitch

Returns the LinePitch of the image included in the payload.

Property type

SpinIntNode.

Visibility

default.

ChunkLineStatusAll

Returns the status of all the I/O lines at the time of the FrameStart internal event.

Property type

SpinIntNode.

Visibility

default.

ChunkModeActive

Activates the inclusion of Chunk data in the payload of the image.

Property type

SpinBoolNode.

Visibility

default.

ChunkOffsetX

Returns the Offset X of the image included in the payload.

Property type

SpinIntNode.

Visibility

default.

ChunkOffsetY

Returns the Offset Y of the image included in the payload.

Property type

SpinIntNode.

Visibility

default.

ChunkPartSelector

Selects the part to access in chunk data in a multipart transmission.

Property type

SpinIntNode.

Visibility

default.

ChunkPixelDynamicRangeMax

Returns the maximum value of dynamic range of the image included in the payload.

Property type

SpinIntNode.

Visibility

default.

ChunkPixelDynamicRangeMin

Returns the minimum value of dynamic range of the image included in the payload.

Property type

SpinIntNode.

Visibility

default.

ChunkPixelFormat

Format of the pixel provided by the camera

Property type

SpinEnumDefNode.

Enum entries

ChunkPixelFormat_names.

Visibility

default.

ChunkRegionID

Returns the identifier of Region that the image comes from.

Property type

SpinEnumDefNode.

Enum entries

ChunkRegionID_names.

Visibility

default.

ChunkScan3dAxisMax

Returns the Maximum Axis value for the selected coordinate axis of the image included in the payload.

Property type

SpinFloatNode.

Visibility

default.

ChunkScan3dAxisMin

Returns the Minimum Axis value for the selected coordinate axis of the image included in the payload.

Property type

SpinFloatNode.

Visibility

default.

ChunkScan3dCoordinateOffset

Returns the Offset for the selected coordinate axis of the image included in the payload.

Property type

SpinFloatNode.

Visibility

default.

ChunkScan3dCoordinateReferenceSelector

Selector to read a coordinate system reference value defining the transform of a point from one system to the other.

Property type

SpinEnumDefNode.

Enum entries

ChunkScan3dCoordinateReferenceSelector_names.

Visibility

default.

ChunkScan3dCoordinateReferenceValue

Reads the value of a position or pose coordinate for the anchor or transformed coordinate systems relative to the reference point.

Property type

SpinFloatNode.

Visibility

default.

ChunkScan3dCoordinateScale

Returns the Scale for the selected coordinate axis of the image included in the payload.

Property type

SpinFloatNode.

Visibility

default.

ChunkScan3dCoordinateSelector

Selects which Coordinate to retrieve data from.

Property type

SpinEnumDefNode.

Enum entries

ChunkScan3dCoordinateSelector_names.

Visibility

default.

ChunkScan3dCoordinateSystem

Returns the Coordinate System of the image included in the payload.

Property type

SpinEnumDefNode.

Enum entries

ChunkScan3dCoordinateSystem_names.

Visibility

default.

ChunkScan3dCoordinateSystemReference

Returns the Coordinate System Position of the image included in the payload.

Property type

SpinEnumDefNode.

Enum entries

ChunkScan3dCoordinateSystemReference_names.

Visibility

default.

ChunkScan3dCoordinateTransformSelector

Selector for transform values.

Property type

SpinEnumDefNode.

Enum entries

ChunkScan3dCoordinateTransformSelector_names.

Visibility

default.

ChunkScan3dDistanceUnit

Returns the Distance Unit of the payload image.

Property type

SpinEnumDefNode.

Enum entries

ChunkScan3dDistanceUnit_names.

Visibility

default.

ChunkScan3dInvalidDataFlag

Returns if a specific non-valid data flag is used in the data stream.

Property type

SpinBoolNode.

Visibility

default.

ChunkScan3dInvalidDataValue

Returns the Invalid Data Value used for the image included in the payload.

Property type

SpinFloatNode.

Visibility

default.

ChunkScan3dOutputMode

Returns the Calibrated Mode of the payload image.

Property type

SpinEnumDefNode.

Enum entries

ChunkScan3dOutputMode_names.

Visibility

default.

ChunkScan3dTransformValue

Returns the transform value.

Property type

SpinFloatNode.

Visibility

default.

ChunkScanLineSelector

Index for vector representation of one chunk value per line in an image.

Property type

SpinIntNode.

Visibility

default.

ChunkSelector

Selects which chunk data to enable or disable.

Property type

SpinEnumDefNode.

Enum entries

ChunkSelector_names.

Visibility

default.

ChunkSequencerSetActive

Returns the index of the active set of the running sequencer included in the payload.

Property type

SpinIntNode.

Visibility

default.

ChunkSerialData

Returns the serial data that was received.

Property type

SpinStrNode.

Visibility

default.

ChunkSerialDataLength

Returns the length of the received serial data that was included in the payload.

Property type

SpinIntNode.

Visibility

default.

ChunkSerialReceiveOverflow

Returns the status of the chunk serial receive overflow.

Property type

SpinBoolNode.

Visibility

default.

ChunkSourceID

Returns the identifier of Source that the image comes from.

Property type

SpinEnumDefNode.

Enum entries

ChunkSourceID_names.

Visibility

default.

ChunkStreamChannelID

Returns identifier of the stream channel used to carry the block.

Property type

SpinIntNode.

Visibility

default.

ChunkTimerSelector

Selects which Timer to retrieve data from.

Property type

SpinEnumDefNode.

Enum entries

ChunkTimerSelector_names.

Visibility

default.

ChunkTimerValue

Returns the value of the selected Timer at the time of the FrameStart internal event.

Property type

SpinFloatNode.

Visibility

default.

ChunkTimestamp

Returns the Timestamp of the image.

Property type

SpinIntNode.

Visibility

default.

ChunkTimestampLatchValue

Returns the last Timestamp latched with the TimestampLatch command.

Property type

SpinIntNode.

Visibility

default.

ChunkTransferBlockID

Returns the unique identifier of the transfer block used to transport the payload.

Property type

SpinIntNode.

Visibility

default.

ChunkTransferQueueCurrentBlockCount

Returns the current number of blocks in the transfer queue.

Property type

SpinIntNode.

Visibility

default.

ChunkTransferStreamID

Returns identifier of the stream that generated this block.

Property type

SpinEnumDefNode.

Enum entries

ChunkTransferStreamID_names.

Visibility

default.

ChunkWidth

Returns the width of the image included in the payload.

Property type

SpinIntNode.

Visibility

default.

ClConfiguration

This Camera Link specific feature describes the configuration used by the camera. It helps especially when a camera is capable of operation in a non-standard configuration, and when the features PixelSize, SensorDigitizationTaps, and DeviceTapGeometry do not provide enough information for interpretation of the image data provided by the camera.

Property type

SpinEnumDefNode.

Enum entries

ClConfiguration_names.

Visibility

default.

ClTimeSlotsCount

This Camera Link specific feature describes the time multiplexing of the camera link connection to transfer more than the configuration allows, in one single clock.

Property type

SpinEnumDefNode.

Enum entries

ClTimeSlotsCount_names.

Visibility

default.

ColorTransformationEnable

Enables/disables the color transform selected with ColorTransformationSelector. For RGB to YUV this is read-only. Enabling/disabling RGB to YUV can only be done by changing pixel format.

Property type

SpinBoolNode.

Visibility

default.

ColorTransformationSelector

Selects which Color Transformation module is controlled by the various Color Transformation features

Property type

SpinEnumDefNode.

Enum entries

ColorTransformationSelector_names.

Visibility

default.

ColorTransformationValue

Represents the value of the selected Gain factor or Offset inside the Transformation matrix in floating point precision.

Property type

SpinFloatNode.

Visibility

default.

ColorTransformationValueSelector

Selects the Gain factor or Offset of the Transformation matrix to access in the selected Color Transformation module

Property type

SpinEnumDefNode.

Enum entries

ColorTransformationValueSelector_names.

Visibility

default.

CompressionRatio

Reports the ratio between the uncompressed image size and compressed image size.

Property type

SpinFloatNode.

Visibility

default.

CompressionSaturationPriority

When FrameRate is enabled, camera drops frames if datarate is saturated. If FrameRate is disabled, camera adjusts the framerate to match the maximum achievable datarate.

Property type

SpinEnumDefNode.

Enum entries

CompressionSaturationPriority_names.

Visibility

default.

CounterDelay

Sets the delay (or number of events) before the CounterStart event is generated.

Property type

SpinIntNode.

Visibility

default.

CounterDuration

Sets the duration (or number of events) before the CounterEnd event is generated.

Property type

SpinIntNode.

Visibility

default.

CounterEventActivation

Selects the activation mode of the event to increment the Counter.

Property type

SpinEnumDefNode.

Enum entries

CounterEventActivation_names.

Visibility

default.

CounterEventSource

Selects the event that will increment the counter

Property type

SpinEnumDefNode.

Enum entries

CounterEventSource_names.

Visibility

default.

CounterReset

Does a software reset of the selected Counter and starts it. The counter starts counting events immediately after the reset unless a Counter trigger is active. CounterReset can be used to reset the Counter independently from the CounterResetSource. To disable the counter temporarily, set CounterEventSource to Off.

Property type

SpinCommandNode.

Visibility

default.

CounterResetActivation

Selects the Activation mode of the Counter Reset Source signal.

Property type

SpinEnumDefNode.

Enum entries

CounterResetActivation_names.

Visibility

default.

CounterResetSource

Selects the signal that will be the source to reset the counter.

Property type

SpinEnumDefNode.

Enum entries

CounterResetSource_names.

Visibility

default.

CounterSelector

Selects which counter to configure

Property type

SpinEnumDefNode.

Enum entries

CounterSelector_names.

Visibility

default.

CounterStatus

Returns the current status of the counter.

Property type

SpinEnumDefNode.

Enum entries

CounterStatus_names.

Visibility

default.

CounterTriggerActivation

Selects the activation mode of the trigger to start the counter.

Property type

SpinEnumDefNode.

Enum entries

CounterTriggerActivation_names.

Visibility

default.

CounterTriggerSource

Selects the source of the trigger to start the counter

Property type

SpinEnumDefNode.

Enum entries

CounterTriggerSource_names.

Visibility

default.

CounterValue

Current counter value

Property type

SpinIntNode.

Visibility

default.

CounterValueAtReset

Value of the selected Counter when it was reset by a trigger.

Property type

SpinIntNode.

Visibility

default.

CxpConnectionSelector

Selects the CoaXPress physical connection to control.

Property type

SpinIntNode.

Visibility

default.

CxpConnectionTestErrorCount

Reports the current connection error count for test packets recieved by the device on the connection selected by CxpConnectionSelector.

Property type

SpinIntNode.

Visibility

default.

CxpConnectionTestMode

Enables the test mode for an individual physical connection of the Device.

Property type

SpinEnumDefNode.

Enum entries

CxpConnectionTestMode_names.

Visibility

default.

CxpConnectionTestPacketCount

Reports the current count for test packets recieved by the device on the connection selected by CxpConnectionSelector.

Property type

SpinIntNode.

Visibility

default.

CxpLinkConfiguration

This feature allows specifying the Link configuration for the communication between the Receiver and Transmitter Device. In most cases this feature does not need to be written because automatic discovery will set configuration correctly to the value returned by CxpLinkConfigurationPreferred. Note that the currently active configuration of the Link can be read using CxpLinkConfigurationStatus.

Property type

SpinEnumDefNode.

Enum entries

CxpLinkConfiguration_names.

Visibility

default.

CxpLinkConfigurationPreferred

Provides the Link configuration that allows the Transmitter Device to operate in its default mode.

Property type

SpinEnumDefNode.

Enum entries

CxpLinkConfigurationPreferred_names.

Visibility

default.

CxpLinkConfigurationStatus

This feature indicates the current and active Link configuration used by the Device.

Property type

SpinEnumDefNode.

Enum entries

CxpLinkConfigurationStatus_names.

Visibility

default.

CxpPoCxpAuto

Activate automatic control of the Power over CoaXPress (PoCXP) for the Link.

Property type

SpinCommandNode.

Visibility

default.

CxpPoCxpStatus

Returns the Power over CoaXPress (PoCXP) status of the Device.

Property type

SpinEnumDefNode.

Enum entries

CxpPoCxpStatus_names.

Visibility

default.

CxpPoCxpTripReset

Reset the Power over CoaXPress (PoCXP) Link after an over-current trip on the Device connection(s).

Property type

SpinCommandNode.

Visibility

default.

CxpPoCxpTurnOff

Disable Power over CoaXPress (PoCXP) for the Link.

Property type

SpinCommandNode.

Visibility

default.

DecimationHorizontal

Horizontal decimation of the image. This reduces the horizontal resolution (width) of the image by only retaining a single pixel within a window whose size is the decimation factor specified here. A value of 1 indicates that no horizontal decimation is performed by the camera. This value must be 1 for binning to be active.

Property type

SpinIntNode.

Visibility

default.

DecimationHorizontalMode

The mode used to reduce the horizontal resolution when DecimationHorizontal is used. The current implementation only supports a single decimation mode: Discard. Average should be achieved via Binning.

Property type

SpinEnumDefNode.

Enum entries

DecimationHorizontalMode_names.

Visibility

default.

DecimationSelector

Selects which decimation layer is controlled by the DecimationHorizontal and DecimationVertical features.

Property type

SpinEnumDefNode.

Enum entries

DecimationSelector_names.

Visibility

default.

DecimationVertical

Vertical decimation of the image. This reduces the vertical resolution (height) of the image by only retaining a single pixel within a window whose size is the decimation factor specified here. A value of 1 indicates that no vertical decimation is performed by the camera. This value must be 1 for binning to be active.

Property type

SpinIntNode.

Visibility

default.

DecimationVerticalMode

The mode used to reduce the vertical resolution when DecimationVertical is used. The current implementation only supports a single decimation mode: Discard. Average should be achieved via Binning.

Property type

SpinEnumDefNode.

Enum entries

DecimationVerticalMode_names.

Visibility

default.

DefectCorrectStaticEnable

Enables/Disables table-based defective pixel correction.

Property type

SpinBoolNode.

Visibility

default.

DefectCorrectionMode

Controls the method used for replacing defective pixels.

Property type

SpinEnumDefNode.

Enum entries

DefectCorrectionMode_names.

Visibility

default.

DefectTableApply

Applies the current defect table, so that any changes made affect images captured by the camera. This writes the table to volatile memory, so changes to the table are lost if the camera loses power. To save the table to non-volatile memory, use DefectTableSave.

Property type

SpinCommandNode.

Visibility

default.

DefectTableCoordinateX

Returns the X coordinate of the defective pixel at DefectTableIndex within the defective pixel table. Changes made do not take effect in captured images until the command DefectTableApply is written.

Property type

SpinIntNode.

Visibility

default.

DefectTableCoordinateY

Returns the Y coordinate of the defective pixel at DefectTableIndex within the defective pixel table. Changes made do not take effect in captured images until the command DefectTableApply is written.

Property type

SpinIntNode.

Visibility

default.

DefectTableFactoryRestore

Restores the Defective Pixel Table to its factory default state, which was calibrated during manufacturing. This permanently overwrites any changes made to the defect table.

Property type

SpinCommandNode.

Visibility

default.

DefectTableIndex

Controls the offset of the element to access in the defective pixel location table.

Property type

SpinIntNode.

Visibility

default.

DefectTablePixelCount

The number of defective pixel locations in the current table.

Property type

SpinIntNode.

Visibility

default.

DefectTableSave

Saves the current defective pixel table non-volatile memory, so that it is preserved when the camera boots up. This overwrites the existing defective pixel table. The new table is loaded whenever the camera powers up.

Property type

SpinCommandNode.

Visibility

default.

Deinterlacing

Controls how the device performs de-interlacing.

Property type

SpinEnumDefNode.

Enum entries

Deinterlacing_names.

Visibility

default.

DeviceCharacterSet

Character set used by the strings of the device`s bootstrap registers.

Property type

SpinEnumDefNode.

Enum entries

DeviceCharacterSet_names.

Visibility

default.

DeviceClockFrequency

Returns the frequency of the selected Clock.

Property type

SpinFloatNode.

Visibility

default.

DeviceClockSelector

Selects the clock frequency to access from the device.

Property type

SpinEnumDefNode.

Enum entries

DeviceClockSelector_names.

Visibility

default.

DeviceConnectionSelector

Selects which Connection of the device to control.

Property type

SpinIntNode.

Visibility

default.

DeviceConnectionSpeed

Indicates the speed of transmission of the specified Connection

Property type

SpinIntNode.

Visibility

default.

DeviceConnectionStatus

Indicates the status of the specified Connection.

Property type

SpinEnumDefNode.

Enum entries

DeviceConnectionStatus_names.

Visibility

default.

DeviceEventChannelCount

Indicates the number of event channels supported by the device.

Property type

SpinIntNode.

Visibility

default.

DeviceFamilyName

Identifier of the product family of the device.

Property type

SpinStrNode.

Visibility

default.

DeviceFeaturePersistenceEnd

Indicate to the device the end of feature persistence.

Property type

SpinCommandNode.

Visibility

default.

DeviceFeaturePersistenceStart

Indicate to the device and GenICam XML to get ready for persisting of all streamable features.

Property type

SpinCommandNode.

Visibility

default.

DeviceFirmwareVersion

Version of the firmware on the device.

Property type

SpinStrNode.

Visibility

default.

DeviceGenCPVersionMajor

Major version of the GenCP protocol supported by the device.

Property type

SpinIntNode.

Visibility

default.

DeviceGenCPVersionMinor

Minor version of the GenCP protocol supported by the device.

Property type

SpinIntNode.

Visibility

default.

DeviceID

Device identifier (serial number).

Property type

SpinStrNode.

Visibility

default.

DeviceIndicatorMode

Controls the LED behaviour: Inactive (off), Active (current status), or Error Status (off unless an error occurs).

Property type

SpinEnumDefNode.

Enum entries

DeviceIndicatorMode_names.

Visibility

default.

DeviceLinkBandwidthReserve

Percentage of streamed data bandwidth reserved for packet resend.

Property type

SpinFloatNode.

Visibility

default.

DeviceLinkCommandTimeout

Indicates the command timeout of the specified Link. This corresponds to the maximum response time of the device for a command sent on that link.

Property type

SpinFloatNode.

Visibility

default.

DeviceLinkConnectionCount

Returns the number of physical connection of the device used by a particular Link.

Property type

SpinIntNode.

Visibility

default.

DeviceLinkCurrentThroughput

Current bandwidth of streamed data.

Property type

SpinIntNode.

Visibility

default.

DeviceLinkHeartbeatMode

Activate or deactivate the Link’s heartbeat.

Property type

SpinEnumDefNode.

Enum entries

DeviceLinkHeartbeatMode_names.

Visibility

default.

DeviceLinkHeartbeatTimeout

Controls the current heartbeat timeout of the specific Link.

Property type

SpinFloatNode.

Visibility

default.

DeviceLinkSelector

Selects which Link of the device to control.

Property type

SpinIntNode.

Visibility

default.

DeviceLinkSpeed

Indicates the speed of transmission negotiated on the specified Link. (Bps)

Property type

SpinIntNode.

Visibility

default.

DeviceLinkThroughputLimit

Limits the maximum bandwidth 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 type

SpinIntNode.

Visibility

default.

DeviceLinkThroughputLimitMode

Controls if the DeviceLinkThroughputLimit is active. When disabled, lower level TL specific features are expected to control the throughput. When enabled, DeviceLinkThroughputLimit controls the overall throughput.

Property type

SpinEnumDefNode.

Enum entries

DeviceLinkThroughputLimitMode_names.

Visibility

default.

DeviceManifestEntrySelector

Selects the manifest entry to reference.

Property type

SpinIntNode.

Visibility

default.

DeviceManifestPrimaryURL

Indicates the first URL to the GenICam XML device description file of the selected manifest entry.

Property type

SpinStrNode.

Visibility

default.

DeviceManifestSchemaMajorVersion

Indicates the major version number of the schema file of the selected manifest entry.

Property type

SpinIntNode.

Visibility

default.

DeviceManifestSchemaMinorVersion

Indicates the minor version number of the schema file of the selected manifest entry.

Property type

SpinIntNode.

Visibility

default.

DeviceManifestSecondaryURL

Indicates the second URL to the GenICam XML device description file of the selected manifest entry.

Property type

SpinStrNode.

Visibility

default.

DeviceManifestXMLMajorVersion

Indicates the major version number of the GenICam XML file of the selected manifest entry.

Property type

SpinIntNode.

Visibility

default.

DeviceManifestXMLMinorVersion

Indicates the minor version number of the GenICam XML file of the selected manifest entry.

Property type

SpinIntNode.

Visibility

default.

DeviceManifestXMLSubMinorVersion

Indicates the subminor version number of the GenICam XML file of the selected manifest entry.

Property type

SpinIntNode.

Visibility

default.

DeviceManufacturerInfo

Manufacturer information about the device.

Property type

SpinStrNode.

Visibility

default.

DeviceMaxThroughput

Maximum bandwidth 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 type

SpinIntNode.

Visibility

default.

DeviceModelName

Model of the device.

Property type

SpinStrNode.

Visibility

default.

DevicePowerSupplySelector

Selects the power supply source to control or read.

Property type

SpinEnumDefNode.

Enum entries

DevicePowerSupplySelector_names.

Visibility

default.

DeviceRegistersCheck

Perform the validation of the current register set for consistency. This will update the DeviceRegistersValid flag.

Property type

SpinCommandNode.

Visibility

default.

DeviceRegistersEndianness

Endianness of the registers of the device.

Property type

SpinEnumDefNode.

Enum entries

DeviceRegistersEndianness_names.

Visibility

default.

DeviceRegistersStreamingEnd

Announce the end of registers streaming. This will do a register set validation for consistency and activate it. This will also update the DeviceRegistersValid flag.

Property type

SpinCommandNode.

Visibility

default.

DeviceRegistersStreamingStart

Prepare the device for registers streaming without checking for consistency.

Property type

SpinCommandNode.

Visibility

default.

DeviceRegistersValid

Returns if the current register set is valid and consistent.

Property type

SpinBoolNode.

Visibility

default.

DeviceReset

This is a command that immediately resets and reboots the device.

Property type

SpinCommandNode.

Visibility

default.

DeviceSFNCVersionMajor

Major version of the Standard Features Naming Convention that was used to create the device’s GenICam XML.

Property type

SpinIntNode.

Visibility

default.

DeviceSFNCVersionMinor

Minor version of the Standard Features Naming Convention that was used to create the device’s GenICam XML.

Property type

SpinIntNode.

Visibility

default.

DeviceSFNCVersionSubMinor

Sub minor version of Standard Features Naming Convention that was used to create the device’s GenICam XML.

Property type

SpinIntNode.

Visibility

default.

DeviceScanType

Scan type of the sensor of the device.

Property type

SpinEnumDefNode.

Enum entries

DeviceScanType_names.

Visibility

default.

DeviceSerialNumber

Device’s serial number. This string is a unique identifier of the device.

Property type

SpinStrNode.

Visibility

default.

DeviceSerialPortBaudRate

This feature controls the baud rate used by the selected serial port.

Property type

SpinEnumDefNode.

Enum entries

DeviceSerialPortBaudRate_names.

Visibility

default.

DeviceSerialPortSelector

Selects which serial port of the device to control.

Property type

SpinEnumDefNode.

Enum entries

DeviceSerialPortSelector_names.

Visibility

default.

DeviceStreamChannelCount

Indicates the number of streaming channels supported by the device.

Property type

SpinIntNode.

Visibility

default.

DeviceStreamChannelEndianness

Endianness of multi-byte pixel data for this stream.

Property type

SpinEnumDefNode.

Enum entries

DeviceStreamChannelEndianness_names.

Visibility

default.

Index of device’s Link to use for streaming the specifed stream channel.

Property type

SpinIntNode.

Visibility

default.

DeviceStreamChannelPacketSize

Specifies the stream packet size, in bytes, to send on the selected channel for a Transmitter or specifies the maximum packet size supported by a receiver.

Property type

SpinIntNode.

Visibility

default.

DeviceStreamChannelSelector

Selects the stream channel to control.

Property type

SpinIntNode.

Visibility

default.

DeviceStreamChannelType

Reports the type of the stream channel.

Property type

SpinEnumDefNode.

Enum entries

DeviceStreamChannelType_names.

Visibility

default.

DeviceTLType

Transport Layer type of the device.

Property type

SpinEnumDefNode.

Enum entries

DeviceTLType_names.

Visibility

default.

DeviceTLVersionMajor

Major version of the Transport Layer of the device.

Property type

SpinIntNode.

Visibility

default.

DeviceTLVersionMinor

Minor version of the Transport Layer of the device.

Property type

SpinIntNode.

Visibility

default.

DeviceTLVersionSubMinor

Sub minor version of the Transport Layer of the device.

Property type

SpinIntNode.

Visibility

default.

DeviceTapGeometry

This device tap geometry feature describes the geometrical properties characterizing the taps of a camera as presented at the output of the device.

Property type

SpinEnumDefNode.

Enum entries

DeviceTapGeometry_names.

Visibility

default.

DeviceTemperature

Device temperature in degrees Celsius (C).

Property type

SpinFloatNode.

Visibility

default.

DeviceTemperatureSelector

Selects the location within the device, where the temperature will be measured.

Property type

SpinEnumDefNode.

Enum entries

DeviceTemperatureSelector_names.

Visibility

default.

DeviceType

Returns the device type.

Property type

SpinEnumDefNode.

Enum entries

DeviceType_names.

Visibility

default.

DeviceUptime

Total time since the device was powered up in seconds.

Property type

SpinIntNode.

Visibility

default.

DeviceUserID

User-programmable device identifier.

Property type

SpinStrNode.

Visibility

default.

DeviceVendorName

Name of the manufacturer of the device.

Property type

SpinStrNode.

Visibility

default.

DeviceVersion

Version of the device.

Property type

SpinStrNode.

Visibility

default.

EncoderDivider

Sets how many Encoder increment/decrements that are needed generate an Encoder output pulse signal.

Property type

SpinIntNode.

Visibility

default.

EncoderMode

Selects if the count of encoder uses FourPhase mode with jitter filtering or the HighResolution mode without jitter filtering.

Property type

SpinEnumDefNode.

Enum entries

EncoderMode_names.

Visibility

default.

EncoderOutputMode

Selects the conditions for the Encoder interface to generate a valid Encoder output signal.

Property type

SpinEnumDefNode.

Enum entries

EncoderOutputMode_names.

Visibility

default.

EncoderReset

Does a software reset of the selected Encoder and starts it. The Encoder starts counting events immediately after the reset. EncoderReset can be used to reset the Encoder independently from the EncoderResetSource.

Property type

SpinCommandNode.

Visibility

default.

EncoderResetActivation

Selects the Activation mode of the Encoder Reset Source signal.

Property type

SpinEnumDefNode.

Enum entries

EncoderResetActivation_names.

Visibility

default.

EncoderResetSource

Selects the signals that will be the source to reset the Encoder.

Property type

SpinEnumDefNode.

Enum entries

EncoderResetSource_names.

Visibility

default.

EncoderSelector

Selects which Encoder to configure.

Property type

SpinEnumDefNode.

Enum entries

EncoderSelector_names.

Visibility

default.

EncoderSourceA

Selects the signal which will be the source of the A input of the Encoder.

Property type

SpinEnumDefNode.

Enum entries

EncoderSourceA_names.

Visibility

default.

EncoderSourceB

Selects the signal which will be the source of the B input of the Encoder.

Property type

SpinEnumDefNode.

Enum entries

EncoderSourceB_names.

Visibility

default.

EncoderStatus

Returns the motion status of the encoder.

Property type

SpinEnumDefNode.

Enum entries

EncoderStatus_names.

Visibility

default.

EncoderTimeout

Sets the maximum time interval between encoder counter increments before the status turns to static.

Property type

SpinFloatNode.

Visibility

default.

EncoderValue

Reads or writes the current value of the position counter of the selected Encoder.

Property type

SpinIntNode.

Visibility

default.

EncoderValueAtReset

Reads the value of the of the position counter of the selected Encoder when it was reset by a signal or by an explicit EncoderReset command.

Property type

SpinIntNode.

Visibility

default.

EnumerationCount

Number of enumerations since uptime.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionEnd

Returns the unique Identifier of the Acquisition End type of Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Acquisition End Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionEndTimestamp

Returns the Timestamp of the Acquisition End Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionError

Returns the unique Identifier of the Acquisition Error type of Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionErrorFrameID

Returns the unique Identifier of the Frame (or image) that generated the Acquisition Error Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionErrorTimestamp

Returns the Timestamp of the Acquisition Error Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionStart

Returns the unique Identifier of the Acquisition Start type of Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Acquisition Start Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionStartTimestamp

Returns the Timestamp of the Acquisition Start Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionTransferEnd

Returns the unique Identifier of the Acquisition Transfer End type of Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionTransferEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Acquisition Transfer End Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionTransferEndTimestamp

Returns the Timestamp of the Acquisition Transfer End Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionTransferStart

Returns the unique Identifier of the Acquisition Transfer Start type of Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionTransferStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Acquisition Transfer Start Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionTransferStartTimestamp

Returns the Timestamp of the Acquisition Transfer Start Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionTrigger

Returns the unique Identifier of the Acquisition Trigger type of Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionTriggerFrameID

Returns the unique Identifier of the Frame (or image) that generated the Acquisition Trigger Event.

Property type

SpinIntNode.

Visibility

default.

EventAcquisitionTriggerTimestamp

Returns the Timestamp of the Acquisition Trigger Event.

Property type

SpinIntNode.

Visibility

default.

EventActionLate

Returns the unique Identifier of the Action Late type of Event.

Property type

SpinIntNode.

Visibility

default.

EventActionLateFrameID

Returns the unique Identifier of the Frame (or image) that generated the Action Late Event.

Property type

SpinIntNode.

Visibility

default.

EventActionLateTimestamp

Returns the Timestamp of the Action Late Event.

Property type

SpinIntNode.

Visibility

default.

EventCounter0End

Returns the unique Identifier of the Counter 0 End type of Event.

Property type

SpinIntNode.

Visibility

default.

EventCounter0EndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Counter 0 End Event.

Property type

SpinIntNode.

Visibility

default.

EventCounter0EndTimestamp

Returns the Timestamp of the Counter 0 End Event.

Property type

SpinIntNode.

Visibility

default.

EventCounter0Start

Returns the unique Identifier of the Counter 0 Start type of Event.

Property type

SpinIntNode.

Visibility

default.

EventCounter0StartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Counter 0 Start Event.

Property type

SpinIntNode.

Visibility

default.

EventCounter0StartTimestamp

Returns the Timestamp of the Counter 0 Start Event.

Property type

SpinIntNode.

Visibility

default.

EventCounter1End

Returns the unique Identifier of the Counter 1 End type of Event.

Property type

SpinIntNode.

Visibility

default.

EventCounter1EndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Counter 1 End Event.

Property type

SpinIntNode.

Visibility

default.

EventCounter1EndTimestamp

Returns the Timestamp of the Counter 1 End Event.

Property type

SpinIntNode.

Visibility

default.

EventCounter1Start

Returns the unique Identifier of the Counter 1 Start type of Event.

Property type

SpinIntNode.

Visibility

default.

EventCounter1StartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Counter 1 Start Event.

Property type

SpinIntNode.

Visibility

default.

EventCounter1StartTimestamp

Returns the Timestamp of the Counter 1 Start Event.

Property type

SpinIntNode.

Visibility

default.

EventEncoder0Restarted

Returns the unique Identifier of the Encoder 0 Restarted type of Event.

Property type

SpinIntNode.

Visibility

default.

EventEncoder0RestartedFrameID

Returns the unique Identifier of the Frame (or image) that generated the Encoder 0 Restarted Event.

Property type

SpinIntNode.

Visibility

default.

EventEncoder0RestartedTimestamp

Returns the Timestamp of the Encoder 0 Restarted Event.

Property type

SpinIntNode.

Visibility

default.

EventEncoder0Stopped

Returns the unique Identifier of the Encoder 0 Stopped type of Event.

Property type

SpinIntNode.

Visibility

default.

EventEncoder0StoppedFrameID

Returns the unique Identifier of the Frame (or image) that generated the Encoder 0 Stopped Event.

Property type

SpinIntNode.

Visibility

default.

EventEncoder0StoppedTimestamp

Returns the Timestamp of the Encoder 0 Stopped Event.

Property type

SpinIntNode.

Visibility

default.

EventEncoder1Restarted

Returns the unique Identifier of the Encoder 1 Restarted type of Event.

Property type

SpinIntNode.

Visibility

default.

EventEncoder1RestartedFrameID

Returns the unique Identifier of the Frame (or image) that generated the Encoder 1 Restarted Event.

Property type

SpinIntNode.

Visibility

default.

EventEncoder1RestartedTimestamp

Returns the Timestamp of the Encoder 1 Restarted Event.

Property type

SpinIntNode.

Visibility

default.

EventEncoder1Stopped

Returns the unique Identifier of the Encoder 1 Stopped type of Event.

Property type

SpinIntNode.

Visibility

default.

EventEncoder1StoppedFrameID

Returns the unique Identifier of the Frame (or image) that generated the Encoder 1 Stopped Event.

Property type

SpinIntNode.

Visibility

default.

EventEncoder1StoppedTimestamp

Returns the Timestamp of the Encoder 1 Stopped Event.

Property type

SpinIntNode.

Visibility

default.

EventError

Returns the unique identifier of the Error type of Event.

Property type

SpinIntNode.

Visibility

default.

EventErrorCode

Returns the error code for the error that happened

Property type

SpinIntNode.

Visibility

default.

EventErrorFrameID

Returns the unique Identifier of the Frame (or image) that generated the Error Event.

Property type

SpinIntNode.

Visibility

default.

EventErrorTimestamp

Returns the Timestamp of the Error Event.

Property type

SpinIntNode.

Visibility

default.

EventExposureEnd

Returns the unique identifier of the Exposure End type of Event.

Property type

SpinIntNode.

Visibility

default.

EventExposureEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Exposure End Event.

Property type

SpinIntNode.

Visibility

default.

EventExposureEndTimestamp

Returns the Timestamp of the Exposure End Event.

Property type

SpinIntNode.

Visibility

default.

EventExposureStart

Returns the unique Identifier of the Exposure Start type of Event.

Property type

SpinIntNode.

Visibility

default.

EventExposureStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Exposure Start Event.

Property type

SpinIntNode.

Visibility

default.

EventExposureStartTimestamp

Returns the Timestamp of the Exposure Start Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameBurstEnd

Returns the unique Identifier of the Frame Burst End type of Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameBurstEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Frame Burst End Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameBurstEndTimestamp

Returns the Timestamp of the Frame Burst End Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameBurstStart

Returns the unique Identifier of the Frame Burst Start type of Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameBurstStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Frame Burst Start Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameBurstStartTimestamp

Returns the Timestamp of the Frame Burst Start Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameEnd

Returns the unique Identifier of the Frame End type of Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Frame End Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameEndTimestamp

Returns the Timestamp of the Frame End Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameStart

Returns the unique Identifier of the Frame Start type of Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Frame Start Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameStartTimestamp

Returns the Timestamp of the Frame Start Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameTransferEnd

Returns the unique Identifier of the Frame Transfer End type of Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameTransferEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Frame Transfer End Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameTransferEndTimestamp

Returns the Timestamp of the Frame Transfer End Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameTransferStart

Returns the unique Identifier of the Frame Transfer Start type of Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameTransferStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Frame Transfer Start Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameTransferStartTimestamp

Returns the Timestamp of the Frame Transfer Start Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameTrigger

Returns the unique Identifier of the FrameTrigger type of Event. It can be used to register a callback function to be notified of the event occurrence. Its value uniquely identifies the type event received.

Property type

SpinIntNode.

Visibility

default.

EventFrameTriggerFrameID

Returns the unique Identifier of the Frame (or image) that generated the FrameTrigger Event.

Property type

SpinIntNode.

Visibility

default.

EventFrameTriggerTimestamp

Returns the Timestamp of the FrameTrigger Event. It can be used to determine precisely when the event occurred.

Property type

SpinIntNode.

Visibility

default.

EventLine0AnyEdge

Returns the unique Identifier of the Line 0 Any Edge type of Event.

Property type

SpinIntNode.

Visibility

default.

EventLine0AnyEdgeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Line 0 Any Edge Event.

Property type

SpinIntNode.

Visibility

default.

EventLine0AnyEdgeTimestamp

Returns the Timestamp of the Line 0 Any Edge Event.

Property type

SpinIntNode.

Visibility

default.

EventLine0FallingEdge

Returns the unique Identifier of the Line 0 Falling Edge type of Event.

Property type

SpinIntNode.

Visibility

default.

EventLine0FallingEdgeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Line 0 Falling Edge Event.

Property type

SpinIntNode.

Visibility

default.

EventLine0FallingEdgeTimestamp

Returns the Timestamp of the Line 0 Falling Edge Event.

Property type

SpinIntNode.

Visibility

default.

EventLine0RisingEdge

Returns the unique Identifier of the Line 0 Rising Edge type of Event.

Property type

SpinIntNode.

Visibility

default.

EventLine0RisingEdgeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Line 0 Rising Edge Event.

Property type

SpinIntNode.

Visibility

default.

EventLine0RisingEdgeTimestamp

Returns the Timestamp of the Line 0 Rising Edge Event.

Property type

SpinIntNode.

Visibility

default.

EventLine1AnyEdge

Returns the unique Identifier of the Line 1 Any Edge type of Event.

Property type

SpinIntNode.

Visibility

default.

EventLine1AnyEdgeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Line 1 Any Edge Event.

Property type

SpinIntNode.

Visibility

default.

EventLine1AnyEdgeTimestamp

Returns the Timestamp of the Line 1 Any Edge Event.

Property type

SpinIntNode.

Visibility

default.

EventLine1FallingEdge

Returns the unique Identifier of the Line 1 Falling Edge type of Event.

Property type

SpinIntNode.

Visibility

default.

EventLine1FallingEdgeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Line 1 Falling Edge Event.

Property type

SpinIntNode.

Visibility

default.

EventLine1FallingEdgeTimestamp

Returns the Timestamp of the Line 1 Falling Edge Event.

Property type

SpinIntNode.

Visibility

default.

EventLine1RisingEdge

Returns the unique Identifier of the Line 1 Rising Edge type of Event.

Property type

SpinIntNode.

Visibility

default.

EventLine1RisingEdgeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Line 1 Rising Edge Event.

Property type

SpinIntNode.

Visibility

default.

EventLine1RisingEdgeTimestamp

Returns the Timestamp of the Line 1 Rising Edge Event.

Property type

SpinIntNode.

Visibility

default.

EventLinkSpeedChange

Returns the unique Identifier of the Link Speed Change type of Event.

Property type

SpinIntNode.

Visibility

default.

EventLinkSpeedChangeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Link Speed Change Event.

Property type

SpinIntNode.

Visibility

default.

EventLinkSpeedChangeTimestamp

Returns the Timestamp of the Link Speed Change Event.

Property type

SpinIntNode.

Visibility

default.

EventLinkTrigger0

Returns the unique Identifier of the Link Trigger 0 type of Event.

Property type

SpinIntNode.

Visibility

default.

EventLinkTrigger0FrameID

Returns the unique Identifier of the Frame (or image) that generated the Link Trigger 0 Event.

Property type

SpinIntNode.

Visibility

default.

EventLinkTrigger0Timestamp

Returns the Timestamp of the Link Trigger 0 Event.

Property type

SpinIntNode.

Visibility

default.

EventLinkTrigger1

Returns the unique Identifier of the Link Trigger 1 type of Event.

Property type

SpinIntNode.

Visibility

default.

EventLinkTrigger1FrameID

Returns the unique Identifier of the Frame (or image) that generated the Link Trigger 1 Event.

Property type

SpinIntNode.

Visibility

default.

EventLinkTrigger1Timestamp

Returns the Timestamp of the Link Trigger 1 Event.

Property type

SpinIntNode.

Visibility

default.

EventNotification

Enables/Disables the selected event.

Property type

SpinEnumDefNode.

Enum entries

EventNotification_names.

Visibility

default.

EventSelector

Selects which Event to enable or disable.

Property type

SpinEnumDefNode.

Enum entries

EventSelector_names.

Visibility

default.

EventSequencerSetChange

Returns the unique Identifier of the Sequencer Set Change type of Event.

Property type

SpinIntNode.

Visibility

default.

EventSequencerSetChangeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Sequencer Set Change Event.

Property type

SpinIntNode.

Visibility

default.

EventSequencerSetChangeTimestamp

Returns the Timestamp of the Sequencer Set Change Event.

Property type

SpinIntNode.

Visibility

default.

EventSerialData

Returns the serial data that was received.

Property type

SpinStrNode.

Visibility

default.

EventSerialDataLength

Returns the length of the received serial data that was included in the event payload.

Property type

SpinIntNode.

Visibility

default.

EventSerialPortReceive

Returns the unique identifier of the Serial Port Receive type of Event.

Property type

SpinIntNode.

Visibility

default.

EventSerialPortReceiveTimestamp

Returns the Timestamp of the Serial Port Receive Event.

Property type

SpinIntNode.

Visibility

default.

EventSerialReceiveOverflow

Returns the status of the event serial receive overflow.

Property type

SpinBoolNode.

Visibility

default.

EventStream0TransferBlockEnd

Returns the unique Identifier of the Stream 0 Transfer Block End type of Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferBlockEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Block End Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferBlockEndTimestamp

Returns the Timestamp of the Stream 0 Transfer Block End Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferBlockStart

Returns the unique Identifier of the Stream 0 Transfer Block Start type of Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferBlockStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Block Start Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferBlockStartTimestamp

Returns the Timestamp of the Stream 0 Transfer Block Start Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferBlockTrigger

Returns the unique Identifier of the Stream 0 Transfer Block Trigger type of Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferBlockTriggerFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Block Trigger Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferBlockTriggerTimestamp

Returns the Timestamp of the Stream 0 Transfer Block Trigger Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferBurstEnd

Returns the unique Identifier of the Stream 0 Transfer Burst End type of Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferBurstEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Burst End Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferBurstEndTimestamp

Returns the Timestamp of the Stream 0 Transfer Burst End Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferBurstStart

Returns the unique Identifier of the Stream 0 Transfer Burst Start type of Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferBurstStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Burst Start Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferBurstStartTimestamp

Returns the Timestamp of the Stream 0 Transfer Burst Start Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferEnd

Returns the unique Identifier of the Stream 0 Transfer End type of Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferEndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer End Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferEndTimestamp

Returns the Timestamp of the Stream 0 Transfer End Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferOverflow

Returns the unique Identifier of the Stream 0 Transfer Overflow type of Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferOverflowFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Overflow Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferOverflowTimestamp

Returns the Timestamp of the Stream 0 Transfer Overflow Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferPause

Returns the unique Identifier of the Stream 0 Transfer Pause type of Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferPauseFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Pause Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferPauseTimestamp

Returns the Timestamp of the Stream 0 Transfer Pause Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferResume

Returns the unique Identifier of the Stream 0 Transfer Resume type of Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferResumeFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Resume Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferResumeTimestamp

Returns the Timestamp of the Stream 0 Transfer Resume Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferStart

Returns the unique Identifier of the Stream 0 Transfer Start type of Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferStartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Start Event.

Property type

SpinIntNode.

Visibility

default.

EventStream0TransferStartTimestamp

Returns the Timestamp of the Stream 0 Transfer Start Event.

Property type

SpinIntNode.

Visibility

default.

EventTest

Returns the unique identifier of the Test type of Event.

Property type

SpinIntNode.

Visibility

default.

EventTestTimestamp

Returns the Timestamp of the Test Event.

Property type

SpinIntNode.

Visibility

default.

EventTimer0End

Returns the unique Identifier of the Timer 0 End type of Event.

Property type

SpinIntNode.

Visibility

default.

EventTimer0EndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Timer 0 End Event.

Property type

SpinIntNode.

Visibility

default.

EventTimer0EndTimestamp

Returns the Timestamp of the Timer 0 End Event.

Property type

SpinIntNode.

Visibility

default.

EventTimer0Start

Returns the unique Identifier of the Timer 0 Start type of Event.

Property type

SpinIntNode.

Visibility

default.

EventTimer0StartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Timer 0 Start Event.

Property type

SpinIntNode.

Visibility

default.

EventTimer0StartTimestamp

Returns the Timestamp of the Timer 0 Start Event.

Property type

SpinIntNode.

Visibility

default.

EventTimer1End

Returns the unique Identifier of the Timer 1 End type of Event.

Property type

SpinIntNode.

Visibility

default.

EventTimer1EndFrameID

Returns the unique Identifier of the Frame (or image) that generated the Timer 1 End Event.

Property type

SpinIntNode.

Visibility

default.

EventTimer1EndTimestamp

Returns the Timestamp of the Timer 1 End Event.

Property type

SpinIntNode.

Visibility

default.

EventTimer1Start

Returns the unique Identifier of the Timer 1 Start type of Event.

Property type

SpinIntNode.

Visibility

default.

EventTimer1StartFrameID

Returns the unique Identifier of the Frame (or image) that generated the Timer 1 Start Event.

Property type

SpinIntNode.

Visibility

default.

EventTimer1StartTimestamp

Returns the Timestamp of the Timer 1 Start Event.

Property type

SpinIntNode.

Visibility

default.

ExposureActiveMode

Control sensor active exposure mode.

Property type

SpinEnumDefNode.

Enum entries

ExposureActiveMode_names.

Visibility

default.

ExposureAuto

Sets the automatic exposure mode

Property type

SpinEnumDefNode.

Enum entries

ExposureAuto_names.

Visibility

default.

ExposureMode

Sets the operation mode of the Exposure.

Property type

SpinEnumDefNode.

Enum entries

ExposureMode_names.

Visibility

default.

ExposureTime

Exposure time in microseconds when Exposure Mode is Timed.

Property type

SpinFloatNode.

Visibility

default.

ExposureTimeMode

Sets the configuration mode of the ExposureTime feature.

Property type

SpinEnumDefNode.

Enum entries

ExposureTimeMode_names.

Visibility

default.

ExposureTimeSelector

Selects which exposure time is controlled by the ExposureTime feature. This allows for independent control over the exposure components.

Property type

SpinEnumDefNode.

Enum entries

ExposureTimeSelector_names.

Visibility

default.

FactoryReset

Returns all user tables to factory default

Property type

SpinCommandNode.

Visibility

default.

FileAccessBuffer

Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.

Property type

SpinRegisterNode.

Visibility

default.

FileAccessLength

Controls the Length of the mapping between the device file storage and the FileAccessBuffer.

Property type

SpinIntNode.

Visibility

default.

FileAccessOffset

Controls the Offset of the mapping between the device file storage and the FileAccessBuffer.

Property type

SpinIntNode.

Visibility

default.

FileOpenMode

The mode of the file when it is opened. The file can be opened for reading, writting or both. This must be set before opening the file.

Property type

SpinEnumDefNode.

Enum entries

FileOpenMode_names.

Visibility

default.

FileOperationExecute

This is a command that executes the selected file operation on the selected file.

Property type

SpinCommandNode.

Visibility

default.

FileOperationResult

Represents the file operation result. For Read or Write operations, the number of successfully read/written bytes is returned.

Property type

SpinIntNode.

Visibility

default.

FileOperationSelector

Sets operation to execute on the selected file when the execute command is given.

Property type

SpinEnumDefNode.

Enum entries

FileOperationSelector_names.

Visibility

default.

FileOperationStatus

Represents the file operation execution status.

Property type

SpinEnumDefNode.

Enum entries

FileOperationStatus_names.

Visibility

default.

FileSelector

Selects which file is being operated on. This must be set before performing any file operations.

Property type

SpinEnumDefNode.

Enum entries

FileSelector_names.

Visibility

default.

FileSize

Represents the size of the selected file in bytes.

Property type

SpinIntNode.

Visibility

default.

Gain

Controls the amplification of the video signal in dB.

Property type

SpinFloatNode.

Visibility

default.

GainAuto

Sets the automatic gain mode. Set to Off for manual control. Set to Once for a single automatic adjustment then return to Off. Set to Continuous for constant adjustment. In automatic modes, the camera adjusts the gain to maximize the dynamic range.

Property type

SpinEnumDefNode.

Enum entries

GainAuto_names.

Visibility

default.

GainAutoBalance

Sets the mode for automatic gain balancing between the sensor color channels or taps. The gain coefficients of each channel or tap are adjusted so they are matched.

Property type

SpinEnumDefNode.

Enum entries

GainAutoBalance_names.

Visibility

default.

GainSelector

Selects which gain to control. The All selection is a total amplification across all channels (or taps).

Property type

SpinEnumDefNode.

Enum entries

GainSelector_names.

Visibility

default.

Gamma

Controls the gamma correction of pixel intensity.

Property type

SpinFloatNode.

Visibility

default.

GammaEnable

Enables/disables gamma correction.

Property type

SpinBoolNode.

Visibility

default.

GevActiveLinkCount

Indicates the current number of active logical links.

Property type

SpinIntNode.

Visibility

default.

GevCCP

Controls the device access privilege of an application.

Property type

SpinEnumDefNode.

Enum entries

GevCCP_names.

Visibility

default.

GevCurrentDefaultGateway

Reports the default gateway IP address to be used on the given logical link.

Property type

SpinIntNode.

Visibility

default.

GevCurrentIPAddress

Reports the IP address for the given logical link.

Property type

SpinIntNode.

Visibility

default.

GevCurrentIPConfigurationDHCP

Controls whether the DHCP IP configuration scheme is activated on the given logical link.

Property type

SpinBoolNode.

Visibility

default.

GevCurrentIPConfigurationLLA

Controls whether the Link Local Address IP configuration scheme is activated on the given logical link.

Property type

SpinBoolNode.

Visibility

default.

GevCurrentIPConfigurationPersistentIP

Controls whether the PersistentIP configuration scheme is activated on the given logical link.

Property type

SpinBoolNode.

Visibility

default.

GevCurrentPhysicalLinkConfiguration

Indicates the current physical link configuration of the device.

Property type

SpinEnumDefNode.

Enum entries

GevCurrentPhysicalLinkConfiguration_names.

Visibility

default.

GevCurrentSubnetMask

Reports the subnet mask of the given logical link.

Property type

SpinIntNode.

Visibility

default.

GevDiscoveryAckDelay

Indicates the maximum randomized delay the device will wait to acknowledge a discovery command.

Property type

SpinIntNode.

Visibility

default.

GevFirstURL

The first choice of URL for the XML device description file.

Property type

SpinStrNode.

Visibility

default.

GevGVCPExtendedStatusCodes

Enables the generation of extended status codes.

Property type

SpinBoolNode.

Visibility

default.

GevGVCPExtendedStatusCodesSelector

Selects the GigE Vision version to control extended status codes for.

Property type

SpinEnumDefNode.

Enum entries

GevGVCPExtendedStatusCodesSelector_names.

Visibility

default.

GevGVCPHeartbeatDisable

Disables the GVCP heartbeat.

Property type

SpinBoolNode.

Visibility

default.

GevGVCPPendingAck

Enables the generation of PENDING_ACK.

Property type

SpinBoolNode.

Visibility

default.

GevGVCPPendingTimeout

Indicates the longest GVCP command execution time before the device returns a PENDING_ACK in milliseconds.

Property type

SpinIntNode.

Visibility

default.

GevGVSPExtendedIDMode

Enables the extended IDs mode.

Property type

SpinEnumDefNode.

Enum entries

GevGVSPExtendedIDMode_names.

Visibility

default.

GevHeartbeatTimeout

Indicates the current heartbeat timeout in milliseconds.

Property type

SpinIntNode.

Visibility

default.

GevIEEE1588

Enables the IEEE 1588 Precision Time Protocol to control the timestamp register.

Property type

SpinBoolNode.

Visibility

default.

GevIEEE1588ClockAccuracy

Indicates the expected accuracy of the device clock when it is the grandmaster, or in the event it becomes the grandmaster.

Property type

SpinEnumDefNode.

Enum entries

GevIEEE1588ClockAccuracy_names.

Visibility

default.

GevIEEE1588Mode

Provides the mode of the IEEE 1588 clock.

Property type

SpinEnumDefNode.

Enum entries

GevIEEE1588Mode_names.

Visibility

default.

GevIEEE1588Status

Provides the status of the IEEE 1588 clock.

Property type

SpinEnumDefNode.

Enum entries

GevIEEE1588Status_names.

Visibility

default.

GevIPConfigurationStatus

Reports the current IP configuration status.

Property type

SpinEnumDefNode.

Enum entries

GevIPConfigurationStatus_names.

Visibility

default.

GevInterfaceSelector

Selects which logical link to control.

Property type

SpinIntNode.

Visibility

default.

GevMACAddress

MAC address of the logical link.

Property type

SpinIntNode.

Visibility

default.

GevMCDA

Controls the destination IP address of the message channel

Property type

SpinIntNode.

Visibility

default.

GevMCPHostPort

The port to which the device must send messages

Property type

SpinIntNode.

Visibility

default.

GevMCRC

Indicates the number of retries of the message channel.

Property type

SpinIntNode.

Visibility

default.

GevMCSP

Indicates the source port of the message channel.

Property type

SpinIntNode.

Visibility

default.

GevMCTT

Indicates the transmission timeout of the message channel.

Property type

SpinIntNode.

Visibility

default.

GevNumberOfInterfaces

Indicates the number of physical network interfaces supported by this device.

Property type

SpinIntNode.

Visibility

default.

GevPAUSEFrameReception

Controls whether incoming PAUSE Frames are handled on the given logical link.

Property type

SpinBoolNode.

Visibility

default.

GevPAUSEFrameTransmission

Controls whether PAUSE Frames can be generated on the given logical link.

Property type

SpinBoolNode.

Visibility

default.

GevPersistentDefaultGateway

Controls the persistent default gateway for this logical link.

Property type

SpinIntNode.

Visibility

default.

GevPersistentIPAddress

Controls the Persistent IP address for this logical link.

Property type

SpinIntNode.

Visibility

default.

GevPersistentSubnetMask

Controls the Persistent subnet mask associated with the Persistent IP address on this logical link.

Property type

SpinIntNode.

Visibility

default.

GevPhysicalLinkConfiguration

Controls the principal physical link configuration to use on next restart/power-up of the device.

Property type

SpinEnumDefNode.

Enum entries

GevPhysicalLinkConfiguration_names.

Visibility

default.

GevPrimaryApplicationIPAddress

Returns the address of the primary application.

Property type

SpinIntNode.

Visibility

default.

GevPrimaryApplicationSocket

Returns the UDP source port of the primary application.

Property type

SpinIntNode.

Visibility

default.

GevPrimaryApplicationSwitchoverKey

Controls the key to use to authenticate primary application switchover requests.

Property type

SpinIntNode.

Visibility

default.

GevSCCFGAllInTransmission

Enables the selected GVSP transmitter to use the single packet per data block All-in Transmission mode.

Property type

SpinBoolNode.

Visibility

default.

GevSCCFGExtendedChunkData

Enables cameras to use the extended chunk data payload type for this stream channel.

Property type

SpinBoolNode.

Visibility

default.

GevSCCFGPacketResendDestination

Enables the alternate IP destination for stream packets resent due to a packet resend request. When True, the source IP address provided in the packet resend command packet is used. When False, the value set in the GevSCDA[GevStreamChannelSelector] feature is used.

Property type

SpinBoolNode.

Visibility

default.

GevSCCFGUnconditionalStreaming

Enables the camera to continue to stream, for this stream channel, if its control channel is closed or regardless of the reception of any ICMP messages (such as destination unreachable messages).

Property type

SpinBoolNode.

Visibility

default.

GevSCDA

Controls the destination IP address of the selected stream channel to which a GVSP transmitter must send data stream or the destination IP address from which a GVSP receiver may receive data stream.

Property type

SpinIntNode.

Visibility

default.

GevSCPD

Controls the delay (in GEV timestamp counter unit) to insert between each packet for this stream channel. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

Property type

SpinIntNode.

Visibility

default.

GevSCPDirection

Transmit or Receive of the channel

Property type

SpinIntNode.

Visibility

default.

GevSCPHostPort

Controls the port of the selected channel to which a GVSP transmitter must send data stream or the port from which a GVSP receiver may receive data stream.

Property type

SpinIntNode.

Visibility

default.

GevSCPInterfaceIndex

Index of the logical link to use.

Property type

SpinIntNode.

Visibility

default.

GevSCPSBigEndian

Endianness of multi-byte pixel data for this stream.

Property type

SpinBoolNode.

Visibility

default.

GevSCPSDoNotFragment

The state of this feature is copied into the “do not fragment” bit of the IP header of each stream packet.

Property type

SpinBoolNode.

Visibility

default.

GevSCPSFireTestPacket

Sends a test packet.

Property type

SpinBoolNode.

Visibility

default.

GevSCPSPacketSize

Specifies the stream packet size (in bytes) to send on this channel.

Property type

SpinIntNode.

Visibility

default.

GevSCSP

Indicates the source port of the stream channel.

Property type

SpinIntNode.

Visibility

default.

GevSCZoneConfigurationLock

Controls whether the selected stream channel multi-zone configuration is locked. When locked, the GVSP transmitter is not allowed to change the number of zones and their direction during block acquisition and transmission.

Property type

SpinBoolNode.

Visibility

default.

GevSCZoneCount

Reports the number of zones per block transmitted on the selected stream channel.

Property type

SpinIntNode.

Visibility

default.

GevSCZoneDirectionAll

Reports the transmission direction of each zone transmitted on the selected stream channel.

Property type

SpinIntNode.

Visibility

default.

GevSecondURL

The second choice of URL to the XML device description file.

Property type

SpinStrNode.

Visibility

default.

GevStreamChannelSelector

Selects the stream channel to control.

Property type

SpinIntNode.

Visibility

default.

GevSupportedOption

Returns if the selected GEV option is supported.

Property type

SpinBoolNode.

Visibility

default.

GevSupportedOptionSelector

Selects the GEV option to interrogate for existing support.

Property type

SpinEnumDefNode.

Enum entries

GevSupportedOptionSelector_names.

Visibility

default.

GevTimestampTickFrequency

Indicates the number of timestamp ticks in 1 second (frequency in Hz).

Property type

SpinIntNode.

Visibility

default.

GuiXmlManifestAddress

Location of the GUI XML manifest table.

Property type

SpinIntNode.

Visibility

default.

Height

Height of the image provided by the device (in pixels).

Property type

SpinIntNode.

Visibility

default.

HeightMax

Maximum height of the image (in pixels). This dimension is calculated after vertical binning. HeightMax does not take into account the current Region of interest (Height or OffsetY).

Property type

SpinIntNode.

Visibility

default.

ImageComponentEnable

Controls if the selected component streaming is active.

Property type

SpinBoolNode.

Visibility

default.

ImageComponentSelector

Selects a component to activate data streaming from.

Property type

SpinEnumDefNode.

Enum entries

ImageComponentSelector_names.

Visibility

default.

ImageCompressionBitrate

Control the rate of the produced compressed stream.

Property type

SpinFloatNode.

Visibility

default.

ImageCompressionJPEGFormatOption

When JPEG is selected as the compression format, a device might optionally offer better control over JPEG-specific options through this feature.

Property type

SpinEnumDefNode.

Enum entries

ImageCompressionJPEGFormatOption_names.

Visibility

default.

ImageCompressionMode
Property type

SpinEnumDefNode.

Enum entries

ImageCompressionMode_names.

Visibility

default.

ImageCompressionQuality

Control the quality of the produced compressed stream.

Property type

SpinIntNode.

Visibility

default.

ImageCompressionRateOption

Two rate controlling options are offered: fixed bit rate or fixed quality. The exact implementation to achieve one or the other is vendor-specific.

Property type

SpinEnumDefNode.

Enum entries

ImageCompressionRateOption_names.

Visibility

default.

IspEnable

Controls whether the image processing core is used for optional pixel format mode (i.e. mono).

Property type

SpinBoolNode.

Visibility

default.

LUTEnable

Activates the selected LUT.

Property type

SpinBoolNode.

Visibility

default.

LUTIndex

Control the index (offset) of the coefficient to access in the selected LUT.

Property type

SpinIntNode.

Visibility

default.

LUTSelector

Selects which LUT to control.

Property type

SpinEnumDefNode.

Enum entries

LUTSelector_names.

Visibility

default.

LUTValue

Returns the Value at entry LUTIndex of the LUT selected by LUTSelector.

Property type

SpinIntNode.

Visibility

default.

LUTValueAll

Accesses all the LUT coefficients in a single access without using individual LUTIndex.

Property type

SpinRegisterNode.

Visibility

default.

LineFilterWidth

Filter width in microseconds for the selected line and filter combination

Property type

SpinFloatNode.

Visibility

default.

LineFormat

Displays the current electrical format of the selected physical input or output Line.

Property type

SpinEnumDefNode.

Enum entries

LineFormat_names.

Visibility

default.

LineInputFilterSelector

Selects the kind of input filter to configure: Deglitch or Debounce.

Property type

SpinEnumDefNode.

Enum entries

LineInputFilterSelector_names.

Visibility

default.

LineInverter

Controls the inversion of the signal of the selected input or output line.

Property type

SpinBoolNode.

Visibility

default.

LineMode

Controls if the physical Line is used to Input or Output a signal.

Property type

SpinEnumDefNode.

Enum entries

LineMode_names.

Visibility

default.

LinePitch

Total number of bytes between 2 successive lines. This feature is used to facilitate alignment of image data.

Property type

SpinIntNode.

Visibility

default.

LineSelector

Selects the physical line (or pin) of the external device connector to configure

Property type

SpinEnumDefNode.

Enum entries

LineSelector_names.

Visibility

default.

LineSource

Selects which internal acquisition or I/O source signal to output on the selected line. LineMode must be Output.

Property type

SpinEnumDefNode.

Enum entries

LineSource_names.

Visibility

default.

LineStatus

Returns the current status of the selected input or output Line

Property type

SpinBoolNode.

Visibility

default.

LineStatusAll

Returns the current status of all the line status bits in a hexadecimal representation (Line 0 status corresponds to bit 0, Line 1 status with bit 1, etc). This allows simultaneous reading of all line statuses at once.

Property type

SpinIntNode.

Visibility

default.

LinkErrorCount

Counts the number of error on the link.

Property type

SpinIntNode.

Visibility

default.

LinkUptime

Time since the last phy negotiation (enumeration).

Property type

SpinIntNode.

Visibility

default.

LogicBlockLUTInputActivation

Selects the activation mode of the Logic Input Source signal.

Property type

SpinEnumDefNode.

Enum entries

LogicBlockLUTInputActivation_names.

Visibility

default.

LogicBlockLUTInputSelector

Controls which LogicBlockLUT Input Source & Activation to access.

Property type

SpinEnumDefNode.

Enum entries

LogicBlockLUTInputSelector_names.

Visibility

default.

LogicBlockLUTInputSource

Selects the source for the input into the Logic LUT.

Property type

SpinEnumDefNode.

Enum entries

LogicBlockLUTInputSource_names.

Visibility

default.

LogicBlockLUTOutputValue

Controls the output column of the truth table for the selected LogicBlockLUTRowIndex.

Property type

SpinBoolNode.

Visibility

default.

LogicBlockLUTOutputValueAll

Sets the value of all the output bits in the selected LUT.

Property type

SpinIntNode.

Visibility

default.

LogicBlockLUTRowIndex

Controls the row of the truth table to access in the selected LUT.

Property type

SpinIntNode.

Visibility

default.

LogicBlockLUTSelector

Selects which LogicBlock LUT to configure

Property type

SpinEnumDefNode.

Enum entries

LogicBlockLUTSelector_names.

Visibility

default.

LogicBlockSelector

Selects which LogicBlock to configure

Property type

SpinEnumDefNode.

Enum entries

LogicBlockSelector_names.

Visibility

default.

MaxDeviceResetTime

Time to wait until device reset complete (ms).

Property type

SpinIntNode.

Visibility

default.

OffsetX

Horizontal offset from the origin to the ROI (in pixels).

Property type

SpinIntNode.

Visibility

default.

OffsetY

Vertical offset from the origin to the ROI (in pixels).

Property type

SpinIntNode.

Visibility

default.

PacketResendRequestCount

Counts the number of resend requests received from the host.

Property type

SpinIntNode.

Visibility

default.

PayloadSize

Provides the number of bytes transferred for each image or chunk on the stream channel.

Property type

SpinIntNode.

Visibility

default.

PixelColorFilter

Type of color filter that is applied to the image. Only applies to Bayer pixel formats. All others have no color filter.

Property type

SpinEnumDefNode.

Enum entries

PixelColorFilter_names.

Visibility

default.

PixelDynamicRangeMax

Maximum value that can be returned during the digitization process. This corresponds to the brightest value of the camera. For color cameras, this returns the biggest value that each color component can take.

Property type

SpinIntNode.

Visibility

default.

PixelDynamicRangeMin

Minimum value that can be returned during the digitization process. This corresponds to the darkest value of the camera. For color cameras, this returns the smallest value that each color component can take.

Property type

SpinIntNode.

Visibility

default.

PixelFormat

Format of the pixel provided by the camera.

Property type

SpinEnumDefNode.

Enum entries

PixelFormat_names.

Visibility

default.

PixelFormatInfoID

Returns the value used by the streaming channels to identify the selected pixel format.

Property type

SpinIntNode.

Visibility

default.

PixelFormatInfoSelector

Select the pixel format for which the information will be returned.

Property type

SpinEnumDefNode.

Enum entries

PixelFormatInfoSelector_names.

Visibility

default.

PixelSize

Total size in bits of a pixel of the image.

Property type

SpinEnumDefNode.

Enum entries

PixelSize_names.

Visibility

default.

PowerSupplyCurrent

Indicates the output current of the selected power supply (A).

Property type

SpinFloatNode.

Visibility

default.

PowerSupplyVoltage

Indicates the current voltage of the selected power supply (V).

Property type

SpinFloatNode.

Visibility

default.

RegionDestination

Control the destination of the selected region.

Property type

SpinEnumDefNode.

Enum entries

RegionDestination_names.

Visibility

default.

RegionMode

Controls if the selected Region of interest is active and streaming.

Property type

SpinEnumDefNode.

Enum entries

RegionMode_names.

Visibility

default.

RegionSelector

Selects the Region of interest to control. The RegionSelector feature allows devices that are able to extract multiple regions out of an image, to configure the features of those individual regions independently.

Property type

SpinEnumDefNode.

Enum entries

RegionSelector_names.

Visibility

default.

ReverseX

Horizontally flips the image sent by the device. The region of interest is applied after flipping. For color cameras the bayer pixel format is affected. For example, BayerRG16 changes to BayerGR16.

Property type

SpinBoolNode.

Visibility

default.

ReverseY

Vertically flips the image sent by the device. The region of interest is applied after flipping. For color cameras the bayer pixel format is affected. For example, BayerRG16 changes to BayerGB16.

Property type

SpinBoolNode.

Visibility

default.

RgbTransformLightSource

Used to select from a set of RGBtoRGB transform matricies calibrated for different light sources. Selecting a value also sets the white balance ratios (BalanceRatioRed and BalanceRatioBlue), but those can be overwritten through manual or auto white balance.

Property type

SpinEnumDefNode.

Enum entries

RgbTransformLightSource_names.

Visibility

default.

Saturation

Controls the color saturation.

Property type

SpinFloatNode.

Visibility

default.

SaturationEnable

Enables/disables Saturation adjustment.

Property type

SpinBoolNode.

Visibility

default.

Scan3dAxisMax

Maximum valid transmitted coordinate value of the selected Axis.

Property type

SpinFloatNode.

Visibility

default.

Scan3dAxisMin

Minimum valid transmitted coordinate value of the selected Axis.

Property type

SpinFloatNode.

Visibility

default.

Scan3dCoordinateOffset

Offset when transforming a pixel from relative coordinates to world coordinates.

Property type

SpinFloatNode.

Visibility

default.

Scan3dCoordinateReferenceSelector

Sets the index to read a coordinate system reference value defining the transform of a point from the current (Anchor or Transformed) system to the reference system.

Property type

SpinEnumDefNode.

Enum entries

Scan3dCoordinateReferenceSelector_names.

Visibility

default.

Scan3dCoordinateReferenceValue

Returns the reference value selected. Reads the value of a rotation or translation value for the current (Anchor or Transformed) coordinate system transformation to the Reference system.

Property type

SpinFloatNode.

Visibility

default.

Scan3dCoordinateScale

Scale factor when transforming a pixel from relative coordinates to world coordinates.

Property type

SpinFloatNode.

Visibility

default.

Scan3dCoordinateSelector

Selects the individual coordinates in the vectors for 3D information/transformation.

Property type

SpinEnumDefNode.

Enum entries

Scan3dCoordinateSelector_names.

Visibility

default.

Scan3dCoordinateSystem

Specifies the Coordinate system to use for the device.

Property type

SpinEnumDefNode.

Enum entries

Scan3dCoordinateSystem_names.

Visibility

default.

Scan3dCoordinateSystemReference

Defines coordinate system reference location.

Property type

SpinEnumDefNode.

Enum entries

Scan3dCoordinateSystemReference_names.

Visibility

default.

Scan3dCoordinateTransformSelector

Sets the index to read/write a coordinate transform value.

Property type

SpinEnumDefNode.

Enum entries

Scan3dCoordinateTransformSelector_names.

Visibility

default.

Scan3dDistanceUnit

Specifies the unit used when delivering calibrated distance data.

Property type

SpinEnumDefNode.

Enum entries

Scan3dDistanceUnit_names.

Visibility

default.

Scan3dInvalidDataFlag

Enables the definition of a non-valid flag value in the data stream. Note that the confidence output is an alternate recommended way to identify non-valid pixels. Using an Scan3dInvalidDataValue may give processing penalties due to special handling.

Property type

SpinBoolNode.

Visibility

default.

Scan3dInvalidDataValue

Value which identifies a non-valid pixel if Scan3dInvalidDataFlag is enabled.

Property type

SpinFloatNode.

Visibility

default.

Scan3dOutputMode

Controls the Calibration and data organization of the device, naming the coordinates transmitted.

Property type

SpinEnumDefNode.

Enum entries

Scan3dOutputMode_names.

Visibility

default.

Scan3dTransformValue

Specifies the transform value selected. For translations (Scan3dCoordinateTransformSelector = TranslationX/Y/Z) it is expressed in the distance unit of the system, for rotations (Scan3dCoordinateTransformSelector =RotationX/Y/Z) in degrees.

Property type

SpinFloatNode.

Visibility

default.

SensorDescription

Returns Sensor Description

Property type

SpinStrNode.

Visibility

default.

SensorDigitizationTaps

Number of digitized samples outputted simultaneously by the camera A/D conversion stage.

Property type

SpinEnumDefNode.

Enum entries

SensorDigitizationTaps_names.

Visibility

default.

SensorHeight

Effective height of the sensor in pixels.

Property type

SpinIntNode.

Visibility

default.

SensorShutterMode

Sets the shutter mode of the device.

Property type

SpinEnumDefNode.

Enum entries

SensorShutterMode_names.

Visibility

default.

SensorTaps

Number of taps of the camera sensor.

Property type

SpinEnumDefNode.

Enum entries

SensorTaps_names.

Visibility

default.

SensorWidth

Effective width of the sensor in pixels.

Property type

SpinIntNode.

Visibility

default.

SequencerConfigurationMode

Controls whether or not a sequencer is in configuration mode.

Property type

SpinEnumDefNode.

Enum entries

SequencerConfigurationMode_names.

Visibility

default.

SequencerConfigurationValid

Display whether the current sequencer configuration is valid to run.

Property type

SpinEnumDefNode.

Enum entries

SequencerConfigurationValid_names.

Visibility

default.

SequencerFeatureEnable

Enables the selected feature and makes it active in all sequencer sets.

Property type

SpinBoolNode.

Visibility

default.

SequencerMode

Controls whether or not a sequencer is active.

Property type

SpinEnumDefNode.

Enum entries

SequencerMode_names.

Visibility

default.

SequencerPathSelector

Selects branching path to be used for subsequent settings.

Property type

SpinIntNode.

Visibility

default.

SequencerSetActive

Displays the currently active sequencer set.

Property type

SpinIntNode.

Visibility

default.

SequencerSetLoad

Loads currently selected sequencer to the current device configuration.

Property type

SpinCommandNode.

Visibility

default.

SequencerSetNext

Specifies the next sequencer set.

Property type

SpinIntNode.

Visibility

default.

SequencerSetSave

Saves the current device configuration to the currently selected sequencer set.

Property type

SpinCommandNode.

Visibility

default.

SequencerSetSelector

Selects the sequencer set to which subsequent settings apply.

Property type

SpinIntNode.

Visibility

default.

SequencerSetStart

Sets the first sequencer set to be used.

Property type

SpinIntNode.

Visibility

default.

SequencerSetValid

Displays whether the currently selected sequencer set’s register contents are valid to use.

Property type

SpinEnumDefNode.

Enum entries

SequencerSetValid_names.

Visibility

default.

SequencerTriggerActivation

Specifies the activation mode of the sequencer trigger.

Property type

SpinEnumDefNode.

Enum entries

SequencerTriggerActivation_names.

Visibility

default.

SequencerTriggerSource

Specifies the internal signal or physical input line to use as the sequencer trigger source.

Property type

SpinEnumDefNode.

Enum entries

SequencerTriggerSource_names.

Visibility

default.

SerialPortBaudRate

This feature controls the baud rate used by the selected serial port.

Property type

SpinEnumDefNode.

Enum entries

SerialPortBaudRate_names.

Visibility

default.

SerialPortDataBits

This feature controls the number of data bits used by the selected serial port. Possible values that can be used are between 5 and 9.

Property type

SpinIntNode.

Visibility

default.

SerialPortParity

This feature controls the parity used by the selected serial port.

Property type

SpinEnumDefNode.

Enum entries

SerialPortParity_names.

Visibility

default.

SerialPortSelector

Selects which serial port of the device to control.

Property type

SpinEnumDefNode.

Enum entries

SerialPortSelector_names.

Visibility

default.

SerialPortSource

Specifies the physical input Line on which to receive serial data.

Property type

SpinEnumDefNode.

Enum entries

SerialPortSource_names.

Visibility

default.

SerialPortStopBits

This feature controls the number of stop bits used by the selected serial port.

Property type

SpinEnumDefNode.

Enum entries

SerialPortStopBits_names.

Visibility

default.

SerialReceiveFramingErrorCount

Returns the number of framing errors that have occurred on the serial port.

Property type

SpinIntNode.

Visibility

default.

SerialReceiveParityErrorCount

Returns the number of parity errors that have occurred on the serial port.

Property type

SpinIntNode.

Visibility

default.

SerialReceiveQueueClear

This is a command that clears the device serial port receive queue.

Property type

SpinCommandNode.

Visibility

default.

SerialReceiveQueueCurrentCharacterCount

Returns the number of characters currently in the serial port receive queue.

Property type

SpinIntNode.

Visibility

default.

SerialReceiveQueueMaxCharacterCount

>Returns the maximum number of characters in the serial port receive queue.

Property type

SpinIntNode.

Visibility

default.

SerialTransmitQueueCurrentCharacterCount

Returns the number of characters currently in the serial port transmit queue.

Property type

SpinIntNode.

Visibility

default.

SerialTransmitQueueMaxCharacterCount

>Returns the maximum number of characters in the serial port transmit queue.

Property type

SpinIntNode.

Visibility

default.

Sharpening

Controls the amount to sharpen a signal. The sharpened amount is proportional to the difference between a pixel and its neighbors. A negative value smooths out the difference, while a positive value amplifies the difference. You can boost by a maximum of 8x, but smoothing is limited to 1x (in float). Default value: 2.0

Property type

SpinFloatNode.

Visibility

default.

SharpeningAuto

Enables/disables the auto sharpening feature. When enabled, the camera automatically determines the sharpening threshold based on the noise level of the camera.

Property type

SpinBoolNode.

Visibility

default.

SharpeningEnable

Enables/disables the sharpening feature. Sharpening is disabled by default.

Property type

SpinBoolNode.

Visibility

default.

SharpeningThreshold

Controls the minimum intensity gradient change to invoke sharpening. When “Sharpening Auto” is enabled, this is determined automatically by the device. The threshold is specified as a fraction of the total intensity range, and ranges from 0 to 0.25. A threshold higher than 25% produces little to no difference than 25%. High thresholds sharpen only areas with significant intensity changes. Low thresholds sharpen more areas.

Property type

SpinFloatNode.

Visibility

default.

SoftwareSignalPulse

Generates a pulse signal that can be used as a software trigger. This command can be used to trigger other modules that accept a SoftwareSignal as trigger source.

Property type

SpinCommandNode.

Visibility

default.

SoftwareSignalSelector

Selects which Software Signal features to control.

Property type

SpinEnumDefNode.

Enum entries

SoftwareSignalSelector_names.

Visibility

default.

SourceCount

Controls or returns the number of sources supported by the device.

Property type

SpinIntNode.

Visibility

default.

SourceSelector

Selects the source to control.

Property type

SpinEnumDefNode.

Enum entries

SourceSelector_names.

Visibility

default.

TLParamsLocked
Property type

SpinIntNode.

Visibility

default.

Test0001

For testing only.

Property type

SpinIntNode.

Visibility

default.

TestEventGenerate

This command generates a test event and sends it to the host.

Property type

SpinCommandNode.

Visibility

default.

TestPattern

Selects the type of test pattern that is generated by the device as image source.

Property type

SpinEnumDefNode.

Enum entries

TestPattern_names.

Visibility

default.

TestPatternGeneratorSelector

Selects which test pattern generator is controlled by the TestPattern feature.

Property type

SpinEnumDefNode.

Enum entries

TestPatternGeneratorSelector_names.

Visibility

default.

TestPendingAck

Tests the device’s pending acknowledge feature. When this feature is written, the device waits a time period corresponding to the value of TestPendingAck before acknowledging the write.

Property type

SpinIntNode.

Visibility

default.

TimerDelay

Sets the duration (in microseconds) of the delay to apply at the reception of a trigger before starting the Timer.

Property type

SpinFloatNode.

Visibility

default.

TimerDuration

Sets the duration (in microseconds) of the Timer pulse.

Property type

SpinFloatNode.

Visibility

default.

TimerReset

Does a software reset of the selected timer and starts it. The timer starts immediately after the reset unless a timer trigger is active.

Property type

SpinCommandNode.

Visibility

default.

TimerSelector

Selects which Timer to configure.

Property type

SpinEnumDefNode.

Enum entries

TimerSelector_names.

Visibility

default.

TimerStatus

Returns the current status of the Timer.

Property type

SpinEnumDefNode.

Enum entries

TimerStatus_names.

Visibility

default.

TimerTriggerActivation

Selects the activation mode of the trigger to start the Timer.

Property type

SpinEnumDefNode.

Enum entries

TimerTriggerActivation_names.

Visibility

default.

TimerTriggerSource

Selects the source of the trigger to start the Timer.

Property type

SpinEnumDefNode.

Enum entries

TimerTriggerSource_names.

Visibility

default.

TimerValue

Reads or writes the current value (in microseconds) of the selected Timer.

Property type

SpinFloatNode.

Visibility

default.

Timestamp

Reports the current value of the device timestamp counter.

Property type

SpinIntNode.

Visibility

default.

TimestampLatch

Latches the current timestamp counter into TimestampLatchValue.

Property type

SpinCommandNode.

Visibility

default.

TimestampLatchValue

Returns the latched value of the timestamp counter.

Property type

SpinIntNode.

Visibility

default.

TimestampReset

Resets the current value of the device timestamp counter.

Property type

SpinCommandNode.

Visibility

default.

TransferAbort

Aborts immediately the streaming of data block(s). Aborting the transfer will result in the lost of the data that is present or currently entering in the block queue. However, the next new block received will be stored in the queue and transferred to the host when the streaming is restarted. If implemented, this feature should be available when the TransferControlMode is set to “UserControlled”.

Property type

SpinCommandNode.

Visibility

default.

TransferBlockCount

Specifies the number of data blocks (images) that the device should stream before stopping. This feature is only active if the Transfer Operation Mode is set to Multi Block.

Property type

SpinIntNode.

Visibility

default.

TransferBurstCount

Number of Block(s) to transfer for each TransferBurstStart trigger.

Property type

SpinIntNode.

Visibility

default.

TransferComponentSelector

Selects the color component for the control of the TransferStreamChannel feature.

Property type

SpinEnumDefNode.

Enum entries

TransferComponentSelector_names.

Visibility

default.

TransferControlMode

Selects the control method for the transfers. Basic and Automatic start transmitting data as soon as there is enough data to fill a link layer packet. User Controlled allows you to directly control the transfer of blocks.

Property type

SpinEnumDefNode.

Enum entries

TransferControlMode_names.

Visibility

default.

TransferOperationMode

Selects the operation mode of the transfer. Continuous is similar to Basic/Automatic but you can start/stop the transfer while acquisition runs independently. Multi Block transmits a specified number of blocks and then stops.

Property type

SpinEnumDefNode.

Enum entries

TransferOperationMode_names.

Visibility

default.

TransferPause

Pauses the streaming of data Block(s). Pausing the streaming will immediately suspend the ongoing data transfer even if a block is partially transfered. The device will resume its transmission at the reception of a TransferResume command.

Property type

SpinCommandNode.

Visibility

default.

TransferQueueCurrentBlockCount

Returns number of data blocks (images) currently in the transfer queue.

Property type

SpinIntNode.

Visibility

default.

TransferQueueMaxBlockCount

Returns the maximum number of data blocks (images) in the transfer queue

Property type

SpinIntNode.

Visibility

default.

TransferQueueMode

Specifies the operation mode of the transfer queue.

Property type

SpinEnumDefNode.

Enum entries

TransferQueueMode_names.

Visibility

default.

TransferQueueOverflowCount

Returns number of images that have been lost before being transmitted because the transmit queue hasn’t been cleared fast enough.

Property type

SpinIntNode.

Visibility

default.

TransferResume

Resumes a data Blocks streaming that was previously paused by a TransferPause command.

Property type

SpinCommandNode.

Visibility

default.

TransferSelector

Selects which stream transfers are currently controlled by the selected Transfer features.

Property type

SpinEnumDefNode.

Enum entries

TransferSelector_names.

Visibility

default.

TransferStart

Starts the streaming of data blocks (images) out of the device. This feature is available when the Transfer Control Mode is set to User Controlled.

Property type

SpinCommandNode.

Visibility

default.

TransferStatus

Reads the status of the Transfer module signal selected by TransferStatusSelector.

Property type

SpinBoolNode.

Visibility

default.

TransferStatusSelector

Selects which status of the transfer module to read.

Property type

SpinEnumDefNode.

Enum entries

TransferStatusSelector_names.

Visibility

default.

TransferStop

Stops the streaming of data block (images). The current block transmission is completed. This feature is available when the Transfer Control Mode is set to User Controlled.

Property type

SpinCommandNode.

Visibility

default.

TransferStreamChannel

Selects the streaming channel that will be used to transfer the selected stream of data. In general, this feature can be omitted and the default streaming channel will be used.

Property type

SpinIntNode.

Visibility

default.

TransferTriggerActivation

Specifies the activation mode of the transfer control trigger.

Property type

SpinEnumDefNode.

Enum entries

TransferTriggerActivation_names.

Visibility

default.

TransferTriggerMode

Controls if the selected trigger is active.

Property type

SpinEnumDefNode.

Enum entries

TransferTriggerMode_names.

Visibility

default.

TransferTriggerSelector

Selects the type of transfer trigger to configure.

Property type

SpinEnumDefNode.

Enum entries

TransferTriggerSelector_names.

Visibility

default.

TransferTriggerSource

Specifies the signal to use as the trigger source for transfers.

Property type

SpinEnumDefNode.

Enum entries

TransferTriggerSource_names.

Visibility

default.

TriggerActivation

Specifies the activation mode of the trigger.

Property type

SpinEnumDefNode.

Enum entries

TriggerActivation_names.

Visibility

default.

TriggerDelay

Specifies the delay in microseconds (us) to apply after the trigger reception before activating it.

Property type

SpinFloatNode.

Visibility

default.

TriggerDivider

Specifies a division factor for the incoming trigger pulses.

Property type

SpinIntNode.

Visibility

default.

TriggerEventTest

This command generates a test event and sends it to the host.

Property type

SpinCommandNode.

Visibility

default.

TriggerMode

Controls whether or not trigger is active.

Property type

SpinEnumDefNode.

Enum entries

TriggerMode_names.

Visibility

default.

TriggerMultiplier

Specifies a multiplication factor for the incoming trigger pulses. It is used generally used in conjunction with TriggerDivider to control the ratio of triggers that are accepted.

Property type

SpinIntNode.

Visibility

default.

TriggerOverlap

Specifies the overlap mode of the trigger.

Property type

SpinEnumDefNode.

Enum entries

TriggerOverlap_names.

Visibility

default.

TriggerSelector

Selects the type of trigger to configure.

Property type

SpinEnumDefNode.

Enum entries

TriggerSelector_names.

Visibility

default.

TriggerSoftware

Generates an internal trigger if Trigger Source is set to Software.

Property type

SpinCommandNode.

Visibility

default.

TriggerSource

Specifies the internal signal or physical input line to use as the trigger source.

Property type

SpinEnumDefNode.

Enum entries

TriggerSource_names.

Visibility

default.

UserOutputSelector

Selects which bit of the User Output register is set by UserOutputValue.

Property type

SpinEnumDefNode.

Enum entries

UserOutputSelector_names.

Visibility

default.

UserOutputValue

Value of the selected user output, either logic high (enabled) or logic low (disabled).

Property type

SpinBoolNode.

Visibility

default.

UserOutputValueAll

Returns the current status of all the user output status bits in a hexadecimal representation (UserOutput 0 status corresponds to bit 0, UserOutput 1 status with bit 1, etc). This allows simultaneous reading of all user output statuses at once.

Property type

SpinIntNode.

Visibility

default.

UserOutputValueAllMask

Sets the write mask to apply to the value specified by UserOutputValueAll before writing it in the User Output register. If the UserOutputValueAllMask feature is present, setting the user Output register using UserOutputValueAll will only change the bits that have a corresponding bit in the mask set to one.

Property type

SpinIntNode.

Visibility

default.

UserSetDefault

Selects the feature User Set to load and make active by default when the device is restarted.

Property type

SpinEnumDefNode.

Enum entries

UserSetDefault_names.

Visibility

default.

UserSetFeatureEnable

Whether or not the selected feature is saved to user sets.

Property type

SpinBoolNode.

Visibility

default.

UserSetLoad

Loads the User Set specified by UserSetSelector to the device and makes it active.

Property type

SpinCommandNode.

Visibility

default.

UserSetSave

Saves the User Set specified by UserSetSelector to the non-volatile memory of the device.

Property type

SpinCommandNode.

Visibility

default.

UserSetSelector

Selects the feature User Set to load, save or configure.

Property type

SpinEnumDefNode.

Enum entries

UserSetSelector_names.

Visibility

default.

V3_3Enable

Internally generated 3.3V rail. Enable to supply external circuits with power. This is different than standard logic outputs in that it is comparatively slow to switch but can supply a more significant amount of power. This is only available on some pins.

Property type

SpinBoolNode.

Visibility

default.

WhiteClip

Controls the maximal intensity taken by the video signal before being clipped as an absolute physical value. The video signal will never exceed the white clipping point: it will saturate at that level.

Property type

SpinFloatNode.

Visibility

default.

WhiteClipSelector

Selects which White Clip to control.

Property type

SpinEnumDefNode.

Enum entries

WhiteClipSelector_names.

Visibility

default.

Width

Width of the image provided by the device (in pixels).

Property type

SpinIntNode.

Visibility

default.

WidthMax

Maximum width of the image (in pixels). The dimension is calculated after horizontal binning. WidthMax does not take into account the current Region of interest (Width or OffsetX).

Property type

SpinIntNode.

Visibility

default.

aPAUSEMACCtrlFramesReceived

Reports the number of received PAUSE frames.

Property type

SpinIntNode.

Visibility

default.

aPAUSEMACCtrlFramesTransmitted

Reports the number of transmitted PAUSE frames.

Property type

SpinIntNode.

Visibility

default.

bool_nodes

bool_nodes: list A list of all the names of the bool nodes.

command_nodes

command_nodes: list A list of all the names of the command nodes.

enum_nodes

enum_nodes: list A list of all the names of the enum nodes.

float_nodes

float_nodes: list A list of all the names of the float nodes.

int_nodes

int_nodes: list A list of all the names of the integer nodes.

register_nodes

register_nodes: list A list of all the names of the register nodes.

str_nodes

str_nodes: list A list of all the names of the string nodes.

class TLDevNodes(camera)

Bases: object

Lists all the pre-listed nodes of the Camera transport layer device.

Warning

Do not create a TLDevNodes manually, rather get it from tl_dev_nodes that is automatically created when the camera is instantiated.

Warning

Once the associated camera is freed, the nodes are not valid anymore.

Note

Even though the nodes are pre-listed, it is simply a convenience and the same nodes can be gotten by name through NodeMap. Additionally, you must check that the node is actually available, readable etc, even if it’s pre-listed.

Some nodes are available before init_cam(), but other nodes, even those pre-listed, become available only after init_cam().

Attributes:

DeviceAccessStatus

Gets the access status the transport layer Producer has on the device.

DeviceCurrentSpeed

The USB Speed that the device is currently operating at.

DeviceDisplayName

User readable name of the device.

DeviceDriverVersion

Version of the device driver.

DeviceEndianessMechanism

Identifies the endianness handling mode.

DeviceID

Interface-wide unique identifier of this device.

DeviceInstanceId

Property type

SpinStrNode.

DeviceIsUpdater

Indicates whether the device is in updater mode.

DeviceLinkSpeed

Indicates the speed of transmission negotiated by the given network interface in Mbps.

DeviceLocation

Device Location.

DeviceModelName

Name of the remote device model.

DeviceMulticastMonitorMode

Controls and indicates if the device is operating in as a Multicast Monitor.

DevicePortId

Device Port ID.

DeviceSerialNumber

Serial number of the remote device.

DeviceType

Transport layer type of the device.

DeviceU3VProtocol

Indicates whether the device is communicating in U3V Protocol.

DeviceUserID

User Defined Name.

DeviceVendorName

Name of the remote device vendor.

DeviceVersion

Version of the device.

GUIXMLLocation

Sets the location to load GUI XML.

GUIXMLPath

GUI XML Path.

GenICamXMLLocation

Sets the location to load GenICam XML.

GenICamXMLPath

GenICam XML Path.

GevCCP

Controls the device access privilege of an application.

GevDeviceAutoForceIP

Forces the camera to be on the same subnet as its corresponding interface.

GevDeviceDiscoverMaximumPacketSize

Discovers and updates the maximum packet size that can be safely used by the device on the current interface.

GevDeviceForceGateway

Static gateway IP address to set for the GVCP interface of the remote device.

GevDeviceForceIP

Apply the force IP settings (GevDeviceForceIPAddress, GevDeviceForceSubnetMask and GevDeviceForceGateway) in the Device using ForceIP command.

GevDeviceForceIPAddress

Static IP address to set for the GVCP interface of the remote device.

GevDeviceForceSubnetMask

Static subnet mask to set for GVCP interface of the remote device.

GevDeviceGateway

Current gateway IP address of the GVCP interface of the remote device.

GevDeviceIPAddress

Current IP address of the GVCP interface of the selected remote device.

GevDeviceIsWrongSubnet

Indicates whether the device is on the wrong subnet.

GevDeviceMACAddress

48-bit MAC address of the GVCP interface of the selected remote device.

GevDeviceMaximumPacketSize

The maximum packet size that can be safely used by the device on the current interface.

GevDeviceMaximumRetryCount

Maximum number of times to retry a read/write operation.

GevDeviceModeIsBigEndian

This represents the endianness of all device's registers (bootstrap registers and manufacturer-specific registers).

GevDevicePort

Current IP port of the GVCP interface of the selected remote device.

GevDeviceReadAndWriteTimeout

The timeout in us for read/write operations to the camera.

GevDeviceSubnetMask

Current subnet mask of the GVCP interface of the selected remote device.

GevVersionMajor

Major version of the specification.

GevVersionMinor

Minor version of the specification.

bool_nodes

bool_nodes: list A list of all the names of the bool nodes.

command_nodes

command_nodes: list A list of all the names of the command nodes.

enum_nodes

enum_nodes: list A list of all the names of the enum nodes.

float_nodes

float_nodes: list A list of all the names of the float nodes.

int_nodes

int_nodes: list A list of all the names of the integer nodes.

register_nodes

register_nodes: list A list of all the names of the register nodes.

str_nodes

str_nodes: list A list of all the names of the string nodes.

DeviceAccessStatus

Gets the access status the transport layer Producer has on the device.

Property type

SpinEnumDefNode.

Enum entries

DeviceAccessStatus_names.

Visibility

default.

DeviceCurrentSpeed

The USB Speed that the device is currently operating at.

Property type

SpinEnumDefNode.

Enum entries

DeviceCurrentSpeed_names.

Visibility

default.

DeviceDisplayName

User readable name of the device. If this is not defined in the device this should be “VENDOR MODEL (ID)”.

Property type

SpinStrNode.

Visibility

default.

DeviceDriverVersion

Version of the device driver.

Property type

SpinStrNode.

Visibility

default.

DeviceEndianessMechanism

Identifies the endianness handling mode.

Property type

SpinEnumDefNode.

Enum entries

DeviceEndianessMechanism_names.

Visibility

default.

DeviceID

Interface-wide unique identifier of this device.

Property type

SpinStrNode.

Visibility

default.

DeviceInstanceId
Property type

SpinStrNode.

Visibility

default.

DeviceIsUpdater

Indicates whether the device is in updater mode.

Property type

SpinBoolNode.

Visibility

default.

DeviceLinkSpeed

Indicates the speed of transmission negotiated by the given network interface in Mbps.

Property type

SpinIntNode.

Visibility

default.

DeviceLocation

Device Location.

Property type

SpinStrNode.

Visibility

default.

DeviceModelName

Name of the remote device model.

Property type

SpinStrNode.

Visibility

default.

DeviceMulticastMonitorMode

Controls and indicates if the device is operating in as a Multicast Monitor.

Property type

SpinBoolNode.

Visibility

default.

DevicePortId

Device Port ID.

Property type

SpinStrNode.

Visibility

default.

DeviceSerialNumber

Serial number of the remote device.

Property type

SpinStrNode.

Visibility

default.

DeviceType

Transport layer type of the device.

Property type

SpinEnumDefNode.

Enum entries

DeviceType_names.

Visibility

default.

DeviceU3VProtocol

Indicates whether the device is communicating in U3V Protocol.

Property type

SpinBoolNode.

Visibility

default.

DeviceUserID

User Defined Name.

Property type

SpinStrNode.

Visibility

default.

DeviceVendorName

Name of the remote device vendor.

Property type

SpinStrNode.

Visibility

default.

DeviceVersion

Version of the device.

Property type

SpinStrNode.

Visibility

default.

GUIXMLLocation

Sets the location to load GUI XML.

Property type

SpinEnumDefNode.

Enum entries

GUIXMLLocation_names.

Visibility

default.

GUIXMLPath

GUI XML Path.

Property type

SpinStrNode.

Visibility

default.

GenICamXMLLocation

Sets the location to load GenICam XML.

Property type

SpinEnumDefNode.

Enum entries

GenICamXMLLocation_names.

Visibility

default.

GenICamXMLPath

GenICam XML Path.

Property type

SpinStrNode.

Visibility

default.

GevCCP

Controls the device access privilege of an application.

Property type

SpinEnumDefNode.

Enum entries

GevCCP_names.

Visibility

default.

GevDeviceAutoForceIP

Forces the camera to be on the same subnet as its corresponding interface.

Property type

SpinCommandNode.

Visibility

default.

GevDeviceDiscoverMaximumPacketSize

Discovers and updates the maximum packet size that can be safely used by the device on the current interface.

Property type

SpinCommandNode.

Visibility

default.

GevDeviceForceGateway

Static gateway IP address to set for the GVCP interface of the remote device.

Property type

SpinIntNode.

Visibility

default.

GevDeviceForceIP

Apply the force IP settings (GevDeviceForceIPAddress, GevDeviceForceSubnetMask and GevDeviceForceGateway) in the Device using ForceIP command.

Property type

SpinCommandNode.

Visibility

default.

GevDeviceForceIPAddress

Static IP address to set for the GVCP interface of the remote device.

Property type

SpinIntNode.

Visibility

default.

GevDeviceForceSubnetMask

Static subnet mask to set for GVCP interface of the remote device.

Property type

SpinIntNode.

Visibility

default.

GevDeviceGateway

Current gateway IP address of the GVCP interface of the remote device.

Property type

SpinIntNode.

Visibility

default.

GevDeviceIPAddress

Current IP address of the GVCP interface of the selected remote device.

Property type

SpinIntNode.

Visibility

default.

GevDeviceIsWrongSubnet

Indicates whether the device is on the wrong subnet.

Property type

SpinBoolNode.

Visibility

default.

GevDeviceMACAddress

48-bit MAC address of the GVCP interface of the selected remote device.

Property type

SpinIntNode.

Visibility

default.

GevDeviceMaximumPacketSize

The maximum packet size that can be safely used by the device on the current interface.

Property type

SpinIntNode.

Visibility

default.

GevDeviceMaximumRetryCount

Maximum number of times to retry a read/write operation.

Property type

SpinIntNode.

Visibility

default.

GevDeviceModeIsBigEndian

This represents the endianness of all device’s registers (bootstrap registers and manufacturer-specific registers).

Property type

SpinBoolNode.

Visibility

default.

GevDevicePort

Current IP port of the GVCP interface of the selected remote device.

Property type

SpinIntNode.

Visibility

default.

GevDeviceReadAndWriteTimeout

The timeout in us for read/write operations to the camera.

Property type

SpinIntNode.

Visibility

default.

GevDeviceSubnetMask

Current subnet mask of the GVCP interface of the selected remote device.

Property type

SpinIntNode.

Visibility

default.

GevVersionMajor

Major version of the specification.

Property type

SpinIntNode.

Visibility

default.

GevVersionMinor

Minor version of the specification.

Property type

SpinIntNode.

Visibility

default.

bool_nodes

bool_nodes: list A list of all the names of the bool nodes.

command_nodes

command_nodes: list A list of all the names of the command nodes.

enum_nodes

enum_nodes: list A list of all the names of the enum nodes.

float_nodes

float_nodes: list A list of all the names of the float nodes.

int_nodes

int_nodes: list A list of all the names of the integer nodes.

register_nodes

register_nodes: list A list of all the names of the register nodes.

str_nodes

str_nodes: list A list of all the names of the string nodes.

class TLStreamNodes(camera)

Bases: object

Lists all the pre-listed nodes of the Camera transport layer stream.

Warning

Do not create a TLStreamNodes manually, rather get it from tl_stream_nodes that is automatically created when the camera is instantiated.

Warning

Once the associated camera is freed, the nodes are not valid anymore.

Note

Even though the nodes are pre-listed, it is simply a convenience and the same nodes can be gotten by name through NodeMap. Additionally, you must check that the node is actually available, readable etc, even if it’s pre-listed.

Some nodes are available before init_cam(), but other nodes, even those pre-listed, become available only after init_cam().

Attributes:

GevFailedPacketCount

DEPRECATED; Replaced by StreamMissedPacketCount.

GevMaximumNumberResendRequests

DEPRECATED; Replaced by StreamPacketResendMaxRequests.

GevPacketResendMode

DEPRECATED; Replaced by StreamPacketResendEnable.

GevPacketResendTimeout

DEPRECATED; Replaced by StreamPacketResendTimeout.

GevResendPacketCount

DEPRECATED; Replaced by StreamPacketResendReceivedPacketCount.

GevResendRequestCount

DEPRECATED; Replaced by StreamPacketResendRequestedPacketCount.

GevTotalPacketCount

DEPRECATED; Replaced by StreamReceivedPacketCount.

StreamAnnounceBufferMinimum

Minimal number of buffers to announce to enable selected buffer handling mode.

StreamAnnouncedBufferCount

Number of announced (known) buffers on this stream.

StreamBlockTransferSize

Controls the image breakup size that should be used on this stream.

StreamBufferAlignment

Alignment size in bytes of the buffer passed to DSAnnounceBuffer.

StreamBufferCountManual

Controls the number of buffers to be used on this stream upon acquisition start when in manual mode.

StreamBufferCountMax

Controls the maximum number of buffers that should be used on this stream.

StreamBufferCountMode

Controls access to setting the number of buffers used for the stream.

StreamBufferCountResult

Displays the number of buffers to be used on this stream upon acquisition start.

StreamBufferHandlingMode

Available buffer handling modes of this data stream:

StreamCRCCheckEnable

Enables or disables CRC checks on received images.

StreamChunkCountMaximum

Maximum number of chunks to be expected in a buffer.

StreamDeliveredFrameCount

Number of delivered frames since last acquisition start.

StreamDroppedFrameCount

Number of dropped frames due to queue overrun.

StreamFailedBufferCount

DEPRECATED; Replaced by StreamIncompleteFrameCount.

StreamID

Device unique ID for the data stream, e.g.

StreamIncompleteFrameCount

Displays number of images with missing packet.

StreamInputBufferCount

Number of buffers in the input buffer pool plus the buffers(s) currently being filled.

StreamIsGrabbing

Flag indicating whether the acquisition engine is started or not.

StreamLostFrameCount

Number of lost frames due to queue underrun.

StreamMissedPacketCount

Displays number of packets missed by this stream.

StreamMode

Stream mode of the device.

StreamOutputBufferCount

Number of buffers in the output buffer queue.

StreamPacketResendEnable

Enables or disables the packet resend mechanism.

StreamPacketResendMaxRequests

Maximum number of resend requests per image.

StreamPacketResendReceivedPacketCount

Displays number of retransmitted packets received on this stream.

StreamPacketResendRequestCount

Displays number of packet resend requests transmitted to the camera.

StreamPacketResendRequestSuccessCount

Displays number of packet resend requests successfully transmitted to the camera.

StreamPacketResendRequestedPacketCount

Displays number of packets requested to be retransmitted on this stream.

StreamPacketResendTimeout

Time in milliseconds to wait after the image trailer is received and before the image is completed by the driver.

StreamReceivedFrameCount

Number of successful GVSP data blocks received.

StreamReceivedPacketCount

Displays number of packets received on this stream.

StreamStartedFrameCount

Number of frames started in the acquisition engine.

StreamType

Stream type of the device.

bool_nodes

bool_nodes: list A list of all the names of the bool nodes.

command_nodes

command_nodes: list A list of all the names of the command nodes.

enum_nodes

enum_nodes: list A list of all the names of the enum nodes.

float_nodes

float_nodes: list A list of all the names of the float nodes.

int_nodes

int_nodes: list A list of all the names of the integer nodes.

register_nodes

register_nodes: list A list of all the names of the register nodes.

str_nodes

str_nodes: list A list of all the names of the string nodes.

GevFailedPacketCount

DEPRECATED; Replaced by StreamMissedPacketCount. Displays number of packets missed by this stream. Successful resent packets are not counted as a missed packet.

Property type

SpinIntNode.

Visibility

default.

GevMaximumNumberResendRequests

DEPRECATED; Replaced by StreamPacketResendMaxRequests. Maximum number of resend requests per image. Each resend request consists of a span of consecutive packet IDs.

Property type

SpinIntNode.

Visibility

default.

GevPacketResendMode

DEPRECATED; Replaced by StreamPacketResendEnable. Enables or disables the packet resend mechanism.

Property type

SpinBoolNode.

Visibility

default.

GevPacketResendTimeout

DEPRECATED; Replaced by StreamPacketResendTimeout. Time in milliseconds to wait after the image trailer is received and before the image is completed by the driver.

Property type

SpinIntNode.

Visibility

default.

GevResendPacketCount

DEPRECATED; Replaced by StreamPacketResendReceivedPacketCount. Displays number of packets received after retransmit request on this stream.

Property type

SpinIntNode.

Visibility

default.

GevResendRequestCount

DEPRECATED; Replaced by StreamPacketResendRequestedPacketCount. Displays number of packets requested to be retransmitted on this stream.

Property type

SpinIntNode.

Visibility

default.

GevTotalPacketCount

DEPRECATED; Replaced by StreamReceivedPacketCount. Displays number of packets received on this stream.

Property type

SpinIntNode.

Visibility

default.

StreamAnnounceBufferMinimum

Minimal number of buffers to announce to enable selected buffer handling mode.

Property type

SpinIntNode.

Visibility

default.

StreamAnnouncedBufferCount

Number of announced (known) buffers on this stream. This value is volatile. It may change if additional buffers are announced and/or buffers are revoked by the GenTL Consumer.

Property type

SpinIntNode.

Visibility

default.

StreamBlockTransferSize

Controls the image breakup size that should be used on this stream.

Property type

SpinIntNode.

Visibility

default.

StreamBufferAlignment

Alignment size in bytes of the buffer passed to DSAnnounceBuffer.

Property type

SpinIntNode.

Visibility

default.

StreamBufferCountManual

Controls the number of buffers to be used on this stream upon acquisition start when in manual mode.

Property type

SpinIntNode.

Visibility

default.

StreamBufferCountMax

Controls the maximum number of buffers that should be used on this stream. This value is calculated based on the available system memory.

Property type

SpinIntNode.

Visibility

default.

StreamBufferCountMode

Controls access to setting the number of buffers used for the stream.

Property type

SpinEnumDefNode.

Enum entries

StreamBufferCountMode_names.

Visibility

default.

StreamBufferCountResult

Displays the number of buffers to be used on this stream upon acquisition start. Recalculated on acquisition start if in auto mode.

Property type

SpinIntNode.

Visibility

default.

StreamBufferHandlingMode

Available buffer handling modes of this data stream:

Property type

SpinEnumDefNode.

Enum entries

StreamBufferHandlingMode_names.

Visibility

default.

StreamCRCCheckEnable

Enables or disables CRC checks on received images.

Property type

SpinBoolNode.

Visibility

default.

StreamChunkCountMaximum

Maximum number of chunks to be expected in a buffer.

Property type

SpinIntNode.

Visibility

default.

StreamDeliveredFrameCount

Number of delivered frames since last acquisition start. It is not reset until the stream is closed.

Property type

SpinIntNode.

Visibility

default.

StreamDroppedFrameCount

Number of dropped frames due to queue overrun. This number is initialized with zero at the time the stream is opened and incremented every time old data is dropped from the output list for new data. It is not reset until the stream is closed.

Property type

SpinIntNode.

Visibility

default.

StreamFailedBufferCount

DEPRECATED; Replaced by StreamIncompleteFrameCount. Displays number of images with missing packet.

Property type

SpinIntNode.

Visibility

default.

StreamID

Device unique ID for the data stream, e.g. a GUID.

Property type

SpinStrNode.

Visibility

default.

StreamIncompleteFrameCount

Displays number of images with missing packet.

Property type

SpinIntNode.

Visibility

default.

StreamInputBufferCount

Number of buffers in the input buffer pool plus the buffers(s) currently being filled.

Property type

SpinIntNode.

Visibility

default.

StreamIsGrabbing

Flag indicating whether the acquisition engine is started or not.

Property type

SpinBoolNode.

Visibility

default.

StreamLostFrameCount

Number of lost frames due to queue underrun. This number is initialized with zero at the time the stream is opened and incremented every time the data could not be acquired because there was no buffer in the input buffer pool. It is not reset until the stream is closed.

Property type

SpinIntNode.

Visibility

default.

StreamMissedPacketCount

Displays number of packets missed by this stream. Successful resent packets are not counted as a missed packet.

Property type

SpinIntNode.

Visibility

default.

StreamMode

Stream mode of the device.

Property type

SpinEnumDefNode.

Enum entries

StreamMode_names.

Visibility

default.

StreamOutputBufferCount

Number of buffers in the output buffer queue.

Property type

SpinIntNode.

Visibility

default.

StreamPacketResendEnable

Enables or disables the packet resend mechanism.

Property type

SpinBoolNode.

Visibility

default.

StreamPacketResendMaxRequests

Maximum number of resend requests per image. Each resend request consists of a span of consecutive packet IDs.

Property type

SpinIntNode.

Visibility

default.

StreamPacketResendReceivedPacketCount

Displays number of retransmitted packets received on this stream.

Property type

SpinIntNode.

Visibility

default.

StreamPacketResendRequestCount

Displays number of packet resend requests transmitted to the camera.

Property type

SpinIntNode.

Visibility

default.

StreamPacketResendRequestSuccessCount

Displays number of packet resend requests successfully transmitted to the camera.

Property type

SpinIntNode.

Visibility

default.

StreamPacketResendRequestedPacketCount

Displays number of packets requested to be retransmitted on this stream.

Property type

SpinIntNode.

Visibility

default.

StreamPacketResendTimeout

Time in milliseconds to wait after the image trailer is received and before the image is completed by the driver.

Property type

SpinIntNode.

Visibility

default.

StreamReceivedFrameCount

Number of successful GVSP data blocks received. Only valid while stream is active.

Property type

SpinIntNode.

Visibility

default.

StreamReceivedPacketCount

Displays number of packets received on this stream.

Property type

SpinIntNode.

Visibility

default.

StreamStartedFrameCount

Number of frames started in the acquisition engine. This number is incremented every time in case of a new buffer is started and then to be filled (data written to) regardless even if the buffer is later delivered to the user or discarded for any reason. This number is initialized with 0 at at the time of the stream is opened. It is not reset until the stream is closed.

Property type

SpinIntNode.

Visibility

default.

StreamType

Stream type of the device.

Property type

SpinEnumDefNode.

Enum entries

StreamType_names.

Visibility

default.

bool_nodes

bool_nodes: list A list of all the names of the bool nodes.

command_nodes

command_nodes: list A list of all the names of the command nodes.

enum_nodes

enum_nodes: list A list of all the names of the enum nodes.

float_nodes

float_nodes: list A list of all the names of the float nodes.

int_nodes

int_nodes: list A list of all the names of the integer nodes.

register_nodes

register_nodes: list A list of all the names of the register nodes.

str_nodes

str_nodes: list A list of all the names of the string nodes.