FUNCTIONAL GUIDE

CoaxlinkCoaxlink Driver Version 7.0

© EURESYS s.a. 2017 - Document version 7.0.629 built on 2017-03-07

EURESYS s.a. shall retain all property rights, title and interest of the documentation of the hardware and the soware,and of the trademarks of EURESYS s.a. All the names of companies and products mentioned in the documentation maybe the trademarks of their respective owners. The licensing, use, leasing, loaning, translation, reproduction, copying ormodification of the hardware or the soware, brands or documentation of EURESYS s.a. contained in this book, is notallowed without prior notice. EURESYS s.a. may modify the product specification or change the information given in thisdocumentation at any time, at its discretion, and without prior notice. EURESYS s.a. shall not be liable for any loss of ordamage to revenues, profits, goodwill, data, information systems or other special, incidental, indirect, consequential orpunitive damages of any kind arising in connection with the use of the hardware or the soware of EURESYS s.a. or resultingof omissions or errors in this documentation.

Contents   Coaxlink Driver 7.0 Functional Guide

Contents

About This Document................................................................................................................................................... 14Document Scope....................................................................................................................................................................... 14Document Revision History...................................................................................................................................................... 14Document Changes................................................................................................................................................................... 15

About Coaxlink Driver Version 7.0.2....................................................................................................................16Products & Accessories............................................................................................................................................................. 16Firmware Variants per Product................................................................................................................................................ 17Development Tools....................................................................................................................................................................18

Managing the Firmware...............................................................................................................................................19Firmware Manager Tool............................................................................................................................................................ 19Firmware Upgrade.....................................................................................................................................................................19Firmware Variant Installation................................................................................................................................................... 20

Product and Firmware Variant Selector...........................................................................................................21

Coaxlink Architecture.................................................................................................................................................... 22Coaxlink Block Diagram............................................................................................................................................................ 22

Interface Module Elements................................................................................................................................................... 22Device Module Elements.......................................................................................................................................................23Data Stream Module Elements.............................................................................................................................................23Buffer Module Elements........................................................................................................................................................24

CoaXPress Host Interface........................................................................................................................................... 25CoaXPress Standard Compliance............................................................................................................................................. 25Host Interface Specification Summary.................................................................................................................................... 25

Specification Summary – Card Level................................................................................................................................... 25Specification Summary – Camera Level.............................................................................................................................. 26Specification Summary – Image Data Stream Level...........................................................................................................27

Camera Connection Schemes...................................................................................................................................................27Host Connection Map Naming Convention......................................................................................................................... 28Host Connection Maps – Standard CoaXPress Devices...................................................................................................... 28Host Connection Maps – Data Forwarding Devices............................................................................................................ 29Host Connection Maps – Sub-Link Devices......................................................................................................................... 29

iii

Coaxlink Driver 7.0 Functional Guide   Contents

Firmware Variant & Product vs. Host Connection Map...................................................................................................... 30Link Configuration..................................................................................................................................................................... 30

CoaXPress 1.1.1 Discovery.................................................................................................................................................... 31Power Over CoaXPress.............................................................................................................................................................. 32CoaXPress I/O Channel..............................................................................................................................................................34CoaXPress Host To Device Trigger............................................................................................................................................34

Host to Device Trigger Transmitter...................................................................................................................................... 35Host to Device Trigger Message Format New .................................................................................................................... 36Host to Device Trigger Packet Acknowledgement.............................................................................................................. 36Host to Device Trigger Latency Compensation................................................................................................................... 37Camera Trigger to Exposure Latency................................................................................................................................... 37Host to Device Trigger Source.............................................................................................................................................. 38

CoaXPress Host Connector Indicator Lamps...........................................................................................................................39Connection Test......................................................................................................................................................................... 40

CoaXPress Data Forwarding QuadG3DF ...................................................................................................................41Data Forwarding Principles...................................................................................................................................................... 41Data Forwarding Connection Schemes................................................................................................................................... 42Line-scan Triggers Synchronization......................................................................................................................................... 43

Configuration Script Example...............................................................................................................................................43

Image Data Flow...............................................................................................................................................................45FIFO Buffer................................................................................................................................................................................. 45Acquisition Gate.........................................................................................................................................................................46Pixel Data Processing Overview............................................................................................................................................... 46Pixel Data Processing Configurations New ............................................................................................................................ 47Lookup Table Processing.......................................................................................................................................................... 50

Monochrome Lookup Table Processing............................................................................................................................... 50LUT Availability...................................................................................................................................................................... 51Lookup Table Content Definition Methods..........................................................................................................................52Lookup Table Setup Procedure............................................................................................................................................ 58

Pixel Component Unpacking New ..........................................................................................................................................60Pixel Component Ordering....................................................................................................................................................... 61Endianness Conversion............................................................................................................................................................. 62Pixel Ordering............................................................................................................................................................................ 62DMA Engine................................................................................................................................................................................ 62

Buffer Filling Rules................................................................................................................................................................ 63Stream Control...................................................................................................................................................................... 64Stream Statistics....................................................................................................................................................................65

Line Scan Acquisition.................................................................................................................................................... 66Line Scan Acquisition Principles.............................................................................................................................................. 66Line Scan Acquisition Use cases...............................................................................................................................................69

iv

Contents   Coaxlink Driver 7.0 Functional Guide

Camera Control Principles.........................................................................................................................................72Camera Cycle............................................................................................................................................................................. 72Camera Cycle Concatenation Rules......................................................................................................................................... 73Camera Control Methods.......................................................................................................................................................... 74

Illumination Control Principles.............................................................................................................................. 76Illumination Devices.................................................................................................................................................................. 76Aligning Camera and illumination Cycles................................................................................................................................76

Camera and Illumination Controller New ........................................................................................................ 78Cycle Timing Machine............................................................................................................................................................... 78Cycle Manager New ................................................................................................................................................................. 80Cycle Trigger Manager New .....................................................................................................................................................81Sequence Manager New .......................................................................................................................................................... 82Camera Trigger Signal............................................................................................................................................................... 83Strobe Signal Paths................................................................................................................................................................... 84

CIC Timing Diagrams..................................................................................................................................................... 85CIC Cycle Timing Diagrams.......................................................................................................................................................85Consecutive Overlapping CIC Cycles........................................................................................................................................86Cycle Sequence Timing Diagrams New .................................................................................................................................. 89

CIC Synchronization....................................................................................................................................................... 91CIC Synchronization Principle.................................................................................................................................................. 91CIC Synchronization Timing Diagram...................................................................................................................................... 92

C2C-Link.................................................................................................................................................................................. 94C2C-Link Specification...............................................................................................................................................................95Trigger Propagation Delays.......................................................................................................................................................96C2C-Link Use Cases................................................................................................................................................................... 97C2C-Link Availability..................................................................................................................................................................98C2C-Link Setup...........................................................................................................................................................................98C2C-Link Hardware Components............................................................................................................................................. 99

3303 C2C-Link Ribbon Cable................................................................................................................................................ 99Custom C2C-Link Ribbon Cable Assembly.........................................................................................................................1001636 InterPC C2C-Link Adapter.......................................................................................................................................... 100C2C-Link Extender............................................................................................................................................................... 102HD26F I/O Adapter...............................................................................................................................................................105

v

Coaxlink Driver 7.0 Functional Guide   Contents

I/O Toolbox........................................................................................................................................................................ 106I/O Toolbox Context.................................................................................................................................................................106I/O Toolbox Structure..............................................................................................................................................................107I/O Toolbox Composition........................................................................................................................................................ 108Line Input Tool.........................................................................................................................................................................109Quadrature Decoder Tool........................................................................................................................................................110User Actions Tool.....................................................................................................................................................................112

User Actions Scheduler....................................................................................................................................................... 113User Events.......................................................................................................................................................................... 114User Output Register...........................................................................................................................................................115

Event Input Tool QuadG3DF .................................................................................................................................................... 115Divider Tool.............................................................................................................................................................................. 116Multiplier/Divider Tool.............................................................................................................................................................117Delay Tool.................................................................................................................................................................................119

General Purpose I/O Lines...................................................................................................................................... 121I/O Lines Types........................................................................................................................................................................ 121Available I/O Lines...................................................................................................................................................................121I/O Lines Usage........................................................................................................................................................................122I/O Control Blocks................................................................................................................................................................... 122

Line Mode Control............................................................................................................................................................... 124I/O Lines Specifics............................................................................................................................................................... 124Line Polarity Control........................................................................................................................................................... 125Filter Control........................................................................................................................................................................ 125Line Source Selection..........................................................................................................................................................126Logical I/O Line State.......................................................................................................................................................... 126Physical I/O Line State........................................................................................................................................................ 127Line Driver Physical Output States.................................................................................................................................... 127Initial States......................................................................................................................................................................... 128

Event Signaling And Counting..............................................................................................................................129Short Description.....................................................................................................................................................................129

About GenTL Signaling........................................................................................................................................................129Event Types.............................................................................................................................................................................. 130Custom Events Sources...........................................................................................................................................................131Custom Events Counter.......................................................................................................................................................... 133Custom Events Configuration................................................................................................................................................. 134Event Specific Context Data................................................................................................................................................... 134Event Control GenICam Features (Interface)......................................................................................................................... 135Event Control GenICam Features (Device).............................................................................................................................136Event Control GenICam Features (Data Stream)...................................................................................................................136

vi

Contents   Coaxlink Driver 7.0 Functional Guide

OEM Safety Key...............................................................................................................................................................138Using OEMSafetyKey............................................................................................................................................................... 139

System Module Features..........................................................................................................................................140Root Category.......................................................................................................................................................................... 140

SystemInformation.............................................................................................................................................................. 140InterfaceEnumeration..........................................................................................................................................................140

SystemInformation Category..................................................................................................................................................141TLVendorName.....................................................................................................................................................................141TLModelName...................................................................................................................................................................... 141TLID.......................................................................................................................................................................................142TLVersion.............................................................................................................................................................................. 142TLPath...................................................................................................................................................................................142TLType...................................................................................................................................................................................143GenTLVersionMajor.............................................................................................................................................................. 143GenTLVersionMinor.............................................................................................................................................................. 144

InterfaceEnumeration Category............................................................................................................................................. 144InterfaceUpdateList............................................................................................................................................................. 144InterfaceSelector..................................................................................................................................................................145InterfaceID............................................................................................................................................................................ 145

Interface Module Features...................................................................................................................................... 146Root Category.......................................................................................................................................................................... 146

InterfaceInformation........................................................................................................................................................... 146DeviceEnumeration............................................................................................................................................................. 147CoaXPress.............................................................................................................................................................................147DigitalIOControl................................................................................................................................................................... 148UserOutputRegister............................................................................................................................................................. 148IOToolbox............................................................................................................................................................................. 149PCIExpress............................................................................................................................................................................150InterfaceControl................................................................................................................................................................... 150InterfaceDetails.................................................................................................................................................................... 151EventControl........................................................................................................................................................................ 151OemSafetyKey......................................................................................................................................................................152

InterfaceInformation Category............................................................................................................................................... 152InterfaceID............................................................................................................................................................................ 152InterfaceType........................................................................................................................................................................153SerialNumber....................................................................................................................................................................... 153PartNumber..........................................................................................................................................................................153FirmwareRevision................................................................................................................................................................ 154FirmwareVariant.................................................................................................................................................................. 154FirmwareStatus....................................................................................................................................................................154

vii

Coaxlink Driver 7.0 Functional Guide   Contents

FirmwareRecoverySwitch....................................................................................................................................................155DeviceEnumeration Category................................................................................................................................................. 155

DeviceUpdateList................................................................................................................................................................. 156DeviceSelector......................................................................................................................................................................156DeviceID................................................................................................................................................................................157DeviceVendorName............................................................................................................................................................. 157DeviceModelName............................................................................................................................................................... 157DeviceAccessStatus..............................................................................................................................................................158

CoaXPress Category.................................................................................................................................................................158CxpPoCxpHostConnectionSelector.................................................................................................................................... 159CxpPoCxpAuto......................................................................................................................................................................160CxpPoCxpTurnOff.................................................................................................................................................................160CxpPoCxpTripReset..............................................................................................................................................................161CxpPoCxpConfigurationStatus............................................................................................................................................161CxpPoCxpStatus...................................................................................................................................................................162CxpPoCxpCurrent.................................................................................................................................................................162CxpPoCxpVoltage................................................................................................................................................................. 163CxpPoCxpPowerInputStatus............................................................................................................................................... 163CxpHostConnectionCount...................................................................................................................................................164CxpHostConnectionSelector............................................................................................................................................... 164CxpConnectionState............................................................................................................................................................165CxpDownConnectionSpeed................................................................................................................................................ 165CxpDeviceConnectionID...................................................................................................................................................... 166CxpHostConnectionTestMode.............................................................................................................................................167CxpHostConnectionTestErrorCount................................................................................................................................... 168CxpHostConnectionTestPacketCount.................................................................................................................................168CxpHostConnectionTestInjectError.................................................................................................................................... 169CxpRevisionSelector............................................................................................................................................................ 169CxpRevisionSupport............................................................................................................................................................ 170

DigitalIOControl Category....................................................................................................................................................... 170LineSelector......................................................................................................................................................................... 171LineFormat........................................................................................................................................................................... 172LineMode.............................................................................................................................................................................. 172LineInverter.......................................................................................................................................................................... 173LineFilterStrength................................................................................................................................................................ 173LineFilterDelay..................................................................................................................................................................... 174LineStatus.............................................................................................................................................................................174LineStatusAll........................................................................................................................................................................ 175LineSource............................................................................................................................................................................176

UserOutputRegister Category................................................................................................................................................. 177UserOutputValueAll............................................................................................................................................................. 177UserActions.......................................................................................................................................................................... 178AddUserAction..................................................................................................................................................................... 178ClearUserActions..................................................................................................................................................................179ExecuteUserActions............................................................................................................................................................. 180ScheduleUserActions...........................................................................................................................................................180UserActionsSchedulerReference.........................................................................................................................................181ScheduledUserActionsPoolStatus...................................................................................................................................... 181

viii

Contents   Coaxlink Driver 7.0 Functional Guide

DiscardScheduledUserActions............................................................................................................................................ 182IOToolbox Category................................................................................................................................................................. 182

LineInputToolSelector......................................................................................................................................................... 183LineInputToolSource........................................................................................................................................................... 184LineInputToolActivation...................................................................................................................................................... 185MultiplierDividerToolSelector............................................................................................................................................. 185MultiplierDividerToolSource............................................................................................................................................... 186MultiplierDividerToolOutputControl...................................................................................................................................187MultiplierDividerToolMultiplicationFactor......................................................................................................................... 187MultiplierDividerToolDivisionFactor................................................................................................................................... 188MultiplierDividerToolEffectiveMultiplicationFactor...........................................................................................................189MultiplierDividerToolEffectiveDivisionFactor.....................................................................................................................189QuadratureDecoderToolSelector........................................................................................................................................ 190QuadratureDecoderToolSources........................................................................................................................................ 190QuadratureDecoderToolActivation.....................................................................................................................................191QuadratureDecoderToolForwardDirection........................................................................................................................ 192QuadratureDecoderToolOutputMode................................................................................................................................ 192QuadratureDecoderToolPosition........................................................................................................................................ 193QuadratureDecoderToolDirection...................................................................................................................................... 193QuadratureDecoderToolPositionReset...............................................................................................................................194DividerToolSelector............................................................................................................................................................. 194DividerToolSource................................................................................................................................................................195DividerToolEnableControl................................................................................................................................................... 196DividerToolDivisionFactor................................................................................................................................................... 196DividerToolInitialOffset........................................................................................................................................................197DelayToolSelector................................................................................................................................................................ 197DelayToolSource1................................................................................................................................................................ 198DelayToolSource2................................................................................................................................................................ 199DelayToolClockSource.........................................................................................................................................................200DelayToolDelayValue........................................................................................................................................................... 200EventInputToolSelector.......................................................................................................................................................201EventInputToolSource......................................................................................................................................................... 202EventInputToolActivation....................................................................................................................................................202InternalTime.........................................................................................................................................................................203

PCIExpress Category................................................................................................................................................................203PCIeMaxPayloadSizeSupported..........................................................................................................................................203PCIeMaxPayloadSize............................................................................................................................................................204PCIeMaxReadRequestSize................................................................................................................................................... 204PCIeMaxLinkSpeed.............................................................................................................................................................. 204PCIeCurrentLinkSpeed........................................................................................................................................................ 205PCIeMaximumLinkWidth..................................................................................................................................................... 205PCIeNegotiatedLinkWidth................................................................................................................................................... 206PCIeLinkSpeed2500MTpsSupported.................................................................................................................................. 206PCIeLinkSpeed5000MTpsSupported.................................................................................................................................. 207PCIeLinkSpeed8000MTpsSupported.................................................................................................................................. 207

InterfaceControl Category.......................................................................................................................................................207FanStatus..............................................................................................................................................................................208TemperatureSensorSelector............................................................................................................................................... 208

ix

Coaxlink Driver 7.0 Functional Guide   Contents

Temperature.........................................................................................................................................................................209AuxiliaryPowerInput............................................................................................................................................................ 209AuxiliaryPower12VInput...................................................................................................................................................... 209

InterfaceDetails Category........................................................................................................................................................210BoardCapabilities................................................................................................................................................................ 210FirmwareBoardID.................................................................................................................................................................211CPLDRevision....................................................................................................................................................................... 211PreviousBootBank............................................................................................................................................................... 211NextBootBank...................................................................................................................................................................... 212CurrentBankSelect...............................................................................................................................................................212CurrentBankSelectReadback.............................................................................................................................................. 212NextBankSelect....................................................................................................................................................................213SpiBankStatus......................................................................................................................................................................213PotBankStatus..................................................................................................................................................................... 213

EventControl Category............................................................................................................................................................ 214EventSelector....................................................................................................................................................................... 214EventNotification................................................................................................................................................................. 215EventNotificationContext1.................................................................................................................................................. 216EventNotificationContext2.................................................................................................................................................. 217EventNotificationContext3.................................................................................................................................................. 218EventCount...........................................................................................................................................................................219EventCountReset................................................................................................................................................................. 219

OemSafetyKey Category..........................................................................................................................................................220OemSafetyKeyVerification...................................................................................................................................................220CheckOemSafetyKey........................................................................................................................................................... 221ProgramOemSafetyKey....................................................................................................................................................... 221EncryptedOemSafetyKey.................................................................................................................................................... 222MaximumOemKeyLength.................................................................................................................................................... 222

Device Module Features............................................................................................................................................223Root Category.......................................................................................................................................................................... 223

DeviceInformation............................................................................................................................................................... 223StreamEnumeration............................................................................................................................................................ 223CameraAndIlluminationControl..........................................................................................................................................224CoaXPress.............................................................................................................................................................................224EventControl........................................................................................................................................................................ 225Errors.................................................................................................................................................................................... 225

DeviceInformation Category................................................................................................................................................... 225DeviceID................................................................................................................................................................................226DeviceVendorName............................................................................................................................................................. 226DeviceModelName............................................................................................................................................................... 226DeviceAccessStatus..............................................................................................................................................................227DeviceType........................................................................................................................................................................... 227

StreamEnumeration Category................................................................................................................................................ 227StreamSelector.................................................................................................................................................................... 228StreamID...............................................................................................................................................................................228

x

Contents   Coaxlink Driver 7.0 Functional Guide

CoaXPress Category.................................................................................................................................................................228CxpLinkConfiguration..........................................................................................................................................................229CxpLinkConfigurationOption.............................................................................................................................................. 230CxpHostConnectionBase.....................................................................................................................................................230CxpHostConnectionCount...................................................................................................................................................231CxpTriggerMessageFormat.................................................................................................................................................. 231CxpTriggerLevel....................................................................................................................................................................232CxpTriggerAckTimeout.........................................................................................................................................................232CxpTriggerMaxResendCount............................................................................................................................................... 233CxpPacketArbiterReset........................................................................................................................................................ 233

CameraAndIlluminationControl Category............................................................................................................................. 234CameraModel....................................................................................................................................................................... 234CycleTiming..........................................................................................................................................................................235CycleControl.........................................................................................................................................................................235SequenceControl................................................................................................................................................................. 236DeviceReset.......................................................................................................................................................................... 236

CameraModel Category...........................................................................................................................................................236CameraControlMethod........................................................................................................................................................ 237C2CLinkConfiguration..........................................................................................................................................................238ExposureReadoutOverlap................................................................................................................................................... 238ExposureRecoveryTime....................................................................................................................................................... 239

CycleTiming Category..............................................................................................................................................................240ExposureTime.......................................................................................................................................................................240StrobeDelay..........................................................................................................................................................................241StrobeDuration.................................................................................................................................................................... 241

CycleControl Category.............................................................................................................................................................242CycleTriggerSource.............................................................................................................................................................. 242CycleTargetPeriod................................................................................................................................................................ 243StartCycle............................................................................................................................................................................. 244CycleMaxPendingTriggerCount........................................................................................................................................... 245CyclePendingTriggerCount..................................................................................................................................................245CycleLostTriggerCount........................................................................................................................................................ 246CycleLostTriggerCountReset............................................................................................................................................... 246

SequenceControl Category..................................................................................................................................................... 247StartOfSequenceTriggerSource...........................................................................................................................................247EndOfSequenceTriggerSource............................................................................................................................................ 248SequenceLength.................................................................................................................................................................. 249StartSequence......................................................................................................................................................................250StopSequence...................................................................................................................................................................... 250AbortSequence.....................................................................................................................................................................251

EventControl Category............................................................................................................................................................ 251EventSelector....................................................................................................................................................................... 252EventNotification................................................................................................................................................................. 253EventNotificationContext1.................................................................................................................................................. 253EventNotificationContext2.................................................................................................................................................. 255EventNotificationContext3.................................................................................................................................................. 256EventCount...........................................................................................................................................................................258EventCountReset................................................................................................................................................................. 258

xi

Coaxlink Driver 7.0 Functional Guide   Contents

Errors Category........................................................................................................................................................................ 258ErrorSelector........................................................................................................................................................................ 259ErrorCount............................................................................................................................................................................260ErrorCountReset.................................................................................................................................................................. 260

Data Stream Module Features..............................................................................................................................261Root Category.......................................................................................................................................................................... 261

StreamInformation.............................................................................................................................................................. 261ImageFormatControl........................................................................................................................................................... 262PixelProcessing.................................................................................................................................................................... 262LUTControl........................................................................................................................................................................... 262TransportLayerControl........................................................................................................................................................ 263BufferHandlingControl........................................................................................................................................................ 263LineScanAcquisitionControl................................................................................................................................................264StreamControl......................................................................................................................................................................264Errors.................................................................................................................................................................................... 264StreamStatistics...................................................................................................................................................................265LaserLineExtractor...............................................................................................................................................................265EventControl........................................................................................................................................................................ 266

StreamInformation Category.................................................................................................................................................. 266StreamID...............................................................................................................................................................................266StreamType.......................................................................................................................................................................... 267

ImageFormatControl Category............................................................................................................................................... 267PixelFormat.......................................................................................................................................................................... 267PixelFormatNamespace...................................................................................................................................................... 273PixelSize................................................................................................................................................................................274Width.................................................................................................................................................................................... 274Height................................................................................................................................................................................... 274

PixelProcessing Category........................................................................................................................................................ 275UnpackingMode................................................................................................................................................................... 275RedBlueSwap....................................................................................................................................................................... 276

LUTControl Category............................................................................................................................................................... 276LUTConfiguration.................................................................................................................................................................277LUTLength............................................................................................................................................................................ 277LUTMaxValue........................................................................................................................................................................278LUTSet...................................................................................................................................................................................278LUTIndex...............................................................................................................................................................................279LUTValue...............................................................................................................................................................................279LUTReadBlockLength.......................................................................................................................................................... 280LUTEnable............................................................................................................................................................................ 280

TransportLayerControl Category............................................................................................................................................ 281PayloadSize.......................................................................................................................................................................... 281

BufferHandlingControl Category............................................................................................................................................ 281StreamAnnouncedBufferCount...........................................................................................................................................282StreamBufferHandlingMode............................................................................................................................................... 282StreamAnnounceBufferMinimum....................................................................................................................................... 282

xii

Contents   Coaxlink Driver 7.0 Functional Guide

StreamAcquisitionModeSelector........................................................................................................................................ 283LineScanAcquisitionControl Category....................................................................................................................................283

StartOfScanTriggerSource...................................................................................................................................................283EndOfScanTriggerSource.....................................................................................................................................................284ScanLength...........................................................................................................................................................................285BufferHeight......................................................................................................................................................................... 286StartScan.............................................................................................................................................................................. 287StopScan.............................................................................................................................................................................. 287

StreamControl Category......................................................................................................................................................... 287StreamReset......................................................................................................................................................................... 288LineWidth............................................................................................................................................................................. 288LinePitch...............................................................................................................................................................................289StripeHeight......................................................................................................................................................................... 289StripePitch............................................................................................................................................................................290

Errors Category........................................................................................................................................................................ 290ErrorSelector........................................................................................................................................................................ 290ErrorCount............................................................................................................................................................................291ErrorCountReset.................................................................................................................................................................. 292

StreamStatistics Category.......................................................................................................................................................292StatisticsSamplingSelector................................................................................................................................................. 292StatisticsFrameRate.............................................................................................................................................................293StatisticsLineRate................................................................................................................................................................ 294StatisticsDataRate............................................................................................................................................................... 294StatisticsStartSampling.......................................................................................................................................................295StatisticsStopSampling....................................................................................................................................................... 295

LaserLineExtractor Category...................................................................................................................................................295LaserLineExtractorRevision.................................................................................................................................................296LaserLineExtractorReset......................................................................................................................................................296LaserLineExtractorAlgorithm.............................................................................................................................................. 296LaserLineExtractorThresholdLevel..................................................................................................................................... 297LaserLineExtractorConvolutionCoefficientA...................................................................................................................... 297LaserLineExtractorConvolutionCoefficientB......................................................................................................................298LaserLineExtractorConvolutionCoefficientC......................................................................................................................298

EventControl Category............................................................................................................................................................ 298EventSelector....................................................................................................................................................................... 299EventNotification................................................................................................................................................................. 300EventNotificationContext1.................................................................................................................................................. 300EventNotificationContext2.................................................................................................................................................. 302EventNotificationContext3.................................................................................................................................................. 303EventCount...........................................................................................................................................................................305EventCountReset................................................................................................................................................................. 305

xiii

Coaxlink Driver 7.0 Functional Guide   About This Document

About This Document

Document ScopeThis document describes and explains how to use the functions of the Coaxlink products when they are operated withCoaxlink Driver version 7.0.2.Unless specified, the functions described in this document are applicable to all the Coaxlink products and theirfirmware variants supported by the Coaxlink Driver.

Document Revision HistoryDate Version Description

2016-08-05 6.0

Functional Guide of Coaxlink Driver 6.0

• Add 1634 Coaxlink Duo PCIe/104 product• Add User Actions Tool on page 112

2016-09-08 6.1

Functional Guide of Coaxlink Driver 6.1

• Extend IntraPC C2C-Link limit to 0.6 m• Add 1636 InterPC C2C-Link Adapter• Extend GPIO Line sources to 'Device<0:3> Stream0 Start Of Camera Readout'• Extend DIV tool range to 16-bit• Improve security level of OEM Safety Key• Preliminary support of sub-link acquisition for a particular 8-connection camera

2016-09-29 6.1.1 Functional Guide of Coaxlink Driver 6.1.1

2016-11-24 6.2.2

Functional Guide of Coaxlink Driver 6.2.2

• Add support of lookup tables for monochrome pixels• Add data stream line-padding and stripe-padding

2017-02-06 6.2.4 Functional Guide of Coaxlink Driver 6.2.4

2017-02-22 7.0

Functional Guide of Coaxlink Driver 7.0

• Add support of 1629 Coaxlink Duo PCIe/104-EMB and 1634 Coaxlink Duo PCIe/104-MIL.• Added the capability to send alternatively rising and falling edge CoaXPress host to device

trigger messages• CIC end of sequence control• Preliminary support of ARM processors

2017-02-24 7.0.1Functional Guide of Coaxlink Driver 7.0.1

• Add capability to acquire packed 10-/12-/14-bit monochrome and Bayer CFA pixels.

2017-03-06 7.0.2 Functional Guide of Coaxlink Driver 7.0.2

14

About This Document   Coaxlink Driver 7.0 Functional Guide

Document ChangesVersion 7.0.2

• Pixel Data Processing Overview on page 46: revised tables. (Split LUT enabled and LUT disabled cases forbetter clarity. Allow unpacking to Msb when LUTs are enabled.)

Version 7.0.1• Pixel Data Processing Configurations on page 47: revised to include unpacked cases• Pixel Component Unpacking on page 60: add OFF value to UnpackingMode• System Module Features on page 140: new import from EuresysCoaxlink-7.0.1.18-TLSystem XML.• Interface Module Features on page 146: new import from EuresysCoaxlink-7.0.1.18-TLInterface XML.• Device Module Features on page 223: new import from EuresysCoaxlink-7.0.1.18-TLDevice XML.• Data Stream Module Features on page 261: new import from EuresysCoaxlink-7.0.1.18-TLDataStream XML.

Version 7.0• Host to Device Trigger Message Format on page 36 : new value Toggle to CxpTriggerMessageFormat,

and related feature CxpTriggerLevel.• Camera and Illumination Controller on page 78: revised section.• Cycle Manager on page 80: revised section.• Cycle Trigger Manager on page 81: revised section, added pending trigger counter.• Sequence Manager on page 82: revised section, added EndOfSequenceTriggerSource andSequenceLength.

• Cycle Sequence Timing Diagrams on page 89: new diagrams.• System Module Features on page 140: new import from EuresysCoaxlink-7.0.0.11-TLSystem XML.• Interface Module Features on page 146: new import from EuresysCoaxlink-7.0.0.11-TLInterface XML.• Device Module Features on page 223: new import from EuresysCoaxlink-7.0.0.11-TLDevice XML.• Data Stream Module Features on page 261: new import from EuresysCoaxlink-7.0.0.11-TLDataStream XML.

15

Coaxlink Driver 7.0 Functional Guide   About Coaxlink Driver Version 7.0.2

About Coaxlink Driver Version 7.0.2

Products & AccessoriesCoaxlink frame grabbers and related accessories supported by Coaxlink Driver 7.0

Coaxlink Products

Product S/N Prefix Icon

1629 Coaxlink Duo PCIe/104-EMB KDI Duo104EMB

1630 Coaxlink Mono KMO Mono

1631 Coaxlink Duo KDU Duo

1632 Coaxlink Quad KQU Quad

1633 Coaxlink Quad G3 KQG QuadG3

1634 Coaxlink Duo PCIe/104-MIL KDR Duo104MIL

1635 Coaxlink Quad G3 DF KDF QuadG3DF

Related Accessories

Product S/N Prefix Icon

1625 DB25F I/O Adapter Cable 1625

1636 InterPC C2C-Link Adapter KCC 1636

3300 HD26F I/O module for Coaxlink Duo PCIe/104 3300

3301 Thermal drain (Model 1) for Coaxlink Duo PCIe/104 3301

3302 DIN1.0/2.3 Coaxial cable for Coaxlink Duo PCIe/104 3302

3303 C2C-Link Ribbon Cable 3303

3304 HD26F I/O Adapter Cable 3304

Note: The S/N prefix is a 3-letter string at the beginning of the card serial number.

Note: Icons are used in this document for tagging titles of card-specific content.

16

About Coaxlink Driver Version 7.0.2   Coaxlink Driver 7.0 Functional Guide

Firmware Variants per ProductList of available firmware variants per product supported by Coaxlink Driver 7.0

1630 Coaxlink Mono

Firmware Variant Description Icon

1-camera One 1-connection area-scan camera Mono

1631 Coaxlink Duo

Firmware Variant Description Icon

1-camera One 1- or 2-connection area-scan camera Duo

2-camera One or two 1-connection area-scan cameras Duo

1632 Coaxlink Quad

Firmware Variant Description Icon

1-camera One 1- or 2- or 4-connection area-scan camera Quad

2-camera One or two 1- or 2-connection area-scan cameras Quad

1-camera, line-scan One 1- or 2- or 4-connection line-scan camera Quad

1633 Coaxlink Quad G3

Firmware Variant Description Icon

1-camera One 1- or 2- or 4-connection area-scan camera Quad G3

2-camera One or two 1- or 2-connection area-scan cameras Quad G3

4-camera One or two or three or four 1-connection area-scan cameras Quad G3

1-camera, line-scan One 1- or 2- or 4-connection line-scan camera Quad G3

2-camera, line-scan One or two 1- or 2-connection line-scan cameras Quad G3

1-slm-cameraMaster 4-connection sub-link of an 8-connection area-scancamera

Quad G3M

17

Coaxlink Driver 7.0 Functional Guide   About Coaxlink Driver Version 7.0.2

Firmware Variant Description Icon

1-sls-cameraSlave 4-connection sub-link of an 8-connection area-scancamera

Quad G3S

1629 Coaxlink Duo PCIe/104-EMB, 1634 Coaxlink Duo PCIe/104-MIL

Firmware Variant Description Icon

1-camera One 1- or 2-connection area-scan camera Duo PCIe/104

2-camera One or two 1-connection area-scan cameras Duo PCIe/104

1-camera, line-scan One 1- or 2-connection line-scan camera Duo PCIe/104

1635 Coaxlink Quad G3 DF

Firmware Variant Description Icon

1-camera One 1- or 2- or 4-connection area-scan camera Quad G3 DF

1-df-cameraOne 1- or 2- or 4-connection area-scan data-forwarded-camera D

F Quad G3 DF

1-camera, line-scan One 1- or 2- or 4-connection line-scan camera Quad G3 DF

1-df-camera, line-scan One 1- or 2- or 4-connection line-scan data-forwarded-camera DF Quad G3 DF

Notice: Combined firmware/product icons are used in this document for tagging content that appliesonly to a particular firmware variant of the designated product.

Development ToolsThe Coaxlink Driver is supplied as GenICam GenTL producer libraries (coaxlink.cti):

• An x86 dynamic library designed to be used with ISO-compliant C/C++ compilers for the development of x86applications.

• An x86_64 dynamic library designed to be used with ISO-compliant C/C++ compilers for the development of x86_64applications.

• An aarch64 dynamic library designed to be used with ISO-compliant C/C++ compilers for the development ofaarch64applications.

• A .NET assembly designed to be used with development environments compatible with .NET frameworks version2.0 or higher.

The Coaxlink cards should be usable with any development tool that supports at least one of these interfaces.

18

Managing the Firmware   Coaxlink Driver 7.0 Functional Guide

Managing the FirmwareHow to manage the firmware upgrades and the installation of firmware variants

The heart of a Coaxlink card is a RAM-based FPGA (Field Programmable Gate Array) that implements several functionsincluding the PCI Express end point.Considering that a PCI Express end point must be ready within 150 milliseconds of the power-up time, the FPGAcontent, hereaer named "firmware", must be loaded quickly aer having applied power to the card. Therefore, thefirmware is stored into a non-volatile flash EEPROM allowing a fast start-up of the FPGA.

Note: This situation differs from other Euresys products, such as Grablink cards, where the FPGAcontent is loaded by the MultiCam Driver when it starts or at any time if a FPGA configuration changeis requested.

The Coaxlink Driver will never modify the content the FPGA during operation. Any modification of the FPGA contentrequires a two-step operation:

• Step 1: The new firmware is written into the Flash EEPROM of the card using a "firmware manager" tool.• Step 2: The new firmware is activated by cycling the system power.

Firmware Manager ToolThe Coaxlink Driver is delivered with a command-line tool named coaxlink-firmware.exe.The Coaxlink Firmware Manager Tool embeds a library of firmware images composed with all the firmware variantsof all the products supported by the specific version the Coaxlink Driver. Unless specified with a --firmware=FILEoption, the tool uses the embedded library.The Coaxlink Firmware Manager Tool allows to:

• List the properties of the firmware installed on each Coaxlink cards present in the system including version number,variant number and name.

• Perform a firmware upgrade (without changing the variant number).• Install a new firmware variant.

Note: Executing coaxlink-firmware.exe --help displays a help message describing all thecommand options.

Firmware UpgradeTo upgrade the firmware with the latest version:

• Step 1. Execute the following command line: coaxlink-firmware.exe upgrade [OPTIONS]

19

Coaxlink Driver 7.0 Functional Guide   Managing the Firmware

• Step 2. Reboot the PC!

IMPORTANT NOTE

The Coaxlink Firmware Manager Tool must be executed when using any Coaxlink card for the first time with aspecific Coaxlink Driver version.In particular, the firmware upgrade must be executed:

• when using a new Coaxlink card for the first time• aer installing a different version of the Coaxlink Driver

This will ensure that the Coaxlink card's firmware is suitable for the Coaxlink Driver version.

Firmware Variant InstallationTo install another firmware variant:

• Step 1. Execute the following command line: coaxlink-firmware.exe upgrade [OPTIONS] VARIANT• Step 2. Reboot the PC!

IMPORTANT NOTE

The Coaxlink Firmware Manager Tool must be executed when another firmware variant must be installed.For instance:

• when another camera connection topology is required (e.g. 1-camera vs. 2-camera on Coaxlink Duo)• when another camera type is required (e.g. 1-camera vs. 1-camera, line-scan on Coaxlink Quad)

20

Product and Firmware Variant Selector   Coaxlink Driver 7.0 Functional Guide

Product and Firmware Variant SelectorCoaxlink product and firmware variant selection guide

The following table provides help for the selection of the appropriate Coaxlink product and firmware variant regardingthe following CoaXPress Host Interface requirements:

• Device Type: the type of camera (line- or area-scan, data-forwarded virtual camera or real camera)• #Dev.: Maximum number of devices per Coaxlink card• #Con.: Number of camera connections

Device Type #Dev. Icon Firmware Variant #Con. Applicable products

1, 2, or 4 Quad QuadG3 QuadG3DF

1 or 2 Duo Duo104EMB Duo104MIL1 1-camera

1 Mono

1 or 2 Quad QuadG3

1 or 2 2-camera1 Duo Duo104EMB Duo104MIL

Area-scan camera

Up to 4 4-camera 1 QuadG3

1, 2, or 4 Quad QuadG3 QuadG3DF

1 1-camera, line-scan1 or 2 Duo104EMB Duo104MILLine-scan camera

1 or 2 2-camera, line-scan 1 or 2 QuadG3

Data-forwarded virtualarea-scan camera 1 D

F 1-df-camera 1, 2, or 4 QuadG3DF

Data-forwarded virtualline-scan camera 1 D

F 1-df-camera, line-scan 1, 2, or 4 QuadG3DF

M 1-slm-camera 4 QuadG3

Specific 8-connectionarea-scan camera 1

S 1-sls-camera 4 QuadG3

21

Coaxlink Driver 7.0 Functional Guide   Coaxlink Architecture

Coaxlink ArchitectureArchitecture of Coaxlink cards

Coaxlink Block DiagramThe following diagram shows the main functional bocks of an image acquisition system including

• One Host PC.• One Coaxlink frame grabber configured with a 1-camera firmware variant.• One imaging device delivering a single image data stream over a CoaXPress Link.• One illumination device, one encoder device and one encoder device.

CoaXPress Link

Data Stream

Strobe

IAC Image Acquisition Controller

Imaging Device (Camera)

SensorController

Acquisition ControllerImage

Sensor

FIFO Buffer

Illumination Device

Application Software

Image Buffers

Acquisition Gate

FIFO Buffer

Host PC

CICCamera

& Illumination Controller

Trigger(s)

Trigger Device(s)

TI/O Toolbox

Pixel Processing

Strobe

Camera Trigger

Legend

Data Stream Module Element

Device ModuleElement

Cycle Trigger

Acquision Triggers

Trigger(s)

Encoder Device(s)

E

Line InputTools

QuadratureDecoder Tools

Delay Tools

Divider Tools

Multiplier/Divider Tools

CameraTriggerCamera Control

Gate Control

Coa

XP

ress

Hos

t Int

erfa

ceI/O

Coaxlink Frame Grabber

Interface ModuleElement

Buffer Module Element

Figure 1: Single-stream single-device Coaxlink image acquisition system

The drawing uses color shading to indicate to which GenTL module the functional elements belong:

• Orange color for elements belonging to the Interface module• Green color for elements belonging to the Device module and the associated Remote Device (camera)• Blue color for elements belonging to the Data Stream module• Purple color for elements belonging to the Buffer module.

Interface Module ElementsThe GenTL hierarchy exposes one GenTL Interface Module for each Coaxlink card.

22

Coaxlink Architecture   Coaxlink Driver 7.0 Functional Guide

It gathers the elements that are common to- (or can be shared by-) all the GenTL Device Modules managed by theCoaxlink card.The interface module contains the following elements:

• I/O Lines: This block gathers all the I/O ports of the card. It is used for the configuration (direction, polarity, filterstrength) and reading the status of each I/O line.

• I/O Toolbox: This block gathers a collection of tools used to build event streams from trigger and encoder devicesattached to the I/O port inputs.

Related InformationGeneral Purpose I/O Lines on page 121Set of general purpose digital I/O lines

I/O Toolbox on page 106Set of tools for building-up and processing hardware events

Device Module ElementsThe GenTL hierarchy exposes one GenTL Device Module for each for each imaging device.It gathers the elements that are common to- (or can be shared by-) all the GENTL Data Stream Modules related to thatimaging device.The elements belonging to the imaging device (camera) itself are referred as "Remote Device". By opposition, theelements belonging to the frame grabber are also referred as "Local Device".The device module contains the following elements:

• Camera and Illumination Controller: This block is used to control the camera cycle and the illumination strobe. Itcan be configured to receive real-time (Camera) Cycle trigger events from any I/O Toolbox output stream. It producestwo real-time signals: the Camera Trigger signal, sent to the camera trigger input, and the Strobe signal, sent to theillumination device associated with the camera.

Note: The number of Device modules per Coaxlink card is determined by the installed firmware variant.

Related InformationCamera and Illumination Controller on page 78Full description of the Camera and Illumination Controller

Product and Firmware Variant Selector on page 21Coaxlink product and firmware variant selection guide

Data Stream Module ElementsThe GenTL hierarchy exposes one GenTL Data Stream Module for each image data stream.It gathers the elements involved into the image build-up and transport from the imaging device to a pool of GenTLbuffers:

• Image Acquisition Controller: This block is used for the control of the acquisition gate. It can be configured to receivereal-time start-of-scan and end-of-scan trigger events from any I/O Toolbox output stream.

• Acquisition Gate: This block filters the data input stream, selecting frames (area-scan imaging) or lines (line-scanimaging) to be acquired

• FIFO Buffer: This block provides a temporary storage for the acquired image data.• Pixel Processing: This block performs pixel data formatting.

Note: The number of Data Stream modules per Device is determined by the installed firmware variant.

23

Coaxlink Driver 7.0 Functional Guide   Coaxlink Architecture

Buffer Module ElementsThe GenTL hierarchy exposes one GenTL Interface Module for each image buffer.

24

CoaXPress Host Interface   Coaxlink Driver 7.0 Functional Guide

CoaXPress Host InterfaceSpecification and functional description of the CoaXPress Host interfaceRelated Interface Module GenICam Feature(s)CoaXPress Category on page 158Related Device Module GenICam Feature(s)CoaXPress Category on page 228

CoaXPress Standard ComplianceCoaxlink products together with Coaxlink Driver version 5.0 or higher complies with the following versions of theCoaXPress standard:

• CoaXPress Standard 1.0• CoaXPress Standard 1.1• CoaXPress Standard 1.1.1 (Partially)

The following standard deviations applies:

• All versions Restrictions to the camera connection schemes. Refer to Camera Connection Schemes on page 27

• For 1.1.1 only Partial implementation of the 1.1.1 discovery. Refer to: CoaXPress 1.1.1 Discovery on page 31

Related Interface Module GenICam Feature(s)CxpRevisionSelector on page 169Selects the CoaXPress Standard Revision for current support

CxpRevisionSupport on page 170Reports the current support of the selected CoaXPress Standard Revision

Host Interface Specification SummaryCoaXPress Host Interface specification summary in tabular format

Specification Summary – Card LevelSpecifications having the scope of one Coaxlink card (one GenTL Interface module)

Characteristic Value Applies to:

CXP-6 DIN 1 Mono

CXP-6 DIN 2 Duo Duo104EMB Duo104MILCoaXPress Feature Bar

CXP-6 DIN 4 Quad QuadG3 QuadG3DF

Down-connectionspeeds 1.250, 2.500, 3.125, 5.000, and 6.250 GT/s All products

25

Coaxlink Driver 7.0 Functional Guide   CoaXPress Host Interface

Characteristic Value Applies to:

625,000 Bytes/s Mono

1,250,000 Bytes/s Duo Duo104EMB Duo104MILMaximum aggregatedinput data rate

2,500,000 Bytes/s Quad QuadG3 QuadG3DF

Maximum deliverablePoCXP power 17 W per connector All products

1 DF

DF

1 or 2Devices Count

1 up to 4

Note: Devices Count is determined only by the installed firmware variant.

Related InformationFirmware Variants per Product on page 17List of available firmware variants per product supported by Coaxlink Driver 7.0

Specification Summary – Camera LevelSpecifications having the scope of one camera attached to the Coaxlink card (one GenTL Device module)

Characteristics Value Applicable Firmware Variants

Area-scan camera

Line-scan camera

Area-scan data-forwarded virtualcamera D

F

Device Type

Line-scan data-forwarded virtualcamera D

F

1

1 or 2Connections Count

1, 2 or 4

See notes

Data Streams Count 1 All firmware-variants

Note: Device Type is determined only by the installed firmware variant.

Note: Connections Count is determined by the product/firmware-variant combination.

Related InformationFirmware Variants per Product on page 17

26

CoaXPress Host Interface   Coaxlink Driver 7.0 Functional Guide

List of available firmware variants per product supported by Coaxlink Driver 7.0

Specification Summary – Image Data Stream LevelSpecifications having the scope of one image data stream (one GenTL Data Stream module)

Characteristic Values Applicable Firmware Variants

Maximum streampacket size 16,384 Bytes All firmware variants

Rectangular Image (YSize > 0) DF

Image Stream Format

Rectangular Image (YSize = 0) DF

Image ScanningMethod Progressive All firmware variants

Tap Geometry 1X-1Y All firmware variants

Raw All firmware variants

Mono8, Mono10, Mono12, Mono14, Mono16 All firmware variants

BayerGR8, BayerRG8, BayerGB8, BayerBG8BayerGR10, BayerRG10, BayerGB10, BayerBG10BayerGR12, BayerRG12, BayerGB12, BayerBG12BayerGR14, BayerRG14, BayerGB14, BayerBG14BayerGR16, BayerRG16, BayerGB16, BayerBG16

All firmware variants

RGB8, RGB10, RGB12, RGB14, RGB16 All firmware variants

Pixel Format

RGBA8, RGBA10, RGBA12, RGBA14, RGBA16 All firmware variants

Note: Image Stream Format is determined only by the installed firmware variant.

Related InformationFirmware Variants per Product on page 17List of available firmware variants per product supported by Coaxlink Driver 7.0

Camera Connection SchemesCoaXPress Host to Devices connections schemes

The Host Interface of Coaxlink requires a specific assignment of the Device connections to the Host connectors.

Important: This is a deviation from the CoaXPress standard rule indicating that Devices (cameras) canbe connected to the Host (frame grabber) using a free connection scheme.

27

Coaxlink Driver 7.0 Functional Guide   CoaXPress Host Interface

Host Connection Map Naming ConventionSyntax used for naming Host Connection Maps (how the connections of the Host Interface of a card are allocatedto the Devices)

A Host Connection Map is designated by an acronym using the following Euresys proprietary naming convention:

• <dev-count><dev-type><connection-count-dev0>...<connection-count-devd-1>• <dev-count> = {1, 2, 4} Number of Devices that can be attached to the Host Interface• <dev-type> = {D, DF} Type of Devices: D for standard CoaXPress Devices, DF for proprietary Data Forwarding Devices

<connection-count-devi> = {1, 2, 4}Number of connections available for the Device i.Example: 2D11 designates a Host Connection Map of a Host Interface with 2 standard CoaXPress Devices, each having1 CoaXPress connection.

Host Connection Maps – Standard CoaXPress DevicesCoaxlink connection schemes for standard CoaXPress devices

1D1 Connecon Map

Device 0 A0 Connecon 0

1D2 Connecon Map

Device 0

01

Connecon 0Connecon 1 B

A0 Connecon 0 AOR

B

1D4 Connecon Map

Device 0

01

Connecon 0Connecon 1 B

A0 Connecon 0 A

OR

01

Connecon 0Connecon 1 B

A

OR23

Connecon 2Connecon 3 D

CBCD

CD

2D11 Connecon Map

Device 0 A0 Connecon 0

Device 1 B0 Connecon 0

28

CoaXPress Host Interface   Coaxlink Driver 7.0 Functional Guide

2D22 Connecon Map

Device 0

01

Connecon 0Connecon 1 B

A0 Connecon 0 AOR

B

Device 1

01

Connecon 0Connecon 1 D

C0 Connecon 0OR

DC

4D1111 Connecon Map

Device 0 A0 Connecon 0

Device 1 B0 Connecon 0

Device 2 C0 Connecon 0

Device 3 D0 Connecon 0

Host Connection Maps – Data Forwarding DevicesCoaxlink connection schemes for proprietary Data Forwarding Devices

1DF4 Connection Map

Device 0

OR OR

Connecon 0Connecon 1 B

A

DC

Connecon 0BA

DC

FAFB

Connecon 0Connecon 1 B

A

Dat

a Fo

rwar

ding

FCFD D

CConnecon 2Connecon 3

FAFB

Dat

a Fo

rwar

ding

FCFD

FAFB

Dat

a Fo

rwar

ding

FCFD

Host Connection Maps – Sub-Link DevicesCoaxlink connection schemes for CoaXPress devices using sub-links

1D8SL4 Connection Map01

Connecon 0Connecon 1 B

A

23

Connecon 2Connecon 3 D

C

45

Connecon 4Connecon 5 B

A

67

Connecon 6Connecon 7 D

C

« 1-slm-camera »

« 1-sls-camera »

29

Coaxlink Driver 7.0 Functional Guide   CoaXPress Host Interface

Firmware Variant & Product vs. Host Connection MapThe Coaxlink product and firmware variant must be selected according to the required Host Connection Map:

Host Connection Map Firmware variant(s) Product(s)

1D1 Mono

Duo

1D2

Duo104EMB Duo104MIL

1D4 Quad QuadG3 QuadG3DF

1DF4 DF

DF QuadG3DF

1D8SL4 M

S QuadG3

2D11 Duo Duo104EMB Duo104MIL

Quad QuadG3

2D22QuadG3

4D1111 QuadG3

Related InformationFirmware Variants per Product on page 17List of available firmware variants per product supported by Coaxlink Driver 7.0

Link ConfigurationCoaXPress Link configuration and discovery

Automatic Link ConfigurationThe Coaxlink Driver provides an automatic link discovery and configuration for CoaXPress 1.0 and CoaXPress 1.1devices.For each connection of the CoaXPress Host interface, the discovery procedure determines:

• The presence of a CoaXPress Device• The speed of the down-connection (Device to Host)• The connection ID

The discovery results are reported through the CxpConnectionState, CxpDownConnectionSpeed andCxpDeviceConnectionID features of the Interface module.The user is invited to check if the resulting link configuration is appropriate:

30

CoaXPress Host Interface   Coaxlink Driver 7.0 Functional Guide

• For the application needs in terms of link bandwidth (link speed and number of connections)• For Coaxlink in terms of camera connection schemes supported by the target Coaxlink product/firmware

combination

Manual Link ConfigurationIf necessary, the user can manually configure the CoaXPress link of the Remote Device.This can be achieved, regardless of the camera brand, by assigning the appropriate value to theCxpLinkConfiguration GenApi feature of the Coaxlink device module.

Note: Assigning the value Preferred enforces the preferred link configuration of the camera:

• The link speed is set to the specified value.• The link width is set to the specified value but, possibly limited to the number of available connections

on the Coaxlink side.

Related Interface Module GenICam Feature(s)CxpHostConnectionCount on page 164Cxp Host Connection Count

CxpHostConnectionSelector on page 164Selects the CoaXPress physical connection

CxpConnectionState on page 165CoaXPress Connection State

CxpDownConnectionSpeed on page 165CoaXPress Connection Speed

CxpDeviceConnectionID on page 166CoaXPress Connection Topology Information

Related Device Module GenICam Feature(s)CxpLinkConfiguration on page 229CoaXPress link configuration

CxpLinkConfigurationOption on page 230CxpLinkConfiguration option

CxpHostConnectionBase on page 230Returns the base CoaXPress physical connection of this device

CxpHostConnectionCount on page 231Returns the number of CoaXPress physical connections of this device

CoaXPress 1.1.1 DiscoveryThe 10.1.3 Discover Devices and Connection Topology paragraph of the CoaXPress 1.1.1 standard claims:"The Host shall read the ConnectionConfigDefault register to find the number of expected connections.It shall then write to the ConnectionConfig register to enable the number of connections read fromConnectionConfigDefault. However it shall not change from the discovery rate at this stage."

The 10.3.33 ConnectionConfig paragraph of the CoaXPress 1.1.1 standard claims:"This register shall hold a valid combination of the Device connection speed and number of activedownconnections. Writing to this register shall set the connection speeds on the specified connections, and thehigh speed upconnection, if supported. If the new ConnectionConfig value results in a change of connectionspeed, the Device shall acknowledge the ConnectionConfig access at the original connection speed. Thereforeit shall acknowledge the access before changing connection speed."

Note: Not all theoretical combinations of connection speed and number of connections may be usable.One register is used to ensure that the two variables are set simultaneously. The XML file and product

31

Coaxlink Driver 7.0 Functional Guide   CoaXPress Host Interface

documentation give valid combinations for the Device. A connection reset sets the value correspondingto the selected discovery rate and one connection.

Considering that:

• The above paragraphs disagree on the value that should be written to the ConnectionConfig register,• Changing the behavior to respect CoaXPress 1.1.1 statements causes issues with some cameras,

the CoaXPress discovery procedure of the Coaxlink Driver is not modified to comply with CoaXPress 1.1.1.At the end of the discovery procedure, the Coaxlink Driver sets the speed and the number of the connections of theCoaXPress Link according to the settings of ConnectionConfigDefault register of the camera.

Power Over CoaXPressCoaXPress camera powering through the CoaXPress Link connections

Each connection of the CoaXPress Host connector is capable of delivering power to the camera through the CoaXPresscable.The Power Transmitting Unit – PTU – is responsible for a safe delivery of power. Therefore, it fulfils all the requirementsof the CoaXPress standard for a CoaXPress Host, namely:

• It is capable of delivering up to 17 W of 24 V DC power to the connector• It implements an over-current protection device – OCP• It supports the CoaXPress PoCXP detection method

In addition, it provides the application with the capability of:

• Controlling the PoCXP automatic detection• Disabling or interrupting the power delivery• Resetting the OCP when tripped

Coaxlink

VoltageSense

Filter

Power Transmier UnitSwitchCurrent

senseOCP

CoaXPress Host

connector24 V

Power converter

Auxiliary Power Input

connector

1.5 APTC

12 V power supply

PEG cable

power

data

Control logic

To other power transmitter units

Figure 2: Power Over CoaXpress functional diagram

Power SourceAll the PTU's of a Coaxlink card are powered by an external 12 V power supply through a 12 V to 24 V power converteron the Coaxlink card. The external 12 V supply is attached to the auxiliary power input connector through a 6-pin PEGcable.The AuxiliaryPowerInput feature reports the status of the connection made by the PEG cable between theexternal power supply and the Coaxlink auxiliary power input connector.The CxpPoCxpPowerInputStatus feature reports the status of the 24 V power converter.

Note: The 12 V supply is typically delivered by the power supply of the Host PC.

32

CoaXPress Host Interface   Coaxlink Driver 7.0 Functional Guide

PTU Control LogicOn execution of the CxpPoCxpAuto command the PTU controller initiates a PoCXP device detection procedure.If the PoCXP device detection procedure terminates successfully, the PTU applies power by closing the switch.If the PoCXP device detection procedure fails, the controller doesn't apply power and retries a new PoCXP detectionprocedure. Possible causes of failure are:

• The external power is not connected (AuxiliaryPowerInput = Unconnected)• The external power source is off (CxpPoCxpPowerInputStatus = NotOK)• There are no camera attached• The attached camera is not PoCXP compliant

Once the power is applied, the controller remains in that state until any of the following situations occurs:

• The application disables the power delivery by executing the PoCxpTurnOff command.• The external power source is disconnected (CxpPoCxpPowerInputStatus = NotOK)• The external power source is turned off (CxpPoCxpPowerInputStatus = NotOK)• The CoaXPress cable is disconnected (The average output current measured over a time interval of 0.3 seconds is

less than 8 mA)• The OCP trips (The output voltage drops for a time interval greater than 20 milliseconds)

On execution of the CxpPoCxpTurnOff command the PTU turns off the switch and disables PoCXP powering. In thatstate, the PTU is not performing PoCXP detection procedures.The CxpPoCxpConfigurationStatus feature reports the configuration status of the PTU: Off or AUTOThe CxpPoCxpStatus feature reports the status of the PTU: Off, On or Tripped.

IMPORTANT NOTE

For users of early versions of the Coaxlink Driver

Since version 3.1 of the Coaxlink Driver, PoCXP powering is enabled at system power-up.Consequently, when using PoCXP powered camera(s), the application is not anymore required to enable PoCXPpowering by issuing a CxpPoCxpAuto command.

Over-current ProtectionThe OCP circuit is built with a PTC device providing two kind of protections:

• The overload protection addresses the cases when the load is excessive.• The short-circuit protection addresses the cases of accidental short-circuits.

In case of overload, the PTC trips (= opens progressively the circuit) aer several seconds or minutes depending onthe current level and the ambient temperature. The higher the current, the lower the time to trip. The same appliesto the ambient temperature.In case of short-circuit, the PTC trips immediately. Consequently, the PTU controller enters the tripped stateand opens the switch. The tripped PTC device returns to the conducting state aer having cooled down. Thismay take a few seconds. However, the PTU controller remains in the tripped state until the application issues aCxpPoCxpTripReset command. Having le the tripped state, the PTU can initiate a new PoCXP device detectionand, if successful, re-establish power.

Note: The PTC is sized to sustain 17 W of power over the whole operating temperature range withouttripping.

Note: Extracting more than 17 W of power and/or operating the Coaxlink card above the operatingtemperature range is prohibited since it may induce unexpected PTC trips.

Related Interface Module GenICam Feature(s)CxpPoCxpHostConnectionSelector on page 159

33

Coaxlink Driver 7.0 Functional Guide   CoaXPress Host Interface

Selects the CoaXPress physical connection for PoCXP control

CxpPoCxpAuto on page 160Activate automatic control of the Power over CoaXPress (PoCXP)

CxpPoCxpTurnOff on page 160Disable Power over CoaXPress (PoCXP)

CxpPoCxpTripReset on page 161Reset Power over CoaXPress (PoCXP) after an over-current trip

CxpPoCxpConfigurationStatus on page 161Return Power over CoaXPress (PoCXP) configuration

CxpPoCxpStatus on page 162Return Power over CoaXPress (PoCXP) status

CxpPoCxpCurrent on page 162Return the current delivered by the PoCXP Transmitter Unit on the selected connection

CxpPoCxpVoltage on page 163Return the voltage measured at the output of the PoCXP Transmitter Unit on the selected connection

CxpPoCxpPowerInputStatus on page 163Return CoaXPress Power Input Status

CoaXPress I/O ChannelCoaXPress logical channel for real-time triggers and general purpose I/O

According to the CoaXPress 1.0 and 1.1 standards, the CoaXPress I/O Channel:

• Is one of the three logical channels of the CoaXPress Link (I/O, Stream, Control)• Is defined only for the master connection (connection 0) of a CoaXPress Link• Is used for transmitting of high-priority "triggers" between the Host and the Device• On CoaXPress 1.0 only, is used for exchanging the state of General Purpose I/Os between the Host and the Device

Coaxlink implements:

• CoaXPress Host to Device trigger

Coaxlink doesn't implement:

• CoaXPress Device to Host trigger• CoaXPress 1.0 GPIO

CoaXPress Host To Device TriggerReal-time Host-to-device triggering though the CoaXPress Link

The CoaXPress Host To Device Trigger is a functionality of the CoaXPress I/O Channel that allows the Host (framegrabber) to trigger the Device (camera) through the CoaXPress Link.The CoaXPress Host Interface of Coaxlink implements one CoaXPress Host to Device trigger transmitter for eachconnected Device.The transmitter can be sourced by:

• The Camera Trigger output of the associated Camera and Illumination Controller• Any input-capable General Purpose I/O

34

CoaXPress Host Interface   Coaxlink Driver 7.0 Functional Guide

Related Device Module GenICam Feature(s)CxpTriggerMessageFormat on page 231CoaXPress Host to Device trigger message format

CxpTriggerLevel on page 232Cxp Trigger Level

CxpTriggerAckTimeout on page 232CoaXPress Host to Device trigger acknowledge timeout value

CxpTriggerMaxResendCount on page 233CoaXPress Host to Device trigger maximum resend count

Host to Device Trigger TransmitterThe Coaxlink implementation of the CoaXPress Host to Device Trigger transmitter complies with the requirements ofthe CoaXPress 1.0 and 1.1 standards for a low-speed CoaXPress Host to Device Trigger.

Default OperationThis section describes the behaviour of the transmitter when it is configured with the default settings:

• CxpTriggerMessageFormat = Pulse• CxpTriggerAckTimeout = 20.0• CxpTriggerMaxResendCount = 3

The transmitter initiates a trigger transaction on both edges of the trigger source signal:

• It computes a delay value allowing the receiving device to recreate the event with a fixed latency. For moreinformation, refer to: Host to Device Trigger Latency Compensation on page 37.

• It inserts a high-priority "trigger packet" on the low-speed host-to-device connection at the next characterboundary.

Then, the transmitter waits for the acknowledgment from the Device (camera):

• If the acknowledgement is received before the expiration of the timeout, the transaction terminates normally.• If no acknowledgement is received within the 20 µs timeout, the transmitter performs a retry: it resends the trigger

packet and initiates a new waiting period for the acknowledgement.• If no acknowledgement is received aer 3 times, the transaction terminates abnormally.

The transmitter doesn't initiate a new transaction while the previous one is not completed.

CustomizationThe transmitter can be customized:

• To send trigger messages only on the rising edge of the source signal. Refer to Host to Device Trigger MessageFormat on page 36

• To configure the acknowledge timeout and the number of retries. Refer to Host to Device Trigger PacketAcknowledgement on page 36

Events ReportingThe transmitter reports the following events:

• CxpTriggerAck: Received acknowledgement for CoaXPress Host to Device trigger packet.• CxpTriggerResend: Resent CoaXPress Host to Device trigger packet.

35

Coaxlink Driver 7.0 Functional Guide   CoaXPress Host Interface

Host to Device Trigger Message Format New

The Host to Device Trigger transmitter unit of Coaxlink provides a "message format" control with theCxpTriggerMessageFormat GenICam feature.

Default SettingsBy default, CxpTriggerMessageFormat is set to Pulse.When CxpTriggerMessageFormat is set to Pulse, the transmitter generates a CoaXPress I/O Channel Host toDevice Trigger transaction on both edges of the input pulse:

• The transaction initiated by the rising edge transmits a rising edge trigger packet from the Host to the Device.• The transaction initiated by the falling edge transmits a falling edge trigger packet from the Host to the Device.

Note: Every trigger pulse requires two distinct CoaXPress I/O Channel transactions!

Alternate Settings – Rising EdgeWhen CxpTriggerMessageFormat is set to RisingEdge, the transmitter generates a CoaXPress I/O ChannelHost to Device Trigger transaction on the rising edge only of the input pulse.The transaction transmits always a rising edge trigger packet from the Host to the Device.

Note: Every trigger pulse requires a single CoaXPress I/O Channel transaction.

Note: This format doesn’t allow the grabber to control the exposure time!

Alternate Settings – Toggle New

When CxpTriggerMessageFormat is set to Toggle, the transmitter generates a CoaXPress I/O Channel Host toDevice Trigger transaction on the rising edge only of the input pulse.The transaction transmits alternatively a rising edge trigger packet and a falling edge trigger packet.

Note: Every trigger pulse requires a single CoaXPress I/O Channel transaction.

Note: This format doesn’t allow the grabber to control the exposure time!

The CxpTriggerLevel feature allows the application to set and/or get the current level of the CoaXPress Host toDevice Trigger signal.

Use CasesThe Pulse settings, is the only one that strictly complies with the CoaXPress standards, it is expected to operatecorrectly with most cameras.The Pulse settings, is the only one that is applicable when the trigger pulse width defines the exposure; namely whenCameraControlMethod is set to RG or EXTERNAL.The RisingEdge and Toggle formats are non-standard formats used by some high-speed line-scan cameraproducts to reach higher line rate (> 100 kHz).

Host to Device Trigger Packet AcknowledgementThe Host to Device Trigger transmitter unit provides a user-configurable trigger packet acknowledgement mechanism:

• The time-out value is configurable using the CxpTriggerAckTimeout GenICam feature.

36

CoaXPress Host Interface   Coaxlink Driver 7.0 Functional Guide

• The number of retries is configurable using the CxpTriggerMaxResendCount GenICam feature.

Default SettingsBy default, CxpTriggerAckTimeout is set to 20.0 (20 microseconds) and CxpTriggerMaxResendCount isset to 3.Coaxlink expects an I/O Channel Acknowledgement packet in response to every Trigger packet. If theacknowledgement packet is not received within the 20 µs time-out value, the transmitter resends the trigger packet.It performs up to 3 retries.

Alternate SettingsSetting CxpTriggerAckTimeout to 0 disables the acknowledgement mechanism. The trigger transactionterminates immediately aer having sent the trigger packet.Setting larger CxpTriggerAckTimeout values allows more time for the Device to acknowledge the trigger packet.

Host to Device Trigger Latency CompensationThe Host to Device trigger packets are transmitted over the low-speed (20.833 Mbps) connection of the CoaXPress Linkat the next character boundary.To minimize trigger jitter, the time between the trigger event and the trigger packet being sent is encoded into thetrigger packet as a delay value expressed in units of 2 ns (1/24th of the bit period). The receiver can then use this delayto recreate the trigger event with low jitter and a fixed latency.Assuming that the Device (the camera) performs the jitter compensation, the trigger packets are transmitted with afixed latency of 3.4 microseconds ± 4 nanoseconds.

Camera Trigger to Exposure Latency

Camera - CoaXPress Interface – Trigger Receiver Output

Coaxlink Frame Grabber - Camera and Illuminaon Controller

CoaXPress Link – Host to Device Connecon

Camera Trigger

Rising Edge Trigger Earliest

Latest

Coaxlink Frame Grabber - CoaXPress Interface – Trigger Transmier Input

With latency compensaon

Without latency compensaon

Camera – Image SensorExposure

Jier = 480 ns3.36 µs

Rising Edge Trigger

With latency compensaon

Without latency compensaon

T1

Exposure

Falling Edge Trigger

Falling Edge Trigger

T2

Earliest

Latest

3.36 µs

Jier = 480 ns

T1

T2

~ 0 ~ 0

37

Coaxlink Driver 7.0 Functional Guide   CoaXPress Host Interface

The above diagram shows the time delay required to propagate Camera Trigger events from the frame grabber up tothe image sensor through the CoaXPress Link using Host to Device CoaXPress Trigger messages.The above diagram assumes that:

• CameraControlMethod is set to RG.• The camera properly acknowledges the trigger messages and effectively initiates a new exposure.

The delay from the rising edge of the Camera Trigger signal up the start of exposure on the image sensor is composedof 3 elements:

• Coaxlink frame grabber: a negligible delay from the CIC output up to the transmitter• CoaXPress Link: a fixed delay of 3.36 µs if the camera compensates the jitter using the method described by the

CoaXPress standard otherwise a variable delay of 2.88 ~ 3.36 µs.• Camera: a delay T1 which corresponds to the time required by the camera to initiate a new exposure. This time is

camera-dependent.

The delay from the falling edge of the Camera Trigger signal up the end of exposure on the image sensor is composedof 3 elements:

• Coaxlink frame grabber: a negligible delay from the CIC output up to the transmitter• CoaXPress Link: a fixed delay of 3.36 µs if the camera compensates the jitter using the method described by the

CoaXPress standard otherwise a variable delay of 2.88 ~ 3.36 µs.• Camera: a delay T2 which corresponds to the time required by the camera to terminate an exposure. This time is

camera-dependent and likely different than T1.

Host to Device Trigger SourceThe CoaXPress Host to Device Trigger transmitter can be sourced from:

• The Camera Trigger output of the associated Camera and Illumination Controller• Any input-capable General Purpose I/O

The trigger source is indirectly controlled through the CameraControlMethod GenICam feature.When CameraControlMethod is set to RG or RC, the trigger source is the Camera Trigger output of the associatedCamera and Illumination Controller.When CameraControlMethod is set to EXTERNAL:

• The trigger source is the line source of a dedicated LIN tool of the I/O Toolbox: LIN1 for Device0, LIN2 for Device1,LIN3 for Device2, and LIN4 for Device3.

• Any input-capable GPIO line can be used as trigger source by configuring the line source –LineInputToolSource – of the dedicated LIN tool.

• The polarity of the external trigger signal can be controlled with the LineInverter setting of the selected I/OControl block.

• The time constant of the glitch-removal filter can be adjusted through the LineFilterStrength setting of theselected I/O Control block.

When CameraControlMethod is set to NC, the Host to Device Trigger transmitter is disabled.Related InformationLine Input Tool on page 109Line Polarity Control on page 125Filter Control on page 125

38

CoaXPress Host Interface   Coaxlink Driver 7.0 Functional Guide

CoaXPress Host Connector Indicator LampsLamps indicating the state of each CoaXPress Link connection

Each connector of the CoaXPress Host Interface is associated with a CoaXPress Host Indicator Lamp.

Note: On Coaxlink PCIe products, the lamps are located on the card's bracket.

Note: On Coaxlink PCIe/104 products, the lamps are located on the I/O module accessory (if any).

CoaXPress Host Connector Indicator Lamps States

Lamp State Symbol Meaning

Off The Coaxlink card is not powered

Solid orange System booting

Fast flash alternategreen / orange

The connection detection is in progress; PoCXP is active.

This state is shown for a minimum of 1s even if the connectiondetection is faster

Fast flash orangeThe connection detection is in progress; PoCXP is off.

This state is shown for a minimum of 1s even if the connectiondetection is faster

Solid red The PoCXP over-current protection has tripped.

Solid greenThe Device to Host connection is established, but no data beingtransferred

Slow pulse orangeThe Device to Host connection is established, but the Host is waiting for atrigger.

Fast flash green.The Device to Host connection is established and image data is beingtransferred

Flashing Lamp States Timing Definitions

Indication Timing

Fast flash 12.5Hz @25% duty cycle: 20 ms on, 60 ms off

Fast flash alternate (color 1/color 2)12.5Hz @25% duty cycle: 20 ms on (color 1), 60 ms off, 20 ms on (color 2),60 ms off

Slow flash 0.5Hz @50% duty cycle: 1 second on, 1 second off

Slow pulse (red | orange) 1Hz @ 20% duty cycle: 200ms on, 800ms off

39

Coaxlink Driver 7.0 Functional Guide   CoaXPress Host Interface

Connection TestCoaXPress link connection test facility

The CoaXPress Host Interface of Coaxlink provides connection test facilities to test the quality up- and down-connections of the CoaXPress link according to the procedures defined in section 8.7 of the CoaXPress 1.1 standard.For each individual CoaXPress connector, it implements

• A test generator• A test receiver

The test generator transmits a Test Data Packet containing a known test pattern produced by a sequence generator. Itincrements the packet counter for each test packet transmitted.The test receiver compares the received test data packet content against its local sequence generator. It incrementsthe error counter for each word that is different in the data packet, and increments the packet counter for each testpacket received.

Note: The test packet counters show how many test packets have been sent and received, so allowinga judgment to be made on the statistical meaning of the value in the error counter.

Note: Both Device to Host and Host to Device connection tests can be run at the same time.

Related Interface Module GenICam Feature(s)CxpHostConnectionTestMode on page 167Enables the test mode for an individual physical connection of the Host

CxpHostConnectionTestErrorCount on page 168Reports the current connection error count for test packets received by the Host on the selected Host connection

CxpHostConnectionTestPacketCount on page 168Reports the current count for test packets received by the Host on the selected Host connection

CxpHostConnectionTestInjectError on page 169Injects one single character error during the Host to Device test

40

CoaXPress Data Forwarding QuadG3DF    Coaxlink Driver 7.0 Functional Guide

CoaXPress Data Forwarding QuadG3DF

Specification and functional description of the CoaXPress Data Forwarding interface

The data forwarding capabilities of 1635 Coaxlink Quad G3 DF allows to forward the image data from a camera tomultiple frame grabbers in different Host PC’s.

Data Forwarding PrinciplesData forwarding

A DF-capable card, such as the 1635 Coaxlink Quad G3 DF, forwards the data received on the CoaXPress Host connectorto the CoaXPress Data Forwarding connector.The serial bit stream on connections A, B, C, D of the CoaXPress Host connector are forwarded respectively to theconnections FA, FB, FC, FD of the CoaXPress Data Forwarding connector.

Note: The data are retransmitted with a negligible latency: typically, a few periods of the 32-bit charactertransmission time.

Considering that link speeds can be different, idle characters are, when necessary, removed or added in the bit stream.

Note: Addition or removal of idle characters doesn't affect the payload. Image data are preserved,including CRC's.

Notice: §8.2.5.1 of the Coaxlink 1.1 standard requires, for high-speed connections, the insertion of oneIDLE word at least once every 100 words. Fulfilling this requirement is mandatory for proper operationof data forwarding.

Data Forwarding ChainA DF-chain is composed of 2 or more data-forwarding capable cards where the CoaXPress Data Forwarding connectorof one card is connected to the CoaXPress Host connector of the next card using a set of 1, 2 or 4 coaxial cables namedDF-bridge.

Note: There are no specified upper limit to the number of cards in a DF-chain.

The camera is attached to the CoaXPress Host connector of the first card of the DF-chain, this card is named DF-master.The other cards, of the DF-chain are named DF-slaves. The CoaXPress Data Forwarding connector of the last DF-slavecard is le unconnected.

Note: All cards of the DF-chain, including the last DF-slave, must be DF-capable.

CoaXPress Link discovery and configurationThe DF-master card is responsible for the discovery and the configuration of the CoaXPress Link of the camera.The CoaXPress Host Interface of the DF-slaves are automatically configured with the same number of connections asdiscovered by the DF-Master.For instance if the camera uses two connections, only two connections are required for every DF-bridge.

Firmware variantsThe firmware variant to install on the DF-master must be selected according to the camera type:

• For an area-scan camera, install the 1-camera firmware variant.• For a line-scan camera, install the 1-camera, line-scan firmware variant.

41

Coaxlink Driver 7.0 Functional Guide   CoaXPress Data Forwarding QuadG3DF

The firmware variant to install on the DF-slaves must match the firmware variant installed on the DF-master:

• When the 1-camera firmware variant is installed on the DF-master, install the 1-df-camera firmware varianton all DF-slaves.

• When 1-camera, line-scan firmware variant is installed on the DF-master, install the 1-df-camera,line-scan firmware variant on all DF-slaves.

Data Acquisition ControlFor correct operation of data forwarding, the application must respect the following rules:

• The data acquisition must be activated on all the DF-slaves before being activated on the DF-master.• The data acquisition must be de-activated on the DF-master before being de-activated on the DF-slaves.

For line-scan applications only, a start-of-scan and end-of-scan synchronization mechanism is implemented toensure that all the cards of the DF-chain can capture the same lines of image data. Refer to Line-scan TriggersSynchronization on page 43 for more info.

Camera Cycle ControlIf required by the application, the DF-master card is responsible for the elaboration of the CoaXPress Host-to-Devicetrigger. This is achieved in the same way as for non-data-forwarding Coaxlink cards.Refer to CoaXPress Host To Device Trigger on page 34 for more details.

Data Forwarding Connection SchemesArea-scan Camera Data Forwarding

The following drawing illustrates 3 connection schemes where the image data of an area-scan camera is forwarded to3 Host PCs: one for a 4-connection camera, one for a 2-connection camera, one for a single-connection camera.The first 1635 Coaxlink Quad G3 DF card must be configured with a 1-camera firmware variant; the other must beconfigured with the 1-df-camera firmware variant.

DF

DF

Connecon 0Connecon 1Connecon 2Connecon 3

01

Connecon 0Connecon 1 B

A

23

Connecon 2Connecon 3 D

C

FAFBFCFD

BA

DC

FAFBFCFD

Connecon 0Connecon 1Connecon 2Connecon 3

BA

DC

FAFBFCFD

DF

DF

Connecon 0Connecon 1

01

Connecon 0Connecon 1 B

A

DC

FAFBFCFD

BA

DC

FAFBFCFD

Connecon 0Connecon 1 B

A

DC

FAFBFCFD

DF

DF

Connecon 00 Connecon 0BA

DC

FAFBFCFD

BA

DC

FAFBFCFD

Connecon 0BA

DC

FAFBFCFD

Line-scan Camera Data ForwardingThe following drawing illustrates 3 connection schemes where the image data of a line-scan is forwarded to 3 HostPCs: one for a 4-connection camera, one for a 2-connection camera, one for a single-connection camera.The first 1635 Coaxlink Quad G3 DF card must be configured with a 1-camera, line-scan firmware variant; theother must be configured with the 1-df-camera, line-scan firmware variant.

42

CoaXPress Data Forwarding QuadG3DF    Coaxlink Driver 7.0 Functional Guide

DF

DF

DF

DF

DF

DF

Connecon 0Connecon 1Connecon 2Connecon 3

01

Connecon 0Connecon 1 B

A

23

Connecon 2Connecon 3 D

C

FAFBFCFD

BA

DC

FAFBFCFD

Connecon 0Connecon 1Connecon 2Connecon 3

BA

DC

FAFBFCFD

Connecon 0Connecon 1

01

Connecon 0Connecon 1 B

A

DC

FAFBFCFD

BA

DC

FAFBFCFD

Connecon 0Connecon 1 B

A

DC

FAFBFCFD

Connecon 00 Connecon 0BA

DC

FAFBFCFD

BA

DC

FAFBFCFD

Connecon 0BA

DC

FAFBFCFD

Line-scan Triggers SynchronizationStart-of-scan and end-of-scan trigger synchronization mechanism to ensure that all the cards of the DF-chaincapture the same lines of image data

In a DF-chain, the DF-master card forwards its start-of-scan and end-of-scan events to the DF-slave cards.The generation of the start-of-scan and end-of-scan events on the DF-master is achieved in the same way as for non-data-forwarding Coaxlink cards. Refer to Line Scan Acquisition on page 66 for more details.The DF-master card:

• First, synchronizes the asynchronous scan triggers on the next start-of line image data.• Then, share the synchronized scan triggers with all the DF-slaves.

The sharing of the scan triggers is achieved by the insertion of high-priority "custom GPIO messages" in the bit stream.These messages are forwarded by all the DF-slaves together with the image data.On reception of such a message, the DF-slave generates a hardware event. Two kind of events are possible:

• Start-of-scan event.• End-of-scan event

These events are available through the EIN tools of the I/O Toolbox.For applications requiring synchronized line-scan acquisition, the I/O toolbox EIN tools of the DF-slaves must be usedas local start-of-scan and end-of-scan trigger sources.

Configuration Script ExampleThe following script configures Data Forwarding frame grabbers for synchronized line-scan acquisition:

for (var grabber of grabbers) { if (grabber.InterfacePort.get("InterfaceID").includes('df-camera')) { console.log("Configuring slave card"); // set the Width/Height/PixelFormat of the (virtual) remote device (on // the slave card) equal to the Width/Height/PixelFormat of the (real) // camera (connected to the master card) grabber.RemotePort.set("Width", 8192); grabber.RemotePort.set("Height", 1); grabber.RemotePort.set("PixelFormat", "Mono8"); // configure the event input tool EIN1 grabber.InterfacePort.set("EventInputToolSource[EIN1]", "A"); grabber.InterfacePort.set("EventInputToolActivation[EIN1]", "StartOfScan"); // configure the event input tool EIN2 grabber.InterfacePort.set("EventInputToolSource[EIN2]", "A"); grabber.InterfacePort.set("EventInputToolActivation[EIN2]", "EndOfScan");

43

Coaxlink Driver 7.0 Functional Guide   CoaXPress Data Forwarding QuadG3DF

// configure start/end of scan triggers grabber.StreamPort.set("StartOfScanTriggerSource", "EIN1"); grabber.StreamPort.set("EndOfScanTriggerSource", "ScanLength"); grabber.StreamPort.set("ScanLength", 1000); } else { console.log("Configuring master card"); grabber.RemotePort.set("TestPattern", "GreyDiagonalRampMoving"); grabber.RemotePort.set("CxpLinkConfiguration", "CXP6_X4"); grabber.RemotePort.set("CxpLinkConfigurationPreferredSwitch", "CXP6_X4"); grabber.RemotePort.set("TriggerSource", "CXPin"); grabber.RemotePort.set("TriggerMode", "On"); grabber.DevicePort.set("CameraControlMethod", "RG"); grabber.DevicePort.set("ExposureReadoutOverlap", "True"); grabber.DevicePort.set("CxpTriggerAckTimeout", "0"); grabber.DevicePort.set("StrobeDuration", "0"); grabber.DevicePort.set("ExposureTime", "20"); grabber.DevicePort.set("ExposureRecoveryTime", "0"); grabber.DevicePort.set("CycleTargetPeriod", "50"); // configure start/end of scan triggers grabber.StreamPort.set("StartOfScanTriggerSource", "Immediate"); grabber.StreamPort.set("EndOfScanTriggerSource", "ScanLength"); grabber.StreamPort.set("ScanLength", 1000); }}

Note: In this example, the start-of-scan trigger is the receipt of the start-of-scan event from themaster, but the end-of-scan trigger is generated locally. One alternative would be to use EIN2 asEndOfScanTriggerSource.

44

Image Data Flow   Coaxlink Driver 7.0 Functional Guide

Image Data FlowDescription of the image data flow through Coaxlink

The CoaXPress Host Interface extracts the image data from the CoaXPress data stream and store them temporarily inthe on-board FIFO buffer together with related metadata such as image size, pixel type, time-stamp...The image data is extracted as soon as possible from the FIFO buffer ensuring the lowest possible latency.The Acquisition Gate controls the data extraction. It filters out the image data that doesn't need to be acquired.The extracted image pixel data flows through the Image Pixel Data Processing chain.Finally, the DMA engine writes directly the processed and formatted image data into the application buffer.

Note: CoaXPress cameras deliver image data using, typically, a single CoaXPress data stream.

Note: Multi-stream CoaXPress cameras are not supported by this release of Coaxlink!

FIFO BufferOn-board memory dedicated to the temporary storage of image pixel data

The FIFO buffer is a large on-board memory that is entirely dedicated to the temporary storage of image pixel data.It decouples the CoaXPress data flow from the PCI Express data flow. Temporary dropout of the PCI Express data floware absorbed by the FIFO buffer while ensuring a reliable CoaXPress data acquisition.It enables burst-mode CoaXPress data acquisition at the highest data rates regardless the limits of the PCI Expressinterface.The total on-board memory is product-dependent.

Characteristic Value Applicable products

512 MB Mono Duo104EMB Duo104MIL

Total memory size1 GB Duo Quad QuadG3 QuadG3DF

There is one FIFO Buffer dedicated to each GenTL Data Stream. Therefore the on-board memory is partitioned asfollows:

Characteristic Value DataStreams Applicable products and firmware variants

2 Duo PCIe/104

Duo PCIe/104

256 MB

4 Quad G3

1 MonoMemory partition size

512 MB

2Duo

Quad

Quad G3

Quad G3

45

Coaxlink Driver 7.0 Functional Guide   Image Data Flow

Characteristic Value DataStreams Applicable products and firmware variants

1 GB 1

Duo

Quad

Quad

Quad G3

Quad G3

Quad G3 DF

Quad G3 DF D

F Quad G3 DF

DF Quad G3 DF

Acquisition GateControl of the image data extraction from the on-board FIFO buffer

The Acquisition Gate controls the image data extraction from the on-board FIFO buffer. It discards the image data thatdoesn't need to be acquired and fed to the Image Pixel Data Processor.

Area Scan AcquisitionThe gate opens and closes at frame boundaries based on the application's calls of the DSStartAcquisition andDSStopAcquisition functions.

Note: The Camera and Illumination Controller indirectly controls the acquisition gating by issuingCamera Triggers using various schemes.

Line Scan AcquisitionThe gate opens and closes at line boundaries according to the application DSStartAcquisition andDSStopAcquisition function calls and, according to the settings of the Image Acquisition Controller, to the Start-of-scan and the End-of-scan triggers.For more information and configuration instructions, refer to, refer to Line Scan Acquisition on page 66.

Pixel Data Processing OverviewGlobal description of the image pixel data processing chain

The Image Pixel Data Processor performs the following successive operations on the image data stream:

CoaXPress bit stream slicingThis operation extracts individual pixel components data from the CoaXPress image data bit stream according to thebit depth – input-bit-depth – specified by the 'PixelF' property of the CoaXPress Image Header.All components have the same pixel bit depth. Possible values are 8-/10-/12-/14- and 16-bit.The slicer delivers, for each image line, all the pixel components necessary to build a number of pixels specified by the'Xsize' property of the CoaXPress Image Header.The slicer discards CoaXPress line-padding data.

Lookup Table processingThis operation performs lookup table processing on individual pixel components.For more information and configuration instructions, refer to Lookup Table Processing on page 50.

46

Image Data Flow   Coaxlink Driver 7.0 Functional Guide

Pixel component unpackingThis operation unpacks 10-bit, 12-bit, and 14-bit pixel components to 8-bit or 16-bit.It can be disabled for monochrome and Bayer CFA pixel formats.For more information and configuration instructions, refer to Pixel Component Unpacking on page 60.

Pixel component orderingThis operation modifies the component order of multi-components pixel data.For more information and configuration instructions, refer to Pixel Component Ordering on page 61.

Endianness conversionThis operation modifies the byte order of 16-bit pixel component data.For more information, refer to Endianness Conversion on page 62.

Image line build-upThis operation builds concatenates the components data of all pixels of an image line:

• 8-bit pixel components are aligned to byte boundaries• 16-bit pixel components (possibly expanded by unpacking or lookup table processing) are aligned to word (2-byte)

boundaries, the 2 bytes are stored according to the little-endian convention.

Line paddingThis operation appends padding bits or bytes to the image line data to reach the next alignment-boundary requiredby the hardware implementation.The alignment boundary requirements are product-specific, for instance:

• 64-bit for 1630 Coaxlink Mono, 1631 Coaxlink Duo, and 1632 Coaxlink Quad• 128-bit for 1633 Coaxlink Quad G3 and 1635 Coaxlink Quad G3 DF

Processing PerformancesThe pixel processor sustain the highest camera pixel rate. All the above operations are executed while transferringdata to the GenTL with a negligible latency. However, particularly when the bit depth is increased, the amount of pixeldata to transfer is increased accordingly. In that case, the PCI Express bandwidth limitation may negatively impact theachievable frame- or line-rate.

Pixel Data Processing Configurations New

Applicable pixel data processing configurations vs. camera pixel formats

Monochrome Pixel Formats (LUT disabled)

Camera Pixel Format Unpacking Mode Output Pixel Format

Mono8 lsb | msb | off Mono8

lsb Mono10Mono10pmsb

msb Mono16

47

Coaxlink Driver 7.0 Functional Guide   Image Data Flow

Camera Pixel Format Unpacking Mode Output Pixel Format

off Mono10pmsb

lsb Mono12

msb Mono16Mono12pmsb

off Mono12pmsb

lsb Mono14

msb Mono16Mono14pmsb

off Mono14pmsb

Mono16 lsb | msb Mono16

Monochrome Pixel Formats (LUT enabled)

Camera Pixel Format Lookup TableConfiguration Unpacking Mode Output Pixel Format

Mono8 M_8x8 lsb | msb Mono8

M_10x8 lsb | msb Mono8

lsb Mono10M_10x10

msb Mono16Mono10pmsb

M_10x16 lsb | msb Mono16

M_12x8 lsb | msb Mono8

M_12x12 lsb Mono12

msb Mono16Mono12pmsb

M_12x16 lsb | msb Mono16

Bayer CFA Pixel Formats (LUT disabled)

Camera Pixel Format Unpacking Mode Output Pixel Format

Bayer**8 lsb | msb | off Bayer**8

lsb Bayer**10

msb Bayer**16Bayer**10pmsb

off Bayer**10pmsb

lsb Bayer**12

msb Bayer**16Bayer**12pmsb

off Bayer**12pmsb

lsb Bayer**14Bayer**14pmsb

msb Bayer**16

48

Image Data Flow   Coaxlink Driver 7.0 Functional Guide

Camera Pixel Format Unpacking Mode Output Pixel Format

off Bayer**14pmsb

Bayer**16 lsb | msb Bayer**16

RGB Pixel Formats (LUT disabled)

Input Pixel Format Unpacking Mode RedBlueSwap Output Pixel Format

off RGB8RGB8 lsb | msb

on BGR8

off RGB10lsb

on BGR10

off RGB16RGB10pmsb

msbon BGR16

off RGB12lsb

on BGR12

off RGB16RGB12pmsb

msbon BGR16

off RGB14lsb

on BGR14

off RGB16RGB14pmsb

msbon BGR16

off RGB16RGB16 lsb | msb

on BGR16

RGBa Pixel Formats (LUT disabled)

Input Pixel Format UnpackingMode RedBlueSwap Output Pixel Format

RGBa8 lsb | msb | off off | on RGBa8

lsb off | on RGBa10RGBa10pmsb

msb off | on RGBa16

lsb off | on RGBa12RGBa12pmsb

msb off | on RGBa16

lsb off | on RGBa14RGBa14pmsb

msb off | on RGBa16

RGBa16 lsb | msb | off off | on RGBa16

49

Coaxlink Driver 7.0 Functional Guide   Image Data Flow

Lookup Table ProcessingProcessing of pixel component data using lookup tables

Coaxlink Driver provides lookup table capabilities for monochrome pixels on a selected set of product/firmwarecombinations. Refer to Monochrome Lookup Table Processing on page 50 for more information.Coaxlink Driver provides four methods to define the content of lookup tables. Refer to Lookup Table ContentDefinition Methods on page 52 for more descriptionTo setup lookup tables, refer to Lookup Table Setup Procedure on page 58.

Monochrome Lookup Table ProcessingSpecification of lookup table processing for monochrome pixels

Monochrome 8-bit pixels can be transformed into monochrome 8-bit pixels.Monochrome 10-bit pixels can be transformed into monochrome 8-bit, 10-bit or 16-bit pixels.Monochrome 12-bit pixels can be transformed into monochrome 8-bit, 12-bit or 16-bit pixels.

ConfigurationsThe following table lists all the available lookup table configurations for monochrome pixels:

Configuration Input Pixel Format [PFNC] Input bits Output bits

M_8x8 Mono8, Raw 8 8

M_10x8 8

M_10x10 10

M_10x16

Mono10 10

16

M_12x8 8

M_12x12 12

M_12x16

Mono12 12

16

Lookup Table Data SetsA lookup table data set is defined as the set of data required to configure one lookup table for each component of apixel. In the case of monochrome pixels, a lookup table data set includes only one single lookup table content.The number of lookup table data sets that can be uploaded depends on the lookup table configuration:

Configuration Data Sets

M_8x8 16

M_10x8, M_10x10, M_10x16 4

M_12x8, M_12x12, M_12x16 1

50

Image Data Flow   Coaxlink Driver 7.0 Functional Guide

LUT AvailabilityList of supported LUT configurations for all firmware variants and products

1630 Coaxlink Mono

Firmware Variant LUT Configurations

1-camera M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

1631 Coaxlink Duo

Firmware Variant LUT Configurations

1-camera M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

2-camera M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

1632 Coaxlink Quad

Firmware Variant LUT Configurations

1-camera M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

2-camera M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

1-camera, line-scan M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

1633 Coaxlink Quad G3

Firmware Variant LUT Configurations

1-camera M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

2-camera M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

4-camera M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

1-camera, line-scan M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

2-camera, line-scan M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

1-slm-camera M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

1-sls-camera M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

1629 Coaxlink Duo PCIe/104-EMB, 1634 Coaxlink Duo PCIe/104-MIL

Firmware Variant LUT Configurations

1-camera M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

2-camera M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

1-camera, line-scan M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

51

Coaxlink Driver 7.0 Functional Guide   Image Data Flow

1635 Coaxlink Quad G3 DF

Firmware Variant LUT Configurations

1-camera M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

1-df-camera M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

1-camera, line-scan M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

1-df-camera, line-scan M_8x8, M_10x8, M_10x10, M_10x16, M_12x8, M_12x12, M_12x16

Lookup Table Content Definition MethodsMethods to define the content of a lookup table

The Coaxlink Driver provides four methods to define the transfer function of a lookup table.

• Response Control• Emphasis• Threshold• Table

Response Control MethodThis method defines the transfer function of a lookup table by means of four parameters: Contrast, Brightness,Visibility and Negative.The Contrast and Brightness parameters provide controls similar to the brightness and contrast controls of atelevision monitor. For more information, refer to Contrast Parameter on page 53 and Brightness Parameter onpage 53.The Visibility parameters provides control to smoothly reshape the transfer function to cover the full input range.For more information, refer to Visibility Parameter on page 54.The Negative parameter allows transforming an image into its negative image. For more information, refer toNegative Parameter on page 55.

Emphasis MethodThis method defines the transfer function of a lookup table by means of two parameters: Emphasis and Negative.It allows transforming an image using a power-law expression also known as γ – Gamma – function. For moreinformation refer to Emphasis Parameter on page 56.The Negative parameter allows transforming an image into its negative image. For more information, refer toNegative Parameter on page 55.

Threshold MethodThis method defines a double threshold transformation law by means of five parameters: SlicingLevel,SlicingBand, LightResponse, BandResponse, DarkResponse.For more information, refer to Threshold Method Parameters on page 57.

Table MethodThis method defines the transfer function of a lookup table in a tabular form.

52

Image Data Flow   Coaxlink Driver 7.0 Functional Guide

Contrast ParameterThe Contrast parameter exclusively applies to the Response Control lookup table definition method.It implements a control similar to the contrast control of a television monitor.The slope of the transformation law is the gain, which is non-linearly controlled from the Contrast parameter.Mathematically, the relationship is: Gain = 102x(Contrast-1)

Contrast Gain Note

0.00 0.01 Min. Contrast value; smallest gain

1.00 1 Default Contrast value;unity gain

2.00 100 Max. Contrast value; largest gain

To achieve a required given gain, the contrast control should be set to:Contrast = 1 + (log10 Gain)/2If the required gain is expressed in decibels (dB):Contrast = 1 + Gain(dB)/40The following charts explain the effect of Contrast when all other controls are set to their default value:

• Brightness = 0.00• Visibility = 0.00• Negative = FALSE

Contrast = 2.00Contrast = 0.00

Input

Out

put

Contrast = 0.80 Contrast = 1.20Contrast = 1.00

Input

Out

put

Input

Out

put

Input

Out

put

InputO

utpu

t

Brightness ParameterThe Brightness parameter exclusively applies to the Response Control lookup table definition method.It implements a control similar to the brightness control of a television monitor.

Brightness Note

-1.00Min. Brightness value: darkest output.The whole input range data gets transformed into the full black. This rule applies for any chosenContrast value.

53

Coaxlink Driver 7.0 Functional Guide   Image Data Flow

Brightness Note

0.00

Default Brightness value.The mid-level input level of 0.5 is transformed as the same output level of 0.5. This is true for anyvalue of the other parameters.Any increase in the brightness towards +1.00 results into a lighter output.Any decrease of the brightness towards -1.00 results into a darker output.

+1.00Max. Brightness value: lightest output.The whole input range data gets transformed into the full white. This rule applies for any chosenContrast value.

The following charts explain the effect of Brightness when all other controls are set to their default value:

• Contrast = 1.00• Visibility = 0.00• Negative = FALSE

Brightness = +1.00Brightness = -1.00

Input

Out

put

Brightness = -0.20 Brightness = +0.20Brightness = 0.00

Input

Out

put

Input

Out

put

InputO

utpu

t

Out

put

Input

Visibility ParameterThe Visibility parameter exclusively applies to the Response Control lookup table definition method.The operation of Contrast and Brightness parameters occasionally removes some part of the input dynamics.Very dark regions of the image can be transformed into full black, and become invisible. This holds true for very brightregions, clipping to full white.The Visibility parameter has been created to smoothly reveal these hidden parts in the image.

Visibility Gain Note

0.00 0.01Minimum and default Visibility value.This generates the piecewise linear transformation curves. Choosingvalues closer to +1 generates smoother curves.

1.00 100 Max. Visibility value.

The following charts explain the Visibility effect for typical values of Contrast and Brightness parametersassuming that Negative = FALSE.

54

Image Data Flow   Coaxlink Driver 7.0 Functional Guide

Brightness = +0.22Brightness = +0.14 Brightness = -0.38Brightness = -0.14

Input

Out

put

InputO

utpu

tInput

Out

put

Out

put

Input

Contrast = 1.10Contrast = 0.94 Contrast = 0.82Contrast = 1.06

Visi

bilit

y =

0.00

Visi

bilit

y =

0.25

Input

Out

put

Input

Out

put

InputO

utpu

t

Out

put

Input

InputO

utpu

tInput

Out

put

Input

Out

put

Visi

bilit

y =

1.00

Input

Out

put

Negative ParameterThe Negative parameter applies to both the Response Control and the Emphasis lookup table definition methods.This control allows transforming an image into its negative image, where the lightest areas of the image appear darkestand the darkest areas appear lightest.

Negative Note

FALSE Default value.

TRUE The transformation table is mirrored around a vertical axis in the graphs. This swaps the black andwhite values, and gives rise to a photographic negative effect.

The following charts explain the effect of Negative for typical values of other controls.

55

Coaxlink Driver 7.0 Functional Guide   Image Data Flow

Brightness = +0.22Brightness = +0.14 Brightness = -0.38Brightness = -0.14

Input

Out

put

InputO

utpu

tInput

Out

put

Out

put

Input

Contrast = 1.10Contrast = 0.94 Contrast = 0.82Contrast = 1.06

Neg

ativ

e =

FALS

E

Input

Out

put

Input

Out

put

InputO

utpu

t

Out

put

Input

Neg

ativ

e =

TRU

E

Emphasis ParameterThe Emphasis parameter exclusively applies to the Emphasis lookup table definition method.It allows transforming an image using a power-law expression:

Output = Inputγ

The γ – Gamma – exponent is mathematically linked to Emphasis by:γ = 10-Emphasis

Emphasis Gamma Note

1.00 0.1 Max. Emphasis value; smallest γ value

0.00 1 Default Emphasis value; linear law

-1.00 10 Min. Emphasis value; largest γ value

To achieve a required given γ, Emphasis should be set to:Emphasis = - log10γ

The following charts explain the emphasis effect for typical values of Emphasis and both values of Negative.

56

Image Data Flow   Coaxlink Driver 7.0 Functional Guide

Emphasis = -1.00

Input

Out

put

Neg

ativ

e =

FALS

EN

egat

ive

= TR

UE

Input

Out

put

Input

Out

put

Emphasis = 0.00 Emphasis = +1.00

Input

Out

put

Input

Out

put

Input

Out

put

Threshold Method ParametersSlicingLevel, SlicingBand, LightResponse, BandResponse and DarkResponse parametersexclusively apply to the Threshold lookup table definition method.As shown on the next figure, the parameters set defines a double threshold transformation law.

Parameter Minimum Value Default Value Maximum Value

Slicing Level 0.00 0.50 1.00

Slicing Band 0.00 0.50 1.00

LightResponse 0.00 0.75 1.00

BandResponse 0.00 0.50 1.00

DarkResponse 0.00 0.25 1.00

57

Coaxlink Driver 7.0 Functional Guide   Image Data Flow

SlicingBand

SlicingLevelDa

rkRe

spon

se

Band

Resp

onse

Ligh

tRes

pons

e

Threshold methodO

utpu

t

Input

= =

Note: SlicingLevel specifies the mean value of both thresholds in the input range.

Lookup Table Setup ProcedureHow-to set lookup tables

To setup the lookup table processing, proceed as follows:

1. Disable the lookup table2. Define the lookup table configuration3. Define the content of the lookup table4. Upload the lookup table content into a specified lookup table data set5. Enable the lookup table with a specified data set

Disabling the lookup tableTo disable the lookup table:

• Set the LUTEnable feature to a Off.

Defining the lookup table configurationTo define the lookup table configuration, set the LUTConfiguration feature according to:

• The camera pixel type and bit depth• The required output bit depth.

Refer to Monochrome Lookup Table Processing on page 50 for configurations applicable to monochrome pixels.

Note: The lookup table configuration must be set prior to any other action.

Defining the lookup table contentRefer to Lookup Table Content Definition Methods on page 52 for a description of the parametric and tabularmethods used for defining a lookup table content.

58

Image Data Flow   Coaxlink Driver 7.0 Functional Guide

Note: At least one lookup table set must defined.

Upload a lookup table contentTo upload a lookup table content in one operation:

• Select a lookup table data set to access by assigning the appropriate value to the LUTSet feature. For instanceSet1.

• Set the LUTIndex feature to 0.• Write a string of LUTLength values to the LUTValue feature.

Note: The application may also selectively upload any individual lookup table entry or any block ofconsecutive lookup table entries.

Reading back a lookup table data setTo read back the lookup table data set in one operation:

• Select a lookup table data set to access by assigning the appropriate value to the LUTSet feature. For instanceSet1.

• Set the LUTIndex feature to 0.• Set the LUTReadBlockLength feature to the value returned by LUTLength.• Get a string of LUTReadBlockLength values from the LUTValue feature.

Note: The application may also selectively read any lookup table entry individually or any block ofconsecutive entries.

Enabling the lookup tableTo enable the lookup table:

• Set the LUTEnable feature to a value designating the lookup table data set to use.

Configuration Script ExampleThe following script is an example illustrating how to configure the lookup table for monochrome 8-bit to 8-bitoperation and to define and upload 4 lookup table data sets using different lookup table definition methods.

function configure(g) { // Disable the lookup table g.StreamPort.set('LUTEnable', 'Off'); // Configure the lookup table g.StreamPort.set('LUTConfiguration', 'M_8x8');

// Build lookup table data set 1: response control g.StreamPort.set('LUTSet', 'Set1'); require('coaxlink://lut/response-control')(g, { Contrast: 0.94 , Brightness: 0.14 , Visibility: 0.25 , Negative: false });

// Build lookup table data set 2: emphasis g.StreamPort.set('LUTSet', 'Set2'); require('coaxlink://lut/emphasis')(g, { Emphasis: 0.5 , Negative: true });

// Build lookup table data set 3: threshold g.StreamPort.set('LUTSet', 'Set3'); require('coaxlink://lut/threshold')(g, { SlicingLevel: 0.5 , SlicingBand: 0.5 , LightResponse: 0.75 , BandResponse: 0.5 , DarkResponse: 0.25 });

// Build lookup table data set 4: table g.StreamPort.set('LUTSet', 'Set4');

59

Coaxlink Driver 7.0 Functional Guide   Image Data Flow

var i; for (i = 0; i < 256; ++i) { g.StreamPort.set('LUTIndex', i); g.StreamPort.set('LUTValue', String(255 - i)); }}configure(grabbers[0]);

Related Data Stream Module GenICam Feature(s)LUTControl Category on page 276LUTConfiguration on page 277Configuration of the LUT processor

LUTLength on page 277Number of table entries in a LUT device

LUTMaxValue on page 278Highest value of a table entry

LUTSet on page 278LUT set to access

LUTIndex on page 279Index of the first entry to access

LUTValue on page 279String of value(s) to read from- or to write to- the accessed LUT at location LUTIndex

LUTReadBlockLength on page 280Number of consecutive table entries to read

LUTEnable on page 280Enables the LUT processor with a specific LUT set.

Pixel Component Unpacking New

Unpacking to 16-bit of 10-/12-/14-bit pixel component data

Considering that:

• As specified by the CoaXPress standard, CoaXPress devices deliver packed pixel data,• Machine vision applications prefer byte or 16-bit aligned pixel component data,

the Coaxlink image pixel data processor performs the unpacking of 10-bit, 12-bit, and 14-bit pixel component data to16-bit pixel data.For Coaxlink Driver versions prior to 4.2, the unpacking operation was not configurable: 10-bit, 12-bit, and 14-bit pixelcomponent data were unpacked to 16-bit using the alignment to msb method.Since version 4.2, the unpacking operation is user-configurable through the UnpackingMode GenICam feature. Twooptions are available:

• Unpacking to lsb.• Unpacking to msb.

Since version 7.0.1, the unpacking operation can be disabled for monochrome and Bayer CFA pixels with a third optionof the UnpackingMode GenICam feature:

• Unpacking off.

Note: Since Coaxlink Driver 4.3, the default option is "Unpacking to lsb".

60

Image Data Flow   Coaxlink Driver 7.0 Functional Guide

Unpacking to lsb – DefaultThe significant bits of the pixel component data are aligned to the least significant bit of the data container. Padding'0' bits are put as necessary in the most significant bits to reach the next 8-bit boundary.

Bit assignment of 2-byte pixel components after unpacking to lsb

Input bit depth 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

10-bit 0 0 0 0 0 0 D9 D8 D7 D6 D5 D4 D3 D2 D1 D0

12-bit 0 0 0 0 D11 D10 D9 D8 D7 D6 D5 D4 D3 D2 D1 D0

14-bit 0 0 D13 D12 D11 D10 D9 D8 D7 D6 D5 D4 D3 D2 D1 D0

Note: Unpacking to lsb doesn't modify the pixel component value.

Unpacking to msb – OptionalThe significant bits of the pixel component data are aligned to the most significant bit of the data container. Padding'0' bits are put as necessary in the least significant bits to reach the next 8-bit boundary.

Bit assignment of 2-byte pixel components after unpacking to msb

Input bit depth 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

10-bit D9 D8 D7 D6 D5 D4 D3 D2 D1 D0 0 0 0 0 0 0

12-bit D11 D10 D9 D8 D7 D6 D5 D4 D3 D2 D1 D0 0 0 0 0

14-bit D13 D12 D11 D10 D9 D8 D7 D6 D5 D4 D3 D2 D1 D0 0 0

Note: Unpacking to msb 10-bit, 12-bit, and 14-bit pixel components multiplies the pixel component valueby 64, 16, and 4 respectively.

Note: Unpacking 8-bit and 16-bit pixel components is a neutral operation:

• The size of the data container is unchanged: One byte for 8-bit pixel components; two bytes for 16-bit pixel components

• The data bits are not modified

Note: Unpacking 10-bit, 12-bit, and 14-bit pixel components increases the amount of data by 160%,133%, and 114% respectively.

Related Data Stream Module GenICam Feature(s)UnpackingMode on page 275Unpacking Mode of multi-byte pixel components

Pixel Component OrderingSwap the R and B pixel component data of RGB pixels

The Coaxlink image data stream pixel processor can be configured to swap the R and B pixel component data of RGBpixels.The Red/Blue component swapping can be controlled through the RedBlueSwap boolean GenICam feature. Thecomponent swapping exclusively applies to the 3-component RGB pixel formats. It doesn't apply to other formats, e.e.RGBa.

61

Coaxlink Driver 7.0 Functional Guide   Image Data Flow

The default settings preserve the original component order.

Pixel Component Order

Output Pixel Format [PFNC] Component Order

RGB8 | RGB10 | RGB12| RGB14| RGB16 R (first), G, B (last)

BGR8 | BGR10 | BGR12| BGR14| BGR16 B (first), G, R (last)

RGBa8 | RGBa10 | RGBa12 | RGBa14 | RGBa16 R (first), G, B, a (last)

Note: The order of component of the RGB8 format is not the same as the MultiCam RGB24 format. InRGB24, the component order is BGR with B at byte 0.

Related Data Stream Module GenICam Feature(s)RedBlueSwap on page 276Red-Blue component swapping

Endianness ConversionConversion to little-endian of 16-bit pixel components

The Coaxlink image data stream pixel processor delivers 16-bit pixel components using the little-endian convention.The conversion is not performed when UnpackingMode is set to Off.

Little-endian ConventionThe least-significant byte of a multiple byte data is stored at the lowest address location.For instance, 16-bit data are stored into two consecutive byte locations as follows:

Memory Byte Location Memory Byte Content

N Data[7:0]

N+1 Data[15:8]

Pixel OrderingPreservation of original pixel order

The Coaxlink image data stream pixel processor preserves the pixel order of the CoaXPress data stream:

• The pixels data of an image frame are stored in successive address locations starting with the first pixel of the firstline at the lowest address.

• The successive lines of an image frame are concatenated in the image buffer.

DMA EngineTransfer over the PCI Express bus of the processed image data to the destination buffer

The DMA Engine transfers directly the processed image data over the PCI Express bus to the destination buffer.

62

Image Data Flow   Coaxlink Driver 7.0 Functional Guide

Buffer FillingThe DMA engine delivers image data to GenTL buffers according to rules that are different for line-scan and area-scanimage acquisition.For more informations, refer to Buffer Filling Rules on page 63.

Stream ControlPrior to Coaxlink Driver 6.2, the DMA engine was transferring the whole image data as a single 1D entity regardless the2D structure: the lines of processed image data are concatenated into the destination buffer.Since Coaxlink Driver 6.2, the DMA engine provides the capability to organize the data differently in the buffer by addingline padding or stripe padding.For more informations and configuration instructions, refer to Stream Control on page 64.

StatisticsThe DMA engine performs statistical analysis on the image data flow.For more informations and configuration instructions, refer to Stream Statistics on page 65.

Buffer Filling RulesGenTL buffer filling rules for image acquisition from area-scan and line-scan cameras

GenTL Buffer Filling Rules – Area-scan camerasIn area-scan imaging, GenTL buffers are filled according to the following rules:

• The first acquired line data of a frame is always stored at the beginning of a new buffer.• When the last line data of a frame is acquired, the buffer, possibly partially filled, is made available to the application

for processing.• When the buffer is too small to contain a complete frame, the remaining data is discarded.

GenTL Buffer Filling Rules – Line-scan camerasIn line-scan imaging, GenTL buffers are filled according to the following rules:

• The first acquired line data of a scan is always stored at the beginning of a new buffer.• A buffer contains an integer number of image lines data.• When the remaining space of a buffer is not sufficient to store an image line data, the acquisition continues into a

new buffer and the filled buffer is made available to the application for processing.• When the last line data of a scan is acquired, the last buffer, possibly partially filled, is made available to the

application for processing.

63

Coaxlink Driver 7.0 Functional Guide   Image Data Flow

Stream Control

Line PaddingThe LineWidth and LinePitch features control the line padding.When LinePitch > LineWidth, the line padding is enabled: the DMA engine leaves LinePitch - LineWidthbytes of padding at the end of each image line.The values of LineWidth and LinePitch can only be changed when the data stream doesn't own any buffer (i.e.,before announcing any buffer, or aer all announced buffers have been revoked).LinePitch can be set to 0 to disable padding aer lines.

Stripe paddingStripes are groups of adjacent lines. A stripe of height 1 is a line.The StripeHeight and StripePitch features control the stripe padding.When StripePitch > StripeHeight, the stripe padding is enabled: the DMA engine leaves StripePitch -StripeHeight lines of padding at the end of each stripe.The values of StripeHeight and StripePitch can only be changed when the data stream doesn't own any buffer(i.e., before announcing any buffer, or aer all announced buffers have been revoked).StripePitch can be set to 0 to disable padding aer lines.Related Data Stream Module GenICam Feature(s)StreamControl Category on page 287StreamReset on page 288Stream Reset

LineWidth on page 288Line width in bytes

LinePitch on page 289

64

Image Data Flow   Coaxlink Driver 7.0 Functional Guide

Line pitch in bytes

StripeHeight on page 289Stripe height in lines

StripePitch on page 290Stripe pitch in lines

Stream StatisticsEvery Data Stream of Coaxlink features a Stream Statistics Tool that monitors the image data stream at the card outputand provides the application with averaged frame-, line- and data-rate.

Stream Statistics Sampling MethodsThe sampling method determines the averaging interval. It can be any of the following:

• LastSecond or LastTenSeconds: The last completed time slot of 1 or 10 seconds.• Last2Buffers, Last10Buffers, Last100Buffers, Last1000Buffers: The last 2, 10, 100, or 1000

acquired buffers• LastAcquisition: The last acquisition activity period. Namely since the last DSStartAcquisition() function call

until now, if the acquisition is still active otherwise until the last DSStopAcquisition() function call.• LastAcquisition: Time interval between StatisticsStartSampling andStatisticsStopSampling commands.

The default sampling method is LastSecond.

Statistical DataThe statistical data is effectively computed when getting any of the following feature:

• StatisticsFrameRate reports the averaged frame rate expressed in in frames/second (area-scan).• StatisticsLineRate reports the average line rate expressed in lines/second (line-scan).• StatisticsDataRate reports the average data rate expressed in megabytes/second

For every GenTL buffer filled during the averaging interval, the tool counts:

• The number of filled GenTL buffers and the corresponding number of frames (area-scan) or lines (line-scan)• The number of transferred bytes of image data.

The related GenICam features rare gathered into the Stream Statistics Category of the GenTL Data Stream Module.Related Data Stream Module GenICam Feature(s)StreamStatistics Category on page 292StatisticsSamplingSelector on page 292Selects the stream statistics sampling method

StatisticsFrameRate on page 293Get the average image frames acquisition rate using the selected sampling method

StatisticsLineRate on page 294Get the average image lines acquisition rate using the selected sampling method

StatisticsDataRate on page 294Get the average PCI data delivery rate using the selected sampling method

StatisticsStartSampling on page 295Start sampling the stream data. Applies only when StatisticsSamplingSelector = Custom

StatisticsStopSampling on page 295Stop sampling the stream data. Applies only when StatisticsSamplingSelector = Custom

65

Coaxlink Driver 7.0 Functional Guide   Line Scan Acquisition

Line Scan AcquisitionAcquiring image data from line-scan cameras

This section applies only to the line-scan firmware variants: DF

Related Data Stream Module GenICam Feature(s)LineScanAcquisitionControl Category on page 283StartOfScanTriggerSource on page 283Start Of Scan Trigger Source

EndOfScanTriggerSource on page 284End Of Scan Trigger Source

ScanLength on page 285Scan Length

BufferHeight on page 286Height of the image in line-scan acquisition

StartScan on page 287Starts a scan

StopScan on page 287Stops a scan

Line Scan Acquisition PrinciplesLine Scan Imaging

The expression “Line-scan imaging” designates machine vision applications where 2-D images are obtained by thecombination of successive image lines captured from a 1-D imaging device that moves relatively to the object.In line-scan imaging:

• The imaging device is oen, but not necessarily, a line-scan camera.

66

Line Scan Acquisition   Coaxlink Driver 7.0 Functional Guide

• The inspected object is oen a continuous web, it can also be discrete objects having fixed or variable size.• The inspected web moves relatively to the camera. The motion speed during the acquisition can be fixed or variable.

• The cross-web direction or transverse direction is the axis on the web plane that is observed by the camera.• The down-web direction or axial direction is the motion direction of the inspected web relatively to the camera.

Scanning Area

Scanned Area

Inspected object

LegendScan direction

Dow

nweb direction

Scan

Len

gth

Web

mot

ion

dire

ctio

n

Start-Of-Scan Position

End-Of-Scan Position

Scanned line

First line

Last line

Line

Pitc

h

Second Line

FOV

The scanning area is a 2-D area on the web having a width equal to FOV and a length equal to Scan Length.In the cross-web direction (horizontal direction in the above drawing), the scanning area is delimited by the field ofview – FOV – of the camera.In the down-web direction (vertical direction in the above drawing), the scanning area is delimited by the start-of-scanand the end-of-scan positions. The line pitch is determined by the ratio between the web speed and the camera linerate.The field of view – FOV – of a line-scan camera is determined only by the optical setup and the sensor geometricalproperties.The start-of-scan position is a position on the web corresponding to the scan-line boundary preceding the first acquiredline.The end-of-scan position is a position on the web corresponding to the scan-line boundary following the last acquiredline.Most of the line-scan cameras are delivering a single row of pixels every camera cycle. Consequently, multiple cameracycles are necessary to build-up the object image.

Pixel Aspect Ratio ControlUnlike area-scan imaging, line-scan imaging allows the application to control the image pixel aspect ratio.In the large majority of cases, the imaging application requires a constant, and preferably a 1:1 image pixel aspect ratio.The cross-web pitch being locked by the sensor pitch and the optical magnification factor, the image pixel aspect ratiois controllable only through the line pitch control.The following table summarizes the methods providing a constant line pitch that are applicable with Coaxlink:

Method Name Description

67

Coaxlink Driver 7.0 Functional Guide   Line Scan Acquisition

VCR

Variable Camera cycle.

The web speed is variable and the camera cycle rate is kept proportional to the web speed.

The frame grabber builds the object image by capturing all the successive lines delivered by thecamera.

CCCConstant Camera Cycle.

The camera operates at a constant cycle rate and the frame grabber captures all the successive linesdelivered by the camera.

The VCR method requires:

• A motion encoder for measuring the web speed.

• A real-time processing of the motion encoder events to build a camera trigger at a rate that is proportional to themotion encoder events rate.

Having a proportional rate can be achieved by a divider tool or a multiplier/divider tool:

• The divider tool decimates the input rate by an integer value, it delivers 1 out of N incoming events.• The multiplier/divider tool enables fine control of the image pixel aspect ratio by allowing any rate conversion ratio

value – RCR – in the range 0.001 to 1000 with an accuracy better than 0.1% of the RCR value.

Image Acquisition with Line Scan Imaging Devices

Scanned Area

Inspected object

GenTL Buffer

Object Image

Legend

Image Data

Coaxlink

CXP DataStream

PCIe DMA

Line-ScanSmall object

Line-Scan Image Acquisition

Scan Direction

Fill1

2

3

Line-ScanBig object FOV

Scan

Len

gth

Tile 1

Tile 2

Tile 3

For the transmission on the CoaXPress link, (most of) the line-scan cameras use one CoaXPress Image Data Stream.Regarding the delivery methods of the image data, two cases are to be considered:

• For small objects, the object image data are delivered into a single GenTL buffer.• For big objects, the object image data are delivered into multiple GenTL buffers.

In both cases, the image data are delivered through a single PCIe DMA channel and the transmission latency throughCoaxlink is low: “one image line”.

GenTL Buffer Filling Rules – Line-scan camerasIn line-scan imaging, GenTL buffers are filled according to the following rules:

68

Line Scan Acquisition   Coaxlink Driver 7.0 Functional Guide

• The first acquired line data of a scan is always stored at the beginning of a new buffer.• A buffer contains an integer number of image lines data.• When the remaining space of a buffer is not sufficient to store an image line data, the acquisition continues into a

new buffer and the filled buffer is made available to the application for processing.• When the last line data of a scan is acquired, the last buffer, possibly partially filled, is made available to the

application for processing.

Line Scan Acquisition Use casesScanning of continuous objects

Acquisition Gate

#1

Open

Data Stream

Scan

Buffers #2 #3 #4 #5

Legend

GenTL Buffer

Valid Data

Invalid Data

Start-Of-Scan

End-Of-Scan

DSStartAcquisition DSStopAcquisition

Acquired Lines

Skipped Lines

This case applies to the image scanning of continuous objects.The Coaxlink acquisition controller is configured as follows:

• StartOfScanTriggerSource = Immediate.• EndOfScanTriggerSource = StopScan.

When the DSStartAcquisition function is called, the scanning starts at the next line boundary.The acquisition gate closes when the application calls the DSStopAcquisition function.Depending on the allocated buffer size and the scanning duration, the object image fits in a single buffer or requiresmultiple buffers.Each buffer is delivered to the application as soon as it is filled. The last buffer, likely partially filled, is delivered assoon as the last image data are written.

69

Coaxlink Driver 7.0 Functional Guide   Line Scan Acquisition

Fixed-length scanning of discrete objects

Acquisition Gate

#1

Open

Data Stream

Scan #1

Buf

fers

Start-Of-Scan Trigger

#2

Open

Scan #2

#3

Scan #3

Buffer Size > Image Size

#1 #2 #3 Buffer Size = Image Size

#1 Buffer Size < Image Size #2 #3 #4 #5 #6

Legend

GenTL Buffer

Valid Data

Invalid Data

Start-Of-Scan

End-Of-Scan

Ignore Trigger

DSStartAcquisition DSStopAcquisition

Acquired Lines

Skipped Lines

This case applies to the scanning of discrete objects with a common scan length.The Coaxlink acquisition controller is configured as follows:

• StartOfScanTriggerSource = StartScan or any applicable I/O Toolbox event output, for instance: LIN1.• EndOfScanTriggerSource = ScanLength.• ScanLength = any positive number representing the number of lines required to capture the object image entirely.

When the DSStartAcquisition function is called, the start-of-scan trigger of the acquisition controller is armed.Then, the acquisition controller waits for the first occurrence of a valid start-of-scan trigger event.A valid start-of-scan event can be generated:

• By the application using a StartScan command.• By the selected hardware event source, if specified by StartOfScanTriggerSource.

The acquisition controller ignores any Start-of-Scan trigger event while a scanning is in progress.The acquisition gate opens at the first line boundary following a start-of-scan event.The acquisition gate closes automatically aer the specified number of lines have been acquired or anticipatively whenthe application calls the DSStopAcquisition function.Depending on the allocated buffer size, the object image fits in a single buffer or requires multiple buffers. Each buffer isdelivered to the application as soon as it is filled. At the end-of-scan, partially filled buffers are immediately delivered.The following image acquisition always begins with a new buffer.

70

Line Scan Acquisition   Coaxlink Driver 7.0 Functional Guide

Variable-length scanning of discrete objects

Acquisition Gate

#1

Open

Data Stream

Buffers

Start-Of-Scan Trigger

Open Open

End-Of-Scan Trigger

#2 #3 #4 #5

Legend

GenTL Buffer

Valid Data

Invalid Data

Start-Of-Scan

End-Of-Scan

Ignore Trigger

DSStartAcquisition DSStopAcquisition

Acquired Lines

Skipped LinesScan #1

Scan #3

Scan #2

This case applies to the image scanning of discrete objects requiring a variable scan length.The Coaxlink acquisition controller is configured as follows:

• StartOfScanTriggerSource = StartScan or any applicable I/O Toolbox event output, for instance: LIN1.• EndOfScanTriggerSource = StopScan or any applicable I/O Toolbox event output, for instance: LIN2.

When the DSStartAcquisition function is called, the start-of-scan trigger of the acquisition controller is armed.Then, the acquisition controller waits for the first occurrence of a valid start-of-scan trigger event.A valid start-of-scan event can be generated:

• By the application using a StartScan command.• By the selected hardware event source, if specified by StartOfScanTriggerSource.

The acquisition controller ignores any Start-of-Scan trigger event while a scanning is in progress.The acquisition gate opens at the first line boundary following a start-of-scan event.The acquisition gate closes at the first line boundary following a valid end-of-scan event or immediately when theapplication calls the DSStopAcquisition function.A valid end-of-scan event can be generated:

• By the application using a StopScan command.• By the selected hardware event source, if specified by EndOfScanTriggerSource.

The acquisition controller ignores any End-of-Scan trigger event when no scanning is in progress.Depending on the allocated buffer size, the object image fits in a single buffer or requires multiple buffers. Each buffer isdelivered to the application as soon as it is filled. At the end-of-scan, partially filled buffers are immediately delivered.The next image acquisition always begins with a new buffer.

71

Coaxlink Driver 7.0 Functional Guide   Camera Control Principles

Camera Control PrinciplesGeneral principles used by Coaxlink for controlling a camera

Camera CycleA camera cycle is composed of two consecutive phases: the exposure phase and the readout phase.

Pixels reset

Imaging sensor photocells: Charges integration

Pix

els

trans

fer

Valid pixelsDummy pixels

Dummy pixels

Effective exposure time

Exposure phase Readout phaseCamera cycle

Imaging sensor storage area:

Exposure phaseThe exposure phase is the period of time during which the photocells of the imaging sensor integrate electric chargesinduced by the incoming photons.For cameras having an electronic shutter, the exposure phase begins with a pixel reset action that clears all the sensorphotocells. For permanent exposure cameras, i.e. cameras having no (or not using) the electronic shutter, the exposurephase begins immediately aer the completion of the previous exposure phase.For all types of cameras, the exposure phase terminates with a “pixel transfer” action. The accumulated charges inthe photocell are transferred to the storage area for further readout. This action clears the photocells and new chargeintegration begins immediately.Cameras having an electronic shutter have the capability to reset the pixels asynchronously and initiate a new exposureon request. These cameras are named asynchronous reset cameras.Having the capability of controlling the time of the start of exposure (pixel reset) and the time of the end of exposure(pixel transfer) gives full control on:

• The timing of each image capture• The sensitivity of the imaging sensor by selecting the exposure time

Readout phaseThe readout phase is the period of time during which the total amount of electrical charges accumulated by each pixelis measured and delivered to the imaging sensor output.The readout phase is not controlled by the frame grabber:

• It is automatically initiated aer each pixel transfer.• Its duration is fixed; it is determined by the amount of pixel data to be transferred and by the readout structure of

the sensor (one or more taps, tap output data rate).

Some sensors provide the capability to select one or more region of interest (ROI) speeding up the readout since lessdata needs to be transferred.

72

Camera Control Principles   Coaxlink Driver 7.0 Functional Guide

Camera Cycle Concatenation RulesThis topic explains the rules that MUST be observed by the frame grabber to avoid Camera Trigger overrun whenrequesting successive camera cycles to an asynchronous reset camera.

Rule for cameras not allowing overlapping

The next camera cycle may NOT begin before the completion of the readout phase.

The following diagram illustrates the shortest possible cycle period achievable by cameras NOT allowing the cycleoverlapping:

EXP1RDO1

EXP2RDO2

Min. Camera Cycle Period 1

Camera Cycle 1 Camera Cycle 2

The minimum cycle period is: Min Cycle Periodn = EXPn + RDOn

Note: Only a minority of industrial cameras are NOT allowing the cycle overlapping!

Rules for cameras allowing overlapping

The exposure phases of two consecutive camera cycles may NEVER overlap.

The readout phases of two consecutive camera cycles may NEVER overlap

The following diagrams illustrate the shortest possible cycle period achievable by cameras allowing cycle overlapping:

Use case 2: EXP2 > RDO1Use case 1: EXP2 < RDO1

EXP2

Camera Cycle 2

EXP1RDO1

EXP2RDO2

EXP1RDO1 RDO2

EXP2 - RDO1Camera Cycle Period 1

Camera Cycle 2Camera Cycle 1Camera Cycle 1

Camera Cycle Period 1

In the first case:

• The duration of the exposure phase of the 2nd cycle is shorter than the duration of the readout phase of the firstcycle.

• The next camera cycle may start (EXPn+1 - RDOn) period of time aer the completion of the exposure phase.• The minimum cycle period is Min Cycle Periodn = EXPn + RDOn - EXPn+1

In the second case:

• The duration of the exposure phase of the 2nd cycle is longer than the duration of the readout phase of the first cycle.• The next camera cycle may start immediately aer the completion of the exposure phase.• The minimum cycle period is: Min Cycle Periodn = EXPn

Note: The majority of asynchronous reset cameras used in the machine vision industry supports theoverlapping of the camera cycles!

Related Device Module GenICam Feature(s)ExposureReadoutOverlap on page 238

73

Coaxlink Driver 7.0 Functional Guide   Camera Control Principles

Exposure Readout Overlapping Capability

ExposureRecoveryTime on page 239Exposure Recovery Time

Camera Control MethodsThe Coaxlink frame grabber uses three fundamental camera control methods designated by the acronyms RG, RC, andNC:

• The first letter R designates asynchronous Reset camera control• The second letter C designates Camera-controlled exposure• The second letter G designates Grabber-controlled exposure

Note: RC and RG are acronyms inherited from MultiCam.

RG camera control methodThe RG camera control method targets asynchronous reset cameras where both the camera cycle rate and theexposure duration are controlled by the frame grabber.The real-time control is performed through a single upstream signal named Camera Trigger issued by the Cameraand Illumination Controller (CIC) of Coaxlink.

Camera Trigger

Camera CycleExposure Phase Readout Phase

Leading Edge Trailing Edge

Pixels reset

Imaging Sensor Pixels accumulation

Pixels transfer

Valid pixels

Dummy pixels

Dummy pixelsEffective exposure time

The CIC produces one single Camera Trigger pulse every camera cycle:

• The Camera Trigger leading edge triggers a new camera cycle and initiates a new exposure period• The Camera Trigger falling edge terminates the exposure period and triggers the readout

RC camera control methodThe RC camera control methods targets asynchronous reset cameras where only the camera cycle rate is controlledby the frame grabber. The exposure duration is controlled by the camera.The real-time control is performed through a single upstream signal named "Camera Trigger" issued by the Cameraand Illumination Controller (CIC) of Coaxlink.

Camera Trigger

Camera CycleExposure Phase Readout Phase

Leading Edge Trailing Edge (ignored)

Pixels reset

Imaging Sensor Pixels accumulation

Pixels transfer

Valid pixels

Dummy pixels

Dummy pixelsEffective exposure time

The CIC produces one single Camera Trigger pulse every camera cycle:

• The Camera Trigger leading edge triggers a new camera cycle and initiates a new exposure period• The Camera Trigger falling edge is ignored by the camera

74

Camera Control Principles   Coaxlink Driver 7.0 Functional Guide

NC camera control methodThe NC camera control methods targets cameras that are NOT controlled by the frame grabber. This includes

• Free-run cameras not using any external trigger signal• Asynchronous-reset cameras using an external trigger signal not delivered by the frame grabber.

There are no real-time control of the camera by the frame grabber. The Camera and Illumination Controller (CIC) ofCoaxlink is not used.Related Device Module GenICam Feature(s)CameraControlMethod on page 237Camera Control Method

75

Coaxlink Driver 7.0 Functional Guide   Illumination Control Principles

Illumination Control PrinciplesGeneral principles used by Coaxlink for controlling an illumination device

Illumination DevicesTwo classes of illumination devices can be controlled by the illumination controller:

• Intermittent illumination devices• Strobed illumination devices

Intermittent Illumination DevicesThis illumination device class includes switched light sources where the turn-on and the turn-off time are controlledby the leading and the falling edges of the strobe signal.The width of the strobe pulse determines the ON time duration of the light source.

Strobe Signal

Turn-ON time

ON-meIllumination DeviceTurn-OFF time

Leading Edge Trailing Edge

Note: The turn-on time and the turn-off time need to be considered when configuring the illuminationcontroller!

Strobed Illumination DevicesThis illumination device class includes switched light sources where only the turn-on time is controlled by the leadingedge of the strobe signal.The on-time duration is either uncontrolled or controlled by the illumination device itself.

StrobeLeading Edge Trailing Edge (ignored)

Turn-ON time

ON-meTurn-OFF time

Illumination Device

Note: The turn-on time and the ON time duration need to be considered when configuring the illuminationcontroller.

Aligning Camera and illumination CyclesObviously, the ON time of the light source must coincide with the exposure phase of the imaging sensor.Therefore, the time relationship between the strobe signal(s) and the Camera Trigger signal must be adequatelycontrolled.The following drawing shows 4 typical use cases:

76

Illumination Control Principles   Coaxlink Driver 7.0 Functional Guide

Use case 3

Sensor Exposure

Strobe

Light ONIllumination device:

Imaging device:

Use case 4

Sensor Exposure

Light ON

Camera Trigger

Use case 1

Sensor Exposure

Strobe

Light ONIllumination device:

Imaging device:

Use case 2

Sensor Exposure

Light ON

Camera Trigger

Intermittent Light Sources (Use cases 1 & 2)The duration of the strobe pulse must be adequately controlled in order to provide the right amount of light and geta correctly exposed image.The sensor exposure should be adequately timed in order to terminate the sensor exposure aer the light has turnedoff.

Strobed Light Sources (Use cases 3 & 4)The sensor exposure should be adequately timed in order to terminate the sensor exposure aer the light has turnedoff.

Late Strobe (Use cases 1 & 3)The leading edge (beginning) of the Strobe signal is delayed a little to ensure that the light is not turned on too earlywhile the imaging device is resetting its pixels.

Early Strobe (Use cases 2 & 4)The leading edge of the Camera Trigger signal is delayed a little to ensure that the sensor exposure time is kept as shortas possible and closely matches the on time.Related Device Module GenICam Feature(s)CycleTiming Category on page 240ExposureTime on page 240Exposure Time

StrobeDelay on page 241Strobe Delay

StrobeDuration on page 241Strobe Duration

ExposureReadoutOverlap on page 238Exposure Readout Overlapping Capability

ExposureRecoveryTime on page 239Exposure Recovery Time

CycleTargetPeriod on page 243Cycle Target Period

77

Coaxlink Driver 7.0 Functional Guide   Camera and Illumination Controller New

Camera and Illumination Controller New

Full description of the Camera and Illumination Controller

The Camera and Illumination Controller (abbreviated as CIC) controls one camera and its associated illumination.The camera is controlled with the Camera Trigger signal. For more information refer to Camera Trigger Signal onpage 83.The illumination device is controlled with the Strobe signal. For more information refer to Strobe Signal Paths onpage 84.

Camera Trigger

Strobe

CycleStartCycle Trigger

Manager

Cycle Timing

Machine

AllowNextCycle

Cycle ManagerStartCycle

StartCycleTriggerSource

StartSequence

StartOfSequenceTriggerSource

StopSequence

EndOfSequenceTriggerSource

AbortSequence

Sequence Manager

The CIC is composed of 4 main interconnected blocks:

• The Cycle Timing Machine is responsible for the generation of accurately timed events and signals structuring onecamera and illumination controller cycle (CIC Cycle), namely: Camera Trigger and Strobe. For more information referto Cycle Timing Machine on page 78

• The Cycle Manager is responsible for the generation of the CycleStart event. It prevents initiating a new cycle whilethe start cycle conditions are not all satisfied and while the cycle timing machine doesn’t allow a new cycle tobegin. For more information refer to Cycle Manager on page 80.

• The Cycle Trigger Manager is responsible, in collaboration with the Cycle Manager and the Sequence Manager, toelaborate the effective CycleStart event that initiates one cycle of the Cycle Timing Machine. For more informationrefer to Cycle Trigger Manager on page 81.

• The Sequence Manager manages sequences of CIC cycles according to user-defined start sequence and stopsequence conditions. For more information refer to Sequence Manager on page 82.

Related Device Module GenICam Feature(s)CameraModel Category on page 236CycleTiming Category on page 240CycleControl Category on page 242SequenceControl Category on page 247

Cycle Timing MachineCIC Cycle timing machine

ExposureTime

Cycle Start AllowNextCycle

StrobeDelay > 0 StrobeDuration

StrobeDelay < 0 Camera Trigger

Strobe

Pulse generator

Delay

Delay Pulse generator

Delay

78

Camera and Illumination Controller New    Coaxlink Driver 7.0 Functional Guide

The CIC timing machine is responsible for the generation of accurately timed events and signals structuring one cameraand illumination controller cycle (CIC Cycle).At every occurrence of a Cycle Start event, the timing machine generates:

• One single pulse on the Camera Trigger signal.• One single pulse on the Strobe signal.• One AllowNextCycle event.

Intra-cycle TimingThree GenICam features of the Device module are used to configure the timing of the output signals within a cycle:

• ExposureTime defines the duration of the Camera Trigger pulse.• StobeDuration defines the duration of the Strobe pulse.• StrobeDelay defines the time offset from the leading edge of Camera Trigger up to the leading edge of Strobe.

Refer to CIC Cycle Timing Diagrams on page 85 for more explanations and timing diagrams

Cycle-to-Cycle TimingThe AllowNextCycle event is used by the Cycle Manager to determine when the next Cycle may start.The position of the AllowNextCycle event is not directly set by the user. Instead, it is evaluated by the Coaxlink Driveraccording to the following user settings:

• The ExposureReadoutOverlap feature of the Camera Model category defines if the camera supports or not theexposure/readout overlapping. If overlapping is allowed, the AllowNextCycle event is issued earlier and faster cyclerates are obtained.

• The ExposeRecovery feature of the Camera Model category defines the minimum time gap required by thecamera between two exposures. This feature is relevant when ExposureReadoutOverlap = TRUE and theduration of the exposure phase becomes larger than the duration of the readout phase.

• The CycleTargetPeriod of the Cycle Control category defines the minimum cycle period. This value may notbe smaller than the time required by the camera to perform the image readout!

Note: Some cameras have a data store in the image data path. This enables capturing bursts of imagesat a higher cycle-to-cycle rate than the camera-to-frame grabber data link can sustain. In that case,CycleTargetPeriod declares the smallest cycle-to-cycle time that the image sensor can achieve!

Refer to Consecutive Overlapping CIC Cycles on page 86 for more explanations and timing diagrams.Related Device Module GenICam Feature(s)CycleTiming Category on page 240ExposureTime on page 240Exposure Time

StrobeDelay on page 241Strobe Delay

StrobeDuration on page 241Strobe Duration

ExposureReadoutOverlap on page 238Exposure Readout Overlapping Capability

ExposureRecoveryTime on page 239Exposure Recovery Time

CycleTargetPeriod on page 243

79

Coaxlink Driver 7.0 Functional Guide   Camera and Illumination Controller New

Cycle Target Period

Cycle Manager New

The Cycle Manager is responsible for the generation of the Cycle Start event.It prevents initiating a new cycle while the cycle start conditions listed hereaer are not satisfied:

Sequence Active ConditionThe Sequence Manager must be in the ACTIVE state: the sequence has started and the sequence stop condition hasnot yet been reached.This condition always applies.

Next Cycle Allowed ConditionThe Cycle Timing Machine has already issued the Allow Next Cycle event of the previous cycle.This condition always applies.

Free Memory ConditionThere is enough free memory on board to acquire the image data of the next cycle.This condition always applies.

Cycle Trigger Event ConditionA new Cycle Trigger event is required to initiate a new cycle.This condition applies only when CycleTriggerSource≠Immediate ANDCycleMaxPendingTriggerCount=0

Pending Trigger ConditionThere is at least one pending trigger (possibly a new one) waiting for service.This condition applies only when CycleTriggerSource≠Immediate ANDCycleMaxPendingTriggerCount>0

80

Camera and Illumination Controller New    Coaxlink Driver 7.0 Functional Guide

Cycle Trigger Manager New

Cycle PendingTrigger Counter

+1

- 1 Q > 0Pending

Cycle Trigger

Q

Clear

Cycle Trigger Acknowledge

Cycle Lost Trigger Counter

+ 1 Q

Clear

CycleLostTriggerCount

Accept

Reject

Accept Trigger

B

AA < B

Accept Pending Trigger

Cycle Trigger

Accept Immediate Trigger

From Cycle Manager

StartCycle

CycleTriggerSource

CycleMaxPendingTriggerCount

CycleLostTriggerCountReset

CyclePendingTriggerCount

CyclePendingTriggerCount

CyclePendingTriggerCountReset

From Cycle Manager

To Cycle Manager

To Cycle Manager

The Cycle Trigger Manager is responsible, in collaboration with the Cycle Manager, to elaborate the effective CycleTrigger event that initiates one cycle of the CIC timing machine.

Cycle Trigger SourcesThe source of Cycle Trigger is defined by CycleTriggerSource.When set to Immediate, the Cycle Trigger Manager is self-triggered. It generates a Cycle Trigger immediately aer thestart of the sequence and then repeatedly every CyclePeriodTarget period.When set to StartCycle or to <any I/O toolbox event source> the Cycle Trigger Manager doesn't start immediatelyaer the start of the sequence, instead it waits for the execution of a StartCycle command or the occurrence of anevent on the selected I/O toolbox event source.A wide set of Cycle Trigger event sources is available. It includes all the I/O toolbox events, namely: LIN, QDC, MDV, DIV,DEL, EIN and User Events.

Cycle Trigger Latch MechanismThe Cycle Manager is fitted with a trigger latch mechanism capable of latching cycle triggers that cannot beserved immediately. Such triggers are named ''pending triggers" since their execution is simply postponed until thecorresponding CIC cycle is initiated.The maximum number of pending triggers that can be recorded is defined by CycleMaxPendingTriggerCount.When CycleMaxPendingTriggerCount = 0, the trigger latching mechanism is disabled. This is the default value.To enable the trigger latching mechanism, set CycleMaxPendingTriggerCount to any integer value in range 1to 7.The number of pending triggers is reported by CyclePendingTriggerCount.

Cycle Trigger Events SortingWhen CycleTriggerSource is set to StartCycle or to <any I/O toolbox event source>, every Cycle Triggerevent is evaluated against the trigger acceptance criteria and sorted according to the result.The rejected Cycle Trigger events increment the Cycle Lost Trigger Counter.The accepted Cycle Trigger events increment the Cycle Pending Trigger Counter if the pending trigger cannot be servedimmediately.

81

Coaxlink Driver 7.0 Functional Guide   Camera and Illumination Controller New

Trigger Acceptance CriteriaCycle Trigger events are accepted and executed immediately when both conditions are satisfied:

• Cycle Sequence is active• Cycle Manager is currently waiting for an immediate trigger event to start a new cycle (Accept Immediate Trigger)

Cycle Trigger events are accepted and executed later when following conditions are satisfied:

• Cycle Sequence is active.• The number of pending triggers, CycleMaxPendingTriggerCount, is less thanCycleMaxPendingTriggerCount.

• The Cycle Manager is not (yet) ready to initiate new cycle.

Related Device Module GenICam Feature(s)CycleControl Category on page 242CycleTriggerSource on page 242Cycle Trigger Source

CycleTargetPeriod on page 243Cycle Target Period

StartCycle on page 244Start Cycle

CycleMaxPendingTriggerCount on page 245Maximum number of CIC cycle triggers that can be delayed when they cannot be served immediately

CyclePendingTriggerCount on page 245Gets the count of pending CIC cycle trigger events

CycleLostTriggerCount on page 246Gets the count of lost CIC cycle trigger events

CycleLostTriggerCountReset on page 246Resets the count of lost CIC cycle trigger events

Sequence Manager New

The Sequence Manager is the top-level manager of the CIC: It controls the Cycle Trigger Manager and the Cycle Manager.If defines sequences of identical CIC cycles according to user-defined start sequence and stop sequence conditions.

Starting a SequenceThe conditions for starting a sequence are defined by StartOfSequenceTriggerSource.When StartOfSequenceTriggerSource is set to Immediate (default setting), the Sequence Manager doesn'trequire any further action to allow the Cycle Manager and the Cycle Trigger Manager to proceed with the first cycle.

Note: Depending on the CycleTriggerSource settings of the Cycle Manager the first cycle will beexecuted:

• Immediately when CycleTriggerSource is set to Immediate• On execution of the StartCycle command when CycleTriggerSource is set to StartCycle or• On execution of the StartCycle command or when an event occurs on the I/O toolbox event source

designated by CycleTriggerSource.

When StartOfSequenceTriggerSource is set to StartSequence, the Sequence Manager waits for theexecution of a StartSequence command before allowing the Cycle Manager and the Cycle Trigger Manager toproceed with the first cycle.

82

Camera and Illumination Controller New    Coaxlink Driver 7.0 Functional Guide

When StartOfSequenceTriggerSource is set to <any-event-source>, the Sequence Manager waits for theexecution of a StartSequence command or the occurrence of an I/O toolbox event on the designated event sourcebefore allowing the Cycle Manager and the Cycle Trigger Manager to proceed with the first cycle.

Stopping a sequenceThe conditions for stopping a sequence are defined by EndOfSequenceTriggerSource.When EndOfSequenceTriggerSource is set to StopSequence (default setting), the Sequence Manager stopsthe sequence at the next cycle boundary aer the execution of a StopSequence command.When EndOfSequenceTriggerSource is set to SequenceLength, the Sequence Manager stops automaticallythe sequence aer having executed a number of camera cycles specified by SequenceLength. The sequence canbe stopped anticipatively on execution of the StopSequence command. The default SequenceLength value is 1;any value up to 16,777,215 is allowed.When EndOfSequenceTriggerSource is set to <any-event-source>, the Sequence Manager waits for theexecution of a StopSequence command or the occurrence of an I/O toolbox event on the designated event sourcebefore stopping the sequence at the next cycle boundary.

Note: Any combination of StartOfSequenceTriggerSource andEndOfSequenceTriggerSource settings is allowed.

Related Device Module GenICam Feature(s)SequenceControl Category on page 247StartOfSequenceTriggerSource on page 247Start Of Sequence Trigger Source

EndOfSequenceTriggerSource on page 248End Of Sequence Trigger Source

SequenceLength on page 249Sequence Length

StartSequence on page 250Start Sequence

StopSequence on page 250Stop Sequence

AbortSequence on page 251Abort Sequence

Camera Trigger SignalThe frame grabber controls the camera cycle of an asynchronous reset camera by means of the Camera Trigger signal.The signal can be transmitted from the Coaxlink card to the camera using one of the following media:

• The I/O channel of the CoaXPress link.• A dedicated wiring driven by a TTL I/O

CoaXPress I/O channelThe Camera Trigger signal is transmitted to the camera as a high-priority Host to Device Trigger message on theCoaXPress I/O channelFor detailed information about the Host to Device Trigger transmitter, refer to CoaXPress Host To Device Triggeron page 34.

83

Coaxlink Driver 7.0 Functional Guide   Camera and Illumination Controller New

TTL I/O LineAny TTL I/O line can be configured as a Camera Trigger output. The polarity control of the I/O control block providesan individual polarity control for each I/O port. The mode control of the I/O control block of TTLIO lines provides anindividual output driver configuration.

Strobe Signal PathsI/O Lines

Every output capable I/O line can be configured as an Illumination Strobe output. The polarity control of the I/O controlblock provides an individual polarity control for each I/O port. The mode control of the I/O control block of TTLIO linesprovides an individual output driver configuration for each I/O port used as strobe output.

84

CIC Timing Diagrams   Coaxlink Driver 7.0 Functional Guide

CIC Timing Diagrams

CIC Cycle Timing DiagramsTiming diagrams of individual CIC cycles

This topic illustrates the ExposureTime, StrobeDuration and StrobeDelay features for 3 use casescorresponding to positive, zero and negative values of StrobeDelay.

In-phase Strobe Case

In-phase Strobe

Camera TriggerExposureTime

Strobe

Sensor Exposure

StartCycle

StrobeDuration

Light ON

StrobeDelay=0

When StrobeDelay is set to 0, the Camera Trigger and the Strobe signals go high simultaneously.

Late Strobe Case

Late Strobe

Camera TriggerExposureTime

StrobeStrobeDuration

Light ON

Sensor ExposureStrobeDelay>0

StartCycle

When StrobeDelay is set to a positive value, the Camera Trigger signal goes high immediately aer the StartCycleevent and the Strobe signal goes high aer StrobeDelay microseconds.

Early Strobe Case

Early Strobe ExposureTime

StrobeDuration

Light ON

Sensor ExposureStrobeDelay<0

Camera Trigger

Strobe

StartCycle

When StrobeDelay is set to a negative value, the Strobe signal goes high immediately aer the StartCycle event andthe Camera Trigger signal goes high aer a time delay equal to - StrobeDelay microseconds.

85

Coaxlink Driver 7.0 Functional Guide   CIC Timing Diagrams

Consecutive Overlapping CIC CyclesTiming diagrams of consecutive overlapping CIC cycles

This topic illustrates how the user has to set the ExposureRecovery and TargetFramePeriod features whenExposureReadoutOverlap = True to properly configure the CIC to avoid trigger overruns and maximize thecycle rate.The Coaxlink Driver calculates the duration of the Camera Cycle value from the user-defined settings ExposureTime,ExposureRecovery and TargetFramePeriod by searching the smallest value satisfying the followingconditions:

• Condition 1: The time interval between consecutive Camera Trigger pulses (r – in the drawings) must be greater orequal to the ExposureRecovery settings. This ensures that the Camera Trigger properly flows through the triggertransmission link. It ensures also that a new exposure doesn't begin before the completion of the previous one.

• Condition 2: The CIC Cycle duration (a in the drawings) must be big enough to ensure that a new readout doesn'tbegin before the completion of the previous one.

• Condition 3: The CIC Cycle duration must be big enough to include both transitions of the Camera Trigger and theStrobe Signal.

The "readout-limited" use cases illustrate situations where the cycle period is equal to the duration of the readoutphase.The "exposure-limited" use cases illustrate situations where the cycle period is equal to the duration of the exposurephase.In the following timing diagrams:

• e is the Camera Trigger pulse width. This value is defined by ExposureTime.• d is the Strobe delay. This value is defined by StrobeDelay.

Case 1: Readout Limited (Late Strobe)

Overlapped Exposure/Readout Readout Limited Late Strobe

Camera Trigger

Sensor Exposure

Sensor Readout

CIC Cycle 1

11

readout

re

a

CIC Cycle 2

22

d s

Strobe

exposure

This situation occurs when e (= Exposure Time) is significantly smaller than the readout duration.In that situation:

• r is likely larger that ExposureRecovery: Condition 1 is fulfilled.• The strobe pulse being "inside" the Camera Trigger pulse: Condition 3 becomes irrelevant when Condition 1 is

fulfilled.• The Condition 2 is the only condition used by the Coaxlink Driver to calculate the cycle duration.

The optimal duration of the Cycle is equal to the effective duration of the sensor readout phase. This is obtained whenthe user sets TargetFramePeriod to a value corresponding to the readout duration.

Note: The readout duration can be derived from the maximum frame rate specification of the cameradata sheet or experimentally.

86

CIC Timing Diagrams   Coaxlink Driver 7.0 Functional Guide

Case 2: Readout Limited (Early Strobe)

Overlapped Exposure/Readout Readout Limited Early Strobe

Camera Trigger

Sensor Exposure

Sensor Readout

11

re

a

d

sStrobe

22

CIC Cycle 1 CIC Cycle 2

readoutexposure

This situation is similar to the case 1. It shows that despite a early strobe, it is possible to reach the maximum cyclerate of the camera.This situation occurs when e (= Exposure Time) is significantly smaller than the readout duration.In that situation:

• r is likely larger that ExposureRecovery: Condition 1 is fulfilled.• The strobe pulse being terminating before the Camera Trigger pulse: Condition 3 is fulfilled if r is greater than d.

This is the case when (d + e < readout duration).• The Condition 2 is the only condition used by the Coaxlink Driver to calculate the cycle duration.

The optimal duration of the Cycle is equal to the effective duration of the sensor readout phase. This is obtained whenthe user sets TargetFramePeriod to a value corresponding to the readout duration.

Note: The readout duration can be derived from the maximum frame rate specification of the cameradata sheet or experimentally.

Case 3: Exposure Limited (Late Strobe)

Overlapped Exposure/Readout Exposure Limited Late Strobe

Camera Trigger

Sensor Exposure

Sensor Readout

CIC Cycle 1

11

re

a

exposure readout

22

d s

Strobe

CIC Cycle 2

This situation occurs when e (= Exposure Time) is significantly larger than the readout duration.In that situation:

• All cycles being identical, having the readout duration smaller than the exposure duration,implies that Condition2 becomes irrelevant.

• The strobe pulse being "inside" the Camera Trigger pulse: Condition 3 becomes irrelevant when Condition 1 isfulfilled.

• The Condition 1 is the only condition used by the Coaxlink Driver to calculate the cycle duration .

The optimal duration of the Cycle is equal to the effective duration of the exposure phase. This is obtained when theuser sets ExposeRecovery to a value corresponding to the minimal time interval allowed by the camera betweenconsecutive Camera Trigger pulses.

87

Coaxlink Driver 7.0 Functional Guide   CIC Timing Diagrams

Case 4: Exposure Limited with Early-Strobe

Overlapped Exposure/Readout Exposure Limited Early Strobe

Camera Trigger

Sensor Exposure

Sensor Readout

CIC Cycle 1

11

e

a

d

CIC Cycle 2

22

r

exposure readout

sStrobe

This situation is similar to the case 3. It shows that despite an early strobe, it is possible to reach the same cycle ratewin case of small negative StrobeDelay values.This situation occurs when e (= Exposure Time) is significantly larger than the readout duration.In that situation:

• All cycles being identical, having the readout duration smaller than the exposure duration,implies that Condition2 becomes irrelevant.

• The strobe pulse terminating before the Camera Trigger pulse: Condition 3 becomes irrelevant when Condition 1is fulfilled and d < r.

• Condition 3 and Condition 1 are the only condition used by the Coaxlink Driver to calculate the cycle duration.

The user must set ExposeRecovery to a value corresponding to the largest of of the following two values:

• Minimal time interval allowed by the camera between consecutive Camera Trigger pulses.• - StrobeDelay

Tip: When CycleTriggerSource = Immediate, the cycle rate can be lowered to the desired rateby assigning a greater value to TargetFramePeriod.

Related Device Module GenICam Feature(s)ExposureReadoutOverlap on page 238Exposure Readout Overlapping Capability

ExposureRecoveryTime on page 239Exposure Recovery Time

Related Device Module GenICam Feature(s)CycleControl Category on page 242CycleTriggerSource on page 242Cycle Trigger Source

CycleTargetPeriod on page 243Cycle Target Period

StartCycle on page 244Start Cycle

CycleMaxPendingTriggerCount on page 245Maximum number of CIC cycle triggers that can be delayed when they cannot be served immediately

CyclePendingTriggerCount on page 245Gets the count of pending CIC cycle trigger events

CycleLostTriggerCount on page 246Gets the count of lost CIC cycle trigger events

CycleLostTriggerCountReset on page 246

88

CIC Timing Diagrams   Coaxlink Driver 7.0 Functional Guide

Resets the count of lost CIC cycle trigger events

Cycle Sequence Timing Diagrams New

Timing diagrams of CIC camera & illumination cycle sequences

Immediate Start

StartOfSequenceTriggerSource=Immediate; EndOfSequenceTriggerSource=StopSequence; CycleTriggerSource≠Immediate;

StartOfSequenceTriggerSource=Immediate; EndOfSequenceTriggerSource=StopSequence; CycleTriggerSource=Immediate;

CIC Cycles

Sequence

StopSequence

Sequence

CIC Cycles 2 3 41

Sequence

1 2 3 4Lost LostCycle Triggers

StopSequence

Sequence

Triggered Start – Fixed Sequence Length

StartOfSequenceTriggerSource≠Immediate; EndOfSequenceTriggerSource=SequenceLength; SequenceLength=3; CycleTriggerSource≠Immediate;

StartOfSequenceTriggerSource≠Immediate; EndOfSequenceTriggerSource=SequenceLength; SequenceLength=3; CycleTriggerSource=Immediate;

CIC Cycles 2 31

Sequence Sequence

1Start Sequence Triggers

2 31

Sequence

2

Sequence Sequence

1Start Sequence Triggers

Sequence

2

CIC Cycles 2 31

1 2 3LostCycle Triggers

2 31

1 2 3Lost Lost Lost Lost

89

Coaxlink Driver 7.0 Functional Guide   CIC Timing Diagrams

Trigerred Start and End

StartOfSequenceTriggerSource≠Immediate; EndOfSequenceTriggerSource≠SequenceLength; CycleTriggerSource=Immediate;

CIC Cycles 2 31

Sequence

1Start Sequence Triggers

1Stop Sequence Triggers

2 31

SequenceSequence

2

2

4

StartOfSequenceTriggerSource≠Immediate; EndOfSequenceTriggerSource≠SequenceLength; CycleTriggerSource≠Immediate;

Sequence

1Start Sequence Triggers

1Stop Sequence Triggers

Sequence

CIC Cycles 2 31

1 2 3LostCycle Triggers Lost

Sequence

2 41

1 2 4 LostLost

3

3

2

2

Related Device Module GenICam Feature(s)SequenceControl Category on page 247StartOfSequenceTriggerSource on page 247Start Of Sequence Trigger Source

EndOfSequenceTriggerSource on page 248End Of Sequence Trigger Source

SequenceLength on page 249Sequence Length

StartSequence on page 250Start Sequence

StopSequence on page 250Stop Sequence

AbortSequence on page 251Abort Sequence

90

CIC Synchronization   Coaxlink Driver 7.0 Functional Guide

CIC SynchronizationSynchronization of multiple Camera and Illumination controllers through the card-to-card link – C2C-Link.Related Device Module GenICam Feature(s)C2CLinkConfiguration on page 238C2C Link Configuration

Related Device Module GenICam Feature(s)C2CLinkConfiguration on page 238C2C Link Configuration

CIC Synchronization PrinciplePrinciples of the CIC Synchronization through C2C-Link

The synchronization is achieved by synchronizing the CIC Cycle Trigger of all involved CIC 's using the C2C-Linkinterconnect.A C2C-Link interconnects two or more Camera Illumination Controllers:

• One configured as the C2C-Link Master.• One (or more) configured as a C2C-Link Slave(s).

The following drawing shows a configuration with one C2C-Link Master (top) and two C2C-Link Slaves:

C2C-Link to other slave devices

Wired ANDGlobal Ready Signal Common Cycle Start Signal

Camera & Illuminaon Controller - C2C-Link Master Device

Cycle Manager

CameraCameraTrigger

StrobeTimers

CycleStart

Start Condions- Cycle finished- Buffer available- Hard/so trigger*

*oponal condion

Cycle StartReady

Camera & Illuminaon Controller - C2C-Link Slave Device

Cycle Manager

CameraCameraTrigger

StrobeTimers

CycleStart

Cycle StartReady

Start Condions- Cycle finished- Buffer available- Hard/so trigger*

*oponal condion

Camera & Illuminaon Controller - C2C-Link Slave Device

Cycle Manager

CameraCameraTrigger

StrobeTimers

CycleStart

Cycle StartReady

Start Condions- Cycle finished- Buffer available- Hard/so trigger*

*oponal condion

The C2C-Link Master:

91

Coaxlink Driver 7.0 Functional Guide   CIC Synchronization

• Generates a Common Cycle Start event when all the start conditions of all the synchronized CIC's, including itself,are satisfied.

• Delivers a common Cycle Start signal to all the synchronized CIC's.• Upon reception of the Common Cycle Start, generates a Strobe pulse and a Camera Trigger pulse according to its

timers settings.

A C2C-Link Slave:

• Forces the Global Ready signal to 'false' until its start conditions are all satisfied• Upon reception of the Common Cycle Start, generates a Strobe pulse and a Camera Trigger pulse according to its

timers settings.

For comparison purpose, the following drawing shows a CIC device where the C2C-Link is disabled:

Cycle Manager

CameraCameraTrigger

StrobeTimers

CycleStart

Camera & Illuminaon Controller – C2C-Link disabled

Start Condions- Cycle finished- Buffer available- Hard/so trigger* *oponal condion

Cycle StartReady

CIC Synchronization Timing DiagramCIC Synchronization through C2C-Link timing diagram

Device #y – Camera and Illuminaon Controller

Device #x – Camera and Illuminaon Controller

C2C-Link Common Cycle Start:

C2C-Link Global Ready

Device #n not readyDevice #n - ReadyDevice #m not readyDevice #m - Ready

Not ready

Camera Trigger

ExposureTime

StrobeStrobeDuration

Light ON

Sensor Exposure

ExposureTime

StrobeDuration

Light ON

Sensor Exposure

StrobeDelay >0

StrobeDelay < 0

Late Strobe case

Early Strobe caseCamera Trigger

Strobe

The above diagram shows the timing diagram of two consecutive common Cycle Start events:The C2C-Link Global Ready signal is held low until the Ready of all participating devices is true preventing the C2C-Link Master to issue a start event. When released by all participating devices, it ramps up rapidly with a rise time ofmaximum 100 ns.

92

CIC Synchronization   Coaxlink Driver 7.0 Functional Guide

As soon as the C2C-Link Global Ready signal is confirmed to be high, the master device asserts an abrupt goinglow transition on the Common Cycle Start signal; this edge is propagated to all the Start inputs of the timers of allparticipating devices.As soon as the cycle has started, every CIC forces the ready low as long as all the local conditions to initiate the nextcycle are not satisfied.The timers of each device issue a Camera Trigger and a Strobe, with their respective delay and duration settings.Usually, the settings are identical for all participating devices; but the application is allowed to apply different ones,if needed.The shortest Cycle Start period allowed by the C2C-Link is 400 ns; allowing a theoretical frequency limit of 2.5 MHz.

93

Coaxlink Driver 7.0 Functional Guide   C2C-Link

C2C-LinkCard-to-card Link description

The C2C-Link is a hardware communication medium allowing a single “C2C-Link master device” to reliably share 1 or2 trigger events with multiple “C2C-Link slave devices”.The C2C-Link is scalable: it may interconnect devices belonging to the same Coaxlink card, or to different cards in thesame PC or to different cards in different PCs.The C2C-Link feedback channel allows any C2C-Link device to indicate to the C2C-Link master device that it is not ableto accept a trigger.A C2C-Link interconnection may combine up to three interconnection levels:

• The IntraCard Level interconnects 2 or more C2C-Link devices belonging to the same card using FPGA internalresources.

• The IntraPC Level interconnects C2C-Link devices across two or more cards of the same PC. It requires one accessorycable such as the 3303 C2C-Link Ribbon Cable or a custom-made C2C-Link cable for each PC.

• The InterPC Level interconnects C2C-Link devices across two or more PCs. It requires one 1636 InterPC C2C-LinkAdapter for each PC and one RJ 45 CAT 5 STP straight LAN cable for each adapter but the last one.

IntraCard Level

IntraPC Level

InterPC Level

PC

Card

Mas

ter D

evic

e

C2C

Master 1636 adapter

OUTIN

C2C

Slave #1 1636 adapter

C2C

Last Slave 1636 adapter

C2C

Slav

e De

vice

Slav

e De

vice

Oth

er D

evic

e

C2C

Slav

e De

vice

Slav

e De

vice

C2C

Slav

e De

vice

C2C

Slav

e De

vice

Slav

e De

vice

C2C

Slav

e De

vice

C2C

Slav

e De

vice

Oth

er D

evic

e

C2C

Slav

e De

vice

C2C

Slav

e De

vice

IN OUTOUTIN

1633

Coa

xlin

k Q

uad

G3

(4-c

amer

a)

1632

Coa

xlin

k Q

uad

(2-c

amer

a)

1631

Coa

xlin

k Du

o (2

-cam

era)

1636

Inte

rPC

C2C-

Link

Ada

pter

3303 C2C-Link Ribbon CablePC

1633

Coa

xlin

k Q

uad

G3

(2-c

amer

a)

1632

Coa

xlin

k Q

uad

(2-c

amer

a)

1631

Coa

xlin

k Du

o (1

-cam

era)

1636

Inte

rPC

C2C-

Link

Ada

pter

3303 C2C-Link Ribbon Cable

1630

Coa

xlin

k M

ono

(1-c

amer

a)

1631

Coa

xlin

k Du

o (1

-cam

era)

1636

Inte

rPC

C2C-

Link

Ada

pter

3303 C2C-Link Ribbon Cable

STP CAT 5 Straight LAN Cable STP CAT 5 Straight LAN Cable

C2C-Link Configurations

C2C-Link Configuration Interconnection Levels

IntraCard IntraCard only

IntraPC IntraPC + IntraCard (optional)

InterPC InterPC + IntraPC+ IntraCard (optional)

94

C2C-Link   Coaxlink Driver 7.0 Functional Guide

C2C-Link SpecificationC2C-Link operating limits per interconnection level

DefinitionsTrigger delay

Propagation delay of the trigger signal from the master device to a slave device. This delay is composed of thepropagation delay inside electronic devices (FPGA, adapter...) and interconnection cables.For cables, the delay is proportional to the cable length, typically: 5ns/m.

Trigger delay skewDispersion of the trigger delay values across all the devices belonging to a C2C-Link.

Trigger delay jitterVariation of the trigger delay depending on external factors such as temperature, signal noise...

Trigger rateRate of occurrence of repetitive trigger events. The reciprocal value (1/Trigger rate) is the minimum time intervalrequired between consecutive triggers.

IntraCard C2C-Link Interconnection Level

Parameter Min. Typ. Max. Units

Trigger delay jitter 5 ns

Trigger rate 0 2.5 MHz

IntraPC C2C-Link Interconnection Level

Parameter Min. Typ. Max. Units

Cable connectors count (including 1636 adapter if any) 2 4 -

Cable length – 0.6 m

Trigger delay jitter 5 10 ns

Trigger rate 0 2.5 MHz

InterPC C2C-Link Interconnection LevelThe following specification targets applications where the highest trigger rate is required:

Parameter Min. Typ. Max. Units

1636 adapters count 2 10 -

Adapter-to-adapter LAN cable length 0.3 100 m

Cumulated adapter-to-adapter LAN cable length 0.3 100 m

Trigger delay jitter 10 20 40 ns

95

Coaxlink Driver 7.0 Functional Guide   C2C-Link

Parameter Min. Typ. Max. Units

Trigger rate 0 2.5 MHz

The following specification targets applications where the longest reachable distance is required:

Parameter Min. Typ. Max. Units

1636 adapters count 2 32 -

Adapter-to-adapter cable length 0.3 1200 m

Cumulated adapter-to-adapter cable length 0.3 1200 m

Trigger delay jitter 1 µs

Trigger rate 0 200 kHz

Note: The maximum trigger rate specification can be extrapolated for intermediate distances between100 m and 1200 m assuming that the length x frequency product is constant: in this case 250 [m. MHz].

Trigger Propagation DelaysEstimating the trigger propagation delays

The propagation delay of the Trigger signals from the master device to a slave device can be roughly estimated byadding the typical delays encountered in each segment of the signal path.

Typical Delay values per C2C-Link segment

Delay Element Min. Typ. Max. Units

(1) IntraPC interconnection (Whole IntraPC C2C-Link interconnectincluding FPGA I/O and IntraPC cable)

0 5 10 ns

(2) 1636 InterPC C2C-Link Adapter – IntraPC-to-InterPC delay 15 ns

(3) 1636 InterPC C2C-Link Adapter – InterPC-to-IntraPC delay 20 ns

(4) 1636 InterPC C2C-Link Adapter – InterPC-to-InterPC delay 0 ns

(5) InterPC LAN cable 5 ns/m

Example 1 – IntraPC ConfigurationFor an IntraPC only configuration there is only one delay element to consider: (1)

Parameter Min. Typ. Max. Units

(1) IntraPC interconnection 0 5 10 ns

Total Trigger Delay 0 5 10 ns

96

C2C-Link   Coaxlink Driver 7.0 Functional Guide

Example 2 – 3-adapter InterPC Configuration; 20 m+20 m LAN cableThis configuration is composed of 3 Intra-PC segments. For devices belonging to the same IntraPC segment as theMaster device, there is only one element to consider.

Parameter Min. Typ. Max. Units

(1) IntraPC interconnection 0 5 10 ns

Total Trigger Delay for devices of the Master InterPC segment 0 5 10 ns

For devices belonging to the same IntraPC segment as the Slave1 adapter, there are 5 delay elements to consider:

Parameter Min. Typ. Max. Units

(1) Master IntraPC interconnection 0 5 10 ns

(2) Master 1636 InterPC C2C-Link Adapter – IntraPC-to-InterPC delay 15 ns

(5) Master to slave1 InterPC LAN cable – 20 m 100 ns

(3) Slave1 1636 InterPC C2C-Link Adapter – InterPC-to-IntraPC delay 20 ns

(1) Slave1 IntraPC interconnection 0 5 10 ns

Total Trigger Delay for devices of the Slave1 InterPC segment 145 ns

For devices belonging to the same IntraPC segment as the Slave2 adapter, there are 7 delay elements to consider:

Parameter Min. Typ. Max. Units

(1) Master IntraPC interconnection 0 5 10 ns

(2) Master 1636 InterPC C2C-Link Adapter – IntraPC-to-InterPC delay 15 ns

(5) Master to slave1 InterPC LAN cable – 20 m 100 ns

(4) Slave1 1636 InterPC C2C-Link Adapter – InterPC-to-InterPC delay 0 ns

(5) Slave1 to slave2 InterPC LAN cable – 20 m 100 ns

(3) Slave2 1636 InterPC C2C-Link Adapter – InterPC-to-IntraPC delay 20 ns

(1) Slave2 IntraPC interconnection 0 5 10 ns

Total Trigger Delay for devices of the Slave2 InterPC segment 245 ns

C2C-Link Use CasesPossible use cases of the C2C-Link

CIC SynchronizationThe Cycle Trigger event of the Camera and Illumination Controller of the "C2C-Link Master Device" is distributed toone or more "C2C-Link Slave Devices".The CIC Cycles of all the devices start simultaneously. However, the Cycle Timing parameters can be configuredindividually.

97

Coaxlink Driver 7.0 Functional Guide   C2C-Link

Refer to CIC Synchronization on page 91 for more information.

C2C-Link AvailabilityAvailability of the C2C-Link vs product and firmware variant

One C2C-Link connector is available on all Coaxlink products for extension of the C2C-Link beyond the card boundary.One IntraCard C2C-Link interconnect is available only in multi-device firmware variants, namely:

• 2-camera• 2-camera, line-scan• 4-camera

CIC Synchronization is available on all firmware variants except:

• 1-df-camera• 1-df-camera, line-scan

C2C-Link SetupHow to setup a C2C-Link?

General Procedure1. C2C-Link hardware setup. This step is specific to each C2C-Link Configuration. Refer to sections hereaer.2. GenAPI setup. Assign a value to the C2CLinkConfiguration GenTL Device feature.

IntraCard C2C-Link Configuration Hardware SetupThis configuration exclusively uses FPGA internal resources to build the C2C-Link interconnect; it doesn't require anyadditional hardware!

IntraPC C2C-Link Configuration Hardware SetupThis configuration requires one accessory cable such as the 3303 C2C-Link Ribbon Cable or a custom-made C2C-Linkcable for each PC.Insert a C2C-Link female connector of the C2C-Link cable into the C2C-Link pin header connector of each participatingCoaxlink cards.

InterPC C2C-Link Configuration Hardware SetupThis configuration requires one 1636 InterPC C2C-Link Adapter for each PC and one RJ 45 CAT 5 STP straight LAN cablefor each adapter but the last one.In each participating PC:

1. Install 1636 InterPC C2C-Link Adapter into a free slot and secure the bracket.2. Connect the adapter to a power source. Refer to Adapter Powering on page 102.3. Using one 3303 C2C-Link Ribbon Cable, bind together the C2C-Link connectors of all the participating cards together

with the C2C-Link of the adapter card.4. Using LAN Cables, interconnect the adapters. Refer to InterPC Interconnect on page 103.

98

C2C-Link   Coaxlink Driver 7.0 Functional Guide

C2C-Link Hardware ComponentsHardware components of the IntraPC and the InterPC C2C-Link interconnections

IntraPC Interconnection Level Hardware3303 C2C-Link Ribbon Cable on page 99Custom C2C-Link Ribbon Cable Assembly on page 100

InterPC Interconnection Level Hardware1636 InterPC C2C-Link Adapter on page 100

3303 C2C-Link Ribbon CableAccessory product used for Intra-PC C2C-Link interconnection

3303 C2C-Link Ribbon Cable

L = 300 mm

DA B C 3303

A, B, C & D connectors: 2x 3-pin 2.54 mm pitch IDC plugs

60 mm 60 mm

The 3303 C2C-Link Ribbon Cable is a 6-conductor 0.05-in pitch ribbon fitted with 4 6-pin female ribbon cableconnectors.This cable is used for interconnecting the C2C-Link connectors of up to 4 cards located in the same PC.

99

Coaxlink Driver 7.0 Functional Guide   C2C-Link

Custom C2C-Link Ribbon Cable AssemblyAssembly instructions of a custom-made IntraPC C2C-Link interconnection

0.1"

6 w

ires

0.05

"

Pin1

Polarization key

Connector pitch

Cable length

The cable assembly is composed with:

• A piece of a 6-conductor 0.05-in pitch ribbon cable. For instance: Belden’s (9L280XX Series).• Two or more pieces of a 2 x 3-pin female ribbon cable connectors. For instance: TE connectivity 1-1658528-1.

The cable assembly has:

• A maximum of 4 connectors allowing up to 4 cards to share the same C2C-Link.• A maximum length of 60 cm.

The connector pitch(es) must be determined according to the actual card to card spacing in the Host PC.

1636 InterPC C2C-Link AdapterAccessory product for use as an InterPC C2C-Link extender and/or as a HD26F I/O adapter

For a 1636 InterPC C2C-Link Adapter hardware description, refer to Hardware Description on page 101.For a description of the C2C-Link extender usage, refer to C2C-Link Extender on page 102.For a description of the HD26F I/O adapter usage, refer to HD26F I/O Adapter on page 105.

100

C2C-Link   Coaxlink Driver 7.0 Functional Guide

Product PicturesPictures of 1636 InterPC C2C-Link Adapter

Hardware DescriptionDetailed hardware description of 1636 InterPC C2C-Link Adapter

C2C-Link connector

Pow

er In

put

conn

ecto

r

Exte

rnal

I/O

co

nnec

tor

1

12

+12V

GND

GND

NC12

Inte

rnal

I/O

co

nnec

tor

L = 200 mm

28

OU

T co

nnec

tor

IN

conn

ecto

r

A & B connectors: 2x 13-pin 2.54 mm pitch IDC plugs

26-way ribbon cable 1.27 mm pitch

1

L2L1

L4L3

OUT

IN

External I/O

BA

L = 300 mm

DA B C 3303

A, B, C & D connectors: 2x 3-pin 2.54 mm pitch IDC plugs

60 mm 60 mm

3303 C2C-Link Ribbon Cable

1636 InterPC C2C-Link Adapter

The 1636 InterPC C2C-Link Adapter product accessory is composed of:

101

Coaxlink Driver 7.0 Functional Guide   C2C-Link

• A printed circuit board assembly fitted with a standard-profile PC bracket.• A 200-mm 26-way ribbon cable.• A 3303 C2C-Link Ribbon Cable.

ConnectorsThe External I/O connector is a HD26F – 26-pin 3-row high-density female – Sub-D connector fitted on the bracket withUNC 4-40 screws. Refer to HD26F I/O Adapter on page 105 for the usage description and the pin assignments.The IN connector and the OUT connector are RJ-45 8-pin sockets fitted on the bracket. Refer to C2C-Link Extenderon page 102 for the usage description.The Internal I/O connector is a 26-pin dual-row 0.1" pitch pin header with shrouding. Refer to HD26F I/O Adapter onpage 105 for the usage description and the pin assignments.The C2C-Link connector is a 6-pin dual-row 0.1" pitch pin header with shrouding. Refer to C2C-Link Extender on page102 for the usage description.The Internal I/O connector is a 26-pin dual-row 0.1" pitch pin header with shrouding. Refer to HD26F I/O Adapter onpage 105 for the usage description.The Power Input connector is a 0.2" pitch right-angled Disk Drive Power connector. Refer to C2C-Link Extender onpage 102 for the usage description.

LampsThe IN connector and the OUT connector are each equipped with 2 green/yellow LED lamps named respectively L1,L2, L3 and L4. Refer to C2C-Link Extender on page 102 topic for the usage description.

C2C-Link ExtenderUsing 1636 InterPC C2C-Link Adapter as a C2C-Link Extender

Adapter PoweringHow to deliver power to the 1636 InterPC C2C-Link Adapter?

Notice: The 1636 InterPC C2C-Link Adapter must be powered when it is used as a C2C-Link extender.

The user has two options to supply power to the adapter:

• From the Coaxlink card +12V power output of an Internal IO connector through the 26-way ribbon cable attachedto the Internal I/O connector.

• From the Host PC power supply through a Disk Drive Power connector cable plugged into the Power Input connector.

Parameter Min. Typ. Max. Units

+12 V DC Input voltage 11.0 12.0 13.0 V

+12 V Input power 1.8 W

102

C2C-Link   Coaxlink Driver 7.0 Functional Guide

InterPC Interconnect

1

L2L1

L4L3

OUT

IN

External I/O

1

L2L1

L4L3

OUT

IN

External I/O

1

L2L1

L4L3

OUT

IN

External I/O

Master Slave Last Slave

STP CAT5 Straight LAN

cable

STP CAT5 Straight LAN

cable

The above drawing shows the external wiring of a C2C-Link across 3 adapters.The external wiring of the C2C-Link is made with RJ 45 CAT 5 STP straight LAN cables. N-1 cables are required tointerconnect N adapters in a daisy-chain scheme.The daisy-chain begins on the OUT connector of the Master adapter and ends at the IN connector of the Last Slaveadapter.The IN connector of the Master adapter and the OUT connector of the Last Slave adapter are unused.

Note: The adapter disables the signal drivers of the IN and OUT connectors to avoid electrical damageswhen it detects a bad or a missing connection.

The InterPC cable drivers and receivers are not electrically isolated.

Important: To avoid damages, the interconnected PCs must have a common ground reference.

LampsOUT

IN

Ready Status Lamps

L3

L1

Trigger Activity Lamps

L4

L2

103

Coaxlink Driver 7.0 Functional Guide   C2C-Link

Trigger Activity LampsThe L2 and L4 Lamps indicate the trigger activity on the LAN cable. L2 shows the activity on the received trigger signals;L4 shows the activity on the transmitted trigger signals.

Lamp State Indication

Off The LAN cable is unplugged or the adapter is not powered.

Green No trigger activity. No trigger events in the past 10 milliseconds.

Yellow Trigger activity. One or more trigger events in the past 10 milliseconds.

Ready Status LampsThe L1 and L3 Lamps indicate the state of the ready signal on the LAN cable. L1 shows the state of the transmittedready signal; L3 shows the state of the received ready signal.

Lamp State Indication

Off The adapter is not powered.

Green

Ready true.

For L1: all the C2C-Link devices attached to this adapter and the downwards adapters (if any)are ready.

For L3: all the C2C-Link devices attached to the downwards adapters (if any) are ready.

Yellow

Ready false.

For L1: one or more C2C-Link devices attached to this adapter and the downwards adapters(if any) are not ready.

For L3: one or more C2C-Link devices attached to the downwards adapters (if any) are notready.

Note: Unlike the trigger activity lamps, the ready signals are not enlarged. Short-duration not-readystates are hardly visible!

Adapters Array Lamp States – Normal Situations

Master

L4L3

L2L1

Slave

L4L3

L2L1

Last Slave

L4L3

L2L1

INO

UT

OK

1

All connections OK No triggers, all adapters ready

Master

L4L3

L2L1

Slave

L4L3

L2L1

Last Slave

L4L3

L2L1

INO

UT

OK

2

All connections OK Triggers activity, all adapters ready

Master

L4L3

L2L1

Slave

L4L3

L2L1

Last Slave

L4L3

L2L1

INO

UT

OK

3

All connections OK Triggers and ready activity

The above drawings show the lamps states of 3 daisy-chained adapters for 3 normal situations.In the OK 1 situation, all adapters are ready to accept triggers but no triggers are sent by the master.In the OK 2 situation, the master adapter sends triggers and the ready signal of all adapters is permanently high. Theyellow/green toggling L2 and L4 lamps indicate the trigger activity. The steady green L1 and L3 lamps indicate that alladapters are permanently ready to receive triggers.

104

C2C-Link   Coaxlink Driver 7.0 Functional Guide

In the OK 3 situation, the master adapter sends triggers and the ready signal of all adapters is cycling. The yellow/green toggling L2 and L4 lamps indicate the trigger activity. The yellow/green toggling L1 and L3 lamps indicate thatall adapters are not ready to receive triggers for a significant duration.

Adapters Array Lamp States – Abnormal SituationsN

OK

1 No power

Master

L4L3

L2

Slave

L4L3

L2Last

Slave

L4L3

L2

INO

UT

L1 L1 L1

Master

L4L3

L2

Slave

L4L3

L2

Last Slave

L4L3

L2

INO

UT

NO

K 2 Connections NOK

L1 L1 L1

Master

L4L3

L2L1

Slave

L4L3

L2L1

Last Slave

L4L3

L2L1

INO

UT

NO

K 3

All connections OK No triggers, slave adapter not ready

The above drawings show the lamps states of 3 daisy-chained adapters for 3 abnormal situations.In the NOK 1 situation, no adapters are powered. All lamps are Off.In the NOK 2 situation, all adapters are powered but all connections are missing or incorrect.In the NOK 3 situation, all adapters are powered and all connections are OK, but the second adapter is not readypreventing the master to send new triggers. This situation is considered as abnormal when it persists.

Troubleshooting Guide

Lamps state Indication and possible causes Action

All lamps Off The adapter is not powered. Apply power to the adapter

L2 Off

L1 GreenThe external connection to the IN connector ismissing or incorrect.

For the master adapter, this is OK: nothing to do!

For the other adapters: check and correct theconnection to the OUT connector of the previousadapter in the daisy-chain.

L4 Off

L3 GreenThe external connection to the OUT connector ismissing or incorrect.

For the last slave adapter of the daisy-chain, this isOK: nothing to do!

For the other adapters: check and correct theconnection to the IN connector of the next adapterin the daisy-chain.

HD26F I/O AdapterUsing the 1636 InterPC C2C-Link Adapter as a HD26F I/O Adapter

To use 1636 InterPC C2C-Link Adapter as an HD26F I/O adapter:

• Plug the A-connector of the supplied 200-mm 26-way ribbon cable to the Internal I/O connector of the 1636 InterPCC2C-Link Adapter

• Plug the B-connector to the Internal I/O connector of the target card.

Note: No power supply connection is required when using the 1636 InterPC C2C-Link Adapter as anHD26F I/O adapter only.

105

Coaxlink Driver 7.0 Functional Guide   I/O Toolbox

I/O ToolboxSet of tools for building-up and processing hardware events

The I/O Toolbox is a configurable array of tools that builds-up streams of event pulses from external signals appliedto the input-capable I/O lines.Related Interface Module GenICam Feature(s)IOToolbox Category on page 182

I/O Toolbox Context

Interface Module

I/O ToolboxDevice Module #4

Device Module #3

Device Module #2

Device Module #1

GPIO

Input Lines

Acquision Controller

Triggers

Camera and Illuminaon Controller

I/O Toolbox Events

Event Counters Array

Input Events

Line Input Tools

Event Tools

Event Input Tools

Figure 3: I/O Toolbox context

There is only one I/O Toolbox instance per Coaxlink card. It belongs to the GenTL Interface module.The input-capable I/O lines and selected event sources are feeding the I/O Toolbox.Tools of the I/O Toolbox generates one (or more) event streams. The I/O Toolbox Events streams are distributed tovarious consumers on the card.The I/O Toolbox events can be used in every GenTL module of the card for:

• The hardware Cycle Trigger source.• The hardware Start-of-scan Trigger source.• The hardware End-of-scan Trigger source.

Every I/O Toolbox event stream is associated with a 32-bit event counter.

106

I/O Toolbox   Coaxlink Driver 7.0 Functional Guide

I/O Toolbox Structure

Event Tools

Input ToolsGPIO Input Lines

LIN<1:*>Line Input Tools

Quadrature Decoder Tools QDC<1:*>

DIV<1:*>Divider Tools

Multiplier/Divider Tools MDV<1:*>

Delay Tools DEL<1:*><1:2>

Event Input Tools EIN<1:*>

User Actions Tool UserEvent<1..4>External Events

I/O Toolbox Events

I/O Toolbox Input ToolsThe I/O Toolbox input tools are fed by the input-capable GPIO lines and a selected set of hardware event sources fromoutside the I/O Toolbox.They deliver one I/O Toolbox event stream.There are four types of input tools:

• The Line Input Tools, for use with sensors/detectors using a single GPIO input line.• The Quadrature Decoder Tools for use with quadrature motion encoders using two GPIO input lines.• The User Actions Tool for use by the application soware to generate user events• The Event Input Tools for use in line-scan data-forwarding applications.

The GPIO Input Lines Interconnections Matrix allows any Line Tool to be fed by any GPIO input line.The External Events Interconnections Matrix allows any Event Input Tool to be fed by the external event source.

Note: Currently, only the CoaXPress Host interface GPIO message receiver of connector A is available.

I/O Toolbox Event ToolsThe I/O Toolbox Event Tools are fed by one (or more) I/O Toolbox event stream(s) and deliver one (or more) I/O Toolboxevent stream (s).There are three types of events tools:

• The Divider Tool generates an event stream by keeping 1 event out of D events of the input stream.• The Multiplier/Divider Tool generates an event stream having M events every D events of the input stream.• The Delay Tool delays the events of one (or two) streams, either by a configurable period of time or by a configurable

number of motion encoder ticks.

107

Coaxlink Driver 7.0 Functional Guide   I/O Toolbox

The Internal Events Interconnection Matrix allows any Event Tool to be fed by any I/O Toolbox event stream.Tools can be cascaded to form a tool chain:

• A tool chain always begins with a Line Tool.• A (Line or Event) Tool may drive 0, 1 or several Event Tools.

I/O Toolbox CompositionComposition of the I/O Toolbox vs product and firmware variant

1630 Coaxlink Mono

Firmware Variant #LIN #QDC #DIV #MDV #DEL #UAS #EIN

1-camera 8 1 1 1 2 1 -

1631 Coaxlink Duo

Firmware Variant #LIN #QDC #DIV #MDV #DEL #UAS #EIN

1-camera 8 1 1 1 2 1 -

2-camera 8 1 1 - - 1 -

1632 Coaxlink Quad

Firmware Variant #LIN #QDC #DIV #MDV #DEL #UAS #EIN

1-camera 8 1 1 1 2 1 -

2-camera 8 1 1 - - 1 -

1-camera, line-scan 8 1 1 1 2 1 -

1633 Coaxlink Quad G3

Firmware Variant #LIN #QDC #DIV #MDV #DEL #UAS #EIN

1-camera 8 1 1 1 2 1 -

2-camera 8 2 2 2 2 1 -

4-camera 8 - - - - 1 -

1-camera, line-scan 8 1 1 1 2 1 -

2-camera, line-scan 8 2 2 2 2 1 -

1-slm-camera 8 1 1 1 2 1 -

1-sls-camera 8 1 1 1 2 1 -

1629 Coaxlink Duo PCIe/104-EMB, 1634 Coaxlink Duo PCIe/104-MIL

Firmware Variant #LIN #QDC #DIV #MDV #DEL #UAS #EIN

1-camera 8 1 1 1 2 1 -

108

I/O Toolbox   Coaxlink Driver 7.0 Functional Guide

Firmware Variant #LIN #QDC #DIV #MDV #DEL #UAS #EIN

2-camera 8 1 1 - - 1 -

1-camera, line-scan 8 1 1 1 2 1 -

1635 Coaxlink Quad G3 DF

Firmware Variant #LIN #QDC #DIV #MDV #DEL #UAS #EIN

1-camera 8 1 1 1 2 1 -

1-df-camera 8 1 1 1 2 1 -

1-camera, line-scan 8 1 1 1 2 1 -

1-df-camera, line-scan 8 1 1 1 2 1 2

Line Input Tool

Tool Name ShortName Inputs Count/Type Outputs Count/Type/Name

Line Input Tool LIN 1 GPIO input line 1 event stream: LIN<i>

Line Input Tool Wiring Diagram

LIN<i>

Edge Selector

OutIn

I/O Toolbox EventsGPIO Input Lines LineInputToolSourceLineInputToolActivation

Any input-capable GPIO line can be selected as the input source.The tool feeds one I/O Toolbox event stream named LIN<i>.

Line Input Tool OperationThe Line Input tool detects the rising or the falling edge of the LineInput signal delivered by the I/O Control blockselected by LineInputToolSource.The Line Input tool delivers one event at every rising or falling edge according to the LineInputToolActivationsettings.Related Interface Module GenICam Feature(s)LineInputToolSelector on page 183Selects a Line Input Tool

LineInputToolSource on page 184Physical I/O line used as input for the selected Line Input Tool

LineInputToolActivation on page 185

109

Coaxlink Driver 7.0 Functional Guide   I/O Toolbox

Edge activating the output of the selected Line Input Tool

Quadrature Decoder Tool

Tool Name ShortName Inputs Count/Type Outputs Count/Type/Name

Quadrature Decoder Tool QDC 2 paired I/O input lines1 event stream: QDC<i>1 status bit: QDC<i>Direction1 status word: QDC<i>Position

Quadrature Decoder Tool Wiring Diagram

QDC<i>Backward Motion Compensator

Position counter

QQuadratureEdge

Detector

A

B Phase

UI/O Toolbox Events

GPIO Input Lines

DIN11, IIN11, IIN13, TTLIO11DIN21, IIN21, IIN23, TTLIO21

DIN12, IIN12, IIN14, TTLIO12DIN22, IIN22, IIN24, TTLIO22

QuadratureDecoderToolSources

QuadratureDecoderToolActivation

QuadratureDecoderToolForwardDirectionQuadratureDecoderToolOutputMode

QuadratureDecoderToolDirection

QuadratureDecoderToolPosition

QuadratureDecoderToolPositionReset

The quadrature edge detector is fed by a pair of signals named A and B delivered by a phase-quadrature motionencoder device.The source selectors allows following pairs of adjacent input-capable GPIO input lines to be selected as A/B inputsources: DIN11-DIN12, DIN21-DIN22, TTLIO11-TTLIO12, TTLIO21-TTLIO22, IIN11-IIN12, IIN13-IIN14, IIN21-IIN22, andIIN23-IIN24.The tool includes the following function blocks:

• A quadrature edge detector• A backward motion compensator• A 32-bit position counter

The tool delivers:

• One I/O Toolbox event stream named QDC<i>.• A direction status bit indicating the direction of the motion.• A position status word indicating the position offset.

Quadrature Decoder Tool OperationThe Quadrature Decoder Tool decodes the A/B signals and delivers 1, 2, or 4 events every A/B cycle, possibly filteredby the backward motion compensator.The quadrature edge detector analyzes the transitions on the A/B lines. It delivers:

• An event stream, named U, having 1, 2, or 4 events every A/B cycle according theQuadratureDecoderToolActivation settings

• An identification of the phase between A and B (A leads B or vice-versa)

110

I/O Toolbox   Coaxlink Driver 7.0 Functional Guide

A leads B B leads A

U

A inputB input

Phase

x 4x 2x 1

The U stream may be filtered by the backward motion compensator before being delivered to the QDC<i> output.The phase indication may be inverted according to the QuadratureDecoderToolForwardDirection settingsbefore being delivered to the Direction output.The backward motion compensator filters the U stream according to the QuadratureDecoderToolOutputModesetting.

When set to Unfiltered, all the events of the U stream are delivered to the QDC<i> output:

ForwardForward BackwardDirecon

U

Q

When set to ForwardOnly, only the events corresponding to the forward direction are delivered to the QDC<i>output:

ForwardForward BackwardDirecon

U

Q

When set to FirstPassForwardOnly, only the events corresponding to the first pass in the forward direction aredelivered to the QDC<i> output:

ForwardForward BackwardDirecon

U

1 6

1 6

Q

The position counter increments by 1 for any U event corresponding to the forward direction and decrements by 1 forthe backward direction.The counter can be reset using the QuadratureDecoderToolPositionReset command.Related Interface Module GenICam Feature(s)QuadratureDecoderToolSelector on page 190Selects a Quadrature Decoder Tool

QuadratureDecoderToolSources on page 190Selects the line input pair to use as A/B line input

QuadratureDecoderToolActivation on page 191Edge activating the output of the selected Quadrature Decoder Tool

QuadratureDecoderToolForwardDirection on page 192Selects the A/B phase relationship corresponding to the forward direction

QuadratureDecoderToolOutputMode on page 192Selects the filtering mode of the backward motion compensator

QuadratureDecoderToolPosition on page 193Position counter value of the selected Quadrature Decoder Tool

QuadratureDecoderToolDirection on page 193

111

Coaxlink Driver 7.0 Functional Guide   I/O Toolbox

Current direction of the selected Quadrature Decoder Tool

QuadratureDecoderToolPositionReset on page 194Reset Position counter of the selected Quadrature Decoder Tool

User Actions Tool

User Output Register

UserOutput0Register Bit

UserEvent1UserEvent2UserEvent3UserEvent4

UserOutput1Register Bit

UserOutput2Register Bit

User Actions Set

AddUserAction

ExecuteUserActions

ClearUserActions

ScheduleUserActions

User Actions Scheduler

Scheduled User Acons

Pool

User Actions Register

UserOutput3Register Bit

UserOutput4Register Bit

UserOutput5Register Bit

UserOutput6Register Bit

UserOutput7Register Bit

To a

ny o

utpu

t-cap

able

GPI

O li

nes.

To any DIV, MDV, and DEL I/O Toolbox tools To any CIC

UserOutputValueAll

Deco

de

UserOutput0_High UserOutput0_Low UserOutput0_ToggleUserOutput1_High UserOutput1_Low UserOutput1_ToggleUserOutput2_High UserOutput2_Low UserOutput2_ToggleUserOutput3_High UserOutput3_Low UserOutput3_ToggleUserOutput4_High UserOutput4_Low UserOutput4_ToggleUserOutput5_High UserOutput5_Low UserOutput5_ToggleUserOutput6_High UserOutput6_Low UserOutput6_ToggleUserOutput7_High UserOutput7_Low UserOutput7_Toggle

All the firmware variants of all Coaxlink products implement a hardware function block named User Actions Tool thatallows the application soware to perform the following User Actions:

• Generate events on any User Events source.• Setting high any bit of the User Output Register.• Setting low any bit of the User Output Register• Toggling any bit of the User Output Register.

With the ClearUserActions and AddUserActions GenICam features, the user application can define a UserActions Set composed with all the actions to be executed simultaneously.Aer having defined the User Actions Set, the application soware has two options for its execution:

• Using the ExecuteUserActions GenICam feature to execute immediately all the actions defined in the UserActions Set.

• Using the ScheduleUserActions GenICam feature to delegate the execution of the User Actions Set to the UserActions Scheduler.

Related Interface Module GenICam Feature(s)UserOutputRegister Category on page 177

112

I/O Toolbox   Coaxlink Driver 7.0 Functional Guide

User Actions Scheduler

InternalTime

QDC1_Position

QDC2_Position Scheduled Time/position

Match

Current Time/Position

Scheduled User Actions

Mux

Time/Position Tick

Scanner

Start

Compare

DiscardScheduledUserActions

UserActionsSchedulerReference

From

I/O

Tool

box

ScheduledUserActionsPoolStatus

User Actions SetTime/position

Scheduled User Actions Pool

ScheduleUserActions

Merge Scheduled User Actions Set

The UAS function block allows an application soware to postpone the execution of the actions.

Scheduler Reference SettingsPrior to using the User Actions Scheduler, the user application has to select a 32-bit reference counter. This is achievedby assigning one of the following three values to the UserActionsSchedulerReference GenICam feature:

• InternalTime selects the Coaxlink card local time: A monotonic time base that increments by 1 every 1microsecond and wraps around aer about 71 minutes when it reaches the maximum value of 4,294,967,295.

• QDC1Position and QDC2Position selects the Position Counter of the Quadrature Decoder tools QDC1 andQDC2 respectively.

Important: For correct operation of the UAS with a position reference, both conditions must be satisfied:

• The position counter must increment monotonically!• The position counter may not increment faster than every microsecond.

Note: To ensure monotonic increments of the QDC position counter:

• Set properly QuadratureDecoderToolForwardDirection such that the counter incrementswhen the object moves in the forward direction.

• If it exists any backward motion, prevent the position counter to decrement by setting theQuadratureDecoderToolOutputMode to ForwardOnly or to FirstPassForwardOnly.

Schedule User Actions Pool OperationThe Scheduled User Actions Pool is a memory area where the Scheduled User Actions Sets are stored by the userapplication. The pool has 64 locations.To add a new Scheduled User Actions to the Pool, the user application must:

1. Ensure that there is at least one free location by getting the value of the ScheduledUserActionsPoolStatusGenICam feature,

2. Define a User Actions Set,3. Determines the time/position 32-bit value when the actions are to be executed,

113

Coaxlink Driver 7.0 Functional Guide   I/O Toolbox

4. Set this value to ScheduledUserActions GenICam feature.

Scheduled User Actions are removed from the pool when they are executed.The pool can be cleared at any time by executing the DiscardScheduledUserActions GenICam command.

Scanner Operation and Scheduled Actions ExecutionAt every increment of the 32-bit (time or position) reference counter, the Scanner reads all the locations and comparesthe scheduled reference time/position with the current time/position count value.When the values are identical, the Scheduled User Actions Set is elected for execution at the end of the scan andremoved from the pool.When multiple sets are elected for execution, their actions are merged.

Note: Merging a set low and a set high action on the same User Output Register bit results into atoggle action.

At the end of the scan: the merged elected actions are executed simultaneously. The time delay from the reference tickup to the execution of the elected actions is very small ( sub-microsecond) and constant.Related Interface Module GenICam Feature(s)UserActions on page 178Current set of user actions

AddUserAction on page 178Add an action to the current set of user actions

ClearUserActions on page 179Clear the current set of user actions

ExecuteUserActions on page 180Immediately execute the current set of user actions

ScheduleUserActions on page 180Schedule the current set of user actions for execution at given time/position

UserActionsSchedulerReference on page 181Defines the reference used by the user action scheduler

ScheduledUserActionsPoolStatus on page 181Reports the status of the pool of scheduled user actions

DiscardScheduledUserActions on page 182Discard all scheduled user actions

User EventsUser-driven event sources

All the firmware variants of all Coaxlink products implement 4 User Events sources named UserEvent1 …UserEvent4.Any User Event can be used:

• As Cycle Trigger source by all the Camera and Illumination Controllers.• As Cycle Sequence Trigger source by all the Camera and Illumination Controllers.• As event source by all the Divider tools of the I/O Toolbox.• As event source by all the Multiplier/Divider tools of the I/O Toolbox• As event source for both channels of all the Delay) tools of the I/O Toolbox.

114

I/O Toolbox   Coaxlink Driver 7.0 Functional Guide

User Output RegisterUser-configurable general purpose output register

All the firmware variants of all Coaxlink products but 1630 Coaxlink Mono implement an 8-bit User Output Registerwhere bits are named UserOutput0 … UserOutput7.1630 Coaxlink Mono implements only the 4 lowest bits!Any User Output Register bit can be used as signal source by any output-capable GPIO line.The user application has two options to define the state of the User Output Register bits:

• The User Actions option allows to change the state of each bit individually.• Setting a value to the UserOutputValueAll to define the state of all bits.

Getting the value of UserOutputValueAll allows the user application to get the state of all bits.Related Interface Module GenICam Feature(s)UserOutputValueAll on page 177Value of all User Output Register bits

Event Input Tool QuadG3DF

Tool Name ShortName Inputs Count/Type Outputs Count/Type/Name

Event Input Tool EIN 1 Event 1 event stream: EIN<i>

Event Input Tool Wiring Diagram

EIN<i>

I/O Toolbox EventsCoaXPress Host Interface

Connector A

EventInputToolSourceEventInputToolActivation

Event Selector

OutIn ☐ Start-of-scan ☐ End-of-scan

Connector A of the CoaXPress Host Interface is the only source of events that can be selected.The tool feeds one I/O Toolbox event stream named EIN<i>.

Event Input Tool OperationThe Event Input tool decodes the custom CoaXPress GPIO message received on the CoaXPress connector A of a slave1635 Coaxlink Quad G3 DF.The Event Input tool delivers one event on the reception of a "Start-of-scan message" or an "End-of-scan message"according to the EventInputToolActivation settings.Related Interface Module GenICam Feature(s)EventInputToolSelector on page 201Selects an Event Input Tool

EventInputToolSource on page 202CoaXPress connector used as input for the selected Event Input Tool

EventInputToolActivation on page 202

115

Coaxlink Driver 7.0 Functional Guide   I/O Toolbox

Signal activating the output of the selected Event Input Tool

Divider Tool

Tool Name ShortName Inputs Count/Type Outputs Count/Type/Name

Divider Tool DIV 1 Toolbox event stream 1 event stream: DIV<i>

Divider Tool Wiring Diagram

DividerIn Out DIV<i>

I/O Toolbox EventsI/O Toolbox Events DividerToolSourceDividerToolDivisionFactorDividerToolInitialOffset

DividerToolEnableControl

Any I/O Toolbox event stream can be selected as the input source.The tool feeds one I/O Toolbox event stream named DIV<i>.

Divider Tool Operation

Input

I

Output

I=4, D=3DReset

Disabled DisabledEnabled

Once enabled, the Divider tool skips the first – I – input events before delivering an event every D input events.The division factor – D – is defined by DividerToolDivisionFactor. The default value is 2 and the value rangeis 1 … 65535.The initial offset – I – is defined by DividerToolInitialOffset. The default value is 0 and the value range is 0… 65535.The operation state is defined by DividerToolEnableControl. The default value is Disable0Related Interface Module GenICam Feature(s)DividerToolSelector on page 194Selects a Divider Tool

DividerToolSource on page 195I/O Toolbox event stream used as input for the selected Divider Tool

DividerToolEnableControl on page 196Output control of the selected Divider Tool

DividerToolDivisionFactor on page 196Divider value of the selected Divider Tool

DividerToolInitialOffset on page 197

116

I/O Toolbox   Coaxlink Driver 7.0 Functional Guide

Initial value of the selected Divider Tool

Multiplier/Divider Tool

Tool Name ShortName Inputs Count/Type Outputs Count/Type/Name

Multiplier/Divider Tool MDV 1 Toolbox event stream 1 Toolbox event stream: MDV<i>

Multiplier/Divider Tool Wiring Diagram

Multiplier DividerIn Out MDV<i>

I/O Toolbox EventsI/O Toolbox Events MultiplierDividerToolSourceMultiplierDividerToolDivisionFactor

MultiplierDividerToolMultiplicationFactor

MultiplierDividerToolEffectiveDivisionFactorMultiplierDividerToolEffectiveMultiplicationFactor

Any I/O Toolbox event stream can be selected as the input source.The tool feeds one I/O Toolbox event stream named MDV<i>.

Multiplier/Divider Tool OperationThe Multiplier/Divider tool multiplies and/or divides the input rate by any rate conversion ratio – RCR – value in therange 0.001 to 1000.0.The Multiplier/Divider tool measures the time interval between every consecutive input events and adapts the outputrate accordingly.The Multiplier/Divider is frequency accurate. The output frequency is strictly proportional to the input frequencyprovided that the input frequency is stable (or varies slowly). In such conditions, the Multiplier/Divider delivers Mevents for every D input events.

InputD

Output

M/D = 5/7

M

The Rate Conversion Ratio is configured as the ratio of two float numbers:

• The M value is defined by MultiplierDividerToolMultiplicationFactor.The default value is 1.0 and the value range is 0.001 to 1000.0.

• The D value is defined by MultiplierDividerToolDivisionFactor.The default value is 1.0 and the value range is 0.001 to 1000.0.

The effective multiplication and division factors are respectively reported byMultiplierDividerToolMultiplicationFactor and MultiplierDividerToolDivisionFactor.

Note: The effective values may slightly differ from the specified values. However, the RCR relative errorremains negligible (less than 1/1000).

117

Coaxlink Driver 7.0 Functional Guide   I/O Toolbox

Note: Frequency variations of the input event stream are reported to the output event stream with alatency of 1 period of the input event stream. Such a latency induces some phase errors in the outputevent stream. The phase of the output event stream accumulates retards when the input frequencyincreases and vice-versa when the input frequency increases. Consequently, the Multiplier/Divider isnot phase accurate.

Multiplier/Divider Tool Operating Limits

Characteristic Symbol Min Max

Rate Conversion Ratio RCR 0.001 1000

Input Rate fIN 0.1 Hz 5 MHz

Output Rate fOUT 0.1 Hz 5 MHz

Legend

0.1 Hz

100 kHz

10 kHz

1 kHz

100 Hz

1 Hz

10 Hz

0.1

Hz

1 M

Hz

100

kHz

10 k

Hz

1 kH

z

100

Hz

1 Hz

10 H

z

Output Rate

Input Rate

1 MHz

10 M

Hz

10 MHz

Lowest Output Rate

Recommended Operating Area

Transfer Funcon

Lowest

RCR

Highest

RCR

1

0.01

0.001

0.1

10

Rate co

nversi

on rao

1001000

5 M

HzHi

ghes

t Inp

ut R

ate

Low

est I

nput

Rat

e

Highest Output Rate5 MHz

Related Interface Module GenICam Feature(s)MultiplierDividerToolSelector on page 185Selects a Multiplier/Divider Tool

MultiplierDividerToolSource on page 186I/O Toolbox event stream used as input for the selected Multiplier/Divider Tool

MultiplierDividerToolOutputControl on page 187Output control of the selected Multiplier/Divider Tool

MultiplierDividerToolMultiplicationFactor on page 187Multiplication factor of the selected Multiplier/Divider Tool

MultiplierDividerToolDivisionFactor on page 188Division factor of the selected Multiplier/Divider Tool

MultiplierDividerToolEffectiveMultiplicationFactor on page 189

118

I/O Toolbox   Coaxlink Driver 7.0 Functional Guide

Effective multiplication factor of the selected Multiplier/Divider Tool

MultiplierDividerToolEffectiveDivisionFactor on page 189Effective division factor of the selected Multiplier/Divider Tool

Delay Tool

Tool Name ShortName Inputs Count/Type Outputs Count/Type/Name

Delay Tool DEL2 Toolbox event streams1 clock signal

2 Toolbox event stream: DEL<i>1, DEL<i>2

Delay Tool Wiring Diagram

Delay

In 1 Out 1 DEL<i>1

In 2 Out 2 DEL<i>2

Clock

I/O Toolbox EventsI/O Toolbox Events

LIN<any> QDC<any>TIME

8NS 200NS

1US

DelayToolSource1

DelayToolSource2

DelayToolClockSource

DelayToolDelayValue

Any I/O Toolbox event stream can be selected as the input 1 source.Any I/O Toolbox event stream can be selected as the input 2 source.The tool feeds two I/O Toolbox event streams. The outputs of the tool instance <i> are named DEL<i>1 and DEL<i>2.

Delay Tool OperationThe event streams applied on either inputs (In1 and In2) are replicated on the corresponding output (Out1 and Out2)aer a configurable number of clock tick events.The sources are selected by DelayToolSource1 and DelayToolSource2 respectively.The same delay applies to both channels. The common delay is defined by DelayToolDelayValue. The delayrange is 0 up to 16,777,215 clock ticks.The same clock source applies to both channels. The clock source is defined by DelayToolClockSource. It canbe a time baseor a line tool event stream.Selecting a time base implements a time delay function. The available time bases are:

• 8NS: A 125 MHz high accuracy regular time base allowing delays up to 134 milliseconds by steps of 8 ns• 200NS: A 5 MHz high accuracy regular time base allowing delays up to 3.35 seconds by steps of 200 ns• 1US: A 1 MHz high accuracy regular time base allowing delays up to 16.7 seconds by steps of 1 µs

Selecting a line tool event stream implements a position offset function when the line tool is fed by a motion encoderdevice. Any available Line Input tool or Quadrature Decoder tool can be used as delay clock source.

119

Coaxlink Driver 7.0 Functional Guide   I/O Toolbox

Important: The Delay tool operates as a delay line. The tool may accept a new event while the previousone is not yet delivered! The Delay tool is capable of recording, globally for all channels, up to 16 distinctevents.

Input

x

Output

A

Clock

A

Bx

B

C x

C

Dx

Da a

+ x

b b +

x

c c +

x

d d +

x

Clock Tick# x=5

Related Interface Module GenICam Feature(s)DelayToolSelector on page 197Selects a Delay Tool

DelayToolSource1 on page 198I/O Toolbox event stream used as input 1 for the selected Delay Tool

DelayToolSource2 on page 199I/O Toolbox event stream used as input 2 for the selected Delay Tool

DelayToolClockSource on page 200I/O Toolbox event stream used as clock

DelayToolDelayValue on page 200Delay value of the selected Delay Tool

120

General Purpose I/O Lines   Coaxlink Driver 7.0 Functional Guide

General Purpose I/O LinesSet of general purpose digital I/O linesRelated Interface Module GenICam Feature(s)DigitalIOControl Category on page 170

I/O Lines Types

Lines Type Electrical Style Frequencyrange

NamePrefix

Differential input lines RS-422 differential inputs Up to 5 MHz DIN

TTL input/output lines5 Volt-tolerant LVTTL single-ended input orLVTTL (totem-pole, open-emitter and open-collector) single-endedoutput

Up to 5 MHz TTLIO

Isolated input lines Isolated current-sense input compliant with 5 V, 12 V and 24 Vsignaling levels Up to 50 kHz IIN

Isolated output lines Isolated 100 mA/30V contact output Up to 50 kHz IOUT

Available I/O LinesI/O Line Set 1

The I/O Line Set 1 is composed of 10 I/O lines. It is available on:

• All Coaxlink PCIe products: Mono Duo Quad QuadG3 QuadG3DF

• The 3300 HD26F I/O module for Coaxlink Duo PCIe/104 optional accessory.

I/O Line Type I/O Line Names Count

Differential input DIN11, DIN12 2

TTL inputs/output TTLIO11, TTLIO12 2

Isolated input IIN11, IIN12, IIN13, IIN14 4

Isolated output IOUT11, IOUT12 2

I/O Line Set 2The I/O Line Set 2 is composed of 10 I/O lines.

It is available on a selection of Coaxlink products: Duo Quad QuadG3

I/O Line Type I/O Line Names Count

Differential input DIN21, DIN22 2

121

Coaxlink Driver 7.0 Functional Guide   General Purpose I/O Lines

I/O Line Type I/O Line Names Count

TTL inputs/output TTLIO21, TTLIO22 2

Isolated input IIN21, IIN22, IIN23, IIN24 4

Isolated output IOUT21, IOUT22 2

I/O Lines UsageInput Lines

The input-capable I/O lines (DIN, TTLIO, IN) can be used as:

• General purpose input: An input signal whose state can be read or monitored by the host application.• Motion encoder input: A pair of input signals delivered by a quadrature motion encoder and used for triggering the

acquisition from the camera.• Trigger input: An input signal used to trigger the acquisition from the camera.

Output LinesThe output-capable I/O lines (TTLIO, IOUT) can be used as:

• General purpose output: An output signal whose state can be set by the host application.• Strobe output: An output signal usually used to control a strobe light, in synchronization with the camera.• Camera trigger output (only available on TTLIO): An output signal generated by the Coaxlink card and used to trigger

the camera.

I/O Control BlocksEvery I/O line is controlled through one I/O control block.

Block DiagramsThere a 3 variations of the control block depending on the input/output capabilities of the I/O line:

I/O Port

Input Filter

LineInverter[x]

Input Inverter RawLineInput

Output Inverter

Rx

Tx

LineMode[x]

LineOutput

LineStatus[x]

LineSourcesLine Output Mux

LineSource[x] x = LineSelector

LineInputLineFormat[x]

LineFilterStrength[x]

Figure 4: I/O control block for bidirectional I/O lines

I/O Port Input Filter

LineInverter[x]

Input Inverter RawLineInput

LineFilterStrength[x]

Rx

LineMode[x]

LineStatus[x]

x = LineSelector

LineInput

LineFormat[x]

Figure 5: I/O control block for input-only I/O lines

122

General Purpose I/O Lines   Coaxlink Driver 7.0 Functional Guide

I/O Port

LineInverter[x]

Output InverterTx

LineMode[x] LineStatus[x]

LineSourcesLine Output MuxLineOutput

LineSource[x]x = LineSelector

LineFormat[x]

Figure 6: I/O control block for output-only I/O lines

Note: In the above drawings:

• A thin blue line represents one individual electrical signal path• A thick blue line represents a collection of electrical signal paths• The blue arrowhead shows the propagation direction of the electrical signal(s)• A blue shape represents a functional element of the I/O control block• An orange (oval) shape represents a GenICam feature; the text inside being the feature name• An [x] appended to the feature name indicates that the feature is associated with a selector feature

(in this case: LineSelector)• The orange arrowhead indicates the access-mode of the feature: read-only features having incoming

arrows, writable features having an outgoing arrow.

Input PathInput-only and bidirectional I/O lines share a common input path structure including:

• The I/O port block representing the I/O pins on the I/O connector(s)• The Rx block representing the line receiver circuit• The Input Inverter block representing the user-configurable logic inverter• The Input Filter block representing the user-configurable glitch-removal filter

Output PathOutput-only and bidirectional I/O lines share a common output path structure including:

• The I/O port block representing the I/O pins on the I/O connector(s)• The Tx block representing the line driver circuit• The Output Inverter block representing the user-configurable logic inverter• The Line Output Mux block representing the user-configurable source multiplexer

Related Interface Module GenICam Feature(s)LineSelector on page 171Selects a physical I/O line

LineFormat on page 172Electrical style of the selected I/O line

LineMode on page 172Direction and line driver of the selected I/O line

LineInverter on page 173Inversion of the selected I/O line

LineFilterStrength on page 173Strength of the glitch removal filter of the selected I/O line

LineFilterDelay on page 174Delay introduced by the glitch removal filter of the selected I/O line

LineStatus on page 174Current status of the selected I/O line

LineStatusAll on page 175

123

Coaxlink Driver 7.0 Functional Guide   General Purpose I/O Lines

Current state of all available line signals at time of polling in a single bit field

LineSource on page 176Internal signal sourcing the output of the selected I/O line

Line Mode ControlFor all the I/O lines, the LineMode feature reports the configuration of the I/O port.Only the TTL I/O lines have a user-configurable line mode.A TTLIO can operate as an input or as an output.When used as input, no configuration is required since at power-up all TTLIO ports are configured as Inputs.When used as output, the user has the choice between 3 configurations of the line driver. The line driver can beconfigured in 3 ways:

• As a totem-pole driver capable of driving low and high.• As an open-collector driver capable of driving low only• As an open-emitter driver capable of driving high only.

The two latest configurations allows wired-AND configurations.

I/O Lines Specifics

Line Selector Bit# Line Format Line Mode

DIN11 0 DIFF Input

DIN12 1 DIFF Input

DIN21 2 DIFF Input

DIN22 3 DIFF Input

IIN11 4 ISO Input

IIN12 5 ISO Input

IIN13 6 ISO Input

IIN14 7 ISO Input

IIN21 8 ISO Input

IIN22 9 ISO Input

IIN23 10 ISO Input

IIN24 11 ISO Input

IOUT11 12 ISO Output

IOUT12 13 ISO Output

IOUT21 14 ISO Output

IOUT22 15 ISO Output

TTLIO11 16 TTL Input, Output, DriveLow or DriveHigh

TTLIO12 17 TTL Input, Output, DriveLow or DriveHigh

124

General Purpose I/O Lines   Coaxlink Driver 7.0 Functional Guide

Line Selector Bit# Line Format Line Mode

TTLIO21 18 TTL Input, Output, DriveLow or DriveHigh

TTLIO22 19 TTL Input, Output, DriveLow or DriveHigh

The above table summarizes the details of the I/O Control blocks of each I/O line:

• The first column indicates the LineSelector value• The second column indicates the bit position in the integer value reported by LineStatusAll• The third column indicates the value reported by LineFormat• The fourth column indicates the values that can be assigned to LineMode

Note: Check the Available I/O Lines on page 121 for applicable values.

Line Polarity ControlAll the I/O lines are fitted with a polarity control. For bidirectional I/O lines, a single control affects equally both paths.The line polarity is user-configurable through the LineInverter control.

Note: The user is invited to set the polarity control according to the polarity of the external signal insuch a way that the Line Input signals of the input path and the LineSources signals of the output pathare always using positive logic.

Filter ControlAll the I/O input lines are fitted with a glitch-removal filter. The filter strength is user-configurable through theLineFilterStrength control.The strength control provides 5 positions from 'Lowest' to 'Highest'. The default position is 'Low'.Each position corresponds to a specific filter time constant for each of the 3 I/O input line types:

Line Filter Time Constant per I/O input line type and LineFilterStrength

LineFilterStrength Differential inputs (DIN) TTL inputs (TTLIO) Isolated Inputs (IIN)

Lowest 50 ns 50 ns 500 ns

Low 100 ns 100 ns 1 µs

Medium 200 ns 200 ns 2 µs

High 500 ns 500 ns 5 µs

Highest 1 µs 1 µs 10 µs

The user is invited to set the filter strength according to the quality of the external signal. Select a filter strength suchthat its time constant is:

• Greater than the longest glitch duration• Greater than the 10%~90% rise/fall time of the signal• At least 2 times smaller than the smallest signal pulse duration

The glitch removal filter introduces a latency into the input signal path. The latency is equal to the filter time constantwhen the incoming signal has clean transitions. The latency may increase significantly in case of bad quality signals.

125

Coaxlink Driver 7.0 Functional Guide   General Purpose I/O Lines

Line Source SelectionAny output-capable I/O lines is fitted with a source signal multiplexer.The source signal multiplexers implement a fully-populated signal routing matrix allowing a selection of internalsignals to be routed to any output lines.

Selecting a signal sourceTo select an internal signal to be used as signal source for the line driver of an output capable I/O line:

• Step1: Select an I/O line by assigning the appropriate value to the LineSelector feature• Step2: Assign the appropriate value to the SignalSource feature

Output-lines routing matrix

Source Signal Possible destinations

Any Bit of the User Output Register Any output line

Any Device Module Camera Trigger Output Any TTLIO output line

Any Device Module Strobe Output Any output line

Steady Low Any output line

Logical I/O Line State

Logical I/O line stateThe (logical) state of an I/O line is the logical state of an electrical signal of the I/O control block:

• For input-capable I/O lines: the LineInput signal: a point in the input path of the I/O control block that is locatedaer the Input Inverter.

• For output-only I/O lines: the LineOutput signal, a point in the output path of the I/O control block that is locatedbefore the Output Inverter.

Getting the state of a single I/O line• Step1: Select an I/O line by assigning the appropriate value to the LineSelector feature• Step2: Obtain directly the line status by getting the value of the LineStatus feature

Getting the state of all I/O lines in a single operationGet the value of the LineStatusAll feature.

Each bit of the integer corresponds to an I/O line. A bit at one corresponds to a line logical state being high.

126

General Purpose I/O Lines   Coaxlink Driver 7.0 Functional Guide

Physical I/O Line StateThe physical state of the I/O line state does not only depend on the value reported when reading LineStatus butalso on the following I/O block settings: LineFormat, LineMode, and LineInverter

LineFormat LineMode LineInverter/LineStatus Physical I/O line state

False/False or True/True (VIN+ - VIN-) < VThreshold

DIFF InputFalse/True or True/False

(VIN+ - VIN-) > VThreshold orunconnected I/O line

False/False or True/True

Opto coupler is OFF. The line current is <1 mA.

Line may be left unconnected orconnected with the wrong polarity.ISO Input

False/True or True/FalseOpto coupler is ON. The line current is >1 mA.

False/False or True/True Opto coupler is OFFISO Output

False/True or True/False Opto coupler is ON

False/False or True/True The line voltage is < 0.8 Volt.TTL Input

False/True or True/False The line voltage is > 2.0 Volt.

False/False or True/True The line is driven LOW.TTL Output

False/True or True/False The line is driven HIGH.

False/False or True/True The line is driven LOW.TTL DriveLow

False/True or True/False The line voltage is > 2.0 Volt.

False/False or True/True The line voltage is < 0.8 Volt.TTL DriveHigh

False/True or True/False The line is driven HIGH.

Line Driver Physical Output StatesThe line driver output state depends not only on the logical level of the selected Line Output signal but also on thefollowing I/O block settings: LineFormat, LineMode, and LineInverter.

LineFormat LineMode LineInverter / LineOutput logicallevel Line driver output state

False / low or True / high The opto-coupler switch is turned OFF.ISO Output

False / high or True / low The opto-coupler switch is turned ON.

False / low or True / high The I/O line is driven LOW.TTL Output

False / high or True / low The I/O line is driven HIGH.

TTL DriveLow False / low or True / high The I/O line is driven LOW.

127

Coaxlink Driver 7.0 Functional Guide   General Purpose I/O Lines

LineFormat LineMode LineInverter / LineOutput logicallevel Line driver output state

False / high or True / low The I/O line is not driven.

False / low or True / high The I/O line is not driven.TTL DriveHigh

False / high or True / low The I/O line is driven HIGH.

Initial StatesAt power-on, the I/O lines are in the following state:

Differential InputsLineInverter = FalseLineFilterStrength = Low

TTL Inputs/outputsLineMode = Input (The line is not driven)LineInverter = FalseLineFilterStrength = Low

Isolated InputsLineInverter = FalseLineFilterStrength = Low

Isolated OutputsLineInverter = FalseLineFilterStrength = LowThe opto-coupler is OFF.

128

Event Signaling And Counting   Coaxlink Driver 7.0 Functional Guide

Event Signaling And CountingExtensive user-configurable event-reporting and event-counting mechanismRelated Interface Module GenICam Feature(s)EventControl Category on page 214Related Device Module GenICam Feature(s)EventControl Category on page 251Related Data Stream Module GenICam Feature(s)EventControl Category on page 298

Short DescriptionCoaxlink products feature a powerful event management that allows the application to be notified of the occurrenceof various events.In addition to the GenTL standard EVENT_NEW_BUFFER event, the Coaxlink GenTL producer provide a wide set ofcustom event sources. The event sources are grouped by types according to the function block and the GenTL modulethey belong to.Each custom event source is associated with a counter that counts the number of occurrences.For each notified custom event, the following event context data is recorded and made available to the application:

• Identifier of the event source

• Time stamp (expressed in microseconds)• 3 user-defined context data

Each individual event source is configurable:

• The event notification can enabled or disabled.• The content of each user-defined context data.

Event data are temporarily stored in the Event Queue Buffer. The Coaxlink Driver is notified, using an interruptionmechanism, of the availability of one or more event entries in the Coaxlink Event Queue Buffer.The Coaxlink Driver implements the GenTL signaling mechanism for reporting the occurrence of asynchronous eventsto the application soware.The EGrabber API provides 3 callback threading models:

• CallbackOnDemand: This is the simplest model which gives complete control over when and how callbacks areinvoked. Events are processed on demand.

• CallbackSingleThread: This model delivers events to callbacks in their chronological order, sequentially, in adedicated thread context. Events are processed automatically as soon as they are available.

• CallbackMultiThread: This model delivers events to callbacks in separate threads (one thread per event DATA type).Events are processed automatically as soon as they are available.

About GenTL SignalingThe Coaxlink Driver implements the Signaling mechanism of a GenTL Provider.This mechanism is briefly described hereaer. For an extensive description, refer to section 4.2 starting on page 34 ofthe GenICam GenTL Standard Version 1.4.

129

Coaxlink Driver 7.0 Functional Guide   Event Signaling And Counting

Event RegistrationSource: GenTL specification

Before the GenTL Consumer can be informed about an event, the event object must be registered. Aer a moduleinstance has been created in the enumeration process an event object can be created with the GCRegisterEvent()function. This function returns a unique EVENT_HANDLE which identifies the registered event object. To getinformation about a registered event the EventGetInfo() function can be used.There must be only one event registered per module and event type.(…)Aer an EVENT_HANDLE is obtained the GenTL Consumer can wait for the event object to be signaled by calling theEventGetData() function. Upon delivery of an event, the event object carries data. This data is copied into a GenTLConsumer provided buffer when the call to EventGetData() was successful.

Notification and Data RetrievalSource: GenTL specification

If the event object is signaled, data was put into the event data queue at some point in time. The EventGetData()function can be called to retrieve the actual data.(…)When data is read with this function the data is removed from the queue. Aerwards the GenTL Producerimplementation checks whether the event data queue is empty or not. If there is more data available the event objectstays signaled and next the call to EventGetData() will deliver the next queue entry. Otherwise the event object is resetto not signaled state.(…)The exact type of data is dependent on the event type and the GenTL Producer implementation. The data iscopied into a user buffer allocated by the GenTL Consumer. The content of the event data can be queried with theEventGetDataInfo() function. The maximum size of the buffer to be filled is defined by the event type and can bequeried using EVENT_INFO_DATA_SIZE_MAX aer the buffer is delivered. This information can be queried using theEventGetInfo() function.

Event TypesList of standard and custom GenTL event types

GenTL identifies the events according to their Type and their relevant object Module.Standard Event TypesThe Coaxlink Driver implements the following standard event type for registration by the GenTL Consumer application:

GenTL Standard Event Type GenTL Module Description

EVENT_NEW_BUFFER Data Stream Notification on newly filled buffers.

Custom Event TypesBeside the standard event types, the GenTL specification provides room for custom event types. Custom event typesare specific to the GenTL Producer implementation (Coaxlink Driver in this case).The Coaxlink Driver implements the following custom event types for registration by the GenTL Consumer application:

Event Type Module Description

EVENT_CUSTOM_IO_TOOLBOX Interface (Device) Notification of I/O Toolbox events

130

Event Signaling And Counting   Coaxlink Driver 7.0 Functional Guide

Event Type Module Description

EVENT_CUSTOM_CXP_INTERFACE Interface (Device) Notification of CoaXPress Host Interface events

EVENT_CUSTOM_CIC Device Notification of Camera and Illumination Control events

EVENT_CUSTOM_DATASTREAM Data Stream Notification of CoaXPress data stream events

Note: The EVENT_CUSTOM_IO_TOOLBOX and the EVENT_CUSTOM_CXP_INTERFACE eventtypes can also be registered on a Device Module.

Note: The custom event types are generic; each one gathers multiple event sources.

Custom Events SourcesList of all available custom event sources grouped by custom event types

EVENT_CUSTOM_IO_TOOLBOX

EVENT_CUSTOM_IO_TOOLBOX event sources

Event Source Description

IO_TOOLBOX_LIN1 Line Input Tool 1 – Event output

IO_TOOLBOX_LIN2 Line Input Tool 2 – Event output

IO_TOOLBOX_LIN3 Line Input Tool 3 – Event output

IO_TOOLBOX_LIN4 Line Input Tool 4 – Event output

IO_TOOLBOX_LIN5 Line Input Tool 5 – Event output

IO_TOOLBOX_LIN6 Line Input Tool 6 – Event output

IO_TOOLBOX_LIN7 Line Input Tool 7 – Event output

IO_TOOLBOX_LIN8 Line Input Tool 8 – Event output

IO_TOOLBOX_QDC1 Quadrature Decoder Tool 1 – Event output

IO_TOOLBOX_QDC1_DIR Quadrature Decoder Tool 1 – Changed direction

IO_TOOLBOX_QDC2 Quadrature Decoder Tool 2 – Event output

IO_TOOLBOX_QDC2_DIR Quadrature Decoder Tool 2 – Changed Direction

IO_TOOLBOX_DIV1 Divider Tool 1 – Event output

IO_TOOLBOX_DIV2 Divider Tool 2 – Event output

IO_TOOLBOX_MDV1 Multiplier/Divider Tool 1 – Event output

IO_TOOLBOX_MDV2 Multiplier/Divider Tool 2 – Event output

IO_TOOLBOX_DEL11 Delay Tool 1 Output 1 – Event output

IO_TOOLBOX_DEL12 Delay Tool 1 Output 2 – Event output

IO_TOOLBOX_DEL21 Delay Tool 2 Output 1 – Event output

131

Coaxlink Driver 7.0 Functional Guide   Event Signaling And Counting

Event Source Description

IO_TOOLBOX_DEL22 Delay Tool 2 Output 2 – Event output

IO_TOOLBOX_USER_EVENT_1 User Event 1

IO_TOOLBOX_USER_EVENT_2 User Event 2

IO_TOOLBOX_USER_EVENT_3 User Event 3

IO_TOOLBOX_USER_EVENT_4 User Event 4

IO_TOOLBOX_EIN1 Event Input Tool 1 – Event output

IO_TOOLBOX_EIN2 Event Input Tool 2 – Event output

This event type belongs to the Interface Module, it gathers all the event sources located inside the I/O Toolbox.All the event outputs of all the I/O Toolbox tools are available as event sources.

Note: Check the I/O Toolbox Composition on page 108 for applicable values

EVENT_CUSTOM_CXP_INTERFACE

Event Source Description

CXP_INTERFACE_CRC_ERROR_CXP_AA CRC error is detected on the Connection A of the CoaXPressHost Interface.

CXP_INTERFACE_CRC_ERROR_CXP_BA CRC error is detected on the Connection B of the CoaXPressHost Interface.

CXP_INTERFACE_CRC_ERROR_CXP_CA CRC error is detected on the Connection C of the CoaXPressHost Interface.

CXP_INTERFACE_CRC_ERROR_CXP_DA CRC error is detected on the Connection A of the CoaXPressHost Interface.

This event type belongs to the Interface Module, it gathers all the event sources located inside the CoaXPress HostInterface.

EVENT_CUSTOM_CIC

EVENT_CUSTOM_CIC event sources

Event Source Description

CIC_CAMERA_TRIGGER_RISING_EDGERising edge of the Camera Trigger output signal

(Start of Exposure in RC and RG camera control methods)

CIC_CAMERA_TRIGGER_FALLING_EDGEFalling edge of the Camera Trigger output signal

(End of Exposure in RG camera control method)

CIC_STROBE_RISING_EDGE Rising edge of the Strobe output signal

CIC_STROBE_FALLING_EDGE Falling edge of the Strobe output signal

CIC_ALLOW_NEXT_CYCLE A new camera cycle is allowed to start immediately.

CIC_DISCARDED_CIC_TRIGGER A CIC cycle trigger is discarded.

132

Event Signaling And Counting   Coaxlink Driver 7.0 Functional Guide

Event Source Description

CIC_PENDING_CIC_TRIGGERA CIC cycle trigger is recorded, but its execution is delayeduntil CIC is ready.

CIC_CXP_TRIGGER_ACKA positive acknowledgment is received in response to aCoaXPress Host to Device Trigger Message.

CIC_CXP_TRIGGER_RESENDA resent of the CoaXPress Host to Device Trigger Message isexecuted.

CIC_TRIGGER CIC trigger

This event type belongs to the Device Module, it gathers all the event sources located inside the Camera andIllumination Controller.

Note: There is one Camera and Illumination Controller instance per GenTL Device Module. The numberof GenTL Device Modules per Coaxlink card is defined by the firmware-variant.

EVENT_CUSTOM_DATASTREAM

Event Source Description

DATASTREAM_START_OF_CAMERA_READOUTThe first pixel data of an image frame is written into the on-board FIFO Buffer.

Applies to area-scan firmware variants only.

DATASTREAM_END_OF_CAMERA_READOUTThe last pixel data of an image frame is written into the on-board FIFO Buffer.

Applies to area-scan firmware variants only.

DATASTREAM_START_OF_SCANThe first pixel data of an image scan is written into the on-board FIFO Buffer.

Applies to line-scan firmware variants only.

DATASTREAM_END_OF_SCANThe last pixel data of an image scan is written into the on-board FIFO Buffer.

Applies to line-scan firmware variants only.

DATASTREAM_REJECTED_FRAMEAn image frame is rejected (On-board FIFO Buffer is full)

Applies to area-scan firmware variants only.

DATASTREAM_REJECTED_SCANAn image scan is rejected (On-board FIFO Buffer is full)

Applies to line-scan firmware variants only.

This event type belongs to the Data Stream Module, it gathers all the event sources located inside the Image AcquisitionController.

Custom Events CounterCounter associated with every custom event

A 32-bit counter is associated with every custom event source.The counter cannot be disabled. When it reaches its maximum value, 4 294 967 295 (232 - 1), it wraps around to 0.At any time, the user application can:

133

Coaxlink Driver 7.0 Functional Guide   Event Signaling And Counting

• Reset the counter.• Read the count value.

The count-value can also be used as user-defined context data by any event source.

Custom Events ConfigurationConfiguring the notification filter and the context data of custom event sources

Each individual event source is configurable:

• The event notification can enabled or disabled.• The content of each user-defined context data.

Event Notification FilterBy default, all notifications are disabled.The application soware must configure the event notification filter according the application needs.The configuration of the notification filter configuration can be modified at any time without interfering with the eventcounting function.

User-defined Event Context DataThe last 3 32-bit context data words of the event context data can be configured as follows:

• Event-specific data.• State of all I/O lines sampled at the event occurrence time• Count value of any event counter.

Event Specific Context DataContext data that is available only for a selected set of custom events

EVENT_DATA_NUMID_CIC_DISCARDED_CIC_TRIGGERValue of EventSpecific for EVENT_DATA_NUMID_CIC_DISCARDED_CIC_TRIGGER is a bitfield that can be interpretedaccording to the following definitions:

Bit# Description

0 Cause: image buffer is full.

1 Cause: camera cycle not complete.

2 Cause: maximum number of pending triggers already reached.

3 Cause: data stream is not active

134

Event Signaling And Counting   Coaxlink Driver 7.0 Functional Guide

EVENT_DATA_NUMID_CIC_PENDING_CIC_TRIGGERValue of EventSpecific for EVENT_DATA_NUMID_CIC_PENDING_CIC_TRIGGER is a bitfield that can be interpretedaccording to the following definitions:

Bit# Description

0 Cause: image buffer is full.

1 Cause: camera cycle not complete

EVENT_DATA_NUMID_DATASTREAM_START_OF_SCANValue of EventSpecific for EVENT_DATA_NUMID_DATASTREAM_START_OF_SCAN is a bitfield that can be interpretedaccording to the following definitions:

Bit# Description

1 Cause:soware trigger.

2 Cause: hardware trigger

3 Cause: DSStartAcquisition or end of previous scan

EVENT_DATA_NUMID_DATASTREAM_END_OF_SCANValue of EventSpecific for EVENT_DATA_NUMID_DATASTREAM_END_OF_SCAN is a bitfield that can be interpretedaccording to the following definitions:

Bit# Description

1 Cause:soware trigger.

2 Cause: hardware trigger

3 Cause: Cause: reached scan length

4 Cause: DSStopAcquisition

5 Cause: internal exception (image buffer almost full)

EVENT_DATA_NUMID_DATASTREAM_REJECTED_FRAMEValue of EventSpecific for EVENT_DATA_NUMID_DATASTREAM_REJECTED_FRAME is a bitfield that can be interpretedaccording to the following definitions:

Bit# Description

0 Cause: image buffer is full.

1 Cause: data stream is not active

Event Control GenICam Features (Interface)Related Interface Module GenICam Feature(s)EventSelector on page 214

135

Coaxlink Driver 7.0 Functional Guide   Event Signaling And Counting

Select an event

EventNotification on page 215Activate or deactivate the notification to the host application of the occurrence of the selected event

EventNotificationContext1 on page 216Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_1

EventNotificationContext2 on page 217Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_2

EventNotificationContext3 on page 218Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_3

EventCount on page 219Number of occurrences of the selected event (32-bit counter)

EventCountReset on page 219Reset the selected EventCount

Event Control GenICam Features (Device)Related Device Module GenICam Feature(s)EventSelector on page 252Select an event

EventNotification on page 253Activate or deactivate the notification to the host application of the occurrence of the selected event

EventNotificationContext1 on page 253Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_1

EventNotificationContext2 on page 255Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_2

EventNotificationContext3 on page 256Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_3

EventCount on page 258Number of occurrences of the selected event (32-bit counter)

EventCountReset on page 258Reset the selected EventCount

Event Control GenICam Features (Data Stream)Related Data Stream Module GenICam Feature(s)EventSelector on page 299Select an event

EventNotification on page 300Activate or deactivate the notification to the host application of the occurrence of the selected event

EventNotificationContext1 on page 300Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_1

EventNotificationContext2 on page 302Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_2

EventNotificationContext3 on page 303

136

Event Signaling And Counting   Coaxlink Driver 7.0 Functional Guide

Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_3

EventCount on page 305Number of occurrences of the selected event (32-bit counter)

EventCountReset on page 305Reset the selected EventCount

137

Coaxlink Driver 7.0 Functional Guide   OEM Safety Key

OEM Safety KeyUser-configurable safety key programming and checking capability

The OEM Safety Key capability allows the application to:

• Program an "OEM safety key" in the non-volatile memory of the Coaxlink card.• Retrieve the encrypted version of the OEM safety key just programmed.• Check a key against the programmed OEM safety key or its encrypted version.

OEM Safety KeyThe OEM Safety Key is an application-defined string of characters. Any character except the null character is allowed.The string length is unlimited.

Key ProgrammingWhen the application sets the ProgramOemSafetyKey GenICam feature with the OEM Safety Key value, theCoaxlink Driver computes an encrypted version of the OEM Safety Key and stores it in the non-volatile memory of theCoaxlink card.The encrypted value can be retrieved by getting the value of EncryptedOemSafetyKey immediately aer havingset ProgramOemSafetyKey.

Important: Only the same application process having set ProgramOemSafetyKey is allowed toretrieve the encrypted value. This is only allowed until any other GenICam feature is set.

Key CheckingThe application has to select one OemSafetyKeyVerification value of theIn order to verify the OEM Safety Key of a Coaxlink card, the application sets a "challenge" value to theCheckOemSafetyKey[selector] feature.When the [selector] argument is set to EncryptedKey, the set action terminates normally only when the challengestring is identical to the encrypted OEM Safety Key string.When the [selector] argument is set to ProgrammingKey, the set action terminates normally only when the challengestring is identical to the programming OEM Safety Key string.When the [selector] argument is set to ProgrammingKeyOrEncryptedKey, or omitted, the set action terminatesnormally only when the challenge string is identical to the original OEM Safety Key string or to the encrypted OEMSafety Key string.Euresys recommends using the EncryptedKey selector. This improves the security level since the programming keydoesn't need to appear anywhere in the end user application. Having only the encrypted key, the end user cannotretrieve the original programming key.Related Interface Module GenICam Feature(s)OemSafetyKey Category on page 220OemSafetyKeyVerification on page 220Defines which key can be compared with the programmed OEM safety key

CheckOemSafetyKey on page 221Write-only string to use for comparing a key (c.f. OemSafetyKeyVerification) and the programmed OEM safetykey

ProgramOemSafetyKey on page 221Write-only string to use for programming the non-volatile OEM safety key

EncryptedOemSafetyKey on page 222

138

OEM Safety Key   Coaxlink Driver 7.0 Functional Guide

Read-only string that contains the encrypted version of the OEM safety key just programmed withProgramOemSafetyKey

Using OEMSafetyKeyHow to program and verify the OEM Safety Key

Programming Step – Option AUsing GenICam Browser:

• Go to the GenApi tab of the interface module.• Write a secret key to ProgramOemSafetyKey• Copy the value of EncryptedOemSafetyKey and paste it somewhere appropriate.

Note: There is a direct relationship between the programming key and the encrypted key. A givenprogramming key will always lead to the same encrypted key, even on different computers or withdifferent Coaxlink cards. This makes it possible to read the encrypted key once and hard-code this valuein the application that must be protected by the OEM safety key.

Programming Step – Option BUsing a custom application:

1. Program the OEM safety key of the Coaxlink card by writing a secret key to ProgramOemSafetyKey.2. Read back the encrypted key by reading EncryptedOemSafetyKey. Write this value somewhere appropriate.grabber.set<InterfacePort>("ProgramOemSafetyKey","plain-text key"); // 1std::stringencryptedKey=grabber.get<InterfacePort>("EncryptedOemSafetyKey"); // 2

Verification StepIn the application that must be protected by the OEM key:InterfacePort>("CheckOemSafetyKey[EncryptedKey]", "encrypted key retrieved in the programming step");

Note: Even if the encrypted key is discovered and an attacker uses it to reprogram cards, the aboveverification will fail.

139

Coaxlink Driver 7.0 Functional Guide   System Module Features

System Module FeaturesCategorized list of System GenTL module features

Root CategoryCategory Members

SystemInformation on page 140InterfaceEnumeration on page 140

SystemInformation

Feature Info

Module Category Path Type Access

System Root Category RW

Parent Category: Root Category on page 140

Category Members• TLVendorName on page 141• TLModelName on page 141• TLID on page 142• TLVersion on page 142• TLPath on page 142• TLType on page 143• GenTLVersionMajor on page 143• GenTLVersionMinor on page 144

InterfaceEnumeration

Feature Info

Module Category Path Type Access

System Root Category RW

Parent Category: Root Category on page 140

140

System Module Features   Coaxlink Driver 7.0 Functional Guide

Category Members• InterfaceUpdateList on page 144• InterfaceSelector on page 145• InterfaceID on page 145

SystemInformation CategoryCategory Members

TLVendorName on page 141TLModelName on page 141TLID on page 142TLVersion on page 142TLPath on page 142TLType on page 143GenTLVersionMajor on page 143GenTLVersionMinor on page 144

TLVendorNameName of the GenTL Producer vendor

Feature Info

Module Category Path Type Access

System Root / SystemInformation String Imposed: RO

Parent Category: SystemInformation Category on page 141

Short DescriptionName of the GenTL Producer vendor.

TLModelNameName of the GenTL Producer

Feature Info

Module Category Path Type Access

System Root / SystemInformation String Imposed: RO

Parent Category: SystemInformation Category on page 141

141

Coaxlink Driver 7.0 Functional Guide   System Module Features

Short DescriptionName of the GenTL Producer.

TLIDUnique identifier of the GenTL

Feature Info

Module Category Path Type Access

System Root / SystemInformation String Imposed: RO

Parent Category: SystemInformation Category on page 141

Short DescriptionUnique identifier of the GenTL.

TLVersionVendor specific version string

Feature Info

Module Category Path Type Access

System Root / SystemInformation String Imposed: RO

Parent Category: SystemInformation Category on page 141

Short DescriptionVendor specific version string.

TLPathPath to the GenTL Producer driver

Feature Info

Module Category Path Type Access

System Root / SystemInformation String Imposed: RO

Parent Category: SystemInformation Category on page 141

142

System Module Features   Coaxlink Driver 7.0 Functional Guide

Short DescriptionFull path to the GenTL Producer driver including name and extension.

TLTypeIdentifies the transport layer technology of the GenTL Producer implementation

Feature Info

Module Category Path Type Access

System Root / SystemInformation Enumeration Imposed: RO

Parent Category: SystemInformation Category on page 141

Short DescriptionIdentifies the transport layer technology of the GenTL Producer implementation.

Enumeration Values• CXP: This enumeration value indicates CoaXPress transport layer technology.

GenTLVersionMajorMajor version number of the GenTL specification the GenTL Producer implementation complies with

Feature Info

Module Category Path Type Access

System Root / SystemInformation IntReg RO

Parent Category: SystemInformation Category on page 141Register Port: TLPort

Short DescriptionMajor version number of the GenTL specification the GenTL Producer implementation complies with.

143

Coaxlink Driver 7.0 Functional Guide   System Module Features

GenTLVersionMinorMinor version number of the GenTL specification the GenTL Producer implementation complies with

Feature Info

Module Category Path Type Access

System Root / SystemInformation IntReg RO

Parent Category: SystemInformation Category on page 141Register Port: TLPort

Short DescriptionMinor version number of the GenTL specification the GenTL Producer implementation complies with.

InterfaceEnumeration CategoryCategory Members

InterfaceUpdateList on page 144InterfaceSelector on page 145InterfaceID on page 145

InterfaceUpdateListUpdates the internal interface list

Feature Info

Module Category Path Type Access

System Root / InterfaceEnumeration Command RW

Parent Category: InterfaceEnumeration Category on page 144

Short DescriptionUpdates the internal interface list.

144

System Module Features   Coaxlink Driver 7.0 Functional Guide

InterfaceSelectorSelector for the different GenTL Producer interfaces

Feature Info

Module Category Path Type Access

System Root / InterfaceEnumeration Integer RW

Parent Category: InterfaceEnumeration Category on page 144

Value InfoMinimum value: 0

Short DescriptionSelector for the different GenTL Producer interfaces.

Selected Features• InterfaceID on page 145

InterfaceIDGenTL Producer wide unique identifier of the selected interface

Feature Info

Module Category Path Type Access

System Root / InterfaceEnumeration String Imposed: RO

Parent Category: InterfaceEnumeration Category on page 144

Short DescriptionGenTL Producer wide unique identifier of the selected interface.

145

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

Interface Module FeaturesCategorized list of Interface GenTL module features

Root CategoryCategory Members

InterfaceInformation on page 146DeviceEnumeration on page 147CoaXPress on page 147DigitalIOControl on page 148UserOutputRegister on page 148IOToolbox on page 149PCIExpress on page 150InterfaceControl on page 150InterfaceDetails on page 151EventControl on page 151OemSafetyKey on page 152

InterfaceInformation

Feature Info

Module Category Path Type Access

Interface Root Category RW

Parent Category: Root Category on page 146

Category Members• InterfaceID on page 152• InterfaceType on page 153• SerialNumber on page 153• PartNumber on page 153• FirmwareRevision on page 154• FirmwareVariant on page 154• FirmwareStatus on page 154• FirmwareRecoverySwitch on page 155

146

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

DeviceEnumeration

Feature Info

Module Category Path Type Access

Interface Root Category RW

Parent Category: Root Category on page 146

Category Members• DeviceUpdateList on page 156• DeviceSelector on page 156• DeviceID on page 157• DeviceVendorName on page 157• DeviceModelName on page 157• DeviceAccessStatus on page 158

CoaXPress

Feature Info

Module Category Path Type Access

Interface Root Category RW

Parent Category: Root Category on page 146

Category Members• CxpPoCxpHostConnectionSelector on page 159• CxpPoCxpAuto on page 160• CxpPoCxpTurnOff on page 160• CxpPoCxpTripReset on page 161• CxpPoCxpConfigurationStatus on page 161• CxpPoCxpStatus on page 162• CxpPoCxpCurrent on page 162• CxpPoCxpVoltage on page 163• CxpPoCxpPowerInputStatus on page 163• CxpHostConnectionCount on page 164• CxpHostConnectionSelector on page 164• CxpConnectionState on page 165• CxpDownConnectionSpeed on page 165• CxpDeviceConnectionID on page 166• CxpHostConnectionTestMode on page 167• CxpHostConnectionTestErrorCount on page 168

147

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

• CxpHostConnectionTestPacketCount on page 168• CxpHostConnectionTestInjectError on page 169• CxpRevisionSelector on page 169• CxpRevisionSupport on page 170

DigitalIOControl

Feature Info

Module Category Path Type Access

Interface Root Category RW

Parent Category: Root Category on page 146

Category Members• LineSelector on page 171• LineFormat on page 172• LineMode on page 172• LineInverter on page 173• LineFilterStrength on page 173• LineFilterDelay on page 174• LineStatus on page 174• LineStatusAll on page 175• LineSource on page 176

UserOutputRegister

Feature Info

Module Category Path Type Access

Interface Root Category RW

Parent Category: Root Category on page 146

Category Members• UserOutputValueAll on page 177• UserActions on page 178• AddUserAction on page 178• ClearUserActions on page 179• ExecuteUserActions on page 180• ScheduleUserActions on page 180• UserActionsSchedulerReference on page 181• ScheduledUserActionsPoolStatus on page 181• DiscardScheduledUserActions on page 182

148

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

IOToolbox

Feature Info

Module Category Path Type Access

Interface Root Category RW

Parent Category: Root Category on page 146

Category Members• LineInputToolSelector on page 183• LineInputToolSource on page 184• LineInputToolActivation on page 185• MultiplierDividerToolSelector on page 185• MultiplierDividerToolSource on page 186• MultiplierDividerToolOutputControl on page 187• MultiplierDividerToolMultiplicationFactor on page 187• MultiplierDividerToolDivisionFactor on page 188• MultiplierDividerToolEffectiveMultiplicationFactor on page 189• MultiplierDividerToolEffectiveDivisionFactor on page 189• QuadratureDecoderToolSelector on page 190• QuadratureDecoderToolSources on page 190• QuadratureDecoderToolActivation on page 191• QuadratureDecoderToolForwardDirection on page 192• QuadratureDecoderToolOutputMode on page 192• QuadratureDecoderToolPosition on page 193• QuadratureDecoderToolDirection on page 193• QuadratureDecoderToolPositionReset on page 194• DividerToolSelector on page 194• DividerToolSource on page 195• DividerToolEnableControl on page 196• DividerToolDivisionFactor on page 196• DividerToolInitialOffset on page 197• DelayToolSelector on page 197• DelayToolSource1 on page 198• DelayToolSource2 on page 199• DelayToolClockSource on page 200• DelayToolDelayValue on page 200• EventInputToolSelector on page 201• EventInputToolSource on page 202• EventInputToolActivation on page 202• InternalTime on page 203

149

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

PCIExpress

Feature Info

Module Category Path Type Access

Interface Root Category RW

Parent Category: Root Category on page 146

Category Members• PCIeMaxPayloadSizeSupported on page 203• PCIeMaxPayloadSize on page 204• PCIeMaxReadRequestSize on page 204• PCIeMaxLinkSpeed on page 204• PCIeCurrentLinkSpeed on page 205• PCIeMaximumLinkWidth on page 205• PCIeNegotiatedLinkWidth on page 206• PCIeLinkSpeed2500MTpsSupported on page 206• PCIeLinkSpeed5000MTpsSupported on page 207• PCIeLinkSpeed8000MTpsSupported on page 207

InterfaceControl

Feature Info

Module Category Path Type Access

Interface Root Category RW

Parent Category: Root Category on page 146

Category Members• FanStatus on page 208• TemperatureSensorSelector on page 208• Temperature on page 209• AuxiliaryPowerInput on page 209• AuxiliaryPower12VInput on page 209

150

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

InterfaceDetails

Feature Info

Module Category Path Type Access

Interface Root Category RW

Parent Category: Root Category on page 146

Category Members• BoardCapabilities on page 210• FirmwareBoardID on page 211• CPLDRevision on page 211• PreviousBootBank on page 211• NextBootBank on page 212• CurrentBankSelect on page 212• CurrentBankSelectReadback on page 212• NextBankSelect on page 213• SpiBankStatus on page 213• PotBankStatus on page 213

EventControl

Feature Info

Module Category Path Type Access

Interface Root Category RW

Parent Category: Root Category on page 146

Category Members• EventSelector on page 214• EventNotification on page 215• EventNotificationContext1 on page 216• EventNotificationContext2 on page 217• EventNotificationContext3 on page 218• EventCount on page 219• EventCountReset on page 219

151

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

OemSafetyKey

Feature Info

Module Category Path Type Access

Interface Root Category RW

Parent Category: Root Category on page 146

Category Members• OemSafetyKeyVerification on page 220• CheckOemSafetyKey on page 221• ProgramOemSafetyKey on page 221• EncryptedOemSafetyKey on page 222• MaximumOemKeyLength on page 222

InterfaceInformation CategoryCategory Members

InterfaceID on page 152InterfaceType on page 153SerialNumber on page 153PartNumber on page 153FirmwareRevision on page 154FirmwareVariant on page 154FirmwareStatus on page 154FirmwareRecoverySwitch on page 155

InterfaceIDGenTL Producer wide unique identifier of the selected interface

Feature Info

Module Category Path Type Access

Interface Root / InterfaceInformation String Imposed: RO

Parent Category: InterfaceInformation Category on page 152

Short DescriptionGenTL Producer wide unique identifier of the selected interface.

152

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

InterfaceTypeIdentifies the transport layer technology of the interface

Feature Info

Module Category Path Type Access

Interface Root / InterfaceInformation Enumeration Imposed: RO

Parent Category: InterfaceInformation Category on page 152

Short DescriptionIdentifies the transport layer technology of the interface.

Enumeration Values• CXP: This enumeration value indicates CoaXPress transport layer technology.

SerialNumberSerial Number

Feature Info

Module Category Path Type Access

Interface Root / InterfaceInformation String Imposed: RO

Parent Category: InterfaceInformation Category on page 152

Short DescriptionSerial Number.

PartNumberPart Number

Feature Info

Module Category Path Type Access

Interface Root / InterfaceInformation String Imposed: RO

Parent Category: InterfaceInformation Category on page 152

153

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

Short DescriptionPart Number.

FirmwareRevisionFirmware Revision

Feature Info

Module Category Path Type Access

Interface Root / InterfaceInformation IntReg RO

Parent Category: InterfaceInformation Category on page 152Register Port: InterfacePort

Short DescriptionFirmware Revision.

FirmwareVariantFirmware Variant

Feature Info

Module Category Path Type Access

Interface Root / InterfaceInformation IntReg RO

Parent Category: InterfaceInformation Category on page 152Register Port: InterfacePort

Short DescriptionFirmware Variant.

FirmwareStatusFirmware Status

Feature Info

Module Category Path Type Access

Interface Root / InterfaceInformation Enumeration RW

Parent Category: InterfaceInformation Category on page 152

154

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

Short DescriptionFirmware Status.

Enumeration Values• OK: OK.• TooRecent: Firmware is too recent.• TooOld: Firmware is too old.• RecoveryMode: Firmware is in recovery mode.• PCIeGen1NotSupported: PCIe gen 1 not supported.

FirmwareRecoverySwitchPosition of the firmware recovery switch

Feature Info

Module Category Path Type Access

Interface Root / InterfaceInformation Boolean RW

Parent Category: InterfaceInformation Category on page 152

Short DescriptionPosition of the firmware recovery switch.

DeviceEnumeration CategoryCategory Members

DeviceUpdateList on page 156DeviceSelector on page 156DeviceID on page 157DeviceVendorName on page 157DeviceModelName on page 157DeviceAccessStatus on page 158

155

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

DeviceUpdateListUpdates the internal device list

Feature Info

Module Category Path Type Access

Interface Root / DeviceEnumeration Command RW

Parent Category: DeviceEnumeration Category on page 155

Short DescriptionUpdates the internal device list.

DeviceSelectorSelector for the different devices on this interface

Feature Info

Module Category Path Type Access

Interface Root / DeviceEnumeration Integer RW

Parent Category: DeviceEnumeration Category on page 155

Value InfoMinimum value: 0

Short DescriptionSelector for the different devices on this interface.

Selected Features• DeviceID on page 157• DeviceVendorName on page 157• DeviceModelName on page 157• DeviceAccessStatus on page 158

156

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

DeviceIDInterface wide unique identifier of the selected device

Feature Info

Module Category Path Type Access

Interface Root / DeviceEnumeration String Imposed: RO

Parent Category: DeviceEnumeration Category on page 155

Short DescriptionInterface wide unique identifier of the selected device.

DeviceVendorNameName of the device vendor

Feature Info

Module Category Path Type Access

Interface Root / DeviceEnumeration String Imposed: RO

Parent Category: DeviceEnumeration Category on page 155

Short DescriptionName of the device vendor.

DeviceModelNameName of the device model

Feature Info

Module Category Path Type Access

Interface Root / DeviceEnumeration String Imposed: RO

Parent Category: DeviceEnumeration Category on page 155

Short DescriptionName of the device model.

157

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

DeviceAccessStatusGives the device's access status at the moment of the last execution of DeviceUpdateList

Feature Info

Module Category Path Type Access

Interface Root / DeviceEnumeration Enumeration Imposed: RO

Parent Category: DeviceEnumeration Category on page 155

Short DescriptionGives the device's access status at the moment of the last execution of DeviceUpdateList.

Enumeration Values• Unknown: Unknown access.• ReadWrite: Full access.• ReadOnly: Read-only access.• NoAccess: Another device has exclusive access.

CoaXPress CategoryCategory Members

CxpPoCxpHostConnectionSelector on page 159CxpPoCxpAuto on page 160CxpPoCxpTurnOff on page 160CxpPoCxpTripReset on page 161CxpPoCxpConfigurationStatus on page 161CxpPoCxpStatus on page 162CxpPoCxpCurrent on page 162CxpPoCxpVoltage on page 163CxpPoCxpPowerInputStatus on page 163CxpHostConnectionCount on page 164CxpHostConnectionSelector on page 164CxpConnectionState on page 165CxpDownConnectionSpeed on page 165CxpDeviceConnectionID on page 166CxpHostConnectionTestMode on page 167CxpHostConnectionTestErrorCount on page 168CxpHostConnectionTestPacketCount on page 168CxpHostConnectionTestInjectError on page 169CxpRevisionSelector on page 169

158

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

CxpRevisionSupport on page 170Related Functional Guide Topic(s)CoaXPress Host Interface on page 25Specification and functional description of the CoaXPress Host interface

CxpPoCxpHostConnectionSelectorSelects the CoaXPress physical connection for PoCXP control

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Enumeration RW

Parent Category: CoaXPress Category on page 158

DescriptionSelects one (or a group of) CoaXPress physical Host connection(s) for PoCXP control.Default value: All.

Selected Features• CxpPoCxpAuto on page 160• CxpPoCxpTurnOff on page 160• CxpPoCxpTripReset on page 161• CxpPoCxpConfigurationStatus on page 161• CxpPoCxpStatus on page 162• CxpPoCxpCurrent on page 162• CxpPoCxpVoltage on page 163

Enumeration Values• All: All CoaXPress physical host connections.• A: CoaXPress physical host connection A.• B: CoaXPress physical host connection B.• C: CoaXPress physical host connection C.• D: CoaXPress physical host connection D.

Related Functional Guide Topic(s)Power Over CoaXPress on page 32

159

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

CoaXPress camera powering through the CoaXPress Link connections

CxpPoCxpAutoActivate automatic control of the Power over CoaXPress (PoCXP)

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Command Imposed: WO

Parent Category: CoaXPress Category on page 158

DescriptionActivates automatic control of Power over CoaXPress (PoCXP) on the CoaXPress physical Host connection(s)designated by CxpPoCxpHostConnectionSelector.Related Functional Guide Topic(s)Power Over CoaXPress on page 32CoaXPress camera powering through the CoaXPress Link connections

CxpPoCxpTurnOffDisable Power over CoaXPress (PoCXP)

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Command Imposed: WO

Parent Category: CoaXPress Category on page 158

DescriptionDisables Power over CoaXPress (PoCXP) on the CoaXPress physical Host connection(s) designated byCxpPoCxpHostConnectionSelector.Related Functional Guide Topic(s)Power Over CoaXPress on page 32

160

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

CoaXPress camera powering through the CoaXPress Link connections

CxpPoCxpTripResetReset Power over CoaXPress (PoCXP) after an over-current trip

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Command Imposed: WO

Parent Category: CoaXPress Category on page 158

DescriptionResets Power over CoaXPress (PoCXP) aer an over-current trip on the CoaXPress physical Host connection(s)designated by CxpPoCxpHostConnectionSelector.Related Functional Guide Topic(s)Power Over CoaXPress on page 32CoaXPress camera powering through the CoaXPress Link connections

CxpPoCxpConfigurationStatusReturn Power over CoaXPress (PoCXP) configuration

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Enumeration Imposed: RO

Parent Category: CoaXPress Category on page 158

DescriptionReturns the Power over CoaXPress (PoCXP) configuration of the CoaXPress physical Host connection(s) designated byCxpPoCxpHostConnectionSelector.

Enumeration Values• Off: PoCXP is forced off.• Auto: Normal automatic PoCXP operation.• Unknown: PoCXP configuration is unknown.• Compound: PoCXP configuration is compound.

Related Functional Guide Topic(s)Power Over CoaXPress on page 32

161

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

CoaXPress camera powering through the CoaXPress Link connections

CxpPoCxpStatusReturn Power over CoaXPress (PoCXP) status

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Enumeration Imposed: RO

Parent Category: CoaXPress Category on page 158

DescriptionReturns the Power over CoaXPress (PoCXP) status on the CoaXPress physical Host connection(s) designated byCxpPoCxpHostConnectionSelector.

Enumeration Values• Off: PoCXP is off.• On: PoCXP is on.• Tripped: PoCXP has shut down because of an over-current trip.• Compound: PoCXP status is compound.

Related Functional Guide Topic(s)Power Over CoaXPress on page 32CoaXPress camera powering through the CoaXPress Link connections

CxpPoCxpCurrentReturn the current delivered by the PoCXP Transmitter Unit on the selected connection

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress SwissKnife RW

Parent Category: CoaXPress Category on page 158

Value InfoDimension: CurrentUnit: Ampere [A]

DescriptionReturns the current delivered by the PoCXP transmitter unit of the CoaXPress physical Host connection designated byCxpPoCxpHostConnectionSelector.Unit: Ampere.

162

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

Value range: from 0.0 up to 1.020 by steps of 0.004.Related Functional Guide Topic(s)Power Over CoaXPress on page 32CoaXPress camera powering through the CoaXPress Link connections

CxpPoCxpVoltageReturn the voltage measured at the output of the PoCXP Transmitter Unit on the selected connection

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress SwissKnife RW

Parent Category: CoaXPress Category on page 158

Value InfoDimension: VoltageUnit: Volt [V]

DescriptionReturns the output voltage delivered by the PoCXP transmitter unit of the CoaXPress physical Host connectiondesignated by CxpPoCxpHostConnectionSelector.Unit: Volt.Value range: from 21.0 up to 29.16 by steps of 0.032.Related Functional Guide Topic(s)Power Over CoaXPress on page 32CoaXPress camera powering through the CoaXPress Link connections

CxpPoCxpPowerInputStatusReturn CoaXPress Power Input Status

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Enumeration Imposed: RO

Parent Category: CoaXPress Category on page 158

DescriptionReturns the status of the 24 V power converter delivering power to all the PoCXP transmitter units.

Enumeration Values• NotOK: The 24V Power Converter is not OK.• OK: The 24V Power Converter is OK.

163

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

Related Functional Guide Topic(s)Power Over CoaXPress on page 32CoaXPress camera powering through the CoaXPress Link connections

CxpHostConnectionCountCxp Host Connection Count

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress IntReg RO

Parent Category: CoaXPress Category on page 158Register Port: InterfacePort

Short DescriptionCxp Host Connection Count.Related Functional Guide Topic(s)Link Configuration on page 30CoaXPress Link configuration and discovery

CxpHostConnectionSelectorSelects the CoaXPress physical connection

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Enumeration RW

Parent Category: CoaXPress Category on page 158

Short DescriptionSelects the CoaXPress physical connection.

Selected Features• CxpConnectionState on page 165• CxpDownConnectionSpeed on page 165• CxpDeviceConnectionID on page 166• CxpHostConnectionTestMode on page 167• CxpHostConnectionTestErrorCount on page 168• CxpHostConnectionTestPacketCount on page 168• CxpHostConnectionTestInjectError on page 169

164

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

Enumeration Values• A: CoaXPress physical host connection A.• B: CoaXPress physical host connection B.• C: CoaXPress physical host connection C.• D: CoaXPress physical host connection D.

Related Functional Guide Topic(s)Link Configuration on page 30CoaXPress Link configuration and discovery

CxpConnectionStateCoaXPress Connection State

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Enumeration Imposed: RO

Parent Category: CoaXPress Category on page 158

DescriptionReturns the CoaXPress connection state of the CoaXPress physical Host connection designated byCxpHostConnectionSelector.

Enumeration Values• Undetected: Undetected.• Detected: Detected.

Related Functional Guide Topic(s)Link Configuration on page 30CoaXPress Link configuration and discovery

CxpDownConnectionSpeedCoaXPress Connection Speed

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Enumeration Imposed: RO

Parent Category: CoaXPress Category on page 158

165

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

DescriptionReturns the CoaXPress down-connection speed of the CoaXPress physical Host connection designated byCxpHostConnectionSelector.

Enumeration Values• CXP1: 1.25Gb/s.• CXP2: 2.5Gb/s.• CXP3: 3.125Gb/s.• CXP5: 5Gb/s.• CXP6: 6.25Gb/s.

Related Functional Guide Topic(s)Link Configuration on page 30CoaXPress Link configuration and discovery

CxpDeviceConnectionIDCoaXPress Connection Topology Information

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Enumeration Imposed: RO

Parent Category: CoaXPress Category on page 158

DescriptionReturns the CoaXPress connection topology information of the CoaXPress physical Host connection designated byCxpHostConnectionSelector.

Enumeration Values• CameraW_Master: Master Connection of Camera W.• CameraW_Extension1: Extension 1 of Camera W.• CameraW_Extension2: Extension 2 of Camera W.• CameraW_Extension3: Extension 3 of Camera W.• CameraW_Extension4: Extension 4 of Camera W.• CameraW_Extension5: Extension 5 of Camera W.• CameraW_Extension6: Extension 6 of Camera W.• CameraW_Extension7: Extension 7 of Camera W.• CameraX_Master: Master Connection of Camera X.• CameraX_Extension1: Extension 1 of Camera X.• CameraX_Extension2: Extension 2 of Camera X.• CameraX_Extension3: Extension 3 of Camera X.• CameraX_Extension4: Extension 4 of Camera X.• CameraX_Extension5: Extension 5 of Camera X.• CameraX_Extension6: Extension 6 of Camera X.• CameraX_Extension7: Extension 7 of Camera X.

166

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

• CameraY_Master: Master Connection of Camera Y.• CameraY_Extension1: Extension 1 of Camera Y.• CameraY_Extension2: Extension 2 of Camera Y.• CameraY_Extension3: Extension 3 of Camera Y.• CameraY_Extension4: Extension 4 of Camera Y.• CameraY_Extension5: Extension 5 of Camera Y.• CameraY_Extension6: Extension 6 of Camera Y.• CameraY_Extension7: Extension 7 of Camera Y.• CameraZ_Master: Master Connection of Camera Z.• CameraZ_Extension1: Extension 1 of Camera Z.• CameraZ_Extension2: Extension 2 of Camera Z.• CameraZ_Extension3: Extension 3 of Camera Z.• CameraZ_Extension4: Extension 4 of Camera Z.• CameraZ_Extension5: Extension 5 of Camera Z.• CameraZ_Extension6: Extension 6 of Camera Z.• CameraZ_Extension7: Extension 7 of Camera Z.• SubLink_Extension1: Sub-Link Extension 1.• SubLink_Extension2: Sub-Link Extension 2.• SubLink_Extension3: Sub-Link Extension 3.• SubLink_Extension4: Sub-Link Extension 4.• SubLink_Extension5: Sub-Link Extension 5.• SubLink_Extension6: Sub-Link Extension 6.• SubLink_Extension7: Sub-Link Extension 7.• NotReady: Not Ready.

Related Functional Guide Topic(s)Link Configuration on page 30CoaXPress Link configuration and discovery

CxpHostConnectionTestModeEnables the test mode for an individual physical connection of the Host

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Enumeration RW

Parent Category: CoaXPress Category on page 158

DescriptionControls the Host to Device connection test mode for the CoaXPress physical Host connection designated byCxpHostConnectionSelector.Default value: Off.

Enumeration Values• Off: The test mode is disabled on the selected Host connection.• Mode1: The test mode is one on the selected Host connection.

167

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

Related Functional Guide Topic(s)Connection Test on page 40CoaXPress link connection test facility

CxpHostConnectionTestErrorCountReports the current connection error count for test packets received by the Host on the selected Host connection

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Integer RW

Parent Category: CoaXPress Category on page 158

Value InfoMinimum value: 0Maximum value: 4294967295

Short DescriptionReports the current connection error count for test packets received by the Host on the selected Host connection.Related Functional Guide Topic(s)Connection Test on page 40CoaXPress link connection test facility

CxpHostConnectionTestPacketCountReports the current count for test packets received by the Host on the selected Host connection

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Integer RW

Parent Category: CoaXPress Category on page 158

Value InfoMinimum value: 0Maximum value: 4294967295

DescriptionReturns the current count of test packets received by the CoaXPress physical Host connection designated byCxpHostConnectionSelector.This feature can be read at any time. It can be written to zero to reset the count between tests.Related Functional Guide Topic(s)Connection Test on page 40

168

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

CoaXPress link connection test facility

CxpHostConnectionTestInjectErrorInjects one single character error during the Host to Device test

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Command RW

Parent Category: CoaXPress Category on page 158

DescriptionInjects a single character error into the Host to Device test packet of the CoaXPress physical Host connectiondesignated by CxpHostConnectionSelector.Related Functional Guide Topic(s)Connection Test on page 40CoaXPress link connection test facility

CxpRevisionSelectorSelects the CoaXPress Standard Revision for current support

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Enumeration RW

Parent Category: CoaXPress Category on page 158

DescriptionSelects the CoaXPress Standard Revision for current support.Default value: CXP_1_0.

Selected Features• CxpRevisionSupport on page 170

Enumeration Values• CXP_1_0: CoaXPress Standard Version 1.0.• CXP_1_1: CoaXPress Standard Version 1.1.• CXP_1_1_1: CoaXPress Standard Version 1.1.1.

Related Functional Guide Topic(s)CoaXPress Standard Compliance on page 25

169

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

CxpRevisionSupportReports the current support of the selected CoaXPress Standard Revision

Feature Info

Module Category Path Type Access

Interface Root / CoaXPress Enumeration Imposed: RO

Parent Category: CoaXPress Category on page 158

Short DescriptionReports the current support of the selected CoaXPress Standard Revision.

Enumeration Values• NotSupported: Not supported.• PartiallySupported: Partially supported.• Supported: Supported.

Related Functional Guide Topic(s)CoaXPress Standard Compliance on page 25

DigitalIOControl CategoryCategory Members

LineSelector on page 171LineFormat on page 172LineMode on page 172LineInverter on page 173LineFilterStrength on page 173LineFilterDelay on page 174LineStatus on page 174LineStatusAll on page 175LineSource on page 176Related Functional Guide Topic(s)General Purpose I/O Lines on page 121

170

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

Set of general purpose digital I/O lines

LineSelectorSelects a physical I/O line

Feature Info

Module Category Path Type Access

Interface Root / DigitalIOControl Enumeration RW

Parent Category: DigitalIOControl Category on page 170

DescriptionSelects one physical GPIO line.Default value: DIN11.

Selected Features• LineFormat on page 172• LineMode on page 172• LineInverter on page 173• LineFilterStrength on page 173• LineFilterDelay on page 174• LineStatus on page 174• LineSource on page 176

Enumeration Values• DIN11: Differential input 1 of Internal I/O connector 1.• DIN12: Differential input 2 of Internal I/O connector 1.• DIN21: Differential input 1 of Internal I/O connector 2.• DIN22: Differential input 2 of Internal I/O connector 2.• IIN11: Isolated input 1 of Internal I/O connector 1.• IIN12: Isolated input 2 of Internal I/O connector 1.• IIN13: Isolated input 3 of Internal I/O connector 1.• IIN14: Isolated input 4 of Internal I/O connector 1.• IIN21: Isolated input 1 of Internal I/O connector 2.• IIN22: Isolated input 2 of Internal I/O connector 2.• IIN23: Isolated input 3 of Internal I/O connector 2.• IIN24: Isolated input 4 of Internal I/O connector 2.• IOUT11: Isolated output 1 of Internal I/O connector 1.• IOUT12: Isolated output 2 of Internal I/O connector 1.• IOUT21: Isolated output 1 of Internal I/O connector 2.• IOUT22: Isolated output 2 of Internal I/O connector 2.• TTLIO11: TTL input/output 1 of Internal I/O connector 1.• TTLIO12: TTL input/output 2 of Internal I/O connector 1.• TTLIO21: TTL input/output 1 of Internal I/O connector 2.• TTLIO22: TTL input/output 2 of Internal I/O connector 2.

171

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

Related Functional Guide Topic(s)I/O Control Blocks on page 122

LineFormatElectrical style of the selected I/O line

Feature Info

Module Category Path Type Access

Interface Root / DigitalIOControl Enumeration Imposed: RO

Parent Category: DigitalIOControl Category on page 170

DescriptionReturns the electrical style of the selected physical GPIO line.

Enumeration Values• ISO: The I/O line is opto-coupled.• DIFF: The I/O line is accepting LVDS or RS422 level signals.• TTL: The I/O line is accepting or sending TTL level signals.

Related Functional Guide Topic(s)I/O Control Blocks on page 122

LineModeDirection and line driver of the selected I/O line

Feature Info

Module Category Path Type Access

Interface Root / DigitalIOControl Enumeration RW

Parent Category: DigitalIOControl Category on page 170

DescriptionDirection and line driver mode of the selected physical GPIO line.Default value: Input for the input-capable GPIO lines; Output for the output-only GPIO lines.

Enumeration Values• Input: Input line.• Output: Output line.• DriveLow: Driven-low output line.• DriveHigh: Driven-high output line.

172

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

Related Functional Guide Topic(s)I/O Control Blocks on page 122

LineInverterInversion of the selected I/O line

Feature Info

Module Category Path Type Access

Interface Root / DigitalIOControl Boolean RW

Parent Category: DigitalIOControl Category on page 170

DescriptionSignal inversion of the selected input or output line.When set to False, the line signal is not inverted.When set to True, the line signal is inverted.

Note: For bidirectional GPIO lines such as the TTL input/output lines, the settings applies equally tothe signal input path and the signal output path!

Default value: False.Related Functional Guide Topic(s)I/O Control Blocks on page 122

LineFilterStrengthStrength of the glitch removal filter of the selected I/O line

Feature Info

Module Category Path Type Access

Interface Root / DigitalIOControl Enumeration RW

Parent Category: DigitalIOControl Category on page 170

DescriptionStrength of the glitch removal filter of the selected physical GPIO line.

Note: This feature is only available for input-capable GPIO lines.

Default value: Low.

Enumeration Values• Lowest: Lowest filter strength.• Low: Low filter strength.• Medium: Medium filter strength.

173

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

• High: High filter strength.• Highest: Highest filter strength.• NotAvailable: Filter strength not available on the selected I/O line.

Related Functional Guide Topic(s)I/O Control Blocks on page 122

LineFilterDelayDelay introduced by the glitch removal filter of the selected I/O line

Feature Info

Module Category Path Type Access

Interface Root / DigitalIOControl SwissKnife RW

Parent Category: DigitalIOControl Category on page 170

DescriptionReturns the latency delay, expressed in microseconds, introduced by the glitch removal filter of the selected physicalGPIO line.

Note:

This feature is only available for input-capable GPIO lines.

Related Functional Guide Topic(s)I/O Control Blocks on page 122

LineStatusCurrent status of the selected I/O line

Feature Info

Module Category Path Type Access

Interface Root / DigitalIOControl Boolean RW

Parent Category: DigitalIOControl Category on page 170

DescriptionReturns the current status of the selected physical GPIO line.When False, the logical state of the selected physical GPIO line is low.When True, The logical state of the selected physical GPIO line is high.

Note: For input-capable I/O lines, the reported value is the logical state of the LineInput signal: a nodein the input path of the I/O control block that is located after the Input Inverter.

Note: For output-only I/O lines, the reported value is the logical state of the LineOutput signal, a notein the output path of the I/O control block that is located before the Output Inverter.

174

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

Related Functional Guide Topic(s)I/O Control Blocks on page 122

LineStatusAllCurrent state of all available line signals at time of polling in a single bit field

Feature Info

Module Category Path Type Access

Interface Root / DigitalIOControl Integer RW

Parent Category: DigitalIOControl Category on page 170

DescriptionReturns the current state of all available GPIO line signals at time of polling in a single bit field.Bit values:

• 0: The logical state of the corresponding GPIO line is low.• 1: The logical state of the corresponding GPIO line is high.

Bit assignments:

• Bit 0: DIN11 GPIO line.• Bit 1: DIN12 GPIO line.• Bit 2: DIN21 GPIO line.• Bit 3: DIN22 GPIO line.• Bit 4: IIN11 GPIO line.• Bit 5: IIN12 GPIO line.• Bit 6: IIN13 GPIO line.• Bit 7: IIN14 GPIO line.• Bit 8: IIN21 GPIO line.• Bit 9: IIN22 GPIO line.• Bit 10: IIN23GPIO line.• Bit 11: IIN24 GPIO line.• Bit 12: IOUT11 GPIO line.• Bit 13: IOUT12 GPIO line.• Bit 14: IOUT21 GPIO line.• Bit 15: IOUT22 GPIO line.• Bit 16: TTLIO11 GPIO line.• Bit 17: TTLIO12 GPIO line.• Bit 18: TTLIO21 GPIO line.

Related Functional Guide Topic(s)I/O Control Blocks on page 122

175

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

LineSourceInternal signal sourcing the output of the selected I/O line

Feature Info

Module Category Path Type Access

Interface Root / DigitalIOControl Enumeration RW

Parent Category: DigitalIOControl Category on page 170

DescriptionSelect the internal signal sourcing the output of the selected physical GPIO line.

Note:

This feature is only available for output-capable GPIO lines.

Enumeration Values• UserOutput0: Bit 0 of user output register.• UserOutput1: Bit 1 of user output register.• UserOutput2: Bit 2 of user output register.• UserOutput3: Bit 3 of user output register.• UserOutput4: Bit 4 of user output register.• UserOutput5: Bit 5 of user output register.• UserOutput6: Bit 6 of user output register.• UserOutput7: Bit 7 of user output register.• Device0Strobe: Strobe output of device 0.• Device1Strobe: Strobe output of device 1.• Device2Strobe: Strobe output of device 2.• Device3Strobe: Strobe output of device 3.• Device0CameraTrigger: Camera trigger output of device 0.• Device1CameraTrigger: Camera trigger output of device 1.• Device2CameraTrigger: Camera trigger output of device 2.• Device3CameraTrigger: Camera trigger output of device 3.• Device0Stream0StartOfCameraReadout: Start of camera readout on stream 0 of device 0.• Device1Stream0StartOfCameraReadout: Start of camera readout on stream 0 of device 1.• Device2Stream0StartOfCameraReadout: Start of camera readout on stream 0 of device 2.• Device3Stream0StartOfCameraReadout: Start of camera readout on stream 0 of device 3.• Low: Low.• NotAvailable: Not available on the selected I/O line.

Related Functional Guide Topic(s)I/O Control Blocks on page 122

176

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

UserOutputRegister CategoryCategory Members

UserOutputValueAll on page 177UserActions on page 178AddUserAction on page 178ClearUserActions on page 179ExecuteUserActions on page 180ScheduleUserActions on page 180UserActionsSchedulerReference on page 181ScheduledUserActionsPoolStatus on page 181DiscardScheduledUserActions on page 182Related Functional Guide Topic(s)User Actions Tool on page 112

UserOutputValueAllValue of all User Output Register bits

Feature Info

Module Category Path Type Access

Interface Root / UserOutputRegister Integer RW

Parent Category: UserOutputRegister Category on page 177

Value InfoMinimum value: 0Maximum value: 255

DescriptionValue of all User Output Register bits as a bit-field in a single data word.Bit values:

• 0: The value of the corresponding User Output Register bit is low.• 1: The value of the corresponding User Output Register bit is high.

Bit assignments:

• Bit 0: Value for bit 0 of the user output register.• Bit 1: Value for bit 1 of the user output register.• Bit 2: Value for bit 2 of the user output register.• Bit 3: Value for bit 3 of the user output register.• Bit 4: Value for bit 4 of the user output register.• Bit 5: Value for bit 5 of the user output register.

177

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

• Bit 6: Value for bit 6 of the user output register.• Bit 7: Value for bit 7 of the user output register.

Related Functional Guide Topic(s)User Output Register on page 115User-configurable general purpose output register

UserActionsCurrent set of user actions

Feature Info

Module Category Path Type Access

Interface Root / UserOutputRegister Integer RW

Parent Category: UserOutputRegister Category on page 177

Value InfoMinimum value: 0Maximum value: 2147483647

DescriptionCurrent set of user actions (built with AddUserAction) that can be executed immediately (c.f.ExecuteUserActions) or scheduled for execution at a specific time/position (c.f. ScheduleUserActions).Related Functional Guide Topic(s)User Actions Scheduler on page 113

AddUserActionAdd an action to the current set of user actions

Feature Info

Module Category Path Type Access

Interface Root / UserOutputRegister Enumeration Imposed: WO

Parent Category: UserOutputRegister Category on page 177

DescriptionAdd an action to the current set of user actions (UserActions).

Enumeration Values• UserEvent1: User Event 1.• UserEvent2: User Event 2.• UserEvent3: User Event 3.

178

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

• UserEvent4: User Event 4.• UserOutput0_High: Set User Output Register bit 0 high.• UserOutput0_Low: Set User Output Register bit 0 low.• UserOutput0_Toggle: Toggle User Output Register bit 0.• UserOutput1_High: Set User Output Register bit 1 high.• UserOutput1_Low: Set User Output Register bit 1 low.• UserOutput1_Toggle: Toggle User Output Register bit 1.• UserOutput2_High: Set User Output Register bit 2 high.• UserOutput2_Low: Set User Output Register bit 2 low.• UserOutput2_Toggle: Toggle User Output Register bit 2.• UserOutput3_High: Set User Output Register bit 3 high.• UserOutput3_Low: Set User Output Register bit 3 low.• UserOutput3_Toggle: Toggle User Output Register bit 3.• UserOutput4_High: Set User Output Register bit 4 high.• UserOutput4_Low: Set User Output Register bit 4 low.• UserOutput4_Toggle: Toggle User Output Register bit 4.• UserOutput5_High: Set User Output Register bit 5 high.• UserOutput5_Low: Set User Output Register bit 5 low.• UserOutput5_Toggle: Toggle User Output Register bit 5.• UserOutput6_High: Set User Output Register bit 6 high.• UserOutput6_Low: Set User Output Register bit 6 low.• UserOutput6_Toggle: Toggle User Output Register bit 6.• UserOutput7_High: Set User Output Register bit 7 high.• UserOutput7_Low: Set User Output Register bit 7 low.• UserOutput7_Toggle: Toggle User Output Register bit 7.

Related Functional Guide Topic(s)User Actions Scheduler on page 113

ClearUserActionsClear the current set of user actions

Feature Info

Module Category Path Type Access

Interface Root / UserOutputRegister Command Imposed: WO

Parent Category: UserOutputRegister Category on page 177

DescriptionClear the current set of user actions (UserActions).Related Functional Guide Topic(s)User Actions Scheduler on page 113

179

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

ExecuteUserActionsImmediately execute the current set of user actions

Feature Info

Module Category Path Type Access

Interface Root / UserOutputRegister Command Imposed: WO

Parent Category: UserOutputRegister Category on page 177

DescriptionImmediately execute the current set of user actions (UserActions).Related Functional Guide Topic(s)User Actions Scheduler on page 113

ScheduleUserActionsSchedule the current set of user actions for execution at given time/position

Feature Info

Module Category Path Type Access

Interface Root / UserOutputRegister Integer Imposed: WO

Parent Category: UserOutputRegister Category on page 177

Value InfoMinimum value: 0Maximum value: 4294967295

DescriptionSchedule the current set of user actions (UserActions) for execution at given time/position.Related Functional Guide Topic(s)User Actions Scheduler on page 113

180

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

UserActionsSchedulerReferenceDefines the reference used by the user action scheduler

Feature Info

Module Category Path Type Access

Interface Root / UserOutputRegister Enumeration RW

Parent Category: UserOutputRegister Category on page 177

DescriptionDefines the reference used by the user action scheduler; can only be changed whenScheduledUserActionsPoolStatus is Empty.

Enumeration Values• InternalTime: Coaxlink card internal time.• QDC1Position: Quadrature Decoder Tool 1 Position.• QDC2Position: Quadrature Decoder Tool 2 Position.

Related Functional Guide Topic(s)User Actions Scheduler on page 113

ScheduledUserActionsPoolStatusReports the status of the pool of scheduled user actions

Feature Info

Module Category Path Type Access

Interface Root / UserOutputRegister Enumeration RW

Parent Category: UserOutputRegister Category on page 177

DescriptionReports the status of the pool of scheduled user actions.

Enumeration Values• Empty: The pool of scheduled user actions is empty.• PartiallyFilled: The pool of scheduled user actions is partially filled.• AlmostFull: The pool of scheduled user actions almost full.

Related Functional Guide Topic(s)User Actions Scheduler on page 113

181

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

DiscardScheduledUserActionsDiscard all scheduled user actions

Feature Info

Module Category Path Type Access

Interface Root / UserOutputRegister Command Imposed: WO

Parent Category: UserOutputRegister Category on page 177

Short DescriptionDiscard all scheduled user actions.Related Functional Guide Topic(s)User Actions Scheduler on page 113

IOToolbox CategoryCategory Members

LineInputToolSelector on page 183LineInputToolSource on page 184LineInputToolActivation on page 185MultiplierDividerToolSelector on page 185MultiplierDividerToolSource on page 186MultiplierDividerToolOutputControl on page 187MultiplierDividerToolMultiplicationFactor on page 187MultiplierDividerToolDivisionFactor on page 188MultiplierDividerToolEffectiveMultiplicationFactor on page 189MultiplierDividerToolEffectiveDivisionFactor on page 189QuadratureDecoderToolSelector on page 190QuadratureDecoderToolSources on page 190QuadratureDecoderToolActivation on page 191QuadratureDecoderToolForwardDirection on page 192QuadratureDecoderToolOutputMode on page 192QuadratureDecoderToolPosition on page 193QuadratureDecoderToolDirection on page 193QuadratureDecoderToolPositionReset on page 194DividerToolSelector on page 194DividerToolSource on page 195DividerToolEnableControl on page 196DividerToolDivisionFactor on page 196DividerToolInitialOffset on page 197

182

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

DelayToolSelector on page 197DelayToolSource1 on page 198DelayToolSource2 on page 199DelayToolClockSource on page 200DelayToolDelayValue on page 200EventInputToolSelector on page 201EventInputToolSource on page 202EventInputToolActivation on page 202InternalTime on page 203Related Functional Guide Topic(s)I/O Toolbox on page 106Set of tools for building-up and processing hardware events

LineInputToolSelectorSelects a Line Input Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionSelects a Line Input Tool.

Selected Features• LineInputToolSource on page 184• LineInputToolActivation on page 185

Enumeration Values• LIN1: Line Input Tool 1.• LIN2: Line Input Tool 2.• LIN3: Line Input Tool 3.• LIN4: Line Input Tool 4.• LIN5: Line Input Tool 5.• LIN6: Line Input Tool 6.• LIN7: Line Input Tool 7.• LIN8: Line Input Tool 8.

Related Functional Guide Topic(s)Line Input Tool on page 109

183

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

LineInputToolSourcePhysical I/O line used as input for the selected Line Input Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

DescriptionPhysical GPIO line used as input for the selected Line Input Tool.Default value: DIN11.

Enumeration Values• DIN11: Differential input 1 of Internal I/O connector 1.• DIN12: Differential input 2 of Internal I/O connector 1.• DIN21: Differential input 1 of Internal I/O connector 2.• DIN22: Differential input 2 of Internal I/O connector 2.• IIN11: Isolated input 1 of Internal I/O connector 1.• IIN12: Isolated input 2 of Internal I/O connector 1.• IIN13: Isolated input 3 of Internal I/O connector 1.• IIN14: Isolated input 4 of Internal I/O connector 1.• IIN21: Isolated input 1 of Internal I/O connector 2.• IIN22: Isolated input 2 of Internal I/O connector 2.• IIN23: Isolated input 3 of Internal I/O connector 2.• IIN24: Isolated input 4 of Internal I/O connector 2.• IOUT11: Isolated output 1 of Internal I/O connector 1.• IOUT12: Isolated output 2 of Internal I/O connector 1.• IOUT21: Isolated output 1 of Internal I/O connector 2.• IOUT22: Isolated output 2 of Internal I/O connector 2.• TTLIO11: TTL input/output 1 of Internal I/O connector 1.• TTLIO12: TTL input/output 2 of Internal I/O connector 1.• TTLIO21: TTL input/output 1 of Internal I/O connector 2.• TTLIO22: TTL input/output 2 of Internal I/O connector 2.

Related Functional Guide Topic(s)Line Input Tool on page 109

184

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

LineInputToolActivationEdge activating the output of the selected Line Input Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionEdge activating the output of the selected Line Input Tool.

Enumeration Values• RisingEdge:• FallingEdge:

Related Functional Guide Topic(s)Line Input Tool on page 109

MultiplierDividerToolSelectorSelects a Multiplier/Divider Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionSelects a Multiplier/Divider Tool.

Selected Features• MultiplierDividerToolSource on page 186• MultiplierDividerToolOutputControl on page 187• MultiplierDividerToolMultiplicationFactor on page 187• MultiplierDividerToolDivisionFactor on page 188• MultiplierDividerToolEffectiveMultiplicationFactor on page 189• MultiplierDividerToolEffectiveDivisionFactor on page 189

Enumeration Values• MDV1: Multiplier/Divider Tool 1.

185

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

• MDV2: Multiplier/Divider Tool 2.

Related Functional Guide Topic(s)Multiplier/Divider Tool on page 117

MultiplierDividerToolSourceI/O Toolbox event stream used as input for the selected Multiplier/Divider Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionI/O Toolbox event stream used as input for the selected Multiplier/Divider Tool.

Enumeration Values• NONE: No event stream.• LIN1: When an event occurs on Line Input Tool 1.• LIN2: When an event occurs on Line Input Tool 2.• LIN3: When an event occurs on Line Input Tool 3.• LIN4: When an event occurs on Line Input Tool 4.• LIN5: When an event occurs on Line Input Tool 5.• LIN6: When an event occurs on Line Input Tool 6.• LIN7: When an event occurs on Line Input Tool 7.• LIN8: When an event occurs on Line Input Tool 8.• QDC1: When an event occurs on Quadrature Decoder Tool 1.• QDC2: When an event occurs on Quadrature Decoder Tool 2.• MDV1: When an event occurs on Multiplier/Divider Tool 1.• MDV2: When an event occurs on Multiplier/Divider Tool 2.• DIV1: When an event occurs on Divider Tool 1.• DIV2: When an event occurs on Divider Tool 2.• DEL1_1: When an event occurs on Delay Tool 1 Output 1.• DEL1_2: When an event occurs on Delay Tool 1 Output 2.• DEL2_1: When an event occurs on Delay Tool 2 Output 1.• DEL2_2: When an event occurs on Delay Tool 2 Output 2.• EIN1: When an event occurs on Event Input Tool 1.• EIN2: When an event occurs on Event Input Tool 2.• UserEvent1: When an event occurs on User Event 1.• UserEvent2: When an event occurs on User Event 2.• UserEvent3: When an event occurs on User Event 3.• UserEvent4: When an event occurs on User Event 4.

Related Functional Guide Topic(s)Multiplier/Divider Tool on page 117

186

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

MultiplierDividerToolOutputControlOutput control of the selected Multiplier/Divider Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionOutput control of the selected Multiplier/Divider Tool.

Enumeration Values• Enable: Output enabled.• Disable: Output disabled.

Related Functional Guide Topic(s)Multiplier/Divider Tool on page 117

MultiplierDividerToolMultiplicationFactorMultiplication factor of the selected Multiplier/Divider Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Float RW

Parent Category: IOToolbox Category on page 182

Value InfoMinimum value: 0.001Maximum value: 1000

DescriptionMultiplication factor of the selected Multiplier/Divider Tool.This feature is the numerator of the fraction defining the Rate Conversion Ratio (RCR) of the Multiplier/Divider Tool.RCR = M/D where:

• M = MultiplierDividerToolMultiplicationFactor• D = MultiplierDividerToolDivisionFactor

The Multiplier/Divider Tools allows defining any RCR values in the range 0.001 to 1000.0.

187

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

Note: The user may define RCR using any of the following methods:

• A ratio of 2 integer numbers by assigning integer values to both the numerator and the denominator.• A single non-integer number greater or smaller than 1 assigned to the numerator leaving the

denominator to the default value (1.0).• A single non-integer number greater or smaller than 1 assigned to the denominator leaving the

numerator to the default value (1.0).

Default value: 1.0.Related Functional Guide Topic(s)Multiplier/Divider Tool on page 117

MultiplierDividerToolDivisionFactorDivision factor of the selected Multiplier/Divider Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Float RW

Parent Category: IOToolbox Category on page 182

Value InfoMinimum value: 0.001Maximum value: 1000

DescriptionDivision factor of the selected Multiplier/Divider Tool.This feature is the denominator of the fraction defining the Rate Conversion Ratio (RCR) of the Multiplier/Divider Tool.RCR = M/D where:

• M = MultiplierDividerToolMultiplicationFactor• D = MultiplierDividerToolDivisionFactor

The Multiplier/Divider Tools allows defining any RCR values in the range 0.001 to 1000.0.

Note: The user may define RCR using any of the following methods:

• A ratio of 2 integer numbers by assigning integer values to both the numerator and the denominator.• A single non-integer number greater or smaller than 1 assigned to the numerator leaving the

denominator to the default value (1.0).• A single non-integer number greater or smaller than 1 assigned to the denominator leaving the

numerator to the default value (1.0).

Default value: 1.0.Related Functional Guide Topic(s)Multiplier/Divider Tool on page 117

188

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

MultiplierDividerToolEffectiveMultiplicationFactorEffective multiplication factor of the selected Multiplier/Divider Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Integer RW

Parent Category: IOToolbox Category on page 182

DescriptionEffective multiplication factor of the selected Multiplier/Divider Tool.This feature is the numerator of the fraction defining the Effective Rate Conversion Ratio (Effective RCR) of theMultiplier/Divider Tool.Effective RCR = Effective M/Effective D where:

• Effective M =MultiplierDividerToolEffectiveMultiplicationFactor• Effective D = MultiplierDividerToolEffectiveDivisionFactor

Related Functional Guide Topic(s)Multiplier/Divider Tool on page 117

MultiplierDividerToolEffectiveDivisionFactorEffective division factor of the selected Multiplier/Divider Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Integer RW

Parent Category: IOToolbox Category on page 182

DescriptionEffective division factor of the selected Multiplier/Divider Tool.This feature is the denominator of the fraction defining the Effective Rate Conversion Ratio (Effective RCR) of theMultiplier/Divider Tool.Effective RCR = Effective M/Effective D where:

• Effective M =MultiplierDividerToolEffectiveMultiplicationFactor• Effective D = MultiplierDividerToolEffectiveDivisionFactor

Related Functional Guide Topic(s)Multiplier/Divider Tool on page 117

189

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

QuadratureDecoderToolSelectorSelects a Quadrature Decoder Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionSelects a Quadrature Decoder Tool.

Selected Features• QuadratureDecoderToolSources on page 190• QuadratureDecoderToolActivation on page 191• QuadratureDecoderToolForwardDirection on page 192• QuadratureDecoderToolOutputMode on page 192• QuadratureDecoderToolPosition on page 193• QuadratureDecoderToolDirection on page 193• QuadratureDecoderToolPositionReset on page 194

Enumeration Values• QDC1: Quadrature Decoder Tool 1.• QDC2: Quadrature Decoder Tool 2.

Related Functional Guide Topic(s)Quadrature Decoder Tool on page 110

QuadratureDecoderToolSourcesSelects the line input pair to use as A/B line input

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

DescriptionSelects the pair of physical GPIO lines used as A/B inputs for the selected Quadrature Decoder Tool.

190

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

Enumeration Values• DIN11_DIN12: Differential inputs 1 and 2 of Internal I/O connector 1.• DIN21_DIN22: Differential inputs 1 and 2 of Internal I/O connector 2.• IIN11_IIN12: Isolated inputs 1 and 2 of Internal I/O connector 1.• IIN13_IIN14: Isolated inputs 3 and 4 of Internal I/O connector 1.• IIN21_IIN22: Isolated inputs 1 and 2 of Internal I/O connector 2.• IIN23_IIN24: Isolated inputs 3 and 4 of Internal I/O connector 2.• TTLIO11_TTLIO12: TTL inputs 1 and 2 of Internal I/O connector 1.• TTLIO21_TTLIO22: TTL inputs 1 and 2 of Internal I/O connector 2.

Related Functional Guide Topic(s)Quadrature Decoder Tool on page 110

QuadratureDecoderToolActivationEdge activating the output of the selected Quadrature Decoder Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

DescriptionEdge activating the output of the selected Quadrature Decoder Tool.

Note: The A output of the quadrature encoder device connects to the first physical GPIO line of thedesignated pair, e.g. DIN11.

Note: The B output of the quadrature encoder device connects to the second physical GPIO line ofthe designated pair, e.g. DIN12.

Enumeration Values• RisingEdgeA: The event is activated on the rising edge of the A signal.• FallingEdgeA: The event is activated on the falling edge of the A signal.• AllEdgesA: The event is activated on both edges of the A signal.• AllEdgesAB: The event is activated on both edges of all signals.• None: The event is not activated.

Related Functional Guide Topic(s)Quadrature Decoder Tool on page 110

191

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

QuadratureDecoderToolForwardDirectionSelects the A/B phase relationship corresponding to the forward direction

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionSelects the A/B phase relationship corresponding to the forward direction.

Enumeration Values• A_Leads_B: A leads B.• B_Leads_A: B leads A.

Related Functional Guide Topic(s)Quadrature Decoder Tool on page 110

QuadratureDecoderToolOutputModeSelects the filtering mode of the backward motion compensator

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionSelects the filtering mode of the backward motion compensator.

Enumeration Values• Unfiltered: All the quadrature decoder events are delivered.• ForwardOnly: Only the events corresponding to the forward motion are delivered.• FirstPassForwardOnly: Only the events corresponding to the first pass in the forward direction are delivered.

Related Functional Guide Topic(s)Quadrature Decoder Tool on page 110

192

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

QuadratureDecoderToolPositionPosition counter value of the selected Quadrature Decoder Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox IntReg RO

Parent Category: IOToolbox Category on page 182Register Port: InterfacePort

DescriptionPosition counter value of the selected Quadrature Decoder Tool.The position counter is a 32-bit up/down counter that increments by 1 for any event corresponding to the forwarddirection and decrements by 1 for the backward direction.Unit: encoder events as defined by QuadratureDecoderToolActivation.Value range: from -2,147,483,648 up to 2,147,483,647.Related Functional Guide Topic(s)Quadrature Decoder Tool on page 110

QuadratureDecoderToolDirectionCurrent direction of the selected Quadrature Decoder Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionCurrent direction of the selected Quadrature Decoder Tool.

Enumeration Values• Forward: Forward.• Backward: Backward.

Related Functional Guide Topic(s)Quadrature Decoder Tool on page 110

193

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

QuadratureDecoderToolPositionResetReset Position counter of the selected Quadrature Decoder Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Command Imposed: WO

Parent Category: IOToolbox Category on page 182

Short DescriptionReset Position counter of the selected Quadrature Decoder Tool.Related Functional Guide Topic(s)Quadrature Decoder Tool on page 110

DividerToolSelectorSelects a Divider Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionSelects a Divider Tool.

Selected Features• DividerToolSource on page 195• DividerToolEnableControl on page 196• DividerToolDivisionFactor on page 196• DividerToolInitialOffset on page 197

Enumeration Values• DIV1: Divider Tool 1.• DIV2: Divider Tool 2.

Related Functional Guide Topic(s)Divider Tool on page 116

194

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

DividerToolSourceI/O Toolbox event stream used as input for the selected Divider Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionI/O Toolbox event stream used as input for the selected Divider Tool.

Enumeration Values• NONE: No event stream.• LIN1: When an event occurs on Line Input Tool 1.• LIN2: When an event occurs on Line Input Tool 2.• LIN3: When an event occurs on Line Input Tool 3.• LIN4: When an event occurs on Line Input Tool 4.• LIN5: When an event occurs on Line Input Tool 5.• LIN6: When an event occurs on Line Input Tool 6.• LIN7: When an event occurs on Line Input Tool 7.• LIN8: When an event occurs on Line Input Tool 8.• QDC1: When an event occurs on Quadrature Decoder Tool 1.• QDC2: When an event occurs on Quadrature Decoder Tool 2.• MDV1: When an event occurs on Multiplier/Divider Tool 1.• MDV2: When an event occurs on Multiplier/Divider Tool 2.• DIV1: When an event occurs on Divider Tool 1.• DIV2: When an event occurs on Divider Tool 2.• DEL1_1: When an event occurs on Delay Tool 1 Output 1.• DEL1_2: When an event occurs on Delay Tool 1 Output 2.• DEL2_1: When an event occurs on Delay Tool 2 Output 1.• DEL2_2: When an event occurs on Delay Tool 2 Output 2.• EIN1: When an event occurs on Event Input Tool 1.• EIN2: When an event occurs on Event Input Tool 2.• UserEvent1: When an event occurs on User Event 1.• UserEvent2: When an event occurs on User Event 2.• UserEvent3: When an event occurs on User Event 3.• UserEvent4: When an event occurs on User Event 4.

Related Functional Guide Topic(s)Divider Tool on page 116

195

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

DividerToolEnableControlOutput control of the selected Divider Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionOutput control of the selected Divider Tool.

Enumeration Values• Enable: Output enabled.• Disable: Output disabled.

Related Functional Guide Topic(s)Divider Tool on page 116

DividerToolDivisionFactorDivider value of the selected Divider Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Integer RW

Parent Category: IOToolbox Category on page 182

Value InfoMinimum value: 1Maximum value: 65535Default value: 2

DescriptionDivision factor of the selected Divider Tool.This feature is the denominator of the fraction defining the Rate Conversion Ratio (RCR) of the Divider Tool.RCR = 1/D where:

• D = DividerToolDivisionFactor

Related Functional Guide Topic(s)Divider Tool on page 116

196

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

DividerToolInitialOffsetInitial value of the selected Divider Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Integer RW

Parent Category: IOToolbox Category on page 182

Value InfoMinimum value: 0Maximum value: 65535

DescriptionInitial offset of the selected Divider Tool.This feature defines the number of skipped input events aer enabling the Divider tool.Related Functional Guide Topic(s)Divider Tool on page 116

DelayToolSelectorSelects a Delay Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionSelects a Delay Tool.

Selected Features• DelayToolSource1 on page 198• DelayToolSource2 on page 199• DelayToolClockSource on page 200• DelayToolDelayValue on page 200

Enumeration Values• DEL1: Delay Tool 1.• DEL2: Delay Tool 2.

197

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

Related Functional Guide Topic(s)Delay Tool on page 119

DelayToolSource1I/O Toolbox event stream used as input 1 for the selected Delay Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionI/O Toolbox event stream used as input 1 for the selected Delay Tool.

Enumeration Values• NONE: No event stream.• LIN1: When an event occurs on Line Input Tool 1.• LIN2: When an event occurs on Line Input Tool 2.• LIN3: When an event occurs on Line Input Tool 3.• LIN4: When an event occurs on Line Input Tool 4.• LIN5: When an event occurs on Line Input Tool 5.• LIN6: When an event occurs on Line Input Tool 6.• LIN7: When an event occurs on Line Input Tool 7.• LIN8: When an event occurs on Line Input Tool 8.• QDC1: When an event occurs on Quadrature Decoder Tool 1.• QDC2: When an event occurs on Quadrature Decoder Tool 2.• MDV1: When an event occurs on Multiplier/Divider Tool 1.• MDV2: When an event occurs on Multiplier/Divider Tool 2.• DIV1: When an event occurs on Divider Tool 1.• DIV2: When an event occurs on Divider Tool 2.• DEL1_1: When an event occurs on Delay Tool 1 Output 1.• DEL1_2: When an event occurs on Delay Tool 1 Output 2.• DEL2_1: When an event occurs on Delay Tool 2 Output 1.• DEL2_2: When an event occurs on Delay Tool 2 Output 2.• EIN1: When an event occurs on Event Input Tool 1.• EIN2: When an event occurs on Event Input Tool 2.• UserEvent1: When an event occurs on User Event 1.• UserEvent2: When an event occurs on User Event 2.• UserEvent3: When an event occurs on User Event 3.• UserEvent4: When an event occurs on User Event 4.

Related Functional Guide Topic(s)Delay Tool on page 119

198

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

DelayToolSource2I/O Toolbox event stream used as input 2 for the selected Delay Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionI/O Toolbox event stream used as input 2 for the selected Delay Tool.

Enumeration Values• NONE: No event stream.• LIN1: When an event occurs on Line Input Tool 1.• LIN2: When an event occurs on Line Input Tool 2.• LIN3: When an event occurs on Line Input Tool 3.• LIN4: When an event occurs on Line Input Tool 4.• LIN5: When an event occurs on Line Input Tool 5.• LIN6: When an event occurs on Line Input Tool 6.• LIN7: When an event occurs on Line Input Tool 7.• LIN8: When an event occurs on Line Input Tool 8.• QDC1: When an event occurs on Quadrature Decoder Tool 1.• QDC2: When an event occurs on Quadrature Decoder Tool 2.• MDV1: When an event occurs on Multiplier/Divider Tool 1.• MDV2: When an event occurs on Multiplier/Divider Tool 2.• DIV1: When an event occurs on Divider Tool 1.• DIV2: When an event occurs on Divider Tool 2.• DEL1_1: When an event occurs on Delay Tool 1 Output 1.• DEL1_2: When an event occurs on Delay Tool 1 Output 2.• DEL2_1: When an event occurs on Delay Tool 2 Output 1.• DEL2_2: When an event occurs on Delay Tool 2 Output 2.• EIN1: When an event occurs on Event Input Tool 1.• EIN2: When an event occurs on Event Input Tool 2.• UserEvent1: When an event occurs on User Event 1.• UserEvent2: When an event occurs on User Event 2.• UserEvent3: When an event occurs on User Event 3.• UserEvent4: When an event occurs on User Event 4.

Related Functional Guide Topic(s)Delay Tool on page 119

199

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

DelayToolClockSourceI/O Toolbox event stream used as clock

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionI/O Toolbox event stream used as clock.

Enumeration Values• NONE: No event stream.• TIME8NS: Clock input 8 nanoseconds time base.• TIME200NS: Clock input 200 nanoseconds time base.• TIME1US: Clock input 1 microsecond time base.• LIN1: When an event occurs on Line Input Tool 1.• LIN2: When an event occurs on Line Input Tool 2.• LIN3: When an event occurs on Line Input Tool 3.• LIN4: When an event occurs on Line Input Tool 4.• LIN5: When an event occurs on Line Input Tool 5.• LIN6: When an event occurs on Line Input Tool 6.• LIN7: When an event occurs on Line Input Tool 7.• LIN8: When an event occurs on Line Input Tool 8.• QDC1: When an event occurs on Quadrature Decoder Tool 1.• QDC2: When an event occurs on Quadrature Decoder Tool 2.

Related Functional Guide Topic(s)Delay Tool on page 119

DelayToolDelayValueDelay value of the selected Delay Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Integer RW

Parent Category: IOToolbox Category on page 182

200

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

Value InfoMinimum value: 0Maximum value: 16777215Default value: 0

DescriptionDelay value of the selected Delay Tool.Unit: time or event according to DelayToolClockSource .Related Functional Guide Topic(s)Delay Tool on page 119

EventInputToolSelectorSelects an Event Input Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionSelects an Event Input Tool.

Selected Features• EventInputToolSource on page 202• EventInputToolActivation on page 202

Enumeration Values• EIN1: Event Input Tool 1.• EIN2: Event Input Tool 2.

Related Functional Guide Topic(s)Event Input Tool on page 115

201

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

EventInputToolSourceCoaXPress connector used as input for the selected Event Input Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionCoaXPress connector used as input for the selected Event Input Tool.

Enumeration Values• A: CoaXPress physical host connection A..

Related Functional Guide Topic(s)Event Input Tool on page 115

EventInputToolActivationSignal activating the output of the selected Event Input Tool

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox Enumeration RW

Parent Category: IOToolbox Category on page 182

Short DescriptionSignal activating the output of the selected Event Input Tool.

Enumeration Values• StartOfScan: Receipt of start of scan signal.• EndOfScan: Receipt of end of scan signal.

Related Functional Guide Topic(s)Event Input Tool on page 115

202

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

InternalTimeReports the Coaxlink card internal time

Feature Info

Module Category Path Type Access

Interface Root / IOToolbox IntReg RO

Parent Category: IOToolbox Category on page 182Register Port: InterfacePort

Short DescriptionReports the Coaxlink card internal time.

PCIExpress CategoryCategory Members

PCIeMaxPayloadSizeSupported on page 203PCIeMaxPayloadSize on page 204PCIeMaxReadRequestSize on page 204PCIeMaxLinkSpeed on page 204PCIeCurrentLinkSpeed on page 205PCIeMaximumLinkWidth on page 205PCIeNegotiatedLinkWidth on page 206PCIeLinkSpeed2500MTpsSupported on page 206PCIeLinkSpeed5000MTpsSupported on page 207PCIeLinkSpeed8000MTpsSupported on page 207

PCIeMaxPayloadSizeSupportedMax Payload Size Supported

Feature Info

Module Category Path Type Access

Interface Root / PCIExpress IntReg RO

Parent Category: PCIExpress Category on page 203Register Port: InterfacePort

203

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

Short DescriptionMax Payload Size Supported.

PCIeMaxPayloadSizeMax Payload Size

Feature Info

Module Category Path Type Access

Interface Root / PCIExpress IntReg RO

Parent Category: PCIExpress Category on page 203Register Port: InterfacePort

Short DescriptionMax Payload Size.

PCIeMaxReadRequestSizeMax Read Request Size

Feature Info

Module Category Path Type Access

Interface Root / PCIExpress IntReg RO

Parent Category: PCIExpress Category on page 203Register Port: InterfacePort

Short DescriptionMax Read Request Size.

PCIeMaxLinkSpeedMax Link Speed

Feature Info

Module Category Path Type Access

Interface Root / PCIExpress Enumeration Imposed: RO

Parent Category: PCIExpress Category on page 203

204

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

Short DescriptionMax Link Speed.

Enumeration Values• NotAvailable: Not available.• PCIeLinkSpeed2500MTps: 2.5 GT/s.• PCIeLinkSpeed5000MTps: 5.0 GT/s.• PCIeLinkSpeed8000MTps: 8.0 GT/s.

PCIeCurrentLinkSpeedCurrent Link Speed

Feature Info

Module Category Path Type Access

Interface Root / PCIExpress Enumeration Imposed: RO

Parent Category: PCIExpress Category on page 203

Short DescriptionCurrent Link Speed.

Enumeration Values• NotAvailable: Not available.• PCIeLinkSpeed2500MTps: 2.5 GT/s.• PCIeLinkSpeed5000MTps: 5.0 GT/s.• PCIeLinkSpeed8000MTps: 8.0 GT/s.

PCIeMaximumLinkWidthMaximum Link Width

Feature Info

Module Category Path Type Access

Interface Root / PCIExpress Enumeration Imposed: RO

Parent Category: PCIExpress Category on page 203

Short DescriptionMaximum Link Width.

205

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

Enumeration Values• NotAvailable: Not available.• x1: 1 Lane.• x2: 2 Lanes.• x4: 4 Lanes.• x8: 8 Lanes.• x12: 12 Lanes.• x16: 16 Lanes.• x32: 32 Lanes.

PCIeNegotiatedLinkWidthNegotiated Link Width

Feature Info

Module Category Path Type Access

Interface Root / PCIExpress Enumeration Imposed: RO

Parent Category: PCIExpress Category on page 203

Short DescriptionNegotiated Link Width.

Enumeration Values• NotAvailable: Not available.• x1: 1 Lane.• x2: 2 Lanes.• x4: 4 Lanes.• x8: 8 Lanes.• x12: 12 Lanes.• x16: 16 Lanes.• x32: 32 Lanes.

PCIeLinkSpeed2500MTpsSupportedLink Speed 2.5 GT/s supported

Feature Info

Module Category Path Type Access

Interface Root / PCIExpress Boolean RW

Parent Category: PCIExpress Category on page 203

206

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

Short DescriptionLink Speed 2.5 GT/s supported.

PCIeLinkSpeed5000MTpsSupportedLink Speed 5.0 GT/s supported

Feature Info

Module Category Path Type Access

Interface Root / PCIExpress Boolean RW

Parent Category: PCIExpress Category on page 203

Short DescriptionLink Speed 5.0 GT/s supported.

PCIeLinkSpeed8000MTpsSupportedLink Speed 8.0 GT/s supported

Feature Info

Module Category Path Type Access

Interface Root / PCIExpress Boolean RW

Parent Category: PCIExpress Category on page 203

Short DescriptionLink Speed 8.0 GT/s supported.

InterfaceControl CategoryCategory Members

FanStatus on page 208TemperatureSensorSelector on page 208Temperature on page 209AuxiliaryPowerInput on page 209AuxiliaryPower12VInput on page 209

207

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

FanStatusFan Status

Feature Info

Module Category Path Type Access

Interface Root / InterfaceControl Enumeration Imposed: RO

Parent Category: InterfaceControl Category on page 207

Short DescriptionFan Status.

Enumeration Values• OK: Fan speed is OK.• NotOK: Fan speed is not OK.

TemperatureSensorSelectorTemperature Sensor Selector

Feature Info

Module Category Path Type Access

Interface Root / InterfaceControl Enumeration RW

Parent Category: InterfaceControl Category on page 207

Short DescriptionTemperature Sensor Selector.

Selected Features• Temperature on page 209

Enumeration Values• Grabber: Grabber Temperature Sensor.

208

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

TemperatureTemperature

Feature Info

Module Category Path Type Access

Interface Root / InterfaceControl SwissKnife RW

Parent Category: InterfaceControl Category on page 207

DescriptionReturns the temperature, expressed in °C measured by the selected temperature sensor.

AuxiliaryPowerInputAuxiliary Power Input

Feature Info

Module Category Path Type Access

Interface Root / InterfaceControl Enumeration Imposed: RO

Parent Category: InterfaceControl Category on page 207

DescriptionAuxiliary power input cable connection status.

Note: This status is valid only if a PEG-compliant power supply is attached to the Coaxlink auxiliarypower input connector through a PEG-compliant power cable.

Enumeration Values• Unconnected: There is no PEG-compliant power cable connected to the auxiliary power input.• Connected: A PEG-compliant power cable is connected to the auxiliary power input.

AuxiliaryPower12VInputReturn the status of the 12V Auxiliary Power Input

Feature Info

Module Category Path Type Access

Interface Root / InterfaceControl Enumeration Imposed: RO

209

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

Parent Category: InterfaceControl Category on page 207

Short DescriptionReturn the status of the 12V Auxiliary Power Input.

Enumeration Values• NotOK: The 12V auxiliary power input is NOK.• OK: The 12V auxiliary power input is OK.

InterfaceDetails CategoryCategory Members

BoardCapabilities on page 210FirmwareBoardID on page 211CPLDRevision on page 211PreviousBootBank on page 211NextBootBank on page 212CurrentBankSelect on page 212CurrentBankSelectReadback on page 212NextBankSelect on page 213SpiBankStatus on page 213PotBankStatus on page 213

BoardCapabilitiesBoard Capabilities

Feature Info

Module Category Path Type Access

Interface Root / InterfaceDetails StringReg RO

Parent Category: InterfaceDetails Category on page 210

Short DescriptionBoard Capabilities.

210

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

FirmwareBoardIDFirmware Board ID

Feature Info

Module Category Path Type Access

Interface Root / InterfaceDetails IntReg RO

Parent Category: InterfaceDetails Category on page 210Register Port: InterfacePort

Short DescriptionFirmware Board ID.

CPLDRevisionCPLD Revision

Feature Info

Module Category Path Type Access

Interface Root / InterfaceDetails Integer RW

Parent Category: InterfaceDetails Category on page 210

Short DescriptionCPLD Revision.

PreviousBootBankFlash bank used during the previous power on

Feature Info

Module Category Path Type Access

Interface Root / InterfaceDetails IntSwissKnife RW

Parent Category: InterfaceDetails Category on page 210

Short DescriptionFlash bank used during the previous power on.

211

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

NextBootBankFlash bank that will be used during the next power on

Feature Info

Module Category Path Type Access

Interface Root / InterfaceDetails IntSwissKnife RW

Parent Category: InterfaceDetails Category on page 210

Short DescriptionFlash bank that will be used during the next power on.

CurrentBankSelectCurrent Bank Select

Feature Info

Module Category Path Type Access

Interface Root / InterfaceDetails IntSwissKnife RW

Parent Category: InterfaceDetails Category on page 210

Short DescriptionCurrent Bank Select.

CurrentBankSelectReadbackCurrent Bank Select Readback

Feature Info

Module Category Path Type Access

Interface Root / InterfaceDetails IntSwissKnife RW

Parent Category: InterfaceDetails Category on page 210

Short DescriptionCurrent Bank Select Readback.

212

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

NextBankSelectNext Bank Select

Feature Info

Module Category Path Type Access

Interface Root / InterfaceDetails IntSwissKnife RW

Parent Category: InterfaceDetails Category on page 210

Short DescriptionNext Bank Select.

SpiBankStatusSpi Bank Status

Feature Info

Module Category Path Type Access

Interface Root / InterfaceDetails IntReg RO

Parent Category: InterfaceDetails Category on page 210Register Port: InterfacePort

Short DescriptionSpi Bank Status.

PotBankStatusPot Bank Status

Feature Info

Module Category Path Type Access

Interface Root / InterfaceDetails IntReg RO

Parent Category: InterfaceDetails Category on page 210Register Port: InterfacePort

Short DescriptionPot Bank Status.

213

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

EventControl CategoryCategory Members

EventSelector on page 214EventNotification on page 215EventNotificationContext1 on page 216EventNotificationContext2 on page 217EventNotificationContext3 on page 218EventCount on page 219EventCountReset on page 219Related Functional Guide Topic(s)Event Signaling And Counting on page 129Extensive user-configurable event-reporting and event-counting mechanism

EventSelectorSelect an event

Feature Info

Module Category Path Type Access

Interface Root / EventControl Enumeration RW

Parent Category: EventControl Category on page 214

Short DescriptionSelect an event.

Selected Features• EventNotification on page 215• EventNotificationContext1 on page 216• EventNotificationContext2 on page 217• EventNotificationContext3 on page 218• EventCount on page 219• EventCountReset on page 219

Enumeration Values• LIN1: Line Input Tool 1.• LIN2: Line Input Tool 2.• LIN3: Line Input Tool 3.• LIN4: Line Input Tool 4.• LIN5: Line Input Tool 5.• LIN6: Line Input Tool 6.• LIN7: Line Input Tool 7.

214

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

• LIN8: Line Input Tool 8.• QDC1: Quadrature Decoder Tool 1.• QDC1Dir: Quadrature Decoder Tool 1 Changed Direction.• QDC2: Quadrature Decoder Tool 2.• QDC2Dir: Quadrature Decoder Tool 2 Changed Direction.• DIV1: Divider Tool 1.• DIV2: Divider Tool 2.• MDV1: Multiplier/Divider Tool 1.• MDV2: Multiplier/Divider Tool 2.• DEL11: Delay Tool 1 Output 1.• DEL12: Delay Tool 1 Output 2.• DEL21: Delay Tool 2 Output 1.• DEL22: Delay Tool 2 Output 2.• UserEvent1: User Event 1.• UserEvent2: User Event 2.• UserEvent3: User Event 3.• UserEvent4: User Event 4.• EIN1: Event Input Tool 1.• EIN2: Event Input Tool 2.• CrcErrorCxpA: Detected CRC error on CXP connector A.• CrcErrorCxpB: Detected CRC error on CXP connector B.• CrcErrorCxpC: Detected CRC error on CXP connector C.• CrcErrorCxpD: Detected CRC error on CXP connector D.

Related Functional Guide Topic(s)Event Control GenICam Features (Interface) on page 135

EventNotificationActivate or deactivate the notification to the host application of the occurrence of the selected event

Feature Info

Module Category Path Type Access

Interface Root / EventControl Boolean RW

Parent Category: EventControl Category on page 214

Short DescriptionActivate or deactivate the notification to the host application of the occurrence of the selected event.Related Functional Guide Topic(s)Event Control GenICam Features (Interface) on page 135

215

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

EventNotificationContext1Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_1

Feature Info

Module Category Path Type Access

Interface Root / EventControl Enumeration RW

Parent Category: EventControl Category on page 214

Short DescriptionSelect context information reported in EVENT_DATA_CUSTOM_CONTEXT_1.

Enumeration Values• EventSpecific: Event-specific context information.• LineStatusAll: Value of LineStatusAll.• LIN1EventCount: Number of LIN1 events.• LIN2EventCount: Number of LIN2 events.• LIN3EventCount: Number of LIN3 events.• LIN4EventCount: Number of LIN4 events.• LIN5EventCount: Number of LIN5 events.• LIN6EventCount: Number of LIN6 events.• LIN7EventCount: Number of LIN7 events.• LIN8EventCount: Number of LIN8 events.• QDC1EventCount: Number of QDC1 events.• QDC1DirEventCount: Number of QDC1Dir events.• QDC2EventCount: Number of QDC2 events.• QDC2DirEventCount: Number of QDC2Dir events.• DIV1EventCount: Number of DIV1 events.• DIV2EventCount: Number of DIV2 events.• MDV1EventCount: Number of MDV1 events.• MDV2EventCount: Number of MDV2 events.• DEL11EventCount: Number of DEL11 events.• DEL12EventCount: Number of DEL12 events.• DEL21EventCount: Number of DEL21 events.• DEL22EventCount: Number of DEL22 events.• UserEvent1EventCount: Number of UserEvent1 events.• UserEvent2EventCount: Number of UserEvent2 events.• UserEvent3EventCount: Number of UserEvent3 events.• UserEvent4EventCount: Number of UserEvent4 events.• EIN1EventCount: Number of EIN1 events.• EIN2EventCount: Number of EIN2 events.• CrcErrorCxpAEventCount: Number of CrcErrorCxpA events.• CrcErrorCxpBEventCount: Number of CrcErrorCxpB events.• CrcErrorCxpCEventCount: Number of CrcErrorCxpC events.• CrcErrorCxpDEventCount: Number of CrcErrorCxpD events.

216

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

Related Functional Guide Topic(s)Event Control GenICam Features (Interface) on page 135

EventNotificationContext2Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_2

Feature Info

Module Category Path Type Access

Interface Root / EventControl Enumeration RW

Parent Category: EventControl Category on page 214

Short DescriptionSelect context information reported in EVENT_DATA_CUSTOM_CONTEXT_2.

Enumeration Values• EventSpecific: Event-specific context information.• LineStatusAll: Value of LineStatusAll.• LIN1EventCount: Number of LIN1 events.• LIN2EventCount: Number of LIN2 events.• LIN3EventCount: Number of LIN3 events.• LIN4EventCount: Number of LIN4 events.• LIN5EventCount: Number of LIN5 events.• LIN6EventCount: Number of LIN6 events.• LIN7EventCount: Number of LIN7 events.• LIN8EventCount: Number of LIN8 events.• QDC1EventCount: Number of QDC1 events.• QDC1DirEventCount: Number of QDC1Dir events.• QDC2EventCount: Number of QDC2 events.• QDC2DirEventCount: Number of QDC2Dir events.• DIV1EventCount: Number of DIV1 events.• DIV2EventCount: Number of DIV2 events.• MDV1EventCount: Number of MDV1 events.• MDV2EventCount: Number of MDV2 events.• DEL11EventCount: Number of DEL11 events.• DEL12EventCount: Number of DEL12 events.• DEL21EventCount: Number of DEL21 events.• DEL22EventCount: Number of DEL22 events.• UserEvent1EventCount: Number of UserEvent1 events.• UserEvent2EventCount: Number of UserEvent2 events.• UserEvent3EventCount: Number of UserEvent3 events.• UserEvent4EventCount: Number of UserEvent4 events.• EIN1EventCount: Number of EIN1 events.• EIN2EventCount: Number of EIN2 events.• CrcErrorCxpAEventCount: Number of CrcErrorCxpA events.• CrcErrorCxpBEventCount: Number of CrcErrorCxpB events.

217

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

• CrcErrorCxpCEventCount: Number of CrcErrorCxpC events.• CrcErrorCxpDEventCount: Number of CrcErrorCxpD events.

Related Functional Guide Topic(s)Event Control GenICam Features (Interface) on page 135

EventNotificationContext3Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_3

Feature Info

Module Category Path Type Access

Interface Root / EventControl Enumeration RW

Parent Category: EventControl Category on page 214

Short DescriptionSelect context information reported in EVENT_DATA_CUSTOM_CONTEXT_3.

Enumeration Values• EventSpecific: Event-specific context information.• LineStatusAll: Value of LineStatusAll.• LIN1EventCount: Number of LIN1 events.• LIN2EventCount: Number of LIN2 events.• LIN3EventCount: Number of LIN3 events.• LIN4EventCount: Number of LIN4 events.• LIN5EventCount: Number of LIN5 events.• LIN6EventCount: Number of LIN6 events.• LIN7EventCount: Number of LIN7 events.• LIN8EventCount: Number of LIN8 events.• QDC1EventCount: Number of QDC1 events.• QDC1DirEventCount: Number of QDC1Dir events.• QDC2EventCount: Number of QDC2 events.• QDC2DirEventCount: Number of QDC2Dir events.• DIV1EventCount: Number of DIV1 events.• DIV2EventCount: Number of DIV2 events.• MDV1EventCount: Number of MDV1 events.• MDV2EventCount: Number of MDV2 events.• DEL11EventCount: Number of DEL11 events.• DEL12EventCount: Number of DEL12 events.• DEL21EventCount: Number of DEL21 events.• DEL22EventCount: Number of DEL22 events.• UserEvent1EventCount: Number of UserEvent1 events.• UserEvent2EventCount: Number of UserEvent2 events.• UserEvent3EventCount: Number of UserEvent3 events.• UserEvent4EventCount: Number of UserEvent4 events.• EIN1EventCount: Number of EIN1 events.

218

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

• EIN2EventCount: Number of EIN2 events.• CrcErrorCxpAEventCount: Number of CrcErrorCxpA events.• CrcErrorCxpBEventCount: Number of CrcErrorCxpB events.• CrcErrorCxpCEventCount: Number of CrcErrorCxpC events.• CrcErrorCxpDEventCount: Number of CrcErrorCxpD events.

Related Functional Guide Topic(s)Event Control GenICam Features (Interface) on page 135

EventCountNumber of occurrences of the selected event (32-bit counter)

Feature Info

Module Category Path Type Access

Interface Root / EventControl IntReg RO

Parent Category: EventControl Category on page 214Register Port: InterfacePort

Short DescriptionNumber of occurrences of the selected event (32-bit counter).Related Functional Guide Topic(s)Event Control GenICam Features (Interface) on page 135

EventCountResetReset the selected EventCount

Feature Info

Module Category Path Type Access

Interface Root / EventControl Command Imposed: WO

Parent Category: EventControl Category on page 214

Short DescriptionReset the selected EventCount.Related Functional Guide Topic(s)Event Control GenICam Features (Interface) on page 135

219

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

OemSafetyKey CategoryCategory Members

OemSafetyKeyVerification on page 220CheckOemSafetyKey on page 221ProgramOemSafetyKey on page 221EncryptedOemSafetyKey on page 222MaximumOemKeyLength on page 222Related Functional Guide Topic(s)OEM Safety Key on page 138User-configurable safety key programming and checking capability

OemSafetyKeyVerificationDefines which key can be compared with the programmed OEM safety key

Feature Info

Module Category Path Type Access

Interface Root / OemSafetyKey Enumeration RW

Parent Category: OemSafetyKey Category on page 220

DescriptionDefines which key can be compared with the programmed OEM safety key.Acts as a selector for CheckOemSafetyKey.Recommended value: EncryptedKey.Default value: ProgrammingKeyOrEncryptedKey.

Selected Features• CheckOemSafetyKey on page 221

Enumeration Values• ProgrammingKey: Only the key written to ProgramOemSafetyKey can be used to verify the OEM safety key.• EncryptedKey: Only the key read from EncryptedOemSafetyKey can be used to verify the OEM safety key

(recommended).• ProgrammingKeyOrEncryptedKey: Both the key written to ProgramOemSafetyKey and the key read from

EncryptedOemSafetyKey can be used to verify the OEM safety key.

Related Functional Guide Topic(s)OEM Safety Key on page 138

220

Interface Module Features   Coaxlink Driver 7.0 Functional Guide

User-configurable safety key programming and checking capability

CheckOemSafetyKeyWrite-only string to use for comparing a key (c.f. OemSafetyKeyVerification) and the programmed OEM safetykey

Feature Info

Module Category Path Type Access

Interface Root / OemSafetyKey String Imposed: WO

Parent Category: OemSafetyKey Category on page 220

DescriptionWrite-only string to use for comparing a key (the key written to ProgramOemSafetyKey or the key read fromEncryptedOemSafetyKey) and the programmed OEM safety key.Related Functional Guide Topic(s)OEM Safety Key on page 138User-configurable safety key programming and checking capability

ProgramOemSafetyKeyWrite-only string to use for programming the non-volatile OEM safety key

Feature Info

Module Category Path Type Access

Interface Root / OemSafetyKey String Imposed: WO

Parent Category: OemSafetyKey Category on page 220

Short DescriptionWrite-only string to use for programming the non-volatile OEM safety key.Related Functional Guide Topic(s)OEM Safety Key on page 138

221

Coaxlink Driver 7.0 Functional Guide   Interface Module Features

User-configurable safety key programming and checking capability

EncryptedOemSafetyKeyRead-only string that contains the encrypted version of the OEM safety key just programmed withProgramOemSafetyKey

Feature Info

Module Category Path Type Access

Interface Root / OemSafetyKey String Imposed: RO

Parent Category: OemSafetyKey Category on page 220

DescriptionRead-only string that contains the encrypted version of the OEM safety key just programmed withProgramOemSafetyKey.Related Functional Guide Topic(s)OEM Safety Key on page 138User-configurable safety key programming and checking capability

MaximumOemKeyLengthMaximum length of strings that can be set to ProgramOemSafetyKey and CheckOemSafetyKey

Feature Info

Module Category Path Type Access

Interface Root / OemSafetyKey Integer RW

Parent Category: OemSafetyKey Category on page 220

Value InfoMinimum value: 40Maximum value: 2147483647

DescriptionThe length of ProgramOemSafetyKey and CheckOemSafetyKey is limited by MaximumOemKeyLength.Default value: 4096.

222

Device Module Features   Coaxlink Driver 7.0 Functional Guide

Device Module FeaturesCategorized list of Device GenTL module features

Root CategoryCategory Members

DeviceInformation on page 223StreamEnumeration on page 223CameraAndIlluminationControl on page 224CoaXPress on page 224EventControl on page 225Errors on page 225

DeviceInformation

Feature Info

Module Category Path Type Access

Device Root Category RW

Parent Category: Root Category on page 223

Category Members• DeviceID on page 226• DeviceVendorName on page 226• DeviceModelName on page 226• DeviceAccessStatus on page 227• DeviceType on page 227

StreamEnumeration

Feature Info

Module Category Path Type Access

Device Root Category RW

Parent Category: Root Category on page 223

223

Coaxlink Driver 7.0 Functional Guide   Device Module Features

Category Members• StreamSelector on page 228• StreamID on page 228

CameraAndIlluminationControlCamera and Illumination Controller features set

Feature Info

Module Category Path Type Access

Device Root Category RW

Parent Category: Root Category on page 223

DescriptionSet of features related to the Camera and Illumination Controller (CIC).

Category Members• CameraModel on page 234• CycleTiming on page 235• CycleControl on page 235• SequenceControl on page 236• DeviceReset on page 236

CoaXPress

Feature Info

Module Category Path Type Access

Device Root Category RW

Parent Category: Root Category on page 223

Category Members• CxpLinkConfiguration on page 229• CxpLinkConfigurationOption on page 230• CxpHostConnectionBase on page 230• CxpHostConnectionCount on page 231• CxpTriggerMessageFormat on page 231• CxpTriggerLevel on page 232• CxpTriggerAckTimeout on page 232• CxpTriggerMaxResendCount on page 233

224

Device Module Features   Coaxlink Driver 7.0 Functional Guide

• CxpPacketArbiterReset on page 233

EventControl

Feature Info

Module Category Path Type Access

Device Root Category RW

Parent Category: Root Category on page 223

Category Members• EventSelector on page 252• EventNotification on page 253• EventNotificationContext1 on page 253• EventNotificationContext2 on page 255• EventNotificationContext3 on page 256• EventCount on page 258• EventCountReset on page 258

Errors

Feature Info

Module Category Path Type Access

Device Root Category RW

Parent Category: Root Category on page 223

Category Members• ErrorSelector on page 259• ErrorCount on page 260• ErrorCountReset on page 260

DeviceInformation CategoryCategory Members

DeviceID on page 226DeviceVendorName on page 226DeviceModelName on page 226DeviceAccessStatus on page 227

225

Coaxlink Driver 7.0 Functional Guide   Device Module Features

DeviceType on page 227

DeviceIDInterface wide unique identifier of this device

Feature Info

Module Category Path Type Access

Device Root / DeviceInformation String Imposed: RO

Parent Category: DeviceInformation Category on page 225

Short DescriptionInterface wide unique identifier of this device.

DeviceVendorNameName of the device vendor

Feature Info

Module Category Path Type Access

Device Root / DeviceInformation String Imposed: RO

Parent Category: DeviceInformation Category on page 225

Short DescriptionName of the device vendor.

DeviceModelNameName of the device model

Feature Info

Module Category Path Type Access

Device Root / DeviceInformation String Imposed: RO

Parent Category: DeviceInformation Category on page 225

Short DescriptionName of the device model.

226

Device Module Features   Coaxlink Driver 7.0 Functional Guide

DeviceAccessStatusGives the device's access status at the moment of the last execution of DeviceUpdateList

Feature Info

Module Category Path Type Access

Device Root / DeviceInformation Enumeration Imposed: RO

Parent Category: DeviceInformation Category on page 225

Short DescriptionGives the device's access status at the moment of the last execution of DeviceUpdateList.

Enumeration Values• Unknown: Unknown access.• ReadWrite: Full access.• ReadOnly: Read-only access.• NoAccess: Another device has exclusive access.

DeviceTypeIdentifies the transport layer technology of the interface

Feature Info

Module Category Path Type Access

Device Root / DeviceInformation Enumeration Imposed: RO

Parent Category: DeviceInformation Category on page 225

Short DescriptionIdentifies the transport layer technology of the interface.

Enumeration Values• CXP: This enumeration value indicates CoaXPress transport layer technology.

StreamEnumeration CategoryCategory Members

StreamSelector on page 228StreamID on page 228

227

Coaxlink Driver 7.0 Functional Guide   Device Module Features

StreamSelectorSelector for the different stream channels

Feature Info

Module Category Path Type Access

Device Root / StreamEnumeration Integer RW

Parent Category: StreamEnumeration Category on page 227

Value InfoMinimum value: 0

Short DescriptionSelector for the different stream channels.

Selected Features• StreamID on page 228

StreamIDDevice unique ID for the stream

Feature Info

Module Category Path Type Access

Device Root / StreamEnumeration String Imposed: RO

Parent Category: StreamEnumeration Category on page 227

Short DescriptionDevice unique ID for the stream.

CoaXPress CategoryCategory Members

CxpLinkConfiguration on page 229CxpLinkConfigurationOption on page 230CxpHostConnectionBase on page 230CxpHostConnectionCount on page 231CxpTriggerMessageFormat on page 231

228

Device Module Features   Coaxlink Driver 7.0 Functional Guide

CxpTriggerLevel on page 232CxpTriggerAckTimeout on page 232CxpTriggerMaxResendCount on page 233CxpPacketArbiterReset on page 233Related Functional Guide Topic(s)CoaXPress Host Interface on page 25Specification and functional description of the CoaXPress Host interface

CxpLinkConfigurationCoaXPress link configuration

Feature Info

Module Category Path Type Access

Device Root / CoaXPress Enumeration RW

Parent Category: CoaXPress Category on page 228

DescriptionSet/report the CoaXPress Link configuration.

Enumeration Values• CXP1_X1: 1 connection @1.250 Gbps.• CXP2_X1: 1 connection @2.500 Gbps.• CXP3_X1: 1 connection @3.125 Gbps.• CXP5_X1: 1 connection @5.000 Gbps.• CXP6_X1: 1 connection @6.250 Gbps.• CXP1_X2: 2 connections @1.250 Gbps.• CXP2_X2: 2 connections @2.500 Gbps.• CXP3_X2: 2 connections @3.125 Gbps.• CXP5_X2: 2 connections @5.000 Gbps.• CXP6_X2: 2 connections @6.250 Gbps.• CXP1_X3: 3 connections @1.250 Gbps.• CXP2_X3: 3 connections @2.500 Gbps.• CXP3_X3: 3 connections @3.125 Gbps.• CXP5_X3: 3 connections @5.000 Gbps.• CXP6_X3: 3 connections @6.250 Gbps.• CXP1_X4: 4 connections @1.250 Gbps.• CXP2_X4: 4 connections @2.500 Gbps.• CXP3_X4: 4 connections @3.125 Gbps.• CXP5_X4: 4 connections @5.000 Gbps.• CXP6_X4: 4 connections @6.250 Gbps.• CXP1_X8: 8 connections @1.250 Gbps.• CXP2_X8: 8 connections @2.500 Gbps.• CXP3_X8: 8 connections @3.125 Gbps.• CXP5_X8: 8 connections @5.000 Gbps.

229

Coaxlink Driver 7.0 Functional Guide   Device Module Features

• CXP6_X8: 8 connections @6.250 Gbps.• Preferred: Camera Preferred Configuration.

Related Functional Guide Topic(s)Link Configuration on page 30CoaXPress Link configuration and discovery

CxpLinkConfigurationOptionCxpLinkConfiguration option

Feature Info

Module Category Path Type Access

Device Root / CoaXPress Enumeration RW

Parent Category: CoaXPress Category on page 228

Short DescriptionCxpLinkConfiguration option.

Selected Features• CxpLinkConfiguration on page 229

Enumeration Values• AlwaysWrite: Always write the link configuration to the camera.• WriteIfDifferent: Write the link configuration to the camera only if it is different from the current

configuration.

Related Functional Guide Topic(s)Link Configuration on page 30CoaXPress Link configuration and discovery

CxpHostConnectionBaseReturns the base CoaXPress physical connection of this device

Feature Info

Module Category Path Type Access

Device Root / CoaXPress Enumeration RW

Parent Category: CoaXPress Category on page 228

Short DescriptionReturns the base CoaXPress physical connection of this device.

230

Device Module Features   Coaxlink Driver 7.0 Functional Guide

Enumeration Values• A: CoaXPress physical host connection A.• B: CoaXPress physical host connection B.• C: CoaXPress physical host connection C.• D: CoaXPress physical host connection D.

Related Functional Guide Topic(s)Link Configuration on page 30CoaXPress Link configuration and discovery

CxpHostConnectionCountReturns the number of CoaXPress physical connections of this device

Feature Info

Module Category Path Type Access

Device Root / CoaXPress IntReg RO

Parent Category: CoaXPress Category on page 228Register Port: DevicePort

Short DescriptionReturns the number of CoaXPress physical connections of this device.Related Functional Guide Topic(s)Link Configuration on page 30CoaXPress Link configuration and discovery

CxpTriggerMessageFormatCoaXPress Host to Device trigger message format

Feature Info

Module Category Path Type Access

Device Root / CoaXPress Enumeration RW

Parent Category: CoaXPress Category on page 228

DescriptionSets/gets the CoaXPress Host to Device Trigger Message Format.When set to Pulse, every Camera Trigger requires two transactions on the Host to Device I/O Channel: one rising edgetrigger packet and one falling edge trigger packet. This is the standard behaviour.When set to "RisingEdge", every Camera Trigger requires a single transaction on the Host to Device I/O Channel: onerising edge trigger packet.

231

Coaxlink Driver 7.0 Functional Guide   Device Module Features

When set to CxpTriggerMessageFormat, every Camera Trigger generates a single message transaction on theHost to Device I/O Channel alternating rising edge or falling edge trigger messages.Default value: Pulse.

Enumeration Values• Pulse: Rising edge and falling edge CoaXPress trigger messages.• RisingEdge: Rising edge CoaXPress trigger message.• Toggle: Alternating rising edge or falling edge CoaXPress trigger message.

Related Functional Guide Topic(s)CoaXPress Host To Device Trigger on page 34Real-time Host-to-device triggering though the CoaXPress Link

CxpTriggerLevelCxp Trigger Level

Feature Info

Module Category Path Type Access

Device Root / CoaXPress Enumeration RW

Parent Category: CoaXPress Category on page 228

DescriptionThis feature allows to set or get the logical state of the CoaXPress Host to Device Trigger signal.Setting the logical state is only allowed when CxpTriggerMessageFormat is set to Toggle.Getting the logical state is allowed for any value of CxpTriggerMessageFormat.

Enumeration Values• Low: Next trigger message format will be rising edge CoaXPress trigger message.• High: Next trigger message format will be falling edge CoaXPress trigger message.

Related Functional Guide Topic(s)CoaXPress Host To Device Trigger on page 34Real-time Host-to-device triggering though the CoaXPress Link

CxpTriggerAckTimeoutCoaXPress Host to Device trigger acknowledge timeout value

Feature Info

Module Category Path Type Access

Device Root / CoaXPress Float RW

Parent Category: CoaXPress Category on page 228

232

Device Module Features   Coaxlink Driver 7.0 Functional Guide

Value InfoMinimum value: 0Maximum value: 2097.1469999999999

Short DescriptionCoaXPress Host to Device trigger acknowledge timeout value.Related Functional Guide Topic(s)CoaXPress Host To Device Trigger on page 34Real-time Host-to-device triggering though the CoaXPress Link

CxpTriggerMaxResendCountCoaXPress Host to Device trigger maximum resend count

Feature Info

Module Category Path Type Access

Device Root / CoaXPress Integer RW

Parent Category: CoaXPress Category on page 228

Value InfoMinimum value: 0Maximum value: 7

DescriptionSets/gets the maximum resend count of the CoaXPress Host to Device Trigger Message.Default value:3.Related Functional Guide Topic(s)CoaXPress Host To Device Trigger on page 34Real-time Host-to-device triggering though the CoaXPress Link

CxpPacketArbiterResetCoaXPress Host interface data packet arbiter reset

Feature Info

Module Category Path Type Access

Device Root / CoaXPress Command RW

Parent Category: CoaXPress Category on page 228

233

Coaxlink Driver 7.0 Functional Guide   Device Module Features

DescriptionCoaXPress Data Packet Arbiter Reset.Reset the CoaXPress Data Packet Arbiter to Connection 0.

Caution: This command is only useful for multi-connection cameras that unduly reset the round-Robinconnection sequence order.

CameraAndIlluminationControl CategoryCategory Members

CameraModel on page 234CycleTiming on page 235CycleControl on page 235SequenceControl on page 236DeviceReset on page 236

CameraModelBehavioral model of the camera

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl Category RW

Parent Category: CameraAndIlluminationControl Category on page 234

DescriptionSet of features describing the behavioral model of a grabber-controlled camera.

Note: These features defines the operating limits of the camera and are used to configure the trigger-overrun protection mechanism of the CIC.

Important: An incorrectly set behavioral model may prevent reaching the highest achievable cameracycle rate or, reversely, allow the grabber to assert triggers too quickly.

Category Members• CameraControlMethod on page 237• C2CLinkConfiguration on page 238• ExposureReadoutOverlap on page 238• ExposureRecoveryTime on page 239

234

Device Module Features   Coaxlink Driver 7.0 Functional Guide

CycleTimingCIC Cycle timing properties

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl Category RW

Parent Category: CameraAndIlluminationControl Category on page 234

DescriptionSet of features describing the CIC Cycle timing properties.

Category Members• ExposureTime on page 240• StrobeDelay on page 241• StrobeDuration on page 241

CycleControlCIC Cycle control properties

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl Category RW

Parent Category: CameraAndIlluminationControl Category on page 234

DescriptionSet of features describing the CIC cycle control properties.

Category Members• CycleTriggerSource on page 242• CycleTargetPeriod on page 243• StartCycle on page 244• CycleMaxPendingTriggerCount on page 245• CyclePendingTriggerCount on page 245• CycleLostTriggerCount on page 246• CycleLostTriggerCountReset on page 246

235

Coaxlink Driver 7.0 Functional Guide   Device Module Features

SequenceControlCIC Cycle Sequence control properties

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl Category RW

Parent Category: CameraAndIlluminationControl Category on page 234

DescriptionSet of features describing the CIC cycle sequence control properties.Default value: True.

Category Members• StartOfSequenceTriggerSource on page 247• EndOfSequenceTriggerSource on page 248• SequenceLength on page 249• StartSequence on page 250• StopSequence on page 250• AbortSequence on page 251

DeviceResetDevice Reset

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl Command RW

Parent Category: CameraAndIlluminationControl Category on page 234

DescriptionReset the CIC. ***TBD***

CameraModel CategoryCategory Members

CameraControlMethod on page 237C2CLinkConfiguration on page 238

236

Device Module Features   Coaxlink Driver 7.0 Functional Guide

ExposureReadoutOverlap on page 238ExposureRecoveryTime on page 239Related Functional Guide Topic(s)Camera and Illumination Controller on page 78Full description of the Camera and Illumination Controller

CameraControlMethodCamera Control Method

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / CameraModel Enumeration RW

Parent Category: CameraModel Category on page 236

DescriptionCamera control method.The NC camera control method is to be used with free-run or asynchronous reset cameras not controlled by the framegrabber.The RCcamera control method is to be used with asynchronous reset cameras having the camera cycle start controlledby the grabber CIC and the exposure time controlled by the camera.The RG camera control method is to be used with asynchronous reset cameras having the camera cycle start and theexposure duration controlled by the grabber CIC.The EXTERNAL camera control method is to be used with asynchronous reset cameras having the camera cycle startand the exposure duration controlled by a hardware signal applied by an external controller to any GPIO input portof the grabber.

Note: The NC and the EXTERNAL camera control methods doesn't use the CIC.

Enumeration Values• NC: Not Controlled.• RC: Grabber-controlled cycle start, Camera-controlled exposure time.• RG: Grabber-controlled cycle start and exposure time.• EXTERNAL: Externally-controlled cycle start and exposure time.

Related Functional Guide Topic(s)Camera Control Methods on page 74

237

Coaxlink Driver 7.0 Functional Guide   Device Module Features

C2CLinkConfigurationC2C Link Configuration

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / CameraModel Enumeration RW

Parent Category: CameraModel Category on page 236

DescriptionSets/gets the C2C-Link configuration.Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG).Default value: Disconnected.

Enumeration Values• Disconnected: Disconnected from the C2C-Link.• Master: Connected to the C2C-Link as the C2C-Link Master Device.• Slave: Connected to the C2C-Link as aC2C-Link Slave Device.

Related Functional Guide Topic(s)CIC Synchronization on page 91Synchronization of multiple Camera and Illumination controllers through the card-to-card link – C2C-Link.

Related Functional Guide Topic(s)CIC Synchronization on page 91Synchronization of multiple Camera and Illumination controllers through the card-to-card link – C2C-Link.

ExposureReadoutOverlapExposure Readout Overlapping Capability

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / CameraModel Boolean RW

Parent Category: CameraModel Category on page 236

DescriptionDeclares the exposure overlapping capability of the camera.Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG).When set to true, it indicates that the camera allows overlapping. The exposure phase of a new camera cycle is allowedto begin during the readout phase.

238

Device Module Features   Coaxlink Driver 7.0 Functional Guide

Wen set to false,it indicates that the camera doesn't allow overlapping. The exposure phase of a new camera cycle isnot allowed to begin before the completion of the readout phase.Default value: ***TBD***.Related Functional Guide Topic(s)Camera Cycle Concatenation Rules on page 73Consecutive Overlapping CIC Cycles on page 86Timing diagrams of consecutive overlapping CIC cycles

Related Functional Guide Topic(s)Cycle Timing Machine on page 78CIC Cycle timing machine

Aligning Camera and illumination Cycles on page 76

ExposureRecoveryTimeExposure Recovery Time

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / CameraModel Float RW

Parent Category: CameraModel Category on page 236

Value InfoMinimum value: 0Maximum value: 17179869.179000001Dimension: TimeUnit: microsecond [µs]Increment: 0.008

DescriptionSets/gets the exposure recovery time.This time represents the minimum time interval between two consecutive exposure phases.

Important: An incorrectly set value may, in case of large exposure time, prevent reaching the highestachievable camera cycle rate or, reversely, allow the grabber to assert triggers too quickly.

Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG).Default value: 1,000.0. (1 millisecond)Related Functional Guide Topic(s)Camera Cycle Concatenation Rules on page 73Consecutive Overlapping CIC Cycles on page 86Timing diagrams of consecutive overlapping CIC cycles

Related Functional Guide Topic(s)Cycle Timing Machine on page 78CIC Cycle timing machine

Aligning Camera and illumination Cycles on page 76

239

Coaxlink Driver 7.0 Functional Guide   Device Module Features

CycleTiming CategoryCategory Members

ExposureTime on page 240StrobeDelay on page 241StrobeDuration on page 241Related Functional Guide Topic(s)Camera and Illumination Controller on page 78Full description of the Camera and Illumination Controller

Related Functional Guide Topic(s)Cycle Timing Machine on page 78CIC Cycle timing machine

Aligning Camera and illumination Cycles on page 76

ExposureTimeExposure Time

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / CycleTiming Float RW

Parent Category: CycleTiming Category on page 240

Value InfoMinimum value: 3.3599999999999999Maximum value: 562949953421.30701Dimension: TimeUnit: microsecond [µs]Increment: 0.008

DescriptionSets/gets the exposure time.Applies only when CameraControlMethod is RG.

Important: Avoid using exposure time settings outside the exposure time range of the camera.

Note: The upper limit is very high: > 150 hours!

Default value: 1,000.0. (1 millisecond)Related Functional Guide Topic(s)Cycle Timing Machine on page 78CIC Cycle timing machine

Aligning Camera and illumination Cycles on page 76

240

Device Module Features   Coaxlink Driver 7.0 Functional Guide

StrobeDelayStrobe Delay

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / CycleTiming Float RW

Parent Category: CycleTiming Category on page 240

Value InfoMinimum value: -8589934.5869999994Maximum value: 8589934.5869999994Dimension: TimeUnit: microsecond [µs]Increment: 0.008

DescriptionSets/gets the strobe pulse delay.Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG).Default value: 0Related Functional Guide Topic(s)Cycle Timing Machine on page 78CIC Cycle timing machine

Aligning Camera and illumination Cycles on page 76

StrobeDurationStrobe Duration

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / CycleTiming Float RW

Parent Category: CycleTiming Category on page 240

Value InfoMinimum value: 0Maximum value: 562949953421.30701Dimension: TimeUnit: microsecond [µs]Increment: 0.008

241

Coaxlink Driver 7.0 Functional Guide   Device Module Features

DescriptionSets/gets the strobe pulse duration.Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG).

Note: The upper limit is very high: > 150 hours!

Default value: 1,000.0. (1 millisecond)Related Functional Guide Topic(s)Cycle Timing Machine on page 78CIC Cycle timing machine

Aligning Camera and illumination Cycles on page 76

CycleControl CategoryCategory Members

CycleTriggerSource on page 242CycleTargetPeriod on page 243StartCycle on page 244CycleMaxPendingTriggerCount on page 245CyclePendingTriggerCount on page 245CycleLostTriggerCount on page 246CycleLostTriggerCountReset on page 246Related Functional Guide Topic(s)Camera and Illumination Controller on page 78Full description of the Camera and Illumination Controller

Related Functional Guide Topic(s)Cycle Trigger Manager on page 81Consecutive Overlapping CIC Cycles on page 86Timing diagrams of consecutive overlapping CIC cycles

CycleTriggerSourceCycle Trigger Source

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / CycleControl Enumeration RW

Parent Category: CycleControl Category on page 242

DescriptionSets/gets the start-of-camera-cycle trigger conditions and selects a hardware or soware trigger source.Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG).

242

Device Module Features   Coaxlink Driver 7.0 Functional Guide

Default value: CyclePeriodTarget.

Enumeration Values• Immediate: Immediately aer the start of the sequence and then repeatedly every CyclePeriodTarget period.• StartCycle: On execution of the StartCycle command.• C2C: Synchronized with the C2C-Link master device. This value is enforced when C2CLinkConfiguration = Slave.• LIN1: When an event occurs on Line Input Tool 1 or on execution of the StartCycle command.• LIN2: When an event occurs on Line Input Tool 2 or on execution of the StartCycle command.• LIN3: When an event occurs on Line Input Tool 3 or on execution of the StartCycle command.• LIN4: When an event occurs on Line Input Tool 4 or on execution of the StartCycle command.• LIN5: When an event occurs on Line Input Tool 5 or on execution of the StartCycle command.• LIN6: When an event occurs on Line Input Tool 6 or on execution of the StartCycle command.• LIN7: When an event occurs on Line Input Tool 7 or on execution of the StartCycle command.• LIN8: When an event occurs on Line Input Tool 8 or on execution of the StartCycle command.• QDC1: When an event occurs on Quadrature Decoder Tool 1 or on execution of the StartCycle command.• QDC2: When an event occurs on Quadrature Decoder Tool 2 or on execution of the StartCycle command.• MDV1: When an event occurs on Multiplier/Divider Tool 1 or on execution of the StartCycle command.• MDV2: When an event occurs on Multiplier/Divider Tool 2 or on execution of the StartCycle command.• DIV1: When an event occurs on Divider Tool 1 or on execution of the StartCycle command.• DIV2: When an event occurs on Divider Tool 2 or on execution of the StartCycle command.• DEL1_1: When an event occurs on Delay Tool 1 Output 1 or on execution of the StartCycle command.• DEL1_2: When an event occurs on Delay Tool 1 Output 2 or on execution of the StartCycle command.• DEL2_1: When an event occurs on Delay Tool 2 Output 1 or on execution of the StartCycle command.• DEL2_2: When an event occurs on Delay Tool 2 Output 2 or on execution of the StartCycle command.• EIN1: When an event occurs on Event Input Tool 1 or on execution of the StartCycle command.• EIN2: When an event occurs on Event Input Tool 2 or on execution of the StartCycle command.• UserEvent1: When an event occurs on User Event 1 or on execution of the StartCycle command.• UserEvent2: When an event occurs on User Event 2 or on execution of the StartCycle command.• UserEvent3: When an event occurs on User Event 3 or on execution of the StartCycle command.• UserEvent4: When an event occurs on User Event 4 or on execution of the StartCycle command.

Related Functional Guide Topic(s)Cycle Trigger Manager on page 81Consecutive Overlapping CIC Cycles on page 86Timing diagrams of consecutive overlapping CIC cycles

CycleTargetPeriodCycle Target Period

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / CycleControl Float RW

Parent Category: CycleControl Category on page 242

243

Coaxlink Driver 7.0 Functional Guide   Device Module Features

Value InfoMinimum value: 5Maximum value: 562949953421.30701

DescriptionSets/gets the target cycle period.Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG) and whenCycleTriggerSource = Immediate.

Note: was named CyclePeriodTarget in Coaxlink Driver versions prior to 4.1.

Note: The upper limit is very high: > 150 hours!

Default value: 1,000.0. (1 millisecond)Related Functional Guide Topic(s)Cycle Timing Machine on page 78CIC Cycle timing machine

Aligning Camera and illumination Cycles on page 76Related Functional Guide Topic(s)Cycle Trigger Manager on page 81Consecutive Overlapping CIC Cycles on page 86Timing diagrams of consecutive overlapping CIC cycles

StartCycleStart Cycle

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / CycleControl Command RW

Parent Category: CycleControl Category on page 242

DescriptionStarts a camera cycle.Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG).

Note: was named CycleSoftwareTrigger in Coaxlink Driver versions prior to 4.1.

Related Functional Guide Topic(s)Cycle Trigger Manager on page 81Consecutive Overlapping CIC Cycles on page 86

244

Device Module Features   Coaxlink Driver 7.0 Functional Guide

Timing diagrams of consecutive overlapping CIC cycles

CycleMaxPendingTriggerCountMaximum number of CIC cycle triggers that can be delayed when they cannot be served immediately

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / CycleControl Integer RW

Parent Category: CycleControl Category on page 242

Value InfoMinimum value: 0Maximum value: 7

DescriptionThe Camera and Illumination Controller is fitted with a trigger latching mechanism capable of recording triggers thatcannot be served immediately and postponing their execution.This feature determines the capacity of the latch :

• When 0, the trigger latch mechanism is disabled. Any cycle trigger that cannot be served immediately is rejectedand increments CycleLostTriggerCount.

• When set to any value ranging from 1 to 7, the trigger latch mechanism is enabled. Providing thatCyclePendingTriggerCount is below CycleMaxPendingTriggerCount, any cycle trigger that cannotbe served immediately is latched and increments CyclePendingTriggerCount .

Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG).Default value: 0 (Disabled)Related Functional Guide Topic(s)Cycle Trigger Manager on page 81Consecutive Overlapping CIC Cycles on page 86Timing diagrams of consecutive overlapping CIC cycles

CyclePendingTriggerCountGets the count of pending CIC cycle trigger events

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / CycleControl IntReg RO

Parent Category: CycleControl Category on page 242Register Port: DevicePort

245

Coaxlink Driver 7.0 Functional Guide   Device Module Features

DescriptionReturns the count of pending CIC cycle trigger events.Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG).Related Functional Guide Topic(s)Cycle Trigger Manager on page 81Consecutive Overlapping CIC Cycles on page 86Timing diagrams of consecutive overlapping CIC cycles

CycleLostTriggerCountGets the count of lost CIC cycle trigger events

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / CycleControl IntReg RO

Parent Category: CycleControl Category on page 242Register Port: DevicePort

DescriptionReturns the count of lost CIC cycle trigger events.Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG).Value range: from 0 up to 4,294,967,295.Related Functional Guide Topic(s)Cycle Trigger Manager on page 81Consecutive Overlapping CIC Cycles on page 86Timing diagrams of consecutive overlapping CIC cycles

CycleLostTriggerCountResetResets the count of lost CIC cycle trigger events

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / CycleControl Command RW

Parent Category: CycleControl Category on page 242

DescriptionResets the count of lost CIC cycle trigger events.Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG).

246

Device Module Features   Coaxlink Driver 7.0 Functional Guide

Related Functional Guide Topic(s)Cycle Trigger Manager on page 81Consecutive Overlapping CIC Cycles on page 86Timing diagrams of consecutive overlapping CIC cycles

SequenceControl CategoryCategory Members

StartOfSequenceTriggerSource on page 247EndOfSequenceTriggerSource on page 248SequenceLength on page 249StartSequence on page 250StopSequence on page 250AbortSequence on page 251Related Functional Guide Topic(s)Camera and Illumination Controller on page 78Full description of the Camera and Illumination Controller

Related Functional Guide Topic(s)Sequence Manager on page 82Cycle Sequence Timing Diagrams on page 89Timing diagrams of CIC camera & illumination cycle sequences

StartOfSequenceTriggerSourceStart Of Sequence Trigger Source

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / SequenceControl Enumeration RW

Parent Category: SequenceControl Category on page 247

DescriptionSets/gets the start-of-sequence trigger conditions and selects a hardware or soware trigger source.

• When set to Immediate, the sequence starts immediately.• When set to StartSequence, the sequence starts only on execution of the StartSequence command.• When set to <any-event-source>, the sequence starts on the next occurrence of an event on the specified event

source or on execution of the StartSequence command. Possible event sources include any available LIN*, QDC*,MDV*, DIV*, DEL*, EIN*, User Event* event source.

Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG).

Enumeration Values• Immediate: Immediate.

247

Coaxlink Driver 7.0 Functional Guide   Device Module Features

• StartSequence: StartSequence command.• LIN1: When an event occurs on Line Input Tool 1 or on execution of the StartSequence command.• LIN2: When an event occurs on Line Input Tool 2 or on execution of the StartSequence command.• LIN3: When an event occurs on Line Input Tool 3 or on execution of the StartSequence command.• LIN4: When an event occurs on Line Input Tool 4 or on execution of the StartSequence command.• LIN5: When an event occurs on Line Input Tool 5 or on execution of the StartSequence command.• LIN6: When an event occurs on Line Input Tool 6 or on execution of the StartSequence command.• LIN7: When an event occurs on Line Input Tool 7 or on execution of the StartSequence command.• LIN8: When an event occurs on Line Input Tool 8 or on execution of the StartSequence command.• QDC1: When an event occurs on Quadrature Decoder Tool 1 or on execution of the StartSequence command.• QDC2: When an event occurs on Quadrature Decoder Tool 2 or on execution of the StartSequence command.• MDV1: When an event occurs on Multiplier/Divider Tool 1 or on execution of the StartSequence command.• MDV2: When an event occurs on Multiplier/Divider Tool 2 or on execution of the StartSequence command.• DIV1: When an event occurs on Divider Tool 1 or on execution of the StartSequence command.• DIV2: When an event occurs on Divider Tool 2 or on execution of the StartSequence command.• DEL1_1: When an event occurs on Delay Tool 1 Output 1 or on execution of the StartSequence command.• DEL1_2: When an event occurs on Delay Tool 1 Output 2 or on execution of the StartSequence command.• DEL2_1: When an event occurs on Delay Tool 2 Output 1 or on execution of the StartSequence command.• DEL2_2: When an event occurs on Delay Tool 2 Output 2 or on execution of the StartSequence command.• EIN1: When an event occurs on Event Input Tool 1 or on execution of the StartSequence command.• EIN2: When an event occurs on Event Input Tool 2 or on execution of the StartSequence command.• UserEvent1: When an event occurs on User Event 1 or on execution of the StartSequence command.• UserEvent2: When an event occurs on User Event 2 or on execution of the StartSequence command.• UserEvent3: When an event occurs on User Event 3 or on execution of the StartSequence command.• UserEvent4: When an event occurs on User Event 4 or on execution of the StartSequence command.

Related Functional Guide Topic(s)Sequence Manager on page 82Cycle Sequence Timing Diagrams on page 89Timing diagrams of CIC camera & illumination cycle sequences

EndOfSequenceTriggerSourceEnd Of Sequence Trigger Source

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / SequenceControl Enumeration RW

Parent Category: SequenceControl Category on page 247

DescriptionSets/gets the end-of-sequence trigger conditions and selects a hardware or soware trigger source.

• When set to SequenceLength, the sequence stops automatically aer having executed a number of cameracycles specified by SequenceLength. The sequence can be stopped anticipatively on execution of theStopSequence command.

• When set to StopSequence, the sequence stops only on execution of the StopSequence command.

248

Device Module Features   Coaxlink Driver 7.0 Functional Guide

• When set to <any-event-source>, the sequence stops on the next occurrence of an event on the specified eventsource or on execution of the StopSequence command. Possible event sources include any available LIN*, QDC*,MDV*, DIV*, DEL*, EIN*, User Event* event source.

Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG).

Enumeration Values• SequenceLength: SequenceLength.• StopSequence: StopSequence command.• LIN1: When an event occurs on Line Input Tool 1 or on execution of the StopSequence command.• LIN2: When an event occurs on Line Input Tool 2 or on execution of the StopSequence command.• LIN3: When an event occurs on Line Input Tool 3 or on execution of the StopSequence command.• LIN4: When an event occurs on Line Input Tool 4 or on execution of the StopSequence command.• LIN5: When an event occurs on Line Input Tool 5 or on execution of the StopSequence command.• LIN6: When an event occurs on Line Input Tool 6 or on execution of the StopSequence command.• LIN7: When an event occurs on Line Input Tool 7 or on execution of the StopSequence command.• LIN8: When an event occurs on Line Input Tool 8 or on execution of the StopSequence command.• QDC1: When an event occurs on Quadrature Decoder Tool 1 or on execution of the StopSequence command.• QDC2: When an event occurs on Quadrature Decoder Tool 2 or on execution of the StopSequence command.• MDV1: When an event occurs on Multiplier/Divider Tool 1 or on execution of the StopSequence command.• MDV2: When an event occurs on Multiplier/Divider Tool 2 or on execution of the StopSequence command.• DIV1: When an event occurs on Divider Tool 1 or on execution of the StopSequence command.• DIV2: When an event occurs on Divider Tool 2 or on execution of the StopSequence command.• DEL1_1: When an event occurs on Delay Tool 1 Output 1 or on execution of the StopSequence command.• DEL1_2: When an event occurs on Delay Tool 1 Output 2 or on execution of the StopSequence command.• DEL2_1: When an event occurs on Delay Tool 2 Output 1 or on execution of the StopSequence command.• DEL2_2: When an event occurs on Delay Tool 2 Output 2 or on execution of the StopSequence command.• EIN1: When an event occurs on Event Input Tool 1 or on execution of the StopSequence command.• EIN2: When an event occurs on Event Input Tool 2 or on execution of the StopSequence command.• UserEvent1: When an event occurs on User Event 1 or on execution of the StopSequence command.• UserEvent2: When an event occurs on User Event 2 or on execution of the StopSequence command.• UserEvent3: When an event occurs on User Event 3 or on execution of the StopSequence command.• UserEvent4: When an event occurs on User Event 4 or on execution of the StopSequence command.

Related Functional Guide Topic(s)Sequence Manager on page 82Cycle Sequence Timing Diagrams on page 89Timing diagrams of CIC camera & illumination cycle sequences

SequenceLengthSequence Length

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / SequenceControl Integer RW

Parent Category: SequenceControl Category on page 247

249

Coaxlink Driver 7.0 Functional Guide   Device Module Features

Value InfoMinimum value: 1Maximum value: 16777215

Short DescriptionSequence Length.Related Functional Guide Topic(s)Sequence Manager on page 82Cycle Sequence Timing Diagrams on page 89Timing diagrams of CIC camera & illumination cycle sequences

StartSequenceStart Sequence

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / SequenceControl Command RW

Parent Category: SequenceControl Category on page 247

DescriptionStarts a CIC sequence.Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG) andStartOfSequenceTriggerSource is not set to Immediate.Related Functional Guide Topic(s)Sequence Manager on page 82Cycle Sequence Timing Diagrams on page 89Timing diagrams of CIC camera & illumination cycle sequences

StopSequenceStop Sequence

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / SequenceControl Command RW

Parent Category: SequenceControl Category on page 247

DescriptionStops a CIC sequence.Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG).

250

Device Module Features   Coaxlink Driver 7.0 Functional Guide

Related Functional Guide Topic(s)Sequence Manager on page 82Cycle Sequence Timing Diagrams on page 89Timing diagrams of CIC camera & illumination cycle sequences

AbortSequenceAbort Sequence

Feature Info

Module Category Path Type Access

Device Root / CameraAndIlluminationControl / SequenceControl Command RW

Parent Category: SequenceControl Category on page 247

DescriptionAbort a CIC sequence.Applies only when the CIC is used (i.e., when CameraControlMethod is RC or RG) andStartOfSequenceTriggerSource is not set to Immediate.Related Functional Guide Topic(s)Sequence Manager on page 82Cycle Sequence Timing Diagrams on page 89Timing diagrams of CIC camera & illumination cycle sequences

EventControl CategoryCategory Members

EventSelector on page 252EventNotification on page 253EventNotificationContext1 on page 253EventNotificationContext2 on page 255EventNotificationContext3 on page 256EventCount on page 258EventCountReset on page 258Related Functional Guide Topic(s)Event Signaling And Counting on page 129

251

Coaxlink Driver 7.0 Functional Guide   Device Module Features

Extensive user-configurable event-reporting and event-counting mechanism

EventSelectorSelect an event

Feature Info

Module Category Path Type Access

Device Root / EventControl Enumeration RW

Parent Category: EventControl Category on page 251

Short DescriptionSelect an event.

Selected Features• EventNotification on page 253• EventNotificationContext1 on page 253• EventNotificationContext2 on page 255• EventNotificationContext3 on page 256• EventCount on page 258• EventCountReset on page 258

Enumeration Values• CameraTriggerRisingEdge: Start of camera trigger.• CameraTriggerFallingEdge: End of camera trigger.• StrobeRisingEdge: Start of light strobe.• StrobeFallingEdge: End of light strobe.• AllowNextCycle: CIC is ready for next camera cycle.• DiscardedCicTrigger: Ignored CIC trigger because CIC is not ready for next camera cycle.• PendingCicTrigger: Delayed CIC trigger until CIC is ready for next camera cycle.• CxpTriggerAck: Received acknowledgement for previous CXP trigger message.• CxpTriggerResend: Resent CXP trigger message (acknowledgement to previous CXP trigger message not

received).• Trigger: CIC trigger.

Related Functional Guide Topic(s)Event Control GenICam Features (Device) on page 136

252

Device Module Features   Coaxlink Driver 7.0 Functional Guide

EventNotificationActivate or deactivate the notification to the host application of the occurrence of the selected event

Feature Info

Module Category Path Type Access

Device Root / EventControl Boolean RW

Parent Category: EventControl Category on page 251

DescriptionActivate or deactivate the notification to the host application of the occurrence of the selected event.When true, activate the notification.When false, deactivate the notification.Default value: False.Related Functional Guide Topic(s)Event Control GenICam Features (Device) on page 136

EventNotificationContext1Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_1

Feature Info

Module Category Path Type Access

Device Root / EventControl Enumeration RW

Parent Category: EventControl Category on page 251

Short DescriptionSelect context information reported in EVENT_DATA_CUSTOM_CONTEXT_1.

Enumeration Values• EventSpecific: Event-specific context information.• LineStatusAll: Value of LineStatusAll.• PendingCicTriggerCount: Number of currently pending CIC triggers.• LIN1EventCount: Number of LIN1 events.• LIN2EventCount: Number of LIN2 events.• LIN3EventCount: Number of LIN3 events.• LIN4EventCount: Number of LIN4 events.• LIN5EventCount: Number of LIN5 events.• LIN6EventCount: Number of LIN6 events.• LIN7EventCount: Number of LIN7 events.• LIN8EventCount: Number of LIN8 events.

253

Coaxlink Driver 7.0 Functional Guide   Device Module Features

• QDC1EventCount: Number of QDC1 events.• QDC1DirEventCount: Number of QDC1Dir events.• QDC2EventCount: Number of QDC2 events.• QDC2DirEventCount: Number of QDC2Dir events.• DIV1EventCount: Number of DIV1 events.• DIV2EventCount: Number of DIV2 events.• MDV1EventCount: Number of MDV1 events.• MDV2EventCount: Number of MDV2 events.• DEL11EventCount: Number of DEL11 events.• DEL12EventCount: Number of DEL12 events.• DEL21EventCount: Number of DEL21 events.• DEL22EventCount: Number of DEL22 events.• UserEvent1EventCount: Number of UserEvent1 events.• UserEvent2EventCount: Number of UserEvent2 events.• UserEvent3EventCount: Number of UserEvent3 events.• UserEvent4EventCount: Number of UserEvent4 events.• EIN1EventCount: Number of EIN1 events.• EIN2EventCount: Number of EIN2 events.• CrcErrorCxpAEventCount: Number of CrcErrorCxpA events.• CrcErrorCxpBEventCount: Number of CrcErrorCxpB events.• CrcErrorCxpCEventCount: Number of CrcErrorCxpC events.• CrcErrorCxpDEventCount: Number of CrcErrorCxpD events.• CameraTriggerRisingEdgeEventCount: Number of CameraTriggerRisingEdge events.• CameraTriggerFallingEdgeEventCount: Number of CameraTriggerFallingEdge events.• StrobeRisingEdgeEventCount: Number of StrobeRisingEdge events.• StrobeFallingEdgeEventCount: Number of StrobeFallingEdge events.• AllowNextCycleEventCount: Number of AllowNextCycle events.• DiscardedCicTriggerEventCount: Number of DiscardedCicTrigger events.• PendingCicTriggerEventCount: Number of PendingCicTrigger events.• CxpTriggerAckEventCount: Number of CxpTriggerAck events.• CxpTriggerResendEventCount: Number of CxpTriggerResend events.• TriggerEventCount: Number of Trigger events.• StartOfCameraReadoutEventCount: Number of StartOfCameraReadout events.• EndOfCameraReadoutEventCount: Number of EndOfCameraReadout events.• StartOfScanEventCount: Number of StartOfScan events.• EndOfScanEventCount: Number of EndOfScan events.• RejectedFrameEventCount: Number of RejectedFrame events.• RejectedScanEventCount: Number of RejectedScan events.

Related Functional Guide Topic(s)Event Control GenICam Features (Device) on page 136

254

Device Module Features   Coaxlink Driver 7.0 Functional Guide

EventNotificationContext2Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_2

Feature Info

Module Category Path Type Access

Device Root / EventControl Enumeration RW

Parent Category: EventControl Category on page 251

Short DescriptionSelect context information reported in EVENT_DATA_CUSTOM_CONTEXT_2.

Enumeration Values• EventSpecific: Event-specific context information.• LineStatusAll: Value of LineStatusAll.• PendingCicTriggerCount: Number of currently pending CIC triggers.• LIN1EventCount: Number of LIN1 events.• LIN2EventCount: Number of LIN2 events.• LIN3EventCount: Number of LIN3 events.• LIN4EventCount: Number of LIN4 events.• LIN5EventCount: Number of LIN5 events.• LIN6EventCount: Number of LIN6 events.• LIN7EventCount: Number of LIN7 events.• LIN8EventCount: Number of LIN8 events.• QDC1EventCount: Number of QDC1 events.• QDC1DirEventCount: Number of QDC1Dir events.• QDC2EventCount: Number of QDC2 events.• QDC2DirEventCount: Number of QDC2Dir events.• DIV1EventCount: Number of DIV1 events.• DIV2EventCount: Number of DIV2 events.• MDV1EventCount: Number of MDV1 events.• MDV2EventCount: Number of MDV2 events.• DEL11EventCount: Number of DEL11 events.• DEL12EventCount: Number of DEL12 events.• DEL21EventCount: Number of DEL21 events.• DEL22EventCount: Number of DEL22 events.• UserEvent1EventCount: Number of UserEvent1 events.• UserEvent2EventCount: Number of UserEvent2 events.• UserEvent3EventCount: Number of UserEvent3 events.• UserEvent4EventCount: Number of UserEvent4 events.• EIN1EventCount: Number of EIN1 events.• EIN2EventCount: Number of EIN2 events.• CrcErrorCxpAEventCount: Number of CrcErrorCxpA events.• CrcErrorCxpBEventCount: Number of CrcErrorCxpB events.• CrcErrorCxpCEventCount: Number of CrcErrorCxpC events.

255

Coaxlink Driver 7.0 Functional Guide   Device Module Features

• CrcErrorCxpDEventCount: Number of CrcErrorCxpD events.• CameraTriggerRisingEdgeEventCount: Number of CameraTriggerRisingEdge events.• CameraTriggerFallingEdgeEventCount: Number of CameraTriggerFallingEdge events.• StrobeRisingEdgeEventCount: Number of StrobeRisingEdge events.• StrobeFallingEdgeEventCount: Number of StrobeFallingEdge events.• AllowNextCycleEventCount: Number of AllowNextCycle events.• DiscardedCicTriggerEventCount: Number of DiscardedCicTrigger events.• PendingCicTriggerEventCount: Number of PendingCicTrigger events.• CxpTriggerAckEventCount: Number of CxpTriggerAck events.• CxpTriggerResendEventCount: Number of CxpTriggerResend events.• TriggerEventCount: Number of Trigger events.• StartOfCameraReadoutEventCount: Number of StartOfCameraReadout events.• EndOfCameraReadoutEventCount: Number of EndOfCameraReadout events.• StartOfScanEventCount: Number of StartOfScan events.• EndOfScanEventCount: Number of EndOfScan events.• RejectedFrameEventCount: Number of RejectedFrame events.• RejectedScanEventCount: Number of RejectedScan events.

Related Functional Guide Topic(s)Event Control GenICam Features (Device) on page 136

EventNotificationContext3Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_3

Feature Info

Module Category Path Type Access

Device Root / EventControl Enumeration RW

Parent Category: EventControl Category on page 251

Short DescriptionSelect context information reported in EVENT_DATA_CUSTOM_CONTEXT_3.

Enumeration Values• EventSpecific: Event-specific context information.• LineStatusAll: Value of LineStatusAll.• PendingCicTriggerCount: Number of currently pending CIC triggers.• LIN1EventCount: Number of LIN1 events.• LIN2EventCount: Number of LIN2 events.• LIN3EventCount: Number of LIN3 events.• LIN4EventCount: Number of LIN4 events.• LIN5EventCount: Number of LIN5 events.• LIN6EventCount: Number of LIN6 events.• LIN7EventCount: Number of LIN7 events.• LIN8EventCount: Number of LIN8 events.• QDC1EventCount: Number of QDC1 events.

256

Device Module Features   Coaxlink Driver 7.0 Functional Guide

• QDC1DirEventCount: Number of QDC1Dir events.• QDC2EventCount: Number of QDC2 events.• QDC2DirEventCount: Number of QDC2Dir events.• DIV1EventCount: Number of DIV1 events.• DIV2EventCount: Number of DIV2 events.• MDV1EventCount: Number of MDV1 events.• MDV2EventCount: Number of MDV2 events.• DEL11EventCount: Number of DEL11 events.• DEL12EventCount: Number of DEL12 events.• DEL21EventCount: Number of DEL21 events.• DEL22EventCount: Number of DEL22 events.• UserEvent1EventCount: Number of UserEvent1 events.• UserEvent2EventCount: Number of UserEvent2 events.• UserEvent3EventCount: Number of UserEvent3 events.• UserEvent4EventCount: Number of UserEvent4 events.• EIN1EventCount: Number of EIN1 events.• EIN2EventCount: Number of EIN2 events.• CrcErrorCxpAEventCount: Number of CrcErrorCxpA events.• CrcErrorCxpBEventCount: Number of CrcErrorCxpB events.• CrcErrorCxpCEventCount: Number of CrcErrorCxpC events.• CrcErrorCxpDEventCount: Number of CrcErrorCxpD events.• CameraTriggerRisingEdgeEventCount: Number of CameraTriggerRisingEdge events.• CameraTriggerFallingEdgeEventCount: Number of CameraTriggerFallingEdge events.• StrobeRisingEdgeEventCount: Number of StrobeRisingEdge events.• StrobeFallingEdgeEventCount: Number of StrobeFallingEdge events.• AllowNextCycleEventCount: Number of AllowNextCycle events.• DiscardedCicTriggerEventCount: Number of DiscardedCicTrigger events.• PendingCicTriggerEventCount: Number of PendingCicTrigger events.• CxpTriggerAckEventCount: Number of CxpTriggerAck events.• CxpTriggerResendEventCount: Number of CxpTriggerResend events.• TriggerEventCount: Number of Trigger events.• StartOfCameraReadoutEventCount: Number of StartOfCameraReadout events.• EndOfCameraReadoutEventCount: Number of EndOfCameraReadout events.• StartOfScanEventCount: Number of StartOfScan events.• EndOfScanEventCount: Number of EndOfScan events.• RejectedFrameEventCount: Number of RejectedFrame events.• RejectedScanEventCount: Number of RejectedScan events.

Related Functional Guide Topic(s)Event Control GenICam Features (Device) on page 136

257

Coaxlink Driver 7.0 Functional Guide   Device Module Features

EventCountNumber of occurrences of the selected event (32-bit counter)

Feature Info

Module Category Path Type Access

Device Root / EventControl IntReg RO

Parent Category: EventControl Category on page 251Register Port: DevicePort

Short DescriptionNumber of occurrences of the selected event (32-bit counter).Related Functional Guide Topic(s)Event Control GenICam Features (Device) on page 136

EventCountResetReset the selected EventCount

Feature Info

Module Category Path Type Access

Device Root / EventControl Command Imposed: WO

Parent Category: EventControl Category on page 251

Short DescriptionReset the selected EventCount.Related Functional Guide Topic(s)Event Control GenICam Features (Device) on page 136

Errors CategoryCategory Members

ErrorSelector on page 259ErrorCount on page 260ErrorCountReset on page 260

258

Device Module Features   Coaxlink Driver 7.0 Functional Guide

ErrorSelectorError Selector

Feature Info

Module Category Path Type Access

Device Root / Errors Enumeration RW

Parent Category: Errors Category on page 258

Short DescriptionError Selector.

Selected Features• ErrorCount on page 260• ErrorCountReset on page 260

Enumeration Values• All: All errors.• StreamPacketSizeError: Stream packet size error.• StreamPacketFifoOverflow: Stream packet FIFO overflow.• CameraTriggerOverrun: New trigger sent to remote device even though readout of previous frame has not

started yet.• DidNotReceiveTriggerAck: Trigger ignored because ACK to previous trigger has not been received yet.• TriggerPacketRetryError: Trigger packet resend not successful.• InputStreamFifoHalfFull: Input stream FIFO half full.• InputStreamFifoFull: Input stream FIFO full.• ImageHeaderError: Image header error.• MigAxiWriteError: MIG AXI write error.• MigAxiReadError: MIG AXI read error.• PacketWithUnexpectedTag: Received a CXP packet with unexpected tag.• StreamPacketCrcError0: Stream packet CRC error on connector A.• StreamPacketCrcError1: Stream packet CRC error on connector B.• StreamPacketCrcError2: Stream packet CRC error on connector C.• StreamPacketCrcError3: Stream packet CRC error on connector D.• StartOfScanSkipped: Start of scan skipped (caused by internal exception: image buffer almost full).• PrematureEndOfScan: End of scan (caused by internal exception: image buffer almost full).• ExternalTriggerReqsTooClose: External trigger requests too close together.• Unknown: Unknown errors.

259

Coaxlink Driver 7.0 Functional Guide   Device Module Features

ErrorCountError Count

Feature Info

Module Category Path Type Access

Device Root / Errors IntReg RO

Parent Category: Errors Category on page 258Register Port: DevicePort

Short DescriptionError Count.

ErrorCountResetReset the selected ErrorCount

Feature Info

Module Category Path Type Access

Device Root / Errors Command Imposed: WO

Parent Category: Errors Category on page 258

Short DescriptionReset the selected ErrorCount.

260

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

Data Stream Module FeaturesCategorized list of Data Stream GenTL module features

Root CategoryCategory Members

StreamInformation on page 261ImageFormatControl on page 262PixelProcessing on page 262LUTControl on page 262TransportLayerControl on page 263BufferHandlingControl on page 263LineScanAcquisitionControl on page 264StreamControl on page 264Errors on page 264StreamStatistics on page 265LaserLineExtractor on page 265EventControl on page 266

StreamInformation

Feature Info

Module Category Path Type Access

Data Stream Root Category RW

Parent Category: Root Category on page 261

Category Members• StreamID on page 266• StreamType on page 267

261

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

ImageFormatControl

Feature Info

Module Category Path Type Access

Data Stream Root Category RW

Parent Category: Root Category on page 261

Category Members• PixelFormat on page 267• PixelFormatNamespace on page 273• PixelSize on page 274• Width on page 274• Height on page 274

PixelProcessing

Feature Info

Module Category Path Type Access

Data Stream Root Category RW

Parent Category: Root Category on page 261

Category Members• UnpackingMode on page 275• RedBlueSwap on page 276

LUTControl

Feature Info

Module Category Path Type Access

Data Stream Root Category RW

Parent Category: Root Category on page 261

Category Members• LUTConfiguration on page 277

262

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

• LUTLength on page 277• LUTMaxValue on page 278• LUTSet on page 278• LUTIndex on page 279• LUTValue on page 279• LUTReadBlockLength on page 280• LUTEnable on page 280

TransportLayerControl

Feature Info

Module Category Path Type Access

Data Stream Root Category RW

Parent Category: Root Category on page 261

Category Members• PayloadSize on page 281

BufferHandlingControl

Feature Info

Module Category Path Type Access

Data Stream Root Category RW

Parent Category: Root Category on page 261

Category Members• StreamAnnouncedBufferCount on page 282• StreamBufferHandlingMode on page 282• StreamAnnounceBufferMinimum on page 282• StreamAcquisitionModeSelector on page 283

263

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

LineScanAcquisitionControl

Feature Info

Module Category Path Type Access

Data Stream Root Category RW

Parent Category: Root Category on page 261

Category Members• StartOfScanTriggerSource on page 283• EndOfScanTriggerSource on page 284• ScanLength on page 285• BufferHeight on page 286• StartScan on page 287• StopScan on page 287

StreamControl

Feature Info

Module Category Path Type Access

Data Stream Root Category RW

Parent Category: Root Category on page 261

Category Members• StreamReset on page 288• LineWidth on page 288• LinePitch on page 289• StripeHeight on page 289• StripePitch on page 290

Errors

Feature Info

Module Category Path Type Access

Data Stream Root Category RW

264

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

Parent Category: Root Category on page 261

Category Members• ErrorSelector on page 290• ErrorCount on page 291• ErrorCountReset on page 292

StreamStatistics

Feature Info

Module Category Path Type Access

Data Stream Root Category RW

Parent Category: Root Category on page 261

Category Members• StatisticsSamplingSelector on page 292• StatisticsFrameRate on page 293• StatisticsLineRate on page 294• StatisticsDataRate on page 294• StatisticsStartSampling on page 295• StatisticsStopSampling on page 295

LaserLineExtractor

Feature Info

Module Category Path Type Access

Data Stream Root Category RW

Parent Category: Root Category on page 261

Category Members• LaserLineExtractorRevision on page 296• LaserLineExtractorReset on page 296• LaserLineExtractorAlgorithm on page 296• LaserLineExtractorThresholdLevel on page 297• LaserLineExtractorConvolutionCoefficientA on page 297• LaserLineExtractorConvolutionCoefficientB on page 298• LaserLineExtractorConvolutionCoefficientC on page 298

265

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

EventControl

Feature Info

Module Category Path Type Access

Data Stream Root Category RW

Parent Category: Root Category on page 261

Category Members• EventSelector on page 299• EventNotification on page 300• EventNotificationContext1 on page 300• EventNotificationContext2 on page 302• EventNotificationContext3 on page 303• EventCount on page 305• EventCountReset on page 305

StreamInformation CategoryCategory Members

StreamID on page 266StreamType on page 267

StreamIDDevice unique ID for the data stream

Feature Info

Module Category Path Type Access

Data Stream Root / StreamInformation String Imposed: RO

Parent Category: StreamInformation Category on page 266

Short DescriptionDevice unique ID for the data stream.

266

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

StreamTypeIdentifies the transport layer technology of the interface

Feature Info

Module Category Path Type Access

Data Stream Root / StreamInformation Enumeration Imposed: RO

Parent Category: StreamInformation Category on page 266

Short DescriptionIdentifies the transport layer technology of the interface.

Enumeration Values• CXP: This enumeration value indicates CoaXPress transport layer technology.

ImageFormatControl CategoryCategory Members

PixelFormat on page 267PixelFormatNamespace on page 273PixelSize on page 274Width on page 274Height on page 274

PixelFormatPixel format of the image

Feature Info

Module Category Path Type Access

Data Stream Root / ImageFormatControl Enumeration Imposed: RO

Parent Category: ImageFormatControl Category on page 267

Short DescriptionPixel format of the image.

Enumeration Values• BayerBG10pmsb: BayerBG10pmsb.

267

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

• BayerBG12pmsb: BayerBG12pmsb.• BayerBG14pmsb: BayerBG14pmsb.• BayerGB10pmsb: BayerGB10pmsb.• BayerGB12pmsb: BayerGB12pmsb.• BayerGB14pmsb: BayerGB14pmsb.• BayerGR10pmsb: BayerGR10pmsb.• BayerGR12pmsb: BayerGR12pmsb.• BayerGR14pmsb: BayerGR14pmsb.• BayerRG10pmsb: BayerRG10pmsb.• BayerRG12pmsb: BayerRG12pmsb.• BayerRG14pmsb: BayerRG14pmsb.• Mono10pmsb: Mono10pmsb.• Mono12pmsb: Mono12pmsb.• Mono14pmsb: Mono14pmsb.• RGB10pmsb: RGB10pmsb.• RGB12pmsb: RGB12pmsb.• RGB14pmsb: RGB14pmsb.• RGBa10pmsb: RGBa10pmsb.• RGBa12pmsb: RGBa12pmsb.• RGBa14pmsb: RGBa14pmsb.• YCbCr601_10pmsb: YCbCr601_10pmsb.• YCbCr601_12pmsb: YCbCr601_12pmsb.• YCbCr601_14pmsb: YCbCr601_14pmsb.• YCbCr601_16: YCbCr601_16.• YCbCr601_411_10pmsb: YCbCr601_411_10pmsb.• YCbCr601_411_12pmsb: YCbCr601_411_12pmsb.• YCbCr601_411_14pmsb: YCbCr601_411_14pmsb.• YCbCr601_411_16: YCbCr601_411_16.• YCbCr601_411_8: YCbCr601_411_8.• YCbCr601_422_10pmsb: YCbCr601_422_10pmsb.• YCbCr601_422_12pmsb: YCbCr601_422_12pmsb.• YCbCr601_422_14pmsb: YCbCr601_422_14pmsb.• YCbCr601_422_16: YCbCr601_422_16.• YCbCr601_8: YCbCr601_8.• YCbCr709_10pmsb: YCbCr709_10pmsb.• YCbCr709_12pmsb: YCbCr709_12pmsb.• YCbCr709_14pmsb: YCbCr709_14pmsb.• YCbCr709_16: YCbCr709_16.• YCbCr709_411_10pmsb: YCbCr709_411_10pmsb.• YCbCr709_411_12pmsb: YCbCr709_411_12pmsb.• YCbCr709_411_14pmsb: YCbCr709_411_14pmsb.• YCbCr709_411_16: YCbCr709_411_16.• YCbCr709_411_8: YCbCr709_411_8.• YCbCr709_422_10pmsb: YCbCr709_422_10pmsb.• YCbCr709_422_12pmsb: YCbCr709_422_12pmsb.• YCbCr709_422_14pmsb: YCbCr709_422_14pmsb.• YCbCr709_422_16: YCbCr709_422_16.• YCbCr709_8: YCbCr709_8.• YUV10pmsb: YUV10pmsb.• YUV12pmsb: YUV12pmsb.

268

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

• YUV14pmsb: YUV14pmsb.• YUV16: YUV16.• YUV411_10pmsb: YUV411_10pmsb.• YUV411_12pmsb: YUV411_12pmsb.• YUV411_14pmsb: YUV411_14pmsb.• YUV411_16: YUV411_16.• YUV411_8: YUV411_8.• YUV422_10pmsb: YUV422_10pmsb.• YUV422_12pmsb: YUV422_12pmsb.• YUV422_14pmsb: YUV422_14pmsb.• YUV422_16: YUV422_16.• YUV8: YUV8.• BayerBG10: BayerBG10.• BayerBG10p: BayerBG10p.• BayerBG10Packed: BayerBG10Packed.• BayerBG12: BayerBG12.• BayerBG12p: BayerBG12p.• BayerBG12Packed: BayerBG12Packed.• BayerBG14: BayerBG14.• BayerBG16: BayerBG16.• BayerBG8: BayerBG8.• BayerGB10: BayerGB10.• BayerGB10p: BayerGB10p.• BayerGB10Packed: BayerGB10Packed.• BayerGB12: BayerGB12.• BayerGB12p: BayerGB12p.• BayerGB12Packed: BayerGB12Packed.• BayerGB14: BayerGB14.• BayerGB16: BayerGB16.• BayerGB8: BayerGB8.• BayerGR10: BayerGR10.• BayerGR10p: BayerGR10p.• BayerGR10Packed: BayerGR10Packed.• BayerGR12: BayerGR12.• BayerGR12p: BayerGR12p.• BayerGR12Packed: BayerGR12Packed.• BayerGR14: BayerGR14.• BayerGR16: BayerGR16.• BayerGR8: BayerGR8.• BayerRG10: BayerRG10.• BayerRG10p: BayerRG10p.• BayerRG10Packed: BayerRG10Packed.• BayerRG12: BayerRG12.• BayerRG12p: BayerRG12p.• BayerRG12Packed: BayerRG12Packed.• BayerRG14: BayerRG14.• BayerRG16: BayerRG16.• BayerRG8: BayerRG8.• BGR10: BGR10.• BGR10p: BGR10p.

269

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

• BGR12: BGR12.• BGR12p: BGR12p.• BGR14: BGR14.• BGR16: BGR16.• BGR565p: BGR565p.• BGR8: BGR8.• BGR8a32: BGR8a32.• BGRa10: BGRa10.• BGRa10p: BGRa10p.• BGRa12: BGRa12.• BGRa12p: BGRa12p.• BGRa14: BGRa14.• BGRa16: BGRa16.• BGRa8: BGRa8.• BiColorBGRG10: BiColorBGRG10.• BiColorBGRG10p: BiColorBGRG10p.• BiColorBGRG12: BiColorBGRG12.• BiColorBGRG12p: BiColorBGRG12p.• BiColorBGRG8: BiColorBGRG8.• BiColorRGBG10: BiColorRGBG10.• BiColorRGBG10p: BiColorRGBG10p.• BiColorRGBG12: BiColorRGBG12.• BiColorRGBG12p: BiColorRGBG12p.• BiColorRGBG8: BiColorRGBG8.• Confidence1: Confidence1.• Confidence16: Confidence16.• Confidence1p: Confidence1p.• Confidence32f: Confidence32f.• Confidence8: Confidence8.• Coord3D_A16: Coord3D_A16.• Coord3D_A32f: Coord3D_A32f.• Coord3D_A8: Coord3D_A8.• Coord3D_ABC16: Coord3D_ABC16.• Coord3D_ABC16_Planar: Coord3D_ABC16_Planar.• Coord3D_ABC32f: Coord3D_ABC32f.• Coord3D_ABC32f_Planar: Coord3D_ABC32f_Planar.• Coord3D_ABC8: Coord3D_ABC8.• Coord3D_ABC8_Planar: Coord3D_ABC8_Planar.• Coord3D_AC16: Coord3D_AC16.• Coord3D_AC16_Planar: Coord3D_AC16_Planar.• Coord3D_AC32f: Coord3D_AC32f.• Coord3D_AC32f_Planar: Coord3D_AC32f_Planar.• Coord3D_AC8: Coord3D_AC8.• Coord3D_AC8_Planar: Coord3D_AC8_Planar.• Coord3D_B16: Coord3D_B16.• Coord3D_B32f: Coord3D_B32f.• Coord3D_B8: Coord3D_B8.• Coord3D_C16: Coord3D_C16.• Coord3D_C32f: Coord3D_C32f.• Coord3D_C8: Coord3D_C8.

270

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

• Mono10: Mono10.• Mono10p: Mono10p.• Mono10Packed: Mono10Packed.• Mono12: Mono12.• Mono12p: Mono12p.• Mono12Packed: Mono12Packed.• Mono14: Mono14.• Mono16: Mono16.• Mono1p: Mono1p.• Mono2p: Mono2p.• Mono4p: Mono4p.• Mono8: Mono8.• Mono8s: Mono8s.• RGB10: RGB10.• RGB10_Planar: RGB10_Planar.• RGB10p: RGB10p.• RGB10p32: RGB10p32.• RGB10V1Packed: RGB10V1Packed.• RGB12: RGB12.• RGB12_Planar: RGB12_Planar.• RGB12p: RGB12p.• RGB12V1Packed: RGB12V1Packed.• RGB14: RGB14.• RGB16: RGB16.• RGB16_Planar: RGB16_Planar.• RGB565p: RGB565p.• RGB8: RGB8.• RGB8_Planar: RGB8_Planar.• RGB8a32: RGB8a32.• RGBa10: RGBa10.• RGBa10p: RGBa10p.• RGBa12: RGBa12.• RGBa12p: RGBa12p.• RGBa14: RGBa14.• RGBa16: RGBa16.• RGBa8: RGBa8.• SCF1WBWG10: SCF1WBWG10.• SCF1WBWG10p: SCF1WBWG10p.• SCF1WBWG12: SCF1WBWG12.• SCF1WBWG12p: SCF1WBWG12p.• SCF1WBWG14: SCF1WBWG14.• SCF1WBWG16: SCF1WBWG16.• SCF1WBWG8: SCF1WBWG8.• SCF1WGWB10: SCF1WGWB10.• SCF1WGWB10p: SCF1WGWB10p.• SCF1WGWB12: SCF1WGWB12.• SCF1WGWB12p: SCF1WGWB12p.• SCF1WGWB14: SCF1WGWB14.• SCF1WGWB16: SCF1WGWB16.• SCF1WGWB8: SCF1WGWB8.

271

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

• SCF1WGWR10: SCF1WGWR10.• SCF1WGWR10p: SCF1WGWR10p.• SCF1WGWR12: SCF1WGWR12.• SCF1WGWR12p: SCF1WGWR12p.• SCF1WGWR14: SCF1WGWR14.• SCF1WGWR16: SCF1WGWR16.• SCF1WGWR8: SCF1WGWR8.• SCF1WRWG10: SCF1WRWG10.• SCF1WRWG10p: SCF1WRWG10p.• SCF1WRWG12: SCF1WRWG12.• SCF1WRWG12p: SCF1WRWG12p.• SCF1WRWG14: SCF1WRWG14.• SCF1WRWG16: SCF1WRWG16.• SCF1WRWG8: SCF1WRWG8.• YCbCr10_CbYCr: YCbCr10_CbYCr.• YCbCr10p_CbYCr: YCbCr10p_CbYCr.• YCbCr12_CbYCr: YCbCr12_CbYCr.• YCbCr12p_CbYCr: YCbCr12p_CbYCr.• YCbCr411_8: YCbCr411_8.• YCbCr411_8_CbYYCrYY: YCbCr411_8_CbYYCrYY.• YCbCr422_10: YCbCr422_10.• YCbCr422_10_CbYCrY: YCbCr422_10_CbYCrY.• YCbCr422_10p: YCbCr422_10p.• YCbCr422_10p_CbYCrY: YCbCr422_10p_CbYCrY.• YCbCr422_12: YCbCr422_12.• YCbCr422_12_CbYCrY: YCbCr422_12_CbYCrY.• YCbCr422_12p: YCbCr422_12p.• YCbCr422_12p_CbYCrY: YCbCr422_12p_CbYCrY.• YCbCr422_8: YCbCr422_8.• YCbCr422_8_CbYCrY: YCbCr422_8_CbYCrY.• YCbCr601_10_CbYCr: YCbCr601_10_CbYCr.• YCbCr601_10p_CbYCr: YCbCr601_10p_CbYCr.• YCbCr601_12_CbYCr: YCbCr601_12_CbYCr.• YCbCr601_12p_CbYCr: YCbCr601_12p_CbYCr.• YCbCr601_411_8_CbYYCrYY: YCbCr601_411_8_CbYYCrYY.• YCbCr601_422_10: YCbCr601_422_10.• YCbCr601_422_10_CbYCrY: YCbCr601_422_10_CbYCrY.• YCbCr601_422_10p: YCbCr601_422_10p.• YCbCr601_422_10p_CbYCrY: YCbCr601_422_10p_CbYCrY.• YCbCr601_422_12: YCbCr601_422_12.• YCbCr601_422_12_CbYCrY: YCbCr601_422_12_CbYCrY.• YCbCr601_422_12p: YCbCr601_422_12p.• YCbCr601_422_12p_CbYCrY: YCbCr601_422_12p_CbYCrY.• YCbCr601_422_8: YCbCr601_422_8.• YCbCr601_422_8_CbYCrY: YCbCr601_422_8_CbYCrY.• YCbCr601_8_CbYCr: YCbCr601_8_CbYCr.• YCbCr709_10_CbYCr: YCbCr709_10_CbYCr.• YCbCr709_10p_CbYCr: YCbCr709_10p_CbYCr.• YCbCr709_12_CbYCr: YCbCr709_12_CbYCr.• YCbCr709_12p_CbYCr: YCbCr709_12p_CbYCr.

272

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

• YCbCr709_411_8_CbYYCrYY: YCbCr709_411_8_CbYYCrYY.• YCbCr709_422_10: YCbCr709_422_10.• YCbCr709_422_10_CbYCrY: YCbCr709_422_10_CbYCrY.• YCbCr709_422_10p: YCbCr709_422_10p.• YCbCr709_422_10p_CbYCrY: YCbCr709_422_10p_CbYCrY.• YCbCr709_422_12: YCbCr709_422_12.• YCbCr709_422_12_CbYCrY: YCbCr709_422_12_CbYCrY.• YCbCr709_422_12p: YCbCr709_422_12p.• YCbCr709_422_12p_CbYCrY: YCbCr709_422_12p_CbYCrY.• YCbCr709_422_8: YCbCr709_422_8.• YCbCr709_422_8_CbYCrY: YCbCr709_422_8_CbYCrY.• YCbCr709_8_CbYCr: YCbCr709_8_CbYCr.• YCbCr8: YCbCr8.• YCbCr8_CbYCr: YCbCr8_CbYCr.• YUV411_8_UYYVYY: YUV411_8_UYYVYY.• YUV422_8: YUV422_8.• YUV422_8_UYVY: YUV422_8_UYVY.• YUV8_UYV: YUV8_UYV.

PixelFormatNamespaceNamespace of the pixel format

Feature Info

Module Category Path Type Access

Data Stream Root / ImageFormatControl Enumeration Imposed: RO

Parent Category: ImageFormatControl Category on page 267

Short DescriptionNamespace of the pixel format.

Enumeration Values• Unknown: Unknown.• GEV: GEV.• IIDC: IIDC.• PFNC_16BIT: PFNC 16-bit.• PFNC_32BIT: PFNC 32-bit.

273

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

PixelSizePixel size in bits

Feature Info

Module Category Path Type Access

Data Stream Root / ImageFormatControl IntReg RO

Parent Category: ImageFormatControl Category on page 267Register Port: StreamPort

Short DescriptionPixel size in bits.

WidthWidth of the image

Feature Info

Module Category Path Type Access

Data Stream Root / ImageFormatControl Integer Imposed: RO

Parent Category: ImageFormatControl Category on page 267

Short DescriptionWidth of the image.

HeightHeight of the image

Feature Info

Module Category Path Type Access

Data Stream Root / ImageFormatControl Integer Imposed: RO

Parent Category: ImageFormatControl Category on page 267

Short DescriptionHeight of the image.

274

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

PixelProcessing CategoryCategory Members

UnpackingMode on page 275RedBlueSwap on page 276

UnpackingModeUnpacking Mode of multi-byte pixel components

Feature Info

Module Category Path Type Access

Data Stream Root / PixelProcessing Enumeration RW

Parent Category: PixelProcessing Category on page 275

DescriptionUnpacking Mode of multi-byte pixel components.When set to Lsb, each pixel component is unpacked to the least significant bit. Padding '0' bits are put as necessary inthe most significant bits to reach the next 8-bit boundary. 16-bit data are delivered using the little-endian convention.When set to Msb, each pixel component is unpacked to the most significant bit. Padding '0' bits are put as necessary inthe least significant bits to reach the next 8-bit boundary. 16-bit data are delivered using the little-endian convention.When set to Off, the pixel components are not unpacked. The pixel data stream is le unchanged.Default value: Lsb.

Note: The default value was Msb for Coaxlink Driver versions prior to 4.3.

Enumeration Values• Lsb: Unpacking to lsb.• Msb: Unpacking to msb.• Off: No unpacking.

Related Functional Guide Topic(s)Pixel Component Unpacking on page 60

275

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

Unpacking to 16-bit of 10-/12-/14-bit pixel component data

RedBlueSwapRed-Blue component swapping

Feature Info

Module Category Path Type Access

Data Stream Root / PixelProcessing Boolean RW

Parent Category: PixelProcessing Category on page 275

DescriptionRed-Blue component swapping.When true, the first (Red) and the last (Blue) color components of an RGB packed pixel are swapped before beingdelivered.Wen false, the pixel component order remains unchanged.Default value: False.Related Functional Guide Topic(s)Pixel Component Ordering on page 61Swap the R and B pixel component data of RGB pixels

LUTControl CategoryCategory Members

LUTConfiguration on page 277LUTLength on page 277LUTMaxValue on page 278LUTSet on page 278LUTIndex on page 279LUTValue on page 279LUTReadBlockLength on page 280LUTEnable on page 280Related Functional Guide Topic(s)Lookup Table Setup Procedure on page 58

276

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

How-to set lookup tables

LUTConfigurationConfiguration of the LUT processor

Feature Info

Module Category Path Type Access

Data Stream Root / LUTControl Enumeration RW

Parent Category: LUTControl Category on page 276

Short DescriptionConfiguration of the LUT processor.

Enumeration Values• M_8x8: Monochrome 8-bit to 8-bit.• M_10x8: Monochrome 10-bit to 8-bit.• M_10x10: Monochrome 10-bit to 10-bit.• M_10x16: Monochrome 10-bit to 16-bit.• M_12x8: Monochrome 12-bit to 8-bit.• M_12x12: Monochrome 12-bit to 12-bit.• M_12x16: Monochrome 12-bit to 16-bit.

Related Functional Guide Topic(s)Lookup Table Setup Procedure on page 58How-to set lookup tables

LUTLengthNumber of table entries in a LUT device

Feature Info

Module Category Path Type Access

Data Stream Root / LUTControl IntReg RO

Parent Category: LUTControl Category on page 276Register Port: StreamPort

Short DescriptionNumber of table entries in a LUT device.Related Functional Guide Topic(s)Lookup Table Setup Procedure on page 58

277

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

How-to set lookup tables

LUTMaxValueHighest value of a table entry

Feature Info

Module Category Path Type Access

Data Stream Root / LUTControl IntReg RO

Parent Category: LUTControl Category on page 276Register Port: StreamPort

Short DescriptionHighest value of a table entry.Related Functional Guide Topic(s)Lookup Table Setup Procedure on page 58How-to set lookup tables

LUTSetLUT set to access

Feature Info

Module Category Path Type Access

Data Stream Root / LUTControl Enumeration RW

Parent Category: LUTControl Category on page 276

Short DescriptionLUT set to access.

Selected Features• LUTValue on page 279

Enumeration Values• Set1: Select LUT set 1 for access.• Set2: Select LUT set 2 for access.• Set3: Select LUT set 3 for access.• Set4: Select LUT set 4 for access.• Set5: Select LUT set 5 for access.• Set6: Select LUT set 6 for access.• Set7: Select LUT set 7 for access.• Set8: Select LUT set 8 for access.

278

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

• Set9: Select LUT set 9 for access.• Set10: Select LUT set 10 for access.• Set11: Select LUT set 11 for access.• Set12: Select LUT set 12 for access.• Set13: Select LUT set 13 for access.• Set14: Select LUT set 14 for access.• Set15: Select LUT set 15 for access.• Set16: Select LUT set 16 for access.

Related Functional Guide Topic(s)Lookup Table Setup Procedure on page 58How-to set lookup tables

LUTIndexIndex of the first entry to access

Feature Info

Module Category Path Type Access

Data Stream Root / LUTControl Integer RW

Parent Category: LUTControl Category on page 276

Value InfoMinimum value: 0

Short DescriptionIndex of the first entry to access.

Selected Features• LUTValue on page 279

Related Functional Guide Topic(s)Lookup Table Setup Procedure on page 58How-to set lookup tables

LUTValueString of value(s) to read from- or to write to- the accessed LUT at location LUTIndex

Feature Info

Module Category Path Type Access

Data Stream Root / LUTControl StringReg RW

Parent Category: LUTControl Category on page 276

279

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

Short DescriptionString of value(s) to read from- or to write to- the accessed LUT at location LUTIndex.Related Functional Guide Topic(s)Lookup Table Setup Procedure on page 58How-to set lookup tables

LUTReadBlockLengthNumber of consecutive table entries to read

Feature Info

Module Category Path Type Access

Data Stream Root / LUTControl Integer RW

Parent Category: LUTControl Category on page 276

Value InfoMinimum value: 1

Short DescriptionNumber of consecutive table entries to read.Related Functional Guide Topic(s)Lookup Table Setup Procedure on page 58How-to set lookup tables

LUTEnableEnables the LUT processor with a specific LUT set.

Feature Info

Module Category Path Type Access

Data Stream Root / LUTControl Enumeration RW

Parent Category: LUTControl Category on page 276

Short DescriptionEnables the LUT processor with a specific LUT set..

Enumeration Values• Off:• Set1: Enables the LUT processor with LUT set 1.• Set2: Enables the LUT processor with LUT set 2.• Set3: Enables the LUT processor with LUT set 3.

280

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

• Set4: Enables the LUT processor with LUT set 4.• Set5: Enables the LUT processor with LUT set 5.• Set6: Enables the LUT processor with LUT set 6.• Set7: Enables the LUT processor with LUT set 7.• Set8: Enables the LUT processor with LUT set 8.• Set9: Enables the LUT processor with LUT set 9.• Set10: Enables the LUT processor with LUT set 10.• Set11: Enables the LUT processor with LUT set 11.• Set12: Enables the LUT processor with LUT set 12.• Set13: Enables the LUT processor with LUT set 13.• Set14: Enables the LUT processor with LUT set 14.• Set15: Enables the LUT processor with LUT set 15.• Set16: Enables the LUT processor with LUT set 16.

Related Functional Guide Topic(s)Lookup Table Setup Procedure on page 58How-to set lookup tables

TransportLayerControl CategoryCategory Members

PayloadSize on page 281

PayloadSizeProvides the number of bytes transferred for each image on the stream channel

Feature Info

Module Category Path Type Access

Data Stream Root / TransportLayerControl IntReg RO

Parent Category: TransportLayerControl Category on page 281Register Port: StreamPort

Short DescriptionProvides the number of bytes transferred for each image on the stream channel.

BufferHandlingControl CategoryCategory Members

StreamAnnouncedBufferCount on page 282StreamBufferHandlingMode on page 282StreamAnnounceBufferMinimum on page 282

281

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

StreamAcquisitionModeSelector on page 283

StreamAnnouncedBufferCountNumber of announced buffers on the stream

Feature Info

Module Category Path Type Access

Data Stream Root / BufferHandlingControl Integer Imposed: RO

Parent Category: BufferHandlingControl Category on page 281

Short DescriptionNumber of announced buffers on the stream.

StreamBufferHandlingModeAvailable buffer handling modes of this Stream

Feature Info

Module Category Path Type Access

Data Stream Root / BufferHandlingControl Enumeration RW

Parent Category: BufferHandlingControl Category on page 281

Short DescriptionAvailable buffer handling modes of this Stream.

Enumeration Values• Default: Default Buffer Handling Mode.

StreamAnnounceBufferMinimumMinimal number of buffers to announce to enable selected buffer handling mode

Feature Info

Module Category Path Type Access

Data Stream Root / BufferHandlingControl Integer Imposed: RO

Parent Category: BufferHandlingControl Category on page 281

282

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

Short DescriptionMinimal number of buffers to announce to enable selected buffer handling mode.

StreamAcquisitionModeSelectorAvailable buffer handling modes of this Stream

Feature Info

Module Category Path Type Access

Data Stream Root / BufferHandlingControl Enumeration RW

Parent Category: BufferHandlingControl Category on page 281

Short DescriptionAvailable buffer handling modes of this Stream. Deprecated.

Enumeration Values• Default: Default Buffer Handling Mode.

LineScanAcquisitionControl CategoryCategory Members

StartOfScanTriggerSource on page 283EndOfScanTriggerSource on page 284ScanLength on page 285BufferHeight on page 286StartScan on page 287StopScan on page 287Related Functional Guide Topic(s)Line Scan Acquisition on page 66Acquiring image data from line-scan cameras

StartOfScanTriggerSourceStart Of Scan Trigger Source

Feature Info

Module Category Path Type Access

Data Stream Root / LineScanAcquisitionControl Enumeration RW

283

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

Parent Category: LineScanAcquisitionControl Category on page 283

DescriptionStart-of-scan trigger conditions and trigger source.Default value: Immediate.

Enumeration Values• Immediate: Immediate.• StartScan: StartScan command.• LIN1: When an event occurs on Line Input Tool 1 or on execution of the StartScan command.• LIN2: When an event occurs on Line Input Tool 2 or on execution of the StartScan command.• LIN3: When an event occurs on Line Input Tool 3 or on execution of the StartScan command.• LIN4: When an event occurs on Line Input Tool 4 or on execution of the StartScan command.• LIN5: When an event occurs on Line Input Tool 5 or on execution of the StartScan command.• LIN6: When an event occurs on Line Input Tool 6 or on execution of the StartScan command.• LIN7: When an event occurs on Line Input Tool 7 or on execution of the StartScan command.• LIN8: When an event occurs on Line Input Tool 8 or on execution of the StartScan command.• QDC1: When an event occurs on Quadrature Decoder Tool 1 or on execution of the StartScan command.• QDC2: When an event occurs on Quadrature Decoder Tool 2 or on execution of the StartScan command.• MDV1: When an event occurs on Multiplier/Divider Tool 1 or on execution of the StartScan command.• MDV2: When an event occurs on Multiplier/Divider Tool 2 or on execution of the StartScan command.• DIV1: When an event occurs on Divider Tool 1 or on execution of the StartScan command.• DIV2: When an event occurs on Divider Tool 2 or on execution of the StartScan command.• DEL1_1: When an event occurs on Delay Tool 1 Output 1 or on execution of the StartScan command.• DEL1_2: When an event occurs on Delay Tool 1 Output 2 or on execution of the StartScan command.• DEL2_1: When an event occurs on Delay Tool 2 Output 1 or on execution of the StartScan command.• DEL2_2: When an event occurs on Delay Tool 2 Output 2 or on execution of the StartScan command.• EIN1: When an event occurs on Event Input Tool 1 or on execution of the StartScan command.• EIN2: When an event occurs on Event Input Tool 2 or on execution of the StartScan command.• UserEvent1: When an event occurs on User Event 1 or on execution of the StartScan command.• UserEvent2: When an event occurs on User Event 2 or on execution of the StartScan command.• UserEvent3: When an event occurs on User Event 3 or on execution of the StartScan command.• UserEvent4: When an event occurs on User Event 4 or on execution of the StartScan command.

Related Functional Guide Topic(s)Line Scan Acquisition on page 66Acquiring image data from line-scan cameras

EndOfScanTriggerSourceEnd Of Scan Trigger Source

Feature Info

Module Category Path Type Access

Data Stream Root / LineScanAcquisitionControl Enumeration RW

Parent Category: LineScanAcquisitionControl Category on page 283

284

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

DescriptionEnd-of-scan trigger conditions and trigger source.Default value: ScanLength.

Enumeration Values• ScanLength: ScanLength.• StopScan: StopScan command.• LIN1: When an event occurs on Line Input Tool 1 or on execution of the StopScan command.• LIN2: When an event occurs on Line Input Tool 2 or on execution of the StopScan command.• LIN3: When an event occurs on Line Input Tool 3 or on execution of the StopScan command.• LIN4: When an event occurs on Line Input Tool 4 or on execution of the StopScan command.• LIN5: When an event occurs on Line Input Tool 5 or on execution of the StopScan command.• LIN6: When an event occurs on Line Input Tool 6 or on execution of the StopScan command.• LIN7: When an event occurs on Line Input Tool 7 or on execution of the StopScan command.• LIN8: When an event occurs on Line Input Tool 8 or on execution of the StopScan command.• QDC1: When an event occurs on Quadrature Decoder Tool 1 or on execution of the StopScan command.• QDC2: When an event occurs on Quadrature Decoder Tool 2 or on execution of the StopScan command.• MDV1: When an event occurs on Multiplier/Divider Tool 1 or on execution of the StopScan command.• MDV2: When an event occurs on Multiplier/Divider Tool 2 or on execution of the StopScan command.• DIV1: When an event occurs on Divider Tool 1 or on execution of the StopScan command.• DIV2: When an event occurs on Divider Tool 2 or on execution of the StopScan command.• DEL1_1: When an event occurs on Delay Tool 1 Output 1 or on execution of the StopScan command.• DEL1_2: When an event occurs on Delay Tool 1 Output 2 or on execution of the StopScan command.• DEL2_1: When an event occurs on Delay Tool 2 Output 1 or on execution of the StopScan command.• DEL2_2: When an event occurs on Delay Tool 2 Output 2 or on execution of the StopScan command.• EIN1: When an event occurs on Event Input Tool 1 or on execution of the StopScan command.• EIN2: When an event occurs on Event Input Tool 2 or on execution of the StopScan command.• UserEvent1: When an event occurs on User Event 1 or on execution of the StopScan command.• UserEvent2: When an event occurs on User Event 2 or on execution of the StopScan command.• UserEvent3: When an event occurs on User Event 3 or on execution of the StopScan command.• UserEvent4: When an event occurs on User Event 4 or on execution of the StopScan command.

Related Functional Guide Topic(s)Line Scan Acquisition on page 66Acquiring image data from line-scan cameras

ScanLengthScan Length

Feature Info

Module Category Path Type Access

Data Stream Root / LineScanAcquisitionControl Integer RW

Parent Category: LineScanAcquisitionControl Category on page 283

285

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

Value InfoMinimum value: 1Maximum value: 16777215Unit: linesDefault value: 512

DescriptionSets/gets the number of captured lines before stopping the scanning.

Note: Applies only when EndOfScanTriggerSource = ScanLength.

Related Functional Guide Topic(s)Line Scan Acquisition on page 66Acquiring image data from line-scan cameras

BufferHeightHeight of the image in line-scan acquisition

Feature Info

Module Category Path Type Access

Data Stream Root / LineScanAcquisitionControl Integer RW

Parent Category: LineScanAcquisitionControl Category on page 283

Value InfoUnit: linesDefault value: ***TBD***

Short DescriptionHeight of the image in line-scan mode. This feature is only used in line-scan acquisition scenarios to computePayloadSizeRelated Functional Guide Topic(s)Line Scan Acquisition on page 66

286

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

Acquiring image data from line-scan cameras

StartScanStarts a scan

Feature Info

Module Category Path Type Access

Data Stream Root / LineScanAcquisitionControl Command RW

Parent Category: LineScanAcquisitionControl Category on page 283

Short DescriptionStarts a scan.Related Functional Guide Topic(s)Line Scan Acquisition on page 66Acquiring image data from line-scan cameras

StopScanStops a scan

Feature Info

Module Category Path Type Access

Data Stream Root / LineScanAcquisitionControl Command RW

Parent Category: LineScanAcquisitionControl Category on page 283

Short DescriptionStops a scan.Related Functional Guide Topic(s)Line Scan Acquisition on page 66Acquiring image data from line-scan cameras

StreamControl CategoryCategory Members

StreamReset on page 288LineWidth on page 288LinePitch on page 289StripeHeight on page 289StripePitch on page 290

287

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

Related Functional Guide Topic(s)Stream Control on page 64

StreamResetStream Reset

Feature Info

Module Category Path Type Access

Data Stream Root / StreamControl Command RW

Parent Category: StreamControl Category on page 287

Short DescriptionStream Reset.Related Functional Guide Topic(s)Stream Control on page 64

LineWidthLine width in bytes

Feature Info

Module Category Path Type Access

Data Stream Root / StreamControl Integer RW

Parent Category: StreamControl Category on page 287

Value InfoMinimum value: 0

Short DescriptionLine width in bytes.Related Functional Guide Topic(s)Stream Control on page 64

288

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

LinePitchLine pitch in bytes

Feature Info

Module Category Path Type Access

Data Stream Root / StreamControl Integer RW

Parent Category: StreamControl Category on page 287

Value InfoMinimum value: 0

Short DescriptionLine pitch in bytes.Related Functional Guide Topic(s)Stream Control on page 64

StripeHeightStripe height in lines

Feature Info

Module Category Path Type Access

Data Stream Root / StreamControl Integer RW

Parent Category: StreamControl Category on page 287

Value InfoMinimum value: 0

Short DescriptionStripe height in lines.Related Functional Guide Topic(s)Stream Control on page 64

289

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

StripePitchStripe pitch in lines

Feature Info

Module Category Path Type Access

Data Stream Root / StreamControl Integer RW

Parent Category: StreamControl Category on page 287

Value InfoMinimum value: 0

Short DescriptionStripe pitch in lines.Related Functional Guide Topic(s)Stream Control on page 64

Errors CategoryCategory Members

ErrorSelector on page 290ErrorCount on page 291ErrorCountReset on page 292

ErrorSelectorError Selector

Feature Info

Module Category Path Type Access

Data Stream Root / Errors Enumeration RW

Parent Category: Errors Category on page 290

Short DescriptionError Selector.

Selected Features• ErrorCount on page 291

290

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

• ErrorCountReset on page 292

Enumeration Values• All: All errors.• StreamPacketSizeError: Stream packet size error.• StreamPacketFifoOverflow: Stream packet FIFO overflow.• CameraTriggerOverrun: New trigger sent to remote device even though readout of previous frame has not

started yet.• DidNotReceiveTriggerAck: Trigger ignored because ACK to previous trigger has not been received yet.• TriggerPacketRetryError: Trigger packet resend not successful.• InputStreamFifoHalfFull: Input stream FIFO half full.• InputStreamFifoFull: Input stream FIFO full.• ImageHeaderError: Image header error.• MigAxiWriteError: MIG AXI write error.• MigAxiReadError: MIG AXI read error.• PacketWithUnexpectedTag: Received a CXP packet with unexpected tag.• StreamPacketCrcError0: Stream packet CRC error on connector A.• StreamPacketCrcError1: Stream packet CRC error on connector B.• StreamPacketCrcError2: Stream packet CRC error on connector C.• StreamPacketCrcError3: Stream packet CRC error on connector D.• StartOfScanSkipped: Start of scan skipped (caused by internal exception: image buffer almost full).• PrematureEndOfScan: End of scan (caused by internal exception: image buffer almost full).• ExternalTriggerReqsTooClose: External trigger requests too close together.• Unknown: Unknown errors.

ErrorCountError Count

Feature Info

Module Category Path Type Access

Data Stream Root / Errors IntReg RO

Parent Category: Errors Category on page 290Register Port: StreamPort

Short DescriptionError Count.

291

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

ErrorCountResetReset the selected ErrorCount

Feature Info

Module Category Path Type Access

Data Stream Root / Errors Command Imposed: WO

Parent Category: Errors Category on page 290

Short DescriptionReset the selected ErrorCount.

StreamStatistics CategoryCategory Members

StatisticsSamplingSelector on page 292StatisticsFrameRate on page 293StatisticsLineRate on page 294StatisticsDataRate on page 294StatisticsStartSampling on page 295StatisticsStopSampling on page 295Related Functional Guide Topic(s)Stream Statistics on page 65

StatisticsSamplingSelectorSelects the stream statistics sampling method

Feature Info

Module Category Path Type Access

Data Stream Root / StreamStatistics Enumeration RW

Parent Category: StreamStatistics Category on page 292

DescriptionSelects the stream statistics sampling method.Default value: LastSecond.

292

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

Selected Features• StatisticsFrameRate on page 293• StatisticsLineRate on page 294• StatisticsDataRate on page 294

Enumeration Values• LastSecond: During the last second.• LastTenSeconds: During the last 10 seconds.• Last2Buffers: For the last 2 buffers.• Last10Buffers: For the last 10 buffers.• Last100Buffers: For the last 100 buffers.• Last1000Buffers: For the last 1000 buffers.• LastAcquisition: During the last acquisition activity period. Namely since the last DSStartAcquisition()

function call until now, if the acquisition is still active otherwise until the last DSStopAcquisition() function call.• Custom: Custom sampling using StatisticsStartSampling and StatisticsStopSampling commands.

Related Functional Guide Topic(s)Stream Statistics on page 65

StatisticsFrameRateGet the average image frames acquisition rate using the selected sampling method

Feature Info

Module Category Path Type Access

Data Stream Root / StreamStatistics FloatReg RO

Parent Category: StreamStatistics Category on page 292Register Port: StreamPort

Value InfoUnit: Fps (Frames per second)Unit: Frames per second

DescriptionAverage frame delivery rate using the selected sampling method.

Note: This feature is only available for area-scan firmware variants.

Important: The statistics measures the frame rate at the level of the PCI Express interface, NOT atthe level of the CoaXPress interface!

Related Functional Guide Topic(s)Stream Statistics on page 65

293

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

StatisticsLineRateGet the average image lines acquisition rate using the selected sampling method

Feature Info

Module Category Path Type Access

Data Stream Root / StreamStatistics FloatReg RO

Parent Category: StreamStatistics Category on page 292Register Port: StreamPort

Value InfoUnit: Lps (Lines per second)Unit: Lines per second

DescriptionAverage line delivery rate using the selected sampling method.

Note: This feature is only available for line-scan firmware variants.

Important: The statistics measures the line rate at the level of the PCI Express interface, NOT at thelevel of the CoaXPress interface!

Related Functional Guide Topic(s)Stream Statistics on page 65

StatisticsDataRateGet the average PCI data delivery rate using the selected sampling method

Feature Info

Module Category Path Type Access

Data Stream Root / StreamStatistics FloatReg RO

Parent Category: StreamStatistics Category on page 292Register Port: StreamPort

Value InfoUnit: MBps (Megabytes per second)Unit: 1,000,000 bytes per second

Short DescriptionGet the average PCI data delivery rate using the selected sampling method.

294

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

Related Functional Guide Topic(s)Stream Statistics on page 65

StatisticsStartSamplingStart sampling the stream data. Applies only when StatisticsSamplingSelector = Custom

Feature Info

Module Category Path Type Access

Data Stream Root / StreamStatistics Command RW

Parent Category: StreamStatistics Category on page 292

Short DescriptionStart sampling the stream data. Applies only when StatisticsSamplingSelector = Custom.Related Functional Guide Topic(s)Stream Statistics on page 65

StatisticsStopSamplingStop sampling the stream data. Applies only when StatisticsSamplingSelector = Custom

Feature Info

Module Category Path Type Access

Data Stream Root / StreamStatistics Command RW

Parent Category: StreamStatistics Category on page 292

Short DescriptionStop sampling the stream data. Applies only when StatisticsSamplingSelector = Custom.Related Functional Guide Topic(s)Stream Statistics on page 65

LaserLineExtractor CategoryCategory Members

LaserLineExtractorRevision on page 296LaserLineExtractorReset on page 296LaserLineExtractorAlgorithm on page 296LaserLineExtractorThresholdLevel on page 297LaserLineExtractorConvolutionCoefficientA on page 297LaserLineExtractorConvolutionCoefficientB on page 298

295

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

LaserLineExtractorConvolutionCoefficientC on page 298

LaserLineExtractorRevisionLaser Line Extractor Revision

Feature Info

Module Category Path Type Access

Data Stream Root / LaserLineExtractor IntReg RO

Parent Category: LaserLineExtractor Category on page 295Register Port: StreamPort

Short DescriptionLaser Line Extractor Revision.

LaserLineExtractorResetLaser Line Extractor Reset

Feature Info

Module Category Path Type Access

Data Stream Root / LaserLineExtractor Command RW

Parent Category: LaserLineExtractor Category on page 295

Short DescriptionLaser Line Extractor Reset.

LaserLineExtractorAlgorithmLaser Line Extractor Algorithm

Feature Info

Module Category Path Type Access

Data Stream Root / LaserLineExtractor Enumeration RW

Parent Category: LaserLineExtractor Category on page 295

Short DescriptionLaser Line Extractor Algorithm.

296

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

Enumeration Values• Disabled: Disabled.• PreProcessing: Pre-processing only (linear filtering and thresholding.• MaximumDetection_8: Maximum detection, 8-bit integer coordinates.• MaximumDetection_16: Maximum detection, 16-bit integer coordinates.• PeakDetection_11_5: Peak detection, 11.5 fixed-point coordinates (fx11.16).

LaserLineExtractorThresholdLevelLaser Line Extractor Threshold Level

Feature Info

Module Category Path Type Access

Data Stream Root / LaserLineExtractor Integer RW

Parent Category: LaserLineExtractor Category on page 295

Value InfoMinimum value: 0Maximum value: 255

Short DescriptionLaser Line Extractor Threshold Level.

LaserLineExtractorConvolutionCoefficientALaser Line Extractor Convolution Coefficient A

Feature Info

Module Category Path Type Access

Data Stream Root / LaserLineExtractor Integer RW

Parent Category: LaserLineExtractor Category on page 295

Value InfoMinimum value: 0Maximum value: 512

Short DescriptionLaser Line Extractor Convolution Coefficient A.

297

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

LaserLineExtractorConvolutionCoefficientBLaser Line Extractor Convolution Coefficient B

Feature Info

Module Category Path Type Access

Data Stream Root / LaserLineExtractor Integer RW

Parent Category: LaserLineExtractor Category on page 295

Value InfoMinimum value: 0Maximum value: 512

Short DescriptionLaser Line Extractor Convolution Coefficient B.

LaserLineExtractorConvolutionCoefficientCLaser Line Extractor Convolution Coefficient C

Feature Info

Module Category Path Type Access

Data Stream Root / LaserLineExtractor Integer RW

Parent Category: LaserLineExtractor Category on page 295

Value InfoMinimum value: 0Maximum value: 512

Short DescriptionLaser Line Extractor Convolution Coefficient C.

EventControl CategoryCategory Members

EventSelector on page 299EventNotification on page 300EventNotificationContext1 on page 300

298

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

EventNotificationContext2 on page 302EventNotificationContext3 on page 303EventCount on page 305EventCountReset on page 305Related Functional Guide Topic(s)Event Signaling And Counting on page 129Extensive user-configurable event-reporting and event-counting mechanism

EventSelectorSelect an event

Feature Info

Module Category Path Type Access

Data Stream Root / EventControl Enumeration RW

Parent Category: EventControl Category on page 298

Short DescriptionSelect an event.

Selected Features• EventNotification on page 300• EventNotificationContext1 on page 300• EventNotificationContext2 on page 302• EventNotificationContext3 on page 303• EventCount on page 305• EventCountReset on page 305

Enumeration Values• StartOfCameraReadout: Starts acquiring data of a new image frame (area-scan only).• EndOfCameraReadout: Stops acquiring data of an image frame (area-scan only).• StartOfScan: Starts acquiring data of a new image scan (line-scan only ).• EndOfScan: Stops acquiring data of an image scan (line-scan only).• RejectedFrame: Dropped image frame data (area-scan only).• RejectedScan: Dropped image scan data (line-scan only).

Related Functional Guide Topic(s)Event Control GenICam Features (Data Stream) on page 136

299

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

EventNotificationActivate or deactivate the notification to the host application of the occurrence of the selected event

Feature Info

Module Category Path Type Access

Data Stream Root / EventControl Boolean RW

Parent Category: EventControl Category on page 298

DescriptionActivate or deactivate the notification to the host application of the occurrence of the selected event.Default value: True.Related Functional Guide Topic(s)Event Control GenICam Features (Data Stream) on page 136

EventNotificationContext1Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_1

Feature Info

Module Category Path Type Access

Data Stream Root / EventControl Enumeration RW

Parent Category: EventControl Category on page 298

DescriptionSelect context information reported in EVENT_DATA_CUSTOM_CONTEXT_1 (context information value is latched whenthe event occurs).Default value: EventSpecific.

Enumeration Values• EventSpecific: Event-specific context information.• LineStatusAll: Value of LineStatusAll.• PendingCicTriggerCount: Number of currently pending CIC triggers.• LIN1EventCount: Number of LIN1 events.• LIN2EventCount: Number of LIN2 events.• LIN3EventCount: Number of LIN3 events.• LIN4EventCount: Number of LIN4 events.• LIN5EventCount: Number of LIN5 events.• LIN6EventCount: Number of LIN6 events.• LIN7EventCount: Number of LIN7 events.• LIN8EventCount: Number of LIN8 events.

300

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

• QDC1EventCount: Number of QDC1 events.• QDC1DirEventCount: Number of QDC1Dir events.• QDC2EventCount: Number of QDC2 events.• QDC2DirEventCount: Number of QDC2Dir events.• DIV1EventCount: Number of DIV1 events.• DIV2EventCount: Number of DIV2 events.• MDV1EventCount: Number of MDV1 events.• MDV2EventCount: Number of MDV2 events.• DEL11EventCount: Number of DEL11 events.• DEL12EventCount: Number of DEL12 events.• DEL21EventCount: Number of DEL21 events.• DEL22EventCount: Number of DEL22 events.• UserEvent1EventCount: Number of UserEvent1 events.• UserEvent2EventCount: Number of UserEvent2 events.• UserEvent3EventCount: Number of UserEvent3 events.• UserEvent4EventCount: Number of UserEvent4 events.• EIN1EventCount: Number of EIN1 events.• EIN2EventCount: Number of EIN2 events.• CrcErrorCxpAEventCount: Number of CrcErrorCxpA events.• CrcErrorCxpBEventCount: Number of CrcErrorCxpB events.• CrcErrorCxpCEventCount: Number of CrcErrorCxpC events.• CrcErrorCxpDEventCount: Number of CrcErrorCxpD events.• CameraTriggerRisingEdgeEventCount: Number of CameraTriggerRisingEdge events.• CameraTriggerFallingEdgeEventCount: Number of CameraTriggerFallingEdge events.• StrobeRisingEdgeEventCount: Number of StrobeRisingEdge events.• StrobeFallingEdgeEventCount: Number of StrobeFallingEdge events.• AllowNextCycleEventCount: Number of AllowNextCycle events.• DiscardedCicTriggerEventCount: Number of DiscardedCicTrigger events.• PendingCicTriggerEventCount: Number of PendingCicTrigger events.• CxpTriggerAckEventCount: Number of CxpTriggerAck events.• CxpTriggerResendEventCount: Number of CxpTriggerResend events.• TriggerEventCount: Number of Trigger events.• StartOfCameraReadoutEventCount: Number of StartOfCameraReadout events.• EndOfCameraReadoutEventCount: Number of EndOfCameraReadout events.• StartOfScanEventCount: Number of StartOfScan events.• EndOfScanEventCount: Number of EndOfScan events.• RejectedFrameEventCount: Number of RejectedFrame events.• RejectedScanEventCount: Number of RejectedScan events.

Related Functional Guide Topic(s)Event Control GenICam Features (Data Stream) on page 136

301

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

EventNotificationContext2Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_2

Feature Info

Module Category Path Type Access

Data Stream Root / EventControl Enumeration RW

Parent Category: EventControl Category on page 298

Short DescriptionSelect context information reported in EVENT_DATA_CUSTOM_CONTEXT_2.

Enumeration Values• EventSpecific: Event-specific context information.• LineStatusAll: Value of LineStatusAll.• PendingCicTriggerCount: Number of currently pending CIC triggers.• LIN1EventCount: Number of LIN1 events.• LIN2EventCount: Number of LIN2 events.• LIN3EventCount: Number of LIN3 events.• LIN4EventCount: Number of LIN4 events.• LIN5EventCount: Number of LIN5 events.• LIN6EventCount: Number of LIN6 events.• LIN7EventCount: Number of LIN7 events.• LIN8EventCount: Number of LIN8 events.• QDC1EventCount: Number of QDC1 events.• QDC1DirEventCount: Number of QDC1Dir events.• QDC2EventCount: Number of QDC2 events.• QDC2DirEventCount: Number of QDC2Dir events.• DIV1EventCount: Number of DIV1 events.• DIV2EventCount: Number of DIV2 events.• MDV1EventCount: Number of MDV1 events.• MDV2EventCount: Number of MDV2 events.• DEL11EventCount: Number of DEL11 events.• DEL12EventCount: Number of DEL12 events.• DEL21EventCount: Number of DEL21 events.• DEL22EventCount: Number of DEL22 events.• UserEvent1EventCount: Number of UserEvent1 events.• UserEvent2EventCount: Number of UserEvent2 events.• UserEvent3EventCount: Number of UserEvent3 events.• UserEvent4EventCount: Number of UserEvent4 events.• EIN1EventCount: Number of EIN1 events.• EIN2EventCount: Number of EIN2 events.• CrcErrorCxpAEventCount: Number of CrcErrorCxpA events.• CrcErrorCxpBEventCount: Number of CrcErrorCxpB events.• CrcErrorCxpCEventCount: Number of CrcErrorCxpC events.

302

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

• CrcErrorCxpDEventCount: Number of CrcErrorCxpD events.• CameraTriggerRisingEdgeEventCount: Number of CameraTriggerRisingEdge events.• CameraTriggerFallingEdgeEventCount: Number of CameraTriggerFallingEdge events.• StrobeRisingEdgeEventCount: Number of StrobeRisingEdge events.• StrobeFallingEdgeEventCount: Number of StrobeFallingEdge events.• AllowNextCycleEventCount: Number of AllowNextCycle events.• DiscardedCicTriggerEventCount: Number of DiscardedCicTrigger events.• PendingCicTriggerEventCount: Number of PendingCicTrigger events.• CxpTriggerAckEventCount: Number of CxpTriggerAck events.• CxpTriggerResendEventCount: Number of CxpTriggerResend events.• TriggerEventCount: Number of Trigger events.• StartOfCameraReadoutEventCount: Number of StartOfCameraReadout events.• EndOfCameraReadoutEventCount: Number of EndOfCameraReadout events.• StartOfScanEventCount: Number of StartOfScan events.• EndOfScanEventCount: Number of EndOfScan events.• RejectedFrameEventCount: Number of RejectedFrame events.• RejectedScanEventCount: Number of RejectedScan events.

Related Functional Guide Topic(s)Event Control GenICam Features (Data Stream) on page 136

EventNotificationContext3Select context information reported in EVENT_DATA_CUSTOM_CONTEXT_3

Feature Info

Module Category Path Type Access

Data Stream Root / EventControl Enumeration RW

Parent Category: EventControl Category on page 298

Short DescriptionSelect context information reported in EVENT_DATA_CUSTOM_CONTEXT_3.

Enumeration Values• EventSpecific: Event-specific context information.• LineStatusAll: Value of LineStatusAll.• PendingCicTriggerCount: Number of currently pending CIC triggers.• LIN1EventCount: Number of LIN1 events.• LIN2EventCount: Number of LIN2 events.• LIN3EventCount: Number of LIN3 events.• LIN4EventCount: Number of LIN4 events.• LIN5EventCount: Number of LIN5 events.• LIN6EventCount: Number of LIN6 events.• LIN7EventCount: Number of LIN7 events.• LIN8EventCount: Number of LIN8 events.• QDC1EventCount: Number of QDC1 events.

303

Coaxlink Driver 7.0 Functional Guide   Data Stream Module Features

• QDC1DirEventCount: Number of QDC1Dir events.• QDC2EventCount: Number of QDC2 events.• QDC2DirEventCount: Number of QDC2Dir events.• DIV1EventCount: Number of DIV1 events.• DIV2EventCount: Number of DIV2 events.• MDV1EventCount: Number of MDV1 events.• MDV2EventCount: Number of MDV2 events.• DEL11EventCount: Number of DEL11 events.• DEL12EventCount: Number of DEL12 events.• DEL21EventCount: Number of DEL21 events.• DEL22EventCount: Number of DEL22 events.• UserEvent1EventCount: Number of UserEvent1 events.• UserEvent2EventCount: Number of UserEvent2 events.• UserEvent3EventCount: Number of UserEvent3 events.• UserEvent4EventCount: Number of UserEvent4 events.• EIN1EventCount: Number of EIN1 events.• EIN2EventCount: Number of EIN2 events.• CrcErrorCxpAEventCount: Number of CrcErrorCxpA events.• CrcErrorCxpBEventCount: Number of CrcErrorCxpB events.• CrcErrorCxpCEventCount: Number of CrcErrorCxpC events.• CrcErrorCxpDEventCount: Number of CrcErrorCxpD events.• CameraTriggerRisingEdgeEventCount: Number of CameraTriggerRisingEdge events.• CameraTriggerFallingEdgeEventCount: Number of CameraTriggerFallingEdge events.• StrobeRisingEdgeEventCount: Number of StrobeRisingEdge events.• StrobeFallingEdgeEventCount: Number of StrobeFallingEdge events.• AllowNextCycleEventCount: Number of AllowNextCycle events.• DiscardedCicTriggerEventCount: Number of DiscardedCicTrigger events.• PendingCicTriggerEventCount: Number of PendingCicTrigger events.• CxpTriggerAckEventCount: Number of CxpTriggerAck events.• CxpTriggerResendEventCount: Number of CxpTriggerResend events.• TriggerEventCount: Number of Trigger events.• StartOfCameraReadoutEventCount: Number of StartOfCameraReadout events.• EndOfCameraReadoutEventCount: Number of EndOfCameraReadout events.• StartOfScanEventCount: Number of StartOfScan events.• EndOfScanEventCount: Number of EndOfScan events.• RejectedFrameEventCount: Number of RejectedFrame events.• RejectedScanEventCount: Number of RejectedScan events.

Related Functional Guide Topic(s)Event Control GenICam Features (Data Stream) on page 136

304

Data Stream Module Features   Coaxlink Driver 7.0 Functional Guide

EventCountNumber of occurrences of the selected event (32-bit counter)

Feature Info

Module Category Path Type Access

Data Stream Root / EventControl IntReg RO

Parent Category: EventControl Category on page 298Register Port: StreamPort

Short DescriptionNumber of occurrences of the selected event (32-bit counter).Related Functional Guide Topic(s)Event Control GenICam Features (Data Stream) on page 136

EventCountResetReset the selected EventCount

Feature Info

Module Category Path Type Access

Data Stream Root / EventControl Command Imposed: WO

Parent Category: EventControl Category on page 298

Short DescriptionReset the selected EventCount.Related Functional Guide Topic(s)Event Control GenICam Features (Data Stream) on page 136

305