ATS-VI Software Manual - AlazarTech

1 ATS-VI Software Manual Use AlazarTech PCI and PCI Express Waveform Digitizers in LabVIEW Programming Environment Written for Software Version: March 2009 Edition Part Number: 9462-USR-1 ii ATS-VI Software Manual Version Copyright 2003-2009 AlazarTech , Inc. All rights reserved. AlazarTech Contact Information AlazarTech , Inc. 6600 Trans-Canada Highway, Suite 310 Pointe-Claire, Quebec Canada H9R 4S2 Telephone: (514) 426-4899 Fax: (514) 426-2723 E-mail: Web site: To comment on the documentation for ATS-VI , send e-mail to Information required when contacting AlazarTech for technical support: Owned by: _____ Serial Number: _____ Purchase Date: _____ Purchased From: _____ Software Driver Version: _____ SDK Version: _____ AlazarDSO Version: _____ Operating System: _____ ATS-VI is a registered trademark of Alazar Technologies, Inc.

2 LabVIEW is a registered trademark of National Instruments ATS-VI Software Manual Version iii License Agreement Important By using this Software you accept the following terms of this License Agreement. If you do not agree with these terms, you should not use the Software and promptly return it for a refund. Ownership Alazar Technologies, Inc., retains the ownership of this copy of the enclosed Software package. It is licensed to you for use under the following conditions: Grant of License You may only concurrently use the enclosed Software on the computers that have an Alazar Technologies, Inc. waveform digitizer card plugged in (for example, if you have purchased one Alazar Technologies, Inc. card, you have a license for one concurrent usage).

3 If the number of users of the Software exceeds the number of Alazar Technologies, Inc. cards you have purchased, you must have a reasonable process in place to assure that the number of persons concurrently using the Software does not exceed the number of Alazar Technologies, Inc. cards purchased. You may transfer this Software to another party if the other party agrees to the terms and conditions of the agreement and completes and returns a registration card to Alazar Technologies, Inc. The registration card is available by writing to Alazar Technologies, Inc. If you transfer the Software , you must simultaneously transfer all documentation and related disks. Restrictions You may not copy the documentation or Software except as described in the installation section of this Manual .

4 You may not distribute, rent, sub-lease or lease the Software or documentation, including translating, decomposing, or disassembling. You may not reverse-engineer any part of this Software . You may not make telecommunication transmittal of this Software . Termination This license and your right to use this Software automatically terminates if you fail to comply with any provision of this license agreement. Rights Alazar Technologies, Inc. retains all rights not expressly granted. Nothing in this agreement constitutes a waiver of Alazar Technologies, Inc. s rights under the Canadian and copyright laws or any other Federal or State law. Limited Warranty If you discover physical defects in the media, Alazar Technologies, Inc. will replace the media or documentation at no charge to you, provided you return iv ATS-VI Software Manual Version the item to be replaced with proof of payment to Alazar Technologies, Inc.

5 During the 90-day period after having taken delivery of the Software . Alazar Technologies, Inc. excludes any and all implied warranties, including warranties of merchantability and fitness for a particular purpose and limits your remedy to return the Software and documentation to Alazar Technologies, Inc. for replacement. Although Alazar Technologies, Inc. has tested the Software and reviewed the documentation, ALAZAR TECHNOLOGIES, INC. MAKES NO WARRANTY OF REPRESENTATION, EITHER EXPRESSED OR IMPLIED, WITH RESPECT TO THIS Software OR DOCUMENTATION, ITS QUALITY, PERFORMANCE, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. AS A RESULT, THIS Software AND DOCUMENTATION IS LICENSED as is AND YOU, THE LICENSEE, ARE ASSUMING THE ENTIRE RISK AS TO ITS QUALITY AND PERFORMANCE.

6 IN NO EVENT WILL ALAZAR TECHNOLOGIES, INC. BE LIABLE FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THIS Software OR DOCUMENTATION, even if advised of the possibility of such damages. In particular, Alazar Technologies, Inc. shall have no liability for any data acquired, stored or processed with this Software , including the costs of recovering such data. THE WARRANTY AND REMEDIES SET FORTH ABOVE ARE EXCLUSIVE AND IN LIEU OF ALL OTHERS, ORAL OR WRITTEN, EXPRESSED OR IMPLIED. No Alazar Technologies, Inc. dealer, agent or employee is authorized to make any modifications or additions to this warranty. Information in this document is subject to change without notice and does not represent a commitment on the part of Alazar Technologies, Inc.

7 The Software described in this document is furnished under this license agreement. The Software may be used or copied only in accordance with the terms of the agreement. It is against the law to copy the Software on any medium except as specifically allowed in the license agreement. No part of this Manual may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, for any purpose without the written permission of Alazar Technologies, Inc. Some jurisdictions do not allow the exclusion of implied warranties or liability for incidental or consequential damages, so the above limitation or exclusion may not apply to you. This warranty gives you specific legal rights, and you may also have other rights which vary from jurisdiction to jurisdiction.

8 ATS-VI Software Manual Version v Table of Contents UNDERSTANDING THIS 2 INSTALLING ATS-VI .. 3 PROGRAM USING ATS_EASY VI SET .. 5 DEVICE CONTROL 11 ATS_Card_Spec .. 12 13 14 ATS_DMA_Channel .. 15 ATS_DMA_Ctrl .. 16 ATS_Global .. 17 18 ATS_Query .. 19 20 ATS_Set_Value .. 21 22 Bandwidth .. 23 24 Channel .. 25 Clock .. 26 ClockEdge .. 27 ClockRate .. 28 ClockSource .. 29 30 Device_Ctrl .. 31 Device_Info .. 32 ExtTrigger .. 33 ExtTrigRange .. 34 Impedance .. 35 36 Range .. 37 Record .. 38 Trigger .. 39 40 TriggerEngine .. 41 TriggerOperation .. 42 ATS_EASY VI 43 ATS_Boolean_State .. 44 45 ATS_Device .. 49 vi ATS-VI Software Manual Version 53 ATS_Get_Device .. 55 59 61 ATS_Mode .. 62 ATS_MS_Set_Device.

9 64 ATS_Read_WFMs .. 71 ATS_Set_Device .. 73 ADVANCED VI DESCRIPTION .. 80 ATS_AbortCapture .. 81 ATS_About .. 82 ATS_BoardsFound .. 83 ATS_BoardsInSystem .. 84 ATS_Busy .. 85 ATS_Check .. 86 87 ATS_Close .. 88 89 ATS_ForceTrigger .. 91 ATS_Get_Specs .. 92 ATS_GetBoardBySystemId .. 94 96 ATS_GetCPLDV ersion .. 97 ATS_GetDriverVersion .. 98 99 100 101 103 104 ATS_HyperDisp_Read_8bits .. 106 ATS_InputControl .. 108 ATS_Inputs .. 110 112 113 ATS_Open .. 114 115 116 ATS_Range_Convert .. 117 118 120 ATS_Search_Value .. 122 ATS_SetCaptureClock .. 123 125 126 127 ATS_SetRecordCount .. 129 ATS-VI Software Manual Version vii ATS_SetRecordSize .. 130 ATS_SetTrigger .. 131 133 ATS_SetTriggerTimeOut .. 134 ATS_SetTriggerTimeOut_Brd.

10 135 ATS_SetTriggerTimeOut_HDL .. 136 ATS_Specs .. 137 ATS_StartCapture .. 140 ATS_State_Device .. 141 ATS_TimeOut_Estimate .. 149 150 ATS_Triggered .. 152 ATS_Trunc .. 153 ATS_Value_in_StringArray .. 154 ATS_WhoTriggered .. 155 SYNCHRONOUS DMA VI 157 ATS_AbortAutoDMA .. 158 ATS_CloseAutoDMA .. 160 161 ATS_DMA_Buffer_Size .. 163 164 ATS_DMA_cFlags_NoCont .. 166 168 171 ATS_DMA_Device .. 174 ATS_DMA_Errors .. 177 ATS_Events .. 179 ATS_GetNextBuffer .. 180 ATS_Header .. 182 ATS_Record .. 186 190 ATS_StartAutoDMA .. 194 197 ATS_WaitForBufferReady .. 198 ASYNCHRONOUS DMA VI DESCRIPTION .. 199 ATS_Async_Buffer_Size .. 200 ATS_Async_Code .. 203 ATS_AsyncDMA_cFlags .. 206 ATS_AsyncDMA_Device .. 208 ATS_AsyncDMA_Device_U8 .. 211 ATS_AsyncGetSetBufCount.