Home

User Manual - EAGLE Technology

1. 185 EDR Software Development Kit Appendix A Constants PC104 30G 65 NUMBOARDTYPES 66 17 2 Error codes error writing to file Comment invalid parameter detected hardware error detected board cannot do requested function file does not exist error reading from file ii 2 2 2 2 2 2 2 2 2 2 10 11 12 13 14 15 16 17 18 19 0 1 2 3 4 5 6 7 8 9 30 31 186 EDR Software Development Kit Appendix A Constants EDR NOFREETIMERS 1 40 nofree Windows timers for streamer EDR NOTRIGGER 1 44 notriggerdetected EDR BOARDNOTFOUND 1 46 board is not present or is faulty 17 3 Voltage ranges Constant Number Comment EDR_NOTPRESENT OP EDR RANGESB 14 15048 S O EDR RANGE25B 16 125045 1 EDR RANGEFVB f8 Fixed variable with pot EDR RANGEVU f9 Variable programmable EDR NUMRANGETYPES J5 S O 187 EDR Software Development Kit Appendix A Constants 17 4 A D input types Constant Number EDR SINGLEENDED io gt 4 EDR DIFFERENTIAL 17 5 Transfer modes Constant Number Comment _ EDR NA 10 Jsamplingnotavailable EDR INTR EDR SINGLEDMA EDR DUALDMA 4 dualchannelDMA E A E A EDR NUMTRANSFERMODES 17 6 Burst settings Constant Number Comment Comment EDR ADBURSTNUMCHANS set burst to length of channel list EDR ADNOBURST 10 Idonotuse burst mode 17 7 ADC clock trigger settings Constant Number Comme
2. Allows the voltages on all D A channels to be set Generates a waveform on a single D A channel Generates two waveforms on different D A channels Walks a bit through all digital output ports Checks the A D input channels of a board using its D A outputs 17 EDR Software Development Kit Building applications using EDR freqcnt pas Frequency counter for the PC14B ctread pas Simple demo to read counter timers and software gate them tempmetr pas Continuously displays the temperature on TC board inputs rtdmeter pas Continuously displays the temperature on RTD board inputs dioloop pas Walks a bit through DIO port 0 while displaying the others extint pas Counts external interrupts 2 2 Windows languages 16 and 32 bit When the application is compiled a header file is used to tell the compiler what functions are in the driver and the parameters they expect When the application is linked the linker inserts references to functions in EDR DLL or EDR32 DLL for 32 bit apps into your code the actual code is not added These references are only resolved to call EDR DLL or EDR32 DLL at load or run time hence the term dynamic link library Thus while your applications EXE file will be smaller you need to distribute EDR DLL and EDRVXD 386 Windows 3 1x and Windows 95 or EDR32 DLL and EDR SYS Windows NT with your application and install them on target systems 32 bit Windows 95 apps also need the Windows 95 version of EDR32
3. EDR Software Development Kit Introduction Windows NT requires this scheme It is slower than the direct access of Windows 3 1x and Windows 95 but helps to maintain system integrity as only trusted device drivers can access hardware Applications always call EDR32 DLL and never EDR SYS 1 6 Installation To install the EDR SDK insert Disk 1 in drive A and run the windows setup program This will install the EDR SDK on your PC The paragraphs below contain operating system dependent installation instructions 1 6 1 Windows NT 4 0 Log on as Administrator or another account with admin clearance and run SETUP BAT found in the EDR WINNT directory This will install the kernel mode device driver EDR SYS and EDR32 DLL Setup will also create the necessary registry keys and settings for you After setup is done you have to reboot your PC for the changes to take affect Setup runs a program called REGINI EXE to create the registry entries for EDR SYS You can use this when installing EDR SYS on target systems for your own applications Just run REGINI with EDR INI found in EDR WINNT When setup has completed go to Control Panel and choose Eagle Board Setup Configure your boards and reboot You need to know the exact model number base address and jumper settings for each board See 1 6 3 for more information on the Windows 95 and Windows NT control panel applet and configuring boards The kernel mode device driver EDR SYS r
4. 5 Measuring temperatures ssssnsssvsesnenssvvsvessnnnnnnnnvessnnnnssnnesnensnre II 5 1 Reading thermocouple and CJC voltages ernrrrnrrnnrrvrrrrrnnrennrnee 53 5 2 Converting a CJC voltage into the ambient temperature 53 5 3 Converting a TC voltage into a temperature esnnrrrrrnrrvvrennrner 54 5 4 Converting a RTD voltage into a temperature rrrrrrrnrrvnvrrnrner 54 5 5 Using a non TC board to measure temperatures rrrrrrrrrnnrner 54 6 Generating Voltages and Waveform cccssssrsrcccssssssersee DD 6 1 D A Channel numbers Luramotesraivnkeausmnime ai 55 6 2 Generating voltages on D A channels srrrnnrnnnnnvrnnrnvrnnrrnnrennnnen 55 6 2 1 Prematur 55 6 2 2 Converting microvolt values to binary srrvrrnvrnvenvnnrn 55 6 3 Generating waveforms on D A channels ernrnrnronnrnvrrnrrnnrennrnen 56 6 3 1 Setting the transfer mode srnrrrrrrnnvrrennrnvennrrvnrrnnnnsennrne 56 6 3 2 Choosing channels for the waveforms ccseeeeees 56 G33 D t format sesser reiia a iae 56 6 3 4 Waveform frequenevvansnarausnandaavdimddeser 57 6 3 5 Generating the waveform ssessesssesressessssseesseressseesseee 57 6 3 6 Background waveform generation esseeesssesssereessersseee 57 7 Configuration functions ssecesesssoccceessooccecscosoceessosoceceessosesee DO 7 1 EDR AllocBoardHandle erroovrnnnvrrnnnvvrnnnvvrnnnnernnnnernnnnesennnesenen 58 7 2 EDR 0
5. Dim longvar As Long intvar As Integer longvar 40000 Assign the number to a long var intvar longvar 65536 Convert it to a negative integer EDR_Sub intvar Pass it to the function longvar intvar This bit assumes that it was changed longvar longvar 65536 Convert it back to a positive long Special care has to be taken when using EDR functions that return information in strings You must fill your string with enough spaces to hold the result of the call before calling the function The built in function Space is useful for this EDR will store the result in the string and place a null byte Chr 0 after the last character used If the string is just going to be printed or passed to a function such as MsgBox this is fine as the extra spaces after this null byte will be ignored If required these extra spaces and 29 EDR Software Development Kit Programming guidelines the null byte can be removed by calling RTrimZ to remove the extra spaces and the null byte This function is in EDR BAS Here is an example of its use s SpaceS 80 make space in string for message EDR StrError error s convert error number into a string s RTrimZ s get rid of extra spaces and null byte Here is the Visual Basic definition for the example function Declare Function EDR Function Lib EDR DLL BYVAL a As Integer BYVAL s As String buf as Integer b as Integer BYVAL c as Long As Integer It cou
6. 4 4 2 Interrupts EDR INTR orereroronrrrronrvrenrerennvrrerrvsnnessensenn 35 4 4 3 Single channel DMA EDR_SINGLEDMA 36 4 4 4 Dual channel DMA EDR_DUALDMA c 36 4 4 5 Streaming EDR STREAM rsrroronvvrrrnrrnnvrrsrrrsnnrseennen 37 4 5 Selecting channels to sample rrrrronvrnvonnrrvnvernrnernrrvsrnrrnneennnseen 38 4 6 Setting the sampling frequency cceeeseeeceesteceeeteeeeeeneeeeensees 39 4 6 1 Burst block mode and simultaneous sample and hold gne e rete er EE EE NE 39 4 7 Background samplimssausdarasder aa 39 4 7 1 Windows notification messages rrrrrrrrnnrnvrrrrrnnrerneneernn 40 4 8 Circular buffer sampling vaussssvspessenelsnea kodene 4 4 9 Streaming bd vvs TAN 42 4 9 1 How the Windows streamer works rrrrennrnvrnnrrvvvrnvrnerrnn 42 4 10 Software triggering Windows 3 1x 95 only esnrrrroorrrnnvennrner 43 4 10 1 Setting channel trigger details rrrnnronnrnrrnnrrvrrrrnnnvrrnr 44 4 10 2 Trigger nobheanonuarrgartsensgisststurdasne 44 4 10 3 Setting the global trigger type mode ee eeeeeeees 45 4104 Performanc enstinn n E svette 48 AOS Ouick Telerence avse Aer 48 4 11 Using XMS memory DOS and memory blocks OUA ETE EEE EN 48 4 12 Aborting sampling with a keypress DOS only eee 49 4 13 Using parallel boards to access more than 16 channels 49 4 14 Using PC81A expansion boards to address more than 16 ep 11 NE EE 50
7. C16arAD Ingse 105 922 EDR G tADB rstLem n iene E 106 9 23 EDR_GetADCClockTrigger ias scsevssetessseesensateayedecaves tacevsandesnseee 106 9 24 EDR GetADChanListIndex soronoronnnnoennrrvnrennnneennrrvsrrrnnsennnne 106 925 EDR GetA DC hansen runaursestsvarraasas der 107 9 26 EDR Get A DC han Trggersuatvursnh rsemunmienstedesrbuee 107 921 EDR GetADCh n Trigger Typesuusksesunssarsudansresnerete 108 9 28 EDR GetA D Transler Mode ssescises ceseranseostasteseashobaneteaved neces eeane 108 9 29 EDR GetADDisableAllInts sssoerorroresnonsvnrarnvsernnnvnesarsrseenneee 109 9 30 EDR GetADKeyAbort sernrrrennersennvnssnenrersennvssennrnvennnneessnnsee 109 9 31 EDR_GetADNoDelay sv 109 9 32 EDR Cre AL TARN 110 9 33 EDR_GetADTriggerType sandsten bee 111 9 34 EDR GetADUseTCInts rrernnrrersvnvevevsvevevsvevevsnevsverevsvsreveverener 111 9 35 EDR GetNounheatonMsg usassasadeasadesandsd este 112 9 36 EDR GetNotificationWindow runnnnnnnnnnnnnnnenennnnnennnenenenenenenenes 113 9 37 EDR_GetStreamBlockSize uavvsvvaasasseinaasenk enes 113 9 38 EPR GeStreamButkernsu usv2a42rskraskakas he 113 9 39 EDR_GetStreamFile ne 114 VEDR Paean 114 9 41 EDR S amp etADBurstLenuuuaveemeranmemtenisuenmnssnsiv 115 9 42 EDR SetADCClock Tine gery sanere dk date 115 9 43 EDR SetADChanListIndex rennnnnnnnnennnnnnnnnenenennnennnenenenenenenenes 116 9 44 EDR_SetADChanlistLen stalcse Gv eiscadevas eatiode eit eave men 116 9 45 EDR SetADChanTrigg
8. Installs an ISR for a particular type of interrupt on a board EDR retrieves the IRQ level from its internal configuration information EDR UninstallBoardISR must be called for each ISR installed using this function before the application terminates 16 4 EDR_InstallISR Parameter Type Comment irq integer Hardware IRQ level isr void Pointer to the ISR for the IRQ Returns integer error code 179 EDR Software Development Kit Interrupt functions Error code Comment EDR_OK No error EDR BADPARAM Hardware IRQ level is invalid EDR IRQINUSE Hardware IRQ level is in use Installs an ISR for the specified hardware IRQ EDR saves the pervious ISR for the IRQ EDR Uninstalll SR 16 5 EDR MaskBoardIRQ Parameter Type Comment bh integer Board handle id integer Interrupt ID number listed in 17 17 maskbit integer Mask 1 or unmask 0 flag Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADPARAM Interrupt ID number is invalid Masks or unmasks a particular board interrupt EDR gets the IRQ level from its internal configuration information 16 6 EDR_MaskIRQ Parameter Type Comment irq integer Hardware IRQ level maskbit integer Mask 1 or unmask 0 flag Returns integer error code Error code Comment EDR_OK No error EDR_BADPARAM Hardware IRQ level is invalid Masks or unmasks a particular IRQ level 180 EDR Software Development Kit Interrupt functions 1
9. This chapter explains how to build an application that uses EDR in all of the supported languages 2 1 DOS languages When the application is compiled a header file is used to tell the compiler what functions are in the driver and the parameters they expect When the application is linked code from EDR in a library is combined with your code to form your executable file 2 1 1 Borland C C Follow these steps 1 Make sure you are using the large memory model 2 Include C EDR INCLUDE DOS EDR H in all files that call EDR functions or use constants defined in EDR H You can do this by putting the following line at the top of each file include c edr inlcude dos edr h 3 Link your application with C EDR LIB DOS EDR LIB if you are using the IDE you can just add it to your project C users need not add extern C around EDR H as this has been done inside the file If you get any Fixup overflow errors when linking then one or more of your files have been compiled for a different memory model Rebuild all files using the large memory model Project files have been provided for all of the demo programs A makefile MAKEFILE BC is also provided to build all of the demos using Borland C C The demos in the C EDR EXAMPLES C DOS directory are as follows 14 EDR Software Development Kit Demo voltmetr prj init pr adindemo prj stream prj xms prj voltgen prj wavegen prj wavegen2 prj Building applicat
10. directory in the 386Enh section device edrvxd 386 If you are not using interrupt or DMA data acquisition functions then you can omit this line If you call a function that requires EDRVXD 386 the function will return an appropriate error code You will need to restart your computer for this change to take effect EDR Software Development Kit Introduction 1 6 2 2 Windows 95 Run WIN95 EXE found in your C EDR WIN95 directory This will mark EDR DLL as a Windows 4 0 executable If you do not do this 16 bit applications will work but 32 bit apps will not load Then copy EDR DLL EDR32 DLL EAGLE CPL and EDRVXD 386 to your WINDOWS SYSTEM directory Add the following line to SYSTEM INI found in your WINDOWS directory in the 386Enh section device edrvxd 386 If you are not using interrupt or DMA data acquisition functions then you can omit this line If you call a function that requires EDRVXD 386 the function will return an appropriate error code You will need to restart your computer for this change to take effect Once you have restarted your computer refer to 1 6 3 for information on how to configure your board s 1 6 3 Windows 95 and NT Control Panel applet Going to Control Panel and selecting Eagle Board Setup runs the Control panel applet This applet allows you to configure each of the boards in your computer If you add or remove boards change jumper settings or want to change software selectable settings u
11. 17 23 Trigger edge settings Constant Numer EDR EDGE NONE 0 17 24 Trigger mode settings Constant Number EDR TRIG NONE meer EDR TRIG PRE EDR TRIG MID EDR TRIG POST EDR TRIG USER ia 192 EDR Software Development Kit Appendix B Fine tuning EDRVXD 386 18 Appendix B Fine tuning EDRVXD 386 The SYSTEM INI settings given in this section are used to fine tune the VxD for maximum efficiency and performance The default settings work well for most tasks but may need to be changed for high speed dual channel DMA parallel board DMA when every byte of memory must be conserved or when the system crashes doing DMA All of these settings go in the EDR section of SYSTEM INI and none of them have any effect until Windows is restarted The following sections describe how different transfer modes work and the settings that apply to each 18 1 Single channel DMA Single channel DMA uses a single DMA level to transfer data If the data buffer crosses a DMA page boundary is not physically contiguous or is too high in memory the DMA is done into a special buffer allocated by the driver As the samples are transferred into this buffer by the A D board they are copied out into the original buffer by the driver This copying process takes place whenever EDR_BackgroundADInStatus is called and at specified millisecond intervals The buffering process is completely transparent to the calling application The only effect is th
12. Acquiring analogue data 4 10 3 Setting the global trigger type mode EDR supports 4 different trigger modes Call EDR_SetADTriggerType ee ae 9 50 with one of the constants shown in Figure 5 to select the mode you pretede data require Each mode is discussed in ca ieee te detail in the following paragraphs EDR Eee POST igger lows data EDR TRIG USER riggers are No triggering EDR TRIG NONE me reported but are ignored This is the default setting All Figure 5 Trigger modes individual channel trigger settings are ignored and no triggering is done Pre triggering EDR TRIG PRE With pre triggering the trigger precedes the data see Figure 6 EDR only starts putting data in your buffer once one of the sampled channels has triggered This is the simplest trigger mode The following pseudo code shows how to setup a pre triggering operation Figure 6 Pre triggering Set the transfer mode to EDR STREAM set sampling fr channels gains etc as normal EDR SetADChanTriggerType bh 0 EDR EDGE RISING 4000000 EDR SetADChanTriggerType bh 2 EDR EDGE FALLING 2000000 Trigger on a rising edge at 4000000 uv 4V on channel 0 or a falling edge at 2V on channel 2 This assumes that channels 0 and 2 are among those being sampled EDR SetADTriggerType bh EDR TRIG PRE 0 Trigger precedes the data EDR ADInBinBackground bh Start background sampling data will only appear in the buffer a
13. BADPORT Port number is invalid Reads a word of data from a digital input port If the port is an output port then the last value written to the port is returned 155 EDR Software Development Kit Digital input output functions 12 8 EDR DIOPortOutput16 Parameter Type Comment bh integer Board handle portnum integer Port number value integer Byte of data for port Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADPORT Port number is invalid EDR BADPORTCFG Not an output port Writes a word of data to a digital output port 12 9 EDR HasDOReadback Parameter Type Comment boardtype integer Type of board Returns integer result Result code Comment 0 Board does not support readback of digital output ports 1 Digital output ports can be read back Indicates if a particular board type s digital output ports can be read back or not If the board supports readback from DIO ports then doing EDR DIOPortInput or EDR DIOLinelnput on an output port will read the last value written to the port from a board register If readback is not supported then EDR returns its software copy of the last value written using EDR DIOPortOutput or EDR DIOLineOutput 156 EDR Software Development Kit Memory functions XMS 13 Memory functions XMS These functions work with blocks of memory In the DOS versions of EDR they work with XMS memory blocks In the Windows version of EDR the fu
14. D channels This means that changing the range setting for one channel changes the range for all channels The newer PC30Fxx and PC30Gxx boards allow the A D input range to be toggled between unipolar and bipolar mode from software A jumper is still used to select the span 10V or 20V If this jumper is in the 10V position the range can be set to 0 to 10V EDR_RANGEIO0U or 5V EDR RANFES5B using this function 7 35 EDR SetADInType Parameter Type Comment bh integer Board handle chan integer Channel to configure adtype integer Input type code listed in 17 4 Returns integer error code 79 EDR Software Development Kit Configuration functions Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADTYPE Type is invalid EDR BADCHAN Channel number is invalid Configures the type for an A D channel EDR SINGLEENDED or EDR DIFFERENTIAL Note that for all A D boards currently supported EDR there is one jumper or register bit to control the type for all A D channels This means that changing the type setting for one channel changes the type for all channels On the older series boards PC30B PC30D et al the type is set by jumpers and cannot be changed from software This function still needs to be called for non default settings to tell the driver what the settings are The newer PC30Fxx and PC30Gxx boards allow the A D input type to be set from software 7 36 EDR SetBoardType Parameter Type
15. DOS EDR LIB if you are using the Programmers Workbench you can just add it to your program list C users need not add extern C I around EDR H as this has been done inside the file If you get any Fixup overflow errors when linking then one or more of your files have been compiled for a different memory model Rebuild all files using the large memory model Program list files PWB makefiles have been provided for all of the demo programs A makefile MAKEFILE MSC is also provided to build all of the demos using Microsoft C C The demos in the C VEDR EXAMPLES C DOS directory are as follows Demo voltmetr mak init mak adindemo mak stream mak xms mak voltgen mak wavegen mak wavegen2 mak bitwalk mak xcheck mak freqent mak ctread mak tempmetr mak rtdmeter mak Comments Continuously displays the voltage on all A D channels Detects which board is at a particular base address and initialises it Samples data using polled IO DMA and Interrupts Streams data to disk or memory Samples data using streaming or dual channel DMA into XMS Allows the voltages on all D A channels to be set Generates a waveform on a single D A channel Generates two waveforms on different D A channels Walks a bit through all digital output ports Checks the A D input channels of a board using its D A outputs Frequency counter for the PC14B Simple demo to read counter timers and software gate them Continuously displ
16. EDR BADPARAM Invalid parameter detected Acquires a block of A D data from the channels in the channel list You should read chapter 4 before using this function This function uses the current sampling frequency burst setting and transfer mode It returns immediately after sampling has started The transfer mode cannot be EDR POLLFED This function transfers data into memory blocks allocated with EDR AllocMem 13 1 For DOS versions of EDR these memory blocks are in XMS For Windows versions they are normal global memory blocks You need to call EDR BackgroundADInStatus periodically to check to see if the transfer has finished When the transfer has completed or if you need to stop it early you must call EDR StopBackgroundADIn This process is described in more detail in chapter 4 97 EDR ADInBinMemCircularBuffer Parameter Type Comment bh integer Board handle num long Number of samples buf long Handle of buffer for data Returns long error code 96 EDR Software Development Kit Analogue to digital input functions Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADTRANS Transfer mode is invalid EDR_NOCHANS There are no channels in the channel list EDR_BADCHAN The channel list contains an invalid channel number EDR_BADNUM The number of samples specified is invalid EDR_BADBOARD Board cannot do function EDR BADPARAM Invalid parameter detected Starts sampling data continuously into the buffer
17. EDR SetADChanListIndex Parameter Type Comment bh integer Board handle i integer Index of entry to change first is 0 chan integer New channel for entry Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADINDEX Index is invalid EDR_BADCHAN Channel number is invalid Changes the specified entry in the channel list 9 44 EDR SetADChanListLen Parameter Type Comment bh integer Board handle listlen integer New length of list or 0 to empty it 116 EDR Software Development Kit Analogue to digital input functions Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR TOOMANYCHANS Length is invalid Sets the number of channels in the boards channel list If the this number is 0 then the list is emptied If it is greater than the channel count then the list is padded with channel 0 The maximum length is 31 9 45 EDR SetADChanTrigger Type Parameter Type Comment bh integer Board handle chan integer Channel number edge integer Edge type code level long Level in uv Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Invalid channel number EDR BADTRIGEDGE Edge parameter is invalid EDR BADTRIGLEVEL Level parameter is out of range Sets the trigger settings for an A D input channel These settings are ignored unless a global trigger mode has been s
18. EDR supports 5 different ways of transferring data from the card to memory polled IO interrupts single channel DMA dual channel DMA and streaming All of the transfer modes except polled IO can be used for background sampling Data is stored in the same order as the channels are Channel Positio sampled Figure 14 shows how data would be placed in Sample nin array an array if channels 4 7 and 8 were sampled There are two main block sampling functions EDR_ADInBin 9 2 and EDR_ADInBinBackground 9 3 A number of other functions are used to select the transfer mode sampling frequency and so on and to monitor the status of background transfers Streaming to disk and sampling into XMS or Windows global memory blocks are started by different functions These functions are discussed in the sections below Figure 1 4 4 Selecting the transfer mode EDR_SetADTransferMode 9 49 selects the transfer mode to use for future block A D on the board EDR_GetADTransferMode 9 28 returns the current transfer mode The transfer mode constants are listed in 17 5 Each transfer mode is discussed below 4 4 1 Polled IO EDR_POLLED With polled IO EDR continually monitors the board waiting for conversions to complete When each conversion has completed the data is read by the processor and stored in memory This process requires the full attention of the processor and cannot be done in the background To avoid missing samples wh
19. Note that the lower limit of this variable is the Timerinterval value This should be setto 5 orless when doing high speed gt 40 KHz dual channel DMA without TC interrupts If this variable is 1 then the driver bypasses the built in virtual DMA device VDMAD when programming the DMA controller in certain situations This speeds up DMA operations Turn this off 0 if your machine crashes when doing DMA and lowering MaxP hysicalAddr does not help This setting should be left on when doing high speed dual channel DMA especially when using TC interrupts 18 2 Dual channel DMA Normally dual channel DMA transfers are not buffered as the two DMA channels are used in ping pong mode to skip over non contiguous areas in the buffer However if part of the buffer is too high in memory for the DMA controller to access it that part of the transfer has to be buffered in the same way as single channel DMA 194 EDR Software Development Kit Appendix B Fine tuning EDRVXD 386 The driver still needs to know when a DMA channel has finished its part of the transfer and can be reprogrammed with the next block The most efficient way to do this is to use TC terminal count interrupts TC interrupts are only generated if the board is jumpered or configured correctly they are not generated by the default factory jumper settings EDR SetInterruptSource see 16 8 can be used to configure the PC30Fxx and PC30Gxx The older PC30Dxx and PGx boards have t
20. These boards are based on our popular PC30FG boards They are also exactly compatible with them 1 2 Feature EDR releases The current EDR SDK will only support our ISA range boards and not our newer PCI PnP range The new EDR release will be known as EDR Enhanced and can be used in conjunction with the current release Please note that EDR Enhanced will support the more popular ISA boards but is mainly intended for the PCI boards EDR Enhanced will have the same functionality as EDR but will be easier to program and more powerful It will also only support the Windows 32 bit platform 1 3 Boards supported EDR currently supports the following boards listed according to the board s primary function EDR Software Development Kit Introduction e The PC26 PC30 PC30B C D DS DS4 PGL PGH PC126 and PC127 analogue to digital input boards e The PC30FA PC30FAS16 PC30FAS4 PC30F PC30FS16 PC30FS4 PC30GA PC30GAS 16 PC30GAS4 PC30G PC30GS16 and PC30GS4 advanced analogue to digital input boards The PC30L PC30LA and PC30LBf advanced 16 bit analogue to digital input boards e The PC166 PC166B PC167 PC167A PC167B and PC266 advanced digital to analogue output boards The PC66 PC66A and PC66C digital to analogue output boards The PC63 and PC63C reed relay boards The PC73A and PC73C thermocouple and RTD boards The PC36 PC36B PC36C PC192 and PC192A digital IO boards The PC14 PC14A and PC14B digital IO and counte
21. These boundaries occur every 64K or 128K depending on the DMA level If a page boundary lies within the buffer the transfer has to start at the boundary Once the transfer has completed the data is copied down to the start of the buffer This copying process is handled transparently by EDR Note that the buffer can be in XMS memory Windows The data buffer need only be big enough for the number of samples required EDR uses internal buffers for the transfer if it crosses a page boundary or is not physically contiguous The data is copied out of the internal buffer as needed This process is described in more detail in appendix B Windows NT Single channel DMA and streaming are handled in exactly the same way There is essentially no difference between them A maximum of 32000 samples can be captured in one block using this mode for DOS and Windows There is no limit under Windows NT 4 4 4 Dual channel DMA EDR DUALDMA Dual channel DMA uses 2 DMA channels to transfer data continuously from the card to memory As each channel finishes a block of data the board automatically starts transferring using the other channel The first channel can now be reprogrammed to transfer the next block Thus dual 36 EDR Software Development Kit Acquiring analogue data channel DMA can be used to capture as many samples as will fit into memory at full board throughput Windows NT Dual channel DMA is not supported Streaming is more reliable DO
22. anBeDetettedsnn nam 59 7 3 EDR Core DilosLur ss 60 7 4 EDR Detect Oar d yccsscticteaiditon Gisacestacnutenctisticbiaisena dalen 61 7 5 EDR FreeBoardHandle uk madmumeminnnnerinsidasueteseeie 62 TOEDR GeADINGA dus 63 TJ EDR GARE vender 63 7 8 EDR GetADInRangeMinMax ssrrrennernnvvrennvrenrrrennvrsersssnnessensene 64 Pow EDR Gera Din iy pe nea acct tell tease icra teen 64 7 10 EDR GetBase eeeseerenevevennvevennnevennnevennnevernnenevnnnunvnnnevennrevereneseser 65 TJ1 EDR AGE Board Ly pe racsicaccconcecaceedocnesanetcetustectanins Ga eeNeE 65 7 12 EDR GetDAOutFixedRef rosvrornnnnvnerrrnnnnvverennnnnevernnnnnneseensen 66 7 13 EDR GePDAOUtGams aa AR 66 7 14 EDR GetDAOutMode rernnnnnnnnnnnnnnnnnnnnennnnnenennnnnenenenenenenenenenenenes 67 7 15 EDR_GetDAOutRange unndra seid Waaedeerotenaads 67 7 16 EDR GetDAOutRangeMinMax eerennrnvernraverennrnernnrrnsrernnneennnne 68 7 17 EDR GetDAOutTriggerSource rennrrvrnnrrvnrennnneennrrnserrrnnsennnnee 68 TAIS EDR GEDMALEE Ne 69 TJSEDR GER TEL 69 20 EDR GESYSVES TOT kasser daasdeebarstendvadesbusetdocd 70 7 21 EDR GE VID Versidh sale whee aoataneesiaees 70 122 EDR HasADG nlumperusseusnssrmnsuiaddsksnisjerses 71 723 EDR InBordsssas2ee Tiel nica fella aa 71 T24 EDR IpitBodrdTyPesasrorrs sennen enei 72 7 25 DE IsB se Address Use caus avars oekahes 73 7 26 EDR LoadConfiguration ccscssccsesercsseseccsenencsssnnseseeenecs 74 T2 TEDR Sea OU 112 MA ae aist cecenet tan
23. e Microsoft Visual Basic 3 0 and 4 0 C EDR EXAMPLES VB directory The 32 bit demos in EDR EXAMPLES C WIN32 run under Windows 95 and Windows NT EDR can be used from any language that can call DLL functions just by creating an appropriate header file 1 9 Compiled demo programs Some of the demo programs have compiled and are ready to run If your application is simple you may be able to use one of the following demos as is 1 9 1 Windows 95 and Windows NT 32 bit e EDR EXAMPLES C WIN32 NOTDEM32 EXE GUI app Samples waveforms from selected A D channels in the background if possible and saves the data in a text file This is a port of the 16 bit NOTDEMO e There are a number of console mode ports of the DOS demos Have a look in IEDR EXAMPLES C WIN372 and check the c files for details on what each demo does e There are two Visual Basic 4 0 demos in EDRIEXAMPLESVVB LOGGER32 and WAVEIN32 are ports of the 16 bit applications listed below You need the Visual Basic 4 0 runtime DLL s to run these demos The required files are in EDR EXAMPLES VB You need to copy VB40032 DLL and GRAPH32 OCX to your WINDOWS SYSTEM directory e EDR EXAMPLES DELPHI STREAM32 STREAMER EXE This is a port of the 16 bit streamer application EDR Software Development Kit Introduction 1 9 2 Windows 95 16 bit and Windows 3 1x C EDR EXAMPLES DELPHI SCOPE SCOPE EXE Powerful oscilloscope application Demonstrates the power of the new trigg
24. important information on disk streaming 4 5 Selecting channels to sample EDR maintains a channel list for the board This list can hold up to 32 channels to sample In general the channels can be in any order and can be repeated when using the PC127 the channels must be in ascending order and cannot be repeated EDR_SetADChanListLen 9 44 and EDR_AddToADChanList 9 1 are used to put channels into the channel list 38 EDR Software Development Kit Acquiring analogue data 4 6 Setting the sampling frequency The A D conversion or sample frequency can be set using EDR_SetADClockmilliHz 10 15 Normally one channel is converted on each strobe however some boards support burst block mode or simultaneous sample bud bd bd and hold oO 2 Normal mode 4 6 1 Burst block mode and lex simultaneous sample and hold 0008 Burst mode When sampling in burst mode each strobe triggers a series of conversions done at the maximum speed of the board This is Simultaneous useful when the skew between sampled sampling 2 channels must be minimised Simultaneous sample and hold also only takes place in burst block mode on boards that support it EDR_SetADBurstLen Figure 2 Burst block mode 9 41 can be used to enable and disable and SSH burst block mode Figure 2 shows the spacing between samples taken from channels 0 1 2 and 3 on a PC30D at 25 KHz in normal and burst mode The latter part of the diagram shows how the samp
25. integer Board handle num integer Variable to hold position in waveform cycles unsigned Variable to hold number of cycles done Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid This function is not supported by this version of EDR 140 EDR Software Development Kit Analogue output functions 11 3 0 1 EDR_BackgroundDAOutType Parameter Type Comment bh integer Board handle Returns integer transfer mode or error code Error code Comment EDR_INTR Interrupt waveform generation in progress EDR_OK No background waveform generation EDR_BADHANDLE Board handle is invalid This function is not supported by this version of EDR 11 4 EDR_DAOutBin Parameter Type Comment bh integer Board handle num integer Number of samples in each waveform buf unsigned Interleaved binary waveform s cycles unsigned Number of times to repeat waveforms 1 for continuous numdone integer Variable to hold number of samples done in last cycle cyclesdone unsigned Variable to hold number of cycles done Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR NOCHANS No channels in channel list EDR BADCHAN Invalid channel in channel list EDR BADTRANS Invalid transfer mode EDR BADNUM Invalid number of samples EDR BADBOARD Board cannot do requested function 141 EDR Software Development Kit Analogue output functions Generates a
26. integer Counter timer number source integer Variable to hold source of timers gate input listed in 17 11 Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Counter timer number is invalid Gets the gate source of the specified counter timer channel 135 EDR Software Development Kit Counter Timer functions 10 11 EDR_GetCTInitial Value Parameter Type Comment bh integer Board handle num integer Counter timer number value unsigned Variable to hold value Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Counter timer number is invalid Returns the last value written to the counter 10 12 EDR GetCTInputFreqHz Parameter Type Comment bh integer Board handle num integer Counter timer number hz long Variable to hold frequency in Hz Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADCHAN Counter timer number is invalid Returns the frequency currently set using EDR_SetCTInputFreqHz 10 13 EDR GetDAClockmilliHz Parameter Type Comment bh integer Board handle millihz long 136 EDR Software Development Kit Counter Timer functions Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADBOARD Board does not have hardware clocked D A Gets the D A update cloc
27. into the disk file specified When the end of the buffer is reached sampling continues from the beginning without missing any data This process can continue indefinitely Use EDR BackgroundADInsStatus to see how far sampling has progressed on the current pass and EDR StopBackgroundADIn to stop sampling This function uses the current sampling frequency burst setting transfer mode streamer buffer and block size The transfer mode must be EDR STREAM and the num parameter must be a multiple of the current streamer block size Windows 95 32 bits only You must call EDR BackgroundADInStatus at regular intervals to ensure data is written to disk and the buffers do not overflow When doing high speed streaming in interval of 10 ms is OK The easiest way to do this is to set up a Windows timer to do the calls 9 60 EDR UsesPCTimerlInterrupts Parameter Type Comment boardtype integer Type of board 126 EDR Software Development Kit Analogue to digital input functions Returns integer code Code Comment 0 Does not use the PC timer for interrupt sampling 1 Does use the PC timer for interrupt sampling Some boards such as the PC73C and PC73 do not have onboard counter timer chips and interrupt support EDR supports interrupt sampling from these cards by using the PC s timer tick interrupts to time sampling This is ideal for slow temperature measurement applications If this function returns 1 then the specified board type is su
28. languages 16 and 32 bit eeennrrnnrrrnnnrennrnvrrrrrnneennnnee 18 2 2 1 Borland amp Microsoft C C 16 and 32 bit 18 2 2 2 Borland Turbo Pascal and Delphi rrrnronnrnvnorrnnnvennnne 20 2 2 3 Visual Basic 16 and 32 bit eennnnnnnnnennnenennnenennnnnnnenenener 20 3 Programming guidelines ENE NR EN Le 3 1 Board handles and board numbers svvrnnnnvrnnnnvrnnnnernnnnvvnnnnevennnener 22 3 1 1 Board handles Lu cece hed dedentnlct Harta Aeon eels est 22 312 Board MUM BSLS h a E R ear 23 SA Windows se 23 3 2 Software register Copies as 24 3 3 Parameters and data types esssesssessesseessesessserssereesserssereessereseeees 24 3 3 1 Borland and Microsoft C C 16 bit rrrrrrrrrrrrrrrrrrrenn 25 3 3 2 Borland and Microsoft C C 32 bit rerrrrrrrrrrrrrrrrnrenn 25 3 3 3 Borland Turbo Pascal and Delphi 1 0 16 bit 26 3 3 4 Delphr 2 0 amp 3 0 02 DIa a iet 27 3 3 5 Visual Basic 3 0 amp 4 0 16 bit eenrnnnnnnonrnonrnrrrnrrrrvenseenee 29 3 3 6 Visual Basic 4 0 amp 5 0 32 Dit eeerrnonnnnnnrnenrnrvrnrrrrvensvenne 30 4 Acquiring analogue data cccssccssssccssssssssccssssssssssccsssssesses JI AN AD hata se 33 IT SUNT ND je 33 4 3 Sampling blocks of A D data eronrrnronnrnverrrrvnrernenernnrreserrrnnsennnsee 34 4 4 Selecting the transfer mode si 4 33 d dacneseraccesvate cavern eodedeasea neste 34 4 4 1 Polled IO EDR_POLLED ce ceeccceeseeeeteeeeneeeeeees 34
29. long max A D throughput in Hz Gets the maximum throughput of a boards A D system in Hz If the board does not support hardware clocked A D then 0 is returned 14 16 EDR_MaxDAOutThroughputHz Parameter Type Comment boardtype integer Returns long max D A throughput in Hz Gets the maximum throughput of a boards D A system in Hz If the board does not support hardware clocked D A then 0 is returned Note that the settling time may be a more important figure check your board manual for details 14 17 EDR_ValidADCClockTrigger Parameter Type Comment boardtype integer Board type src integer Clock trigger source listed in 17 7 Returns integer O invalid 1 valid Checks if the supplied A D clock trigger setting is valid 166 EDR Software Development Kit Validation functions 14 18 EDR ValidADInGain Parameter Type Comment boardtype integer Board type gain integer Gain value Returns integer 0 invalid 1 valid Checks an A D gain value 14 19 EDR ValidADInRange Parameter Type Comment boardtype integer Board type r integer Range code listed in 17 3 Returns integer 0 invalid 1 valid Checks an A D input range 14 20 EDR ValidADInType Parameter Type Comment boardtype integer Board type adtype integer A D input type code listed in 17 4 Returns integer 0 invalid 1 valid Checks an A D input type 14 21 EDR ValidBoardType Parameter Type Comment boardtype integer Current or detected board type n
30. parallel boards 50 parallel update 56 parameters 24 Borland Turbo Pascal 26 C C 25 Delphi 2 0 27 QuickBasic 29 Visual Basic 16 bit 30 32 bit 32 PC81 51 polled IO A D 35 A D sampling 35 QuickBasic 17 RTDs 54 104 converting voltages 55 sampling frequency 40 scaling DAC voltages 56 setting D A transfer mode 57 simple A D input 34 simultaneous sample and hold 40 single channel DMA 194 single DMA A D sampling 37 software register copies 24 software triggering channels 45 203 Index EDR_TRIG_NONE 46 mode 46 none 46 performance 49 quick ref 49 throughput 49 type 46 software triggering 44 streaming to disk 38 to memory 38 streaming to disk 43 Windows 43 string functions 87 supported boards 2 supported languages DOS 8 Windows 8 temperature measurement 54 thermocouples 54 linearizing 55 TimerInterval 195 transfer modes 35 dual DMA 37 interrupts 36 polled IO 35 selecting 35 single DMA 37 streaming 38 triggering software channels 45 EDR_TRIG_NONE 46 mode 46 performance 49 quick ref 49 throughput 49 type 46 EDR Software Development Kit triggering software 44 Turbo Pascal DOS 16 Windows 20 using XMS functions 50 Visual Basic 20 voltage generation 56 waveform frequency 58 waveform generation 57 Windows 32 bit demos 9 Windows 95 7 XMS functions 158 XMS memory 50 204 Index
31. specified When the end of the buffer is reached sampling continues from the beginning without missing any data This process can continue indefinitely Use EDR BackgroundADInsStatus to see how far sampling has progressed on the current pass and EDR StopBackgroundADIn to stop sampling This function transfers data into memory blocks allocated with EDR AllocMem For DOS versions of EDR these memory blocks are in XMS For Windows versions they are normal global memory blocks This function works with transfer modes of EDR SINGLEDMA EDR INTR Windows only or EDR STREAM When using this function with EDR STREAM the num parameter must be a multiple of the current streamer block size DOS Due to DMA alignment restrictions discussed in chapter 4 when EDR SINGLEDMA is used the buffer must be at least twice as long as the num parameter The start parameter will be set to the number of first sample used in the buffer When EDR StopBackgroundADIn is called EDR shifts the data in the buffer back down 97 EDR Software Development Kit Analogue to digital input functions 9 8 EDR_ADInBinOneSample Parameter Type Comment bh integer Board handle chan integer Channel to sample bin unsigned Variable to hold the binary value Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid Returns the voltage on the specified A D channel in raw binary format See
32. that it is not necessary to configure any counter timers when using the Set XXClockmillHz functions 10 3 EDR CTGateSource Parameter Type Comment bh integer Board handle num integer Counter timer number source integer Source of gating for timer listed in 17 12 Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADCHAN Counter timer number is invalid EDR_BADPARAM Source parameter is invalid EDR_BADBOARD Board cannot do function Sets the source of gate control for the specified counter timer channel Note that most boards do not support this function check your board manual If the gate source is set to software then EDR_CTSoftGate can be used to start and stop the counter On the PC30Fxx and PC30Gxx the valid source settings and their effects on the clock source and ECLK line are shown in the following table Note that the num parameter must be 2 for these boards Also remember that the EDR_CTClockSource function also sets the direction of the ECLK line 131 EDR Software Development Kit Counter Timer functions Source parameter ECLK CT 2 Gate input EDR CT SOFTGATE Output of counter Software controlled EDR CT EXTGATE Input ECLK line EDR_CT_ENABLED Output of counter Pulled high counter always counts EDR CT DIVOUTPUT Output of counter Divider output counter 1 The PC30Fxx and PC30Gxx do not support software gating of counter timer 2 EDR emu
33. that the voltage is returned in microvolts e g if this function returns 2300000 the voltage on the channel is 2 3 V Some boards such as the PC73A require long delays after the channel mux is set to allow for the multiplexor s setting time This function includes these delays EDR SetADNoDelay for details on how to overlap these delays with other processing 9 12 EDR ADInStreamBufStatus Parameter Type Comment bh integer Board handle percent integer Variable to hold percent full for buffer worst integer Variable to hold worst percent full so far Returns integer error code 100 EDR Software Development Kit Analogue to digital input functions Error code Comment EDR_OK No error EDR NOBACKGROUND No background streaming is in progress EDR_BADBOARD Board cannot do function Reports on how full the streamer buffer is as a percentage It also keeps track of the most full the buffer has been during the current streaming operation You can use this figure to decide if the buffer is big enough 9 13 EDR_ADInVoltageToBin Parameter Type Comment bh integer Board handle chan integer Channel number uvolts long uV value to convert bin unsigned Variable to hold binary result Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Invalid board handle EDR_BADCHAN Invalid channel number EDR_BADPARAM uVolts param is out of range Converts a microvolt value into a binary code that could have been read from
34. the C prototype for the example function int far pascal EDR Function int char far UNS Lone far int far long It could be called as shown in this code fragment int a b err char s 80 unsigned buf 100 long cC err EDR_Function a s buf amp b c 3 3 2 Borland and Microsoft C C 32 bit All value parameters have been expanded to 32 bits All pointers to 16 bit quantities except actual samples have been expanded to 32 bits This table 25 EDR Software Development Kit Programming guidelines shows the correspondence between the listed parameter types and actual C C data types Parameter type C C parameter type integer int long int unsigned unsigned string char integer int long int unsigned unsigned Pointers to sample buffers are left in 16 bit form This means that an integer becomes a short and an unsigned becomes an unsigned short Here is the C prototype for the example function int far pascal EDR Function int char unsigned short int long It could be called as shown in this code fragment int a b err char s 80 unsigned short buf 100 LAC Gy SET EDR_Function a s buf amp b c 3 3 3 Borland Turbo Pascal and Delphi 1 0 16 bit This table shows the correspondence between the listed parameter types and actual pascal data types 26 EDR Software Development Kit Programming guidelines Parameter type Borland Turbo Pascal parameter
35. the PC81A s would have the same dip switch setting and be jumpered for a different block of PC30 A D inputs The PC81A includes a header containing all the cable signals This allows multiple boards to be stacked on top of each other so that only the bottom board needs to be connected to the PC30 via a cable 50 EDR Software Development Kit Acquiring analogue data EDR provides Up to 16 PC81 s functions to directly can be connected z in parallel using access the channels this scheme on up to 16 PC81A s connected in parallel These functions only work if the PC81A s Mux Inputs Bs Inputs are wired to the A D PEDIA board as shown in con CH2 CH8 if differential figure 11 the CH3 CH9 if differential SHINE standard cable l CH4 configuration Of CHS PC81A CH6 CH10 if differential Be course you Can use CH7 CH11 if differential Me any connection scheme you wish and Figure 10 Standard PC81A connection scheme use EDR DIO functions to select PC81 s and muxes yourself In addition the first 4 PC81A s must have their dip switches set to 0 The second 4 must be set to 1 the next 4 to 2 and the last 4 to 3 You may use less than 16 PC81A boards EDR FindPC 81Channel returns the value to output to port 0 A and the A D board input to read to access a multiplexed input channel EDR_ADInPC81 Voltage returns the voltage on a particula
36. waveform on one or more D A channels Note that each channel s waveform must have the same number of steps The values of numdone and cyclesdone parameters are undefined on exit if continuous generation is selected EDR_SetDAKeyAbort see 11 22 should be turned on if continuous mode is used 11 5 EDR_DAOutBinBackground Parameter Type Comment bh integer Board handle num integer Number of samples in each waveform buf unsigned Interleaved binary waveform s cycles unsigned Number of times to repeat waveforms 1 for continuous Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR NOCHANS No channels in channel list EDR BADCHAN Invalid channel in channel list EDR BADTRANS Invalid transfer mode EDR BADNUM Invalid number of samples EDR BADBOARD Board cannot do requested function This function is not supported by this version of EDR 11 6 EDR DAOutBinOneSample Parameter Type Comment bh integer Board handle chan integer Channel number bin unsigned Binary voltage for channel Returns integer error code 142 EDR Software Development Kit Analogue output functions Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid Sets the voltage on the specified D A channel using a binary voltage 11 7 EDR DA OutBinReadback Parameter Type Comment bh integer Board handle chan integer Channel number bin unsi
37. 1 1 About EDR version NTG l 1 2 Feature EDR releases 2 22 s season snccussscadsaceanr needed l 1 3 B ards s pport d visne ern Maced ena EE E R REE ETE 1 14 Feature Sorene E E EE 2 Te DR Driver StU CUS errire o a E E EE 3 LD el OVS sss E E E EE 4 1 5 2 Windows 3 1 and Windows 95 eernrrvnrennvnernnrrvsrrrrvseennrneer 4 Svd NE 4 ASO Le AION REE waa on maar eamianeas 5 1 6 1 Windows NT 4 0 sessssessesssssessseresssersssressseressseesseeesseresse 5 1 6 2 Windows 3 1x Windows 95 and DOS ossen 6 1 6 2 1 Windows Lord lusene 6 1 6 2 2 NAN ae 7 1 6 3 Windows 95 and NT Control Panel applet 7 1 6 3 1 Windows 95 specific information esnrrvrrrrrnvvernnn 7 1 7 DOS languages supported ssssssesessseesseresssersseseesseessseeesseresssresse 8 1 8 Windows languages supported eerrvnronnrrvrvrrrnnvrnnrnesrrrrverernnneernn 8 1 9 Compiled demo programs cccccceesseceesseceeeeececeeeeceeeseeeeeeaeeeees 9 1 9 1 Windows 95 and Windows NT 32 bit eee 9 1 9 2 Windows 95 16 bit and Windows 3 1X cceceeeeeee 10 VDS ee 11 1 10 How this manual is organised rrreronnrnrrnnrrvrrrrnnnrennrnnernrrnneennnneer 12 2 Building applications using EDR cseseeeosssvvvessvvveessvvvveessvnveer 14 Dil DOS AANeUASCS cae EEE E Aaa tailed ENE 14 211 Borland CE FR sen con suesasaietecstes sesausoestesdeeeauanyeeeteneeees 14 212 Microsoft CNG 15 2 1 3 Borland Turbo P se ele eee 17 2 2 Windows
38. 1 25 EDR ValidDATransferMode Parameter Type Comment bh integer Board handle tmode integer Transfer mode listed in 17 5 Returns integer error code Error code Comment 1 Transfer mode is valid 0 Transfer mode is not valid EDR BADHANDLE Board handle is invalid Checks the validity of a transfer mode given the current board setup 151 EDR Software Development Kit Digital input output functions 12 Digital input output functions These functions provide access to digital input and output ports The ports are numbered from 0 up On a board with 2 8255 s ports A B and C of the first 8255 are numbered 0 1 and 2 and ports A B and C of the second 8255 are numbered 3 4 and 5 EDR only directly supports mode 0 EDR_DIO_SIMPLE although the configuration function can be used to program ports for other modes The PC166x PC167x and PC266 have 3 lines that can be used as digital inputs EXDO EXG1 and EXG2 These lines are treated as a 3 bit digital input port by EDR This port is number 0 and bit 0 is EXDO bit I is EXG1 and bit 2 is EXG2 12 1 EDR DIOConfigurePort Parameter Type Comment bh integer Board handle portnum integer Port number dmode integer Mode listed in 17 5 io integer Direction 0 output 1 input Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADPORT Port number is invalid EDR BADPORTCFG Port configuration is invalid Configures a digital port fo
39. 109 EDR Software Development Kit Analogue to digital input functions Returns integer error code or the status of the flag Error code Comment 0 Flag is off 1 Flag is on EDR BADHANDLE Board handle is invalid Gets the status of the no A D delay flag 9 32 EDR GetADTrigger Parameter Type Comment bh integer Board handle chan integer Variable to hold trigger channel sample long Variable to hold trigger sample Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Invalid channel number EDR NOTRIGGER No channel has triggered yet EDR BADBOARD Invalid board type This function checks to see if any A D channels have triggered since the start of sampling or the last call to EDR ClearADTrigger If at least one channel has triggered then this function returns EDR OK and sets chan and sample to the channel number and trigger sample respectively of the first channel to trigger If not then it returns EDR NOTRIGGER Remember that when a trigger is detected further trigger checking is disabled until EDR ClearADTrigger is called 110 EDR Software Development Kit Analogue to digital input functions 9 33 EDR_GetADTriggerType Parameter Type Comment bh integer Board handle postsamples long Variable to hold postsamples value Returns negative integer error code or trigger type code Code Comment EDR_TRIG_NONE Do not do any triggering EDR_TRIG_PRE Pre triggering E
40. 3 and PC73C are supported in this manner See EDR_UsesPCTimerlInterrupts 9 60 for more information DOS The data buffer must be in conventional memory On fast machines higher transfer rates may be possible gt 30 KHz Windows On fast machines fairly high sample rates can be achieved The Windows version of EDR has been tested at up to 17 KHz on a 33 MHz 486 using a PC30D The interrupts are handled in the VxD minimising latency time and allowing the high speed to be maintained However if a DOS box is opened while interrupt sampling is taking place some data may be lost Windows shuts down all interrupts for about 1 ms while opening a DOS box 35 EDR Software Development Kit Acquiring analogue data 4 4 3 Single channel DMA EDR_SINGLEDMA Single channel DMA is a very efficient way to sample data It requires very little work on the part of the processor and supports the maximum transfer rate of the board even on slow machines The PC s DMA controller is programmed to transfer data from the card to memory without going through the processor The transfer can proceed in the background If you need to transfer less than 32000 samples and your board has DMA use this mode as you first choice for DOS and Windows DOS The data buffer must have space for at least twice as many samples as are required This is necessary to deal with limitations imposed by the DMA controller hardware DMA transfers cannot cross physical page boundaries
41. 6 7 EDR ResetInterrupt Parameter Type Comment bh integer Board handle id integer Interrupt ID number listed in 17 17 Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADINTID Interrupt ID number is invalid Resets any interrupt latch on the board and sends an EOI end of interrupt command to one of the PC s interrupt controllers to signal completion of the interrupt You should call this function just before returning from your ISR 16 8 EDR SetInterruptSource Parameter Type Comment bh integer Board handle id integer Interrupt ID number listed in 17 17 Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADINTID Interrupt ID number is invalid Sets the source of interrupts from the board if this can be done from software At present only the PC30Fxx and PC30Gxx boards support this feature See the comments at the beginning of this chapter for more information 181 EDR Software Development Kit Interrupt functions 16 9 EDR SetIntteruptMode Parameter Type Comment bh integer Board handle modearray integer IRQ array list Returns integer error code Error code Comment EDR OK No error The array specifies the board s IRQ list This function is used to set muxes to a specific IRQ level for each interrupt line 16 10 EDR_UninstallBoardISR Parameter Type Comment bh integer Board handle id integer
42. 9 Once streaming has started you can call EDR BackgroundADInStatus to check on its progress This function will return an error if any buffers overflow You must call EDR StopBackgroundADIn once streaming has completed Windows 95 32 bits only You must call EDR BackgroundADInStatus at regular intervals to ensure data is written to disk and the buffers do not overflow When doing high speed streaming in interval of 10 ms is OK The easiest way to do this is to set up a Windows timer to do the calls 4 9 1 How the Windows streamer works Streaming to disk under Windows uses two buffers as shown in figure 3 The first small buffer is filled by the DMA controller and emptied into the second larger buffer by a routine in the VxD or kernel mode device driver Data is dumped from the second buffer to the disk file by the DLL The second buffer has to be big so that it does not overflow when Windows is busy and no data can be dumped to disk This also overcomes the problem posed by lazy writing disk caches The size and memory for second buffer can be set using EDR SetStreamBuffer If you do not specify a buffer the driver will allocate a 256 KB buffer and free it when sampling is stopped You will generally need at least a 1024 KB buffer for high speed streaming The streamer writes data from the second buffer to disk in blocks The size of these blocks can be set using EDR_SetStreamBlockSize 9 53 and should be a multiple of the cluster siz
43. A cycles does not result in lost data When doing parallel board sampling under Windows it may be necessary to increase the size of the VxD s DMA buffer Each 32000 sample single DMA transfer and each streaming operation requires 64K of space The background sampling functions return error EDR NOFREEDMABUF 36 if there is not enough free space in the buffer Increasing the size of the buffer is described in appendix B Also remember that the DMA controller has a theoretical maximum transfer rate of about 900 000 samples second in an AT class machine If the maximum throughput of your system is close to this you may lose data 4 14 Using PC81A expansion boards to address more than 16 channels The PC81A is an input expander board for the PC30 series A D boards It consists of a comparator and four 16 way muxes connected to 64 input terminals The comparator compares an 8 bit address against a PC81A board number set on a dip switch This allows multiple PC81A s to be connected in parallel each addressing 64 channels The mux inputs for each PC81A and the comparator inputs are normally connected to the digital lines of the A D board in use All the muxes share common input lines so 4 of the 64 channels are available at a time Jumpers on the PC81A allow the 4 selected A D signals to be mapped to channels 0 3 4 7 8 11 or 12 15 of the A D board This allows 4 PC81A s to be accessed at the same time using all 16 A D input channels Each of
44. ATransferMode Parameter Type Comment bh integer Board handle 147 EDR Software Development Kit Analogue output functions Returns integer error code or transfer mode Error code Comment gt 0 Transfer mode constant listed in 17 5 EDR BADHANDLE Board handle is invalid Gets the current D A transfer mode 11 19 EDR SetDAChanListIndex Parameter Type Comment bh integer Board handle i integer Index of entry to change first is 0 chan integer New channel for entry Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADINDEX Index is invalid EDR_BADCHAN Channel number is invalid Changes the specified entry in the channel list 11 20 EDR SetDAChanListLen Parameter Type Comment bh integer Board handle listlen integer New length of list or 0 to empty it Returns integer error code 148 EDR Software Development Kit Error code EDR OK EDR BADHANDLE EDR TOOMANYCHANS Analogue output functions Comment No error Board handle is invalid Length is invalid Sets the number of channels in the boards channel list If the this number is O then the list is emptied If it is greater than the channel count then the list is padded with channel 0 The maximum length is 20 11 21 EDR SetDADisableAllInts Parameter Type Comment bh integer Board handle onflag integer 0 Turn off 1 turn on Returns integer error code Error code Comment EDR OK No erro
45. Comment bh integer Board handle boardtype integer New board type Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADPARAM The new type is not possible given the current type Changes the type of board attached to a board handle It is not always possible to determine exactly what board is installed at a base address from software so you may have to use this function to set the correct type EDR_ConfigDialog can also be used The board code table in EDR_DetectBoard lists the boards that may be present for different software detected board types 80 EDR Software Development Kit Configuration functions Example If EDR_GetBoardType returns PC30B and you are using a PC30C then you need to call this function to change the type 7 37 EDR SetDA OutConfig Parameter Type Comment bh integer Board handle chan integer Channel to configure range integer Output voltage range listed in 17 3 tmode integer Update mode for the channel listed in 17 5 gain integer Gain value Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid EDR BADRANGE Range is invalid EDR BADGAIN Gain is invalid EDR BADMODE Mode is invalid Configures a D A channel On some boards some these settings are software programmable and on others they are set using jumpers The values used here must always match the j
46. DLL 2 2 1 Borland amp Microsoft C C 16 and 32 bit Follow these steps 1 Include C EDR INCLUDE EDR H in all files that call EDR functions or use constants defined in EDR H You can do this by putting the following line at the top of each file include c edr include edr h 16 bit 18 EDR Software Development Kit Building applications using EDR 2 Link your application with C EDR LIB EDR LIB if you are using the Borland IDE or the Microsoft Programmers Workbench you can just add it to your project or program list This library does not contain any code It is just an import library that tells the linker that the functions in it are in EDR DLL 32 bit 2 Microsoft Visual C users need to link with EDR32 LIB this is a COFF format library Borland C C users need to link with EDR320MEF LIB this is OMF format library If you are using another compiler you will probably need to use EDR32OMF LIB If you are using an integrated development environment IDE you can just add the appropriate library to your project C users need not add extern C I around EDR H as this has been done inside the file Note that you can use any 16 bit memory model but the large memory model is recommended 32 bit apps can be built as GUI or CONSOLE One 16 bit demo NOTDEMO EXE in C EDR EXAMPLES C WIN16 and 4 32 bit demo s are provided NOTDEM32 EXE et al in C EDR EXAMPLES WIN32 NOTDEM32 is a port of the 16 bit NOTDEMO
47. DR CalcTCmC Parameter Type Comment tc integer Thermocouple type listed in 17 21 tcuv long Voltage from thermocouple in microvolts ambientmc long Temperature of the junction block in milli C tcmc long Variable to hold temperature of thermocouple in milli C Returns integer error code Error code Comment EDR_OK No error EDR_BADPARAM Invalid thermocouple type specified Converts a microvolt value read from a thermocouple into a temperature 9 21 EDR_ClearADTrigger Parameter Type Comment bh integer Board handle Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADBOARD Board type is invalid Windows only function Acknowledges the trigger information supplied by EDR GetADTrigger EDR does not detect any more triggers after the current trigger until this is done Once this function has been called EDR GetADTrigger will return EDR NOTRIGGER until another channel triggers 105 EDR Software Development Kit Analogue to digital input functions 9 22 EDR GetADBurstLen Parameter Type Comment bh integer Board handle Returns integer error code or burst length Error code Comment gt 0 Burst length 0 Burst mode disabled 1 Burst set to length of channel list when sampling starts EDR BADHANDLE Board handle is invalid Returns the current burst setting 9 23 EDR GetADCCIockTrigger Parameter Type Comment bh integer Board handle SIC integer Variable
48. DR_InitBoard to attach a board to a board handle If the configuration info in the file was originally saved after initialising a board with EDR_InitBoardType then EDR_LoadConfiguration does not attempt to detect what board is present at the base address 7 27 EDR_LoadConfigIni Parameter Type Comment bh integer Board handle filename string Name of ini file with config info section string Section name in ini file 74 EDR Software Development Kit Configuration functions Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR READERROR Error reading from ini file Windows NT This function is not supported and always returns EDR_NOTIMPLEMENTED Windows 3 1x and Windows 95 only function This function is similar to EDR_LoadConfiguration but reads the info from a Windows ini file section and not a binary file 7 28 EDR_ResetBoardNumber Parameter Type Comment bh integer Board number Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR READERROR Error reading from ini file 32 bits only Reconfigures the specified board number from its information the registry i e as configured in control panel 7 29 EDR RestoreDefaults Parameter Type Comment bh integer Board handle Returns integer error code 75 EDR Software Development Kit Configuration functions Error code Comment EDR_OK No error EDR BADHANDLE Boar
49. DR_TRIG_MID Mid triggering capture postsamples after the trigger EDR_TRIG_POST Post triggering EDR_TRIG_USER User defined triggering If the return value is lt 0 then it is one of the following error codes Error code Comment EDR BADHANDLE Board handle is invalid Returns the type of triggering in use Remember that even if this function indicates a particular type of triggering nothing will happen unless at least one of the sampled channels is set to trigger as well 9 34 EDR GetADUseTCInts Parameter Type Comment bh integer Board handle Returns integer error code or the status of the flag Error code Comment 0 Flag is off 1 Flag is on EDR BADHANDLE Board handle is invalid Gets the status of the TC ints flag see 17 22 111 EDR Software Development Kit Analogue to digital input functions 9 35 EDR GetNotificationMsg Returns unsigned message ID Returns the message number that gets sent to the notification window for a board This number is not a constant It is allocated when EDR DLL is loaded EDR calls the Windows API function RegisterWindowMessage and may be different each time EDR is loaded Notification messages sent by EDR are formatted as follows The UINT message ID is the value returned by this function e The WPARAM value is the event code The low word of LPARAM contains the board handle that the message applies to e The high word is reserved for future use Do not assume that it will hol
50. E Measures and displays the temperature on selected A D channels at specific intervals If you do not have Visual Basic installed on your system you will need to copy VBRUN300 DLL from the C EDR DLL VB directory into your WINDOWS SYSTEM directory 10 EDR Software Development Kit Introduction 1 9 3 DOS All of these demos accept the base address of the card to use as a command line parameter Generally they assume that the board is jumpered for the factory default settings They do display a configuration dialogue that allows many of these settings to be changed if your board is jumpered differently e C EDR EXAMPLES TPAS ADINDEMO EXE Samples all A D channels at 10 KHz and dumps the data to a text file e C EDR EXAMPLES TPAS BITWALK EXE Walks a bit through all digital output or IO ports on a board e C EDR EXAMPLES TPAS INIT EXE Detects what card is at the specified base address e C EDR EXAMPLES TPAS STREAM EXE Streams data from all A D channels to disk stream dat at 20 KHz e C EDR EXAMPLES TPAS VOLTGEN EXE Interactive program allowing the voltage and range and gain on any D A channel to be set e C EDR EXAMPLES TPAS VOLTMETR EXE Continuously displays the voltage on each A D channel e C EDR EXAMPLES TPAS WAVEGEN EXE Generates a saw tooth waveform on a D A channel e C EDR EXAMPLES TPAS WAVEGEN2 EXE Generates a saw tooth and square wave on two different D A channels e C EDR EXAMPLES TPAS XMS EX
51. E Samples waveforms into XMS using streaming to memory or dual channel DMA The first and last 512 samples are converted to text and dumped to a file e C EDR EXAMPLES TPAS TEMPMETR EXE Interactive program that continuously displays the temperature on all input channels The TC type for each channel can be set e C EDR EXAMPLES TPAS RTDMETER EXE Interactive program that continuously displays the temperature on all input channels The RTD type for each channel can be set e C EDR EXAMPLES C DOS TCLOGGER EXE Batch program to log TC temperatures from multiple boards to a comma delimited text file This is a complete application and not just a simple demo 11 EDR Software Development Kit Introduction C EDR EXAMPLES TPAS DIOLOOP EXE Walks a bit through digital output port 0 and reads all other digital input ports Lines from port 0 can be looped back to the other ports as a test C EDR EXAMPLES TPAS FREQCNT EXE Simple frequency counter for the PC14B only Measures the input frequency of channels 1 and 2 of the counter timer chip by using channel 0 to generate periodic interrupts Can be used to measure your PC s bus clock speed C EDR EXAMPLES TPAS EXTINT EXE Counts external interrupts for boards with an external interrupt input 1 10 How this manual is organised Chapter 2 has a section for each language that explains how to create an application that uses EDR and gives a summary of the demos provided for the language Y
52. EDR Software developers kit for Eagle Technology boards User Manual For Dos amp Windows 1 August 1999 Visit our web site at www eagle co za for up to date information on our software Boards supported PC26 PC30 PC30B PC30C PC30D PC30DS PC30DS4 PC30PGL PC30PGH PC30FA PC30FAS16 PC30FAS4 PC30F PC30FS16 PC30FS4 PC30GA PC30GAS16 PC30GAS4 PC30G PC30GS16 PC30GS4 PC30FA_ADV PC30FAS16_ADV PC30FAS4_ADV PC30GA_ADV PC30GAS16_ADV PC30GAS4_ ADV PC126 PC127 PC166 PC166B PC167 PC167A PC167B PC266 PC66 PC66A PC66C PC63C PC36 PC36C PC14A PC14B PC192 PC73A PC73C PC73R PC60 PC61 PC62B PC62C PC65 PC30L PC30LA PC30LB PC104 72A PC104 30F PC104 30FA PC104 30G PC104 30GA All rights reserved No part of this publication may be reproduced stored in a retrieval system or transmitted in any form by any means electronic mechanical by photocopying recording or otherwise without prior written permission Version 2 35 1 August 1999 Copyright 1994 1999 Eagle Technology Information furnished in this manual is believed to be accurate and reliable however no responsibility is assumed for its use nor any infringements of patents or other rights of third parties which may result from its use Trademarks used in this manual are the property of their respective owners Contents 1 Introd ctioM sss casceassacepisecsacasenseosstesansccereseamevassesacenesaeda atencoeoeaeeasea L
53. EDR_STREAM Windows NT uses this streaming mechanism for both single channel DMA and interrupt sampling Software triggering is not currently supported under Windows NT When it is it will work with single DMA streaming and interrupts 37 EDR Software Development Kit Acquiring analogue data The remainder of this section discusses issues common to streaming to memory and disk Section 4 9 deals with disk streaming in particular The streamer writes data out to disk or memory in fixed size blocks You can set the size of these blocks using EDR_SetStreamBlockSize 9 53 If you are doing high speed streaming to disk under DOS you should use a block size equal to the cluster size of the destination disk The streamer always waits until a full block of data has been collected before writing it out If you are doing slow streaming you may want to use a small block size This will reduce the number of extra samples that are taken at the end to fill up the last block These extra samples are discarded but still take time to collect An alternative way to avoid this effect is to collect a total number of samples that is a multiple of the block size DOS You must give the streamer a second buffer to use for streaming to memory or disk This buffer is used to hold the data before it gets copied to disk or the destination buffer EDR SetStreamBuffer 9 54 must be used to set this buffer which cannot be in XMS Windows Read section 4 9 for more
54. GetDAOutNumBits Parameter Type Comment boardtype integer Board type chan integer D A channel number bits integer Variable to hold the number of bits for the channel Returns integer error code Error code Comment EDR OK No errors EDR BADBOARD Invalid channel number Gets the number of significant bits for a D A channel 162 EDR Software Development Kit Validation functions 14 7 EDR_GetDAOutRefChannel Parameter Type Comment boardtype integer Board type chan integer Channel number Returns integer number of the channels reference channel or error code Error code Comment EDR_BADBOARD Board does not have programmable references EDR_BADCHAN Invalid channel number Some boards e g PC167x use their 16 bit D A channel s as programmable references for their 12 bit D A channels This function returns the reference channel number for a particular 12 bit channel 14 8 EDR_NextADInGain Parameter boardtype gain Returns Type Comment integer Board type integer Gain value integer next gain value or 0 Steps to the next higher valid gain value for a A D channel If no higher gain value exists 0 is returned 163 EDR Software Development Kit Validation functions 14 9 EDR NextDAOutGain Parameter Type Comment boardtype integer Board type chan integer Channel number gain integer Gain value Returns integer next gain value or 0 Steps to the next higher valid gain value for the D A channel If no high
55. HI SCOPE demonstrates software triggering using EDR You can use this program to experiment with different trigger modes and to find the best trigger settings for your input signals 4 10 1 Setting channel trigger details You can specify a trigger level voltage and edge for each channel ORG a ae you are going to sample This is done EDR EDGE RISING by calling rising edge EDR SetADChanTriggerType 9 45 rn wih one ol the Figure 4 Channel trigger settings constants shown in Figure 4 and a level value in microvolts The edge detection algorithm is simple and fast and can give incorrect results on noisy signals It is best to pick a voltage level that lies on a rapidly rising or falling portion of the input signal This reduces the possibility of a noise spike giving an incorrect edge Use the oscilloscope program to examine your input and pick a good level and edge 4 10 2 Trigger notification Whenever a channel triggers EDR sends a message to the notification window for the board if any See 4 7 1 for details on notification messages This is done regardless of the current trigger mode You can also find out if a channel has triggered by calling EDR_GetADTrigger 9 32 This function returns the trigger sample and channel number or an error code if no triggers have been detected so far EDR stops detecting triggers once one has been found until EDR_ClearADTrigger 9 21 has been called 44 EDR Software Development Kit
56. INARY 0 d binarycounter EDR CT BCD bcd counter 17 14 Counter timer numbers Constant Number EDR CT PRESCALER 10 17 15 DIO port modes Constant Number EDR DIO SIMPLE Os EDR DIO STROBED 17 16 DIO port settings Constant Number Comment EDR OUTPUT 0 portis output EDR INPUT port is input EDR 030UT 47IN lower half out upper half in EDR 03IN 470UT lower half in upper half out 190 EDR Software Development Kit Appendix A Constants 17 17 Interrupt ID s Constant Number Comment EDR INT ADIN 0 A D data ready EDR INT DAOUT 1 D A buffer empty I EDR_INT_EXTINPUT 8 External interruptinput 8 EDR INT COUNTER 48 Counter timer channel interrupt 24 17 18 Interrupt enable and disable values Constant Number _ Comment EDR_INT_DISABLED 0 Board interruptis disabled EDR INT ENABLED Board interrupt is enabled 17 19 IRQ mask values Constant Number Comment EDR IRQ MASKED IRQ level is masked EDR IRQ ENABLED 0 TJIRQ level is not masked 17 20 Notification codes Constant Number Comment EDR MSG ADINDONE EDR MSG ADTRIGGER 4 AnADtriggerhashappened _ __ _ 17 21 Thermocouple types Constant Number E DR TG E EDR_TC T EDR Software Development Kit Appendix A Constants EDR TC S Med EDR TC R EDR TC 8 EDR TCN EDR NUMTCTYPES foe 17 22 VxD flags Constant gt Number EDR VXD ALWAYSBUFFERDMA EDR VXD DIRECTDMA
57. Interrupt ID number listed in 17 17 Returns integer error code Error code Comment EDR_OK No error EDR_BADPARAM Interrupt ID number is invalid Removes an ISR installed with EDR_InstallBoardISR 16 11 EDR_UninstallISR Parameter Type Comment irq integer Hardware IRQ level Returns integer error code 182 EDR Software Development Kit Interrupt functions Error code Comment EDR_OK No error EDR BADPARAM Hardware IRQ level is invalid Removes an ISR installed with EDR InstalllSR 183 EDR Software Development Kit Appendix A Constants 17 Appendix A Constants This appendix lists the names and values of constants defined by EDR You should use the names wherever possible as they make your code more readable and if code changes in a new version of EDR all you need to do is recompile 17 1 Board types Constant Number 184 EDR Software Development Kit Appendix A Constants PC36 PC14 PC14B o MW PC62B P PC30FA PC30FAS16 PC30FAS4 PC30F PC30FS16 C30FS4 C30GA PC30GAS16 PC30GAS4 N PC30GS16 PC30GS4 PC73C PC192A A SG MY DM OD OUT OT UT 071071 OF OF OFT OF OF gt e GI GY GC GY GI UVI GI VI GI NO NO RO U N re WJ 00 MI MY O71 amp GI NO RF UT U N W 00 MI olaj AJU e P PC66C PC30LA PC30LB PC30FA ADV PC30FAS16 ADV PC30FAS4 ADV C30GA ADV PC30GAS16 ADV PC30GAS4 ADV 60 PC104 72A PC104 30FA PC104 30F PC104 30GA
58. LE Unable to open or create streamer file EDR WRITEERROR Error writing to streamer file EDR BUFFEROVERRUN Streamer buffer has overflowed This function cannot be used from Windows Use EDR StreamToDiskBackground instead Acquires a block of A D data from the channels in the channel list You should read chapter 4 before using this function This function uses the current sampling frequency burst setting transfer mode streamer buffer and block size and only returns when the data has been collected The transfer mode must be EDR STREAM EDR StreamToDiskBackground is a more flexible function and is better suited to Windows 9 58 EDR StreamToDiskBackground Parameter Type Comment bh integer Board handle num long Returns long 124 EDR Software Development Kit Analogue to digital input functions Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADTRANS Transfer mode is invalid EDR_NOCHANS There are no channels in the channel list EDR_BADCHAN The channel list contains an invalid channel number EDR_BADNUM The number of samples specified is invalid EDR_BADBOARD Board cannot do function EDR BADPARAM Invalid parameter detected EDR NOSTREAMBUF Stream buffer has not been set DOS EDR CANTOPENFILE Unable to open or create streamer file Acquires a block of A D data from the channels in the channel list You should read chapter 4 before using this function This function uses the current sampling f
59. Mem 159 EDR CopyFromMemToMenm 159 EDR CopyToMenm 160 EDR CTClockSource 129 EDR CTConfigure 130 EDR CTGateSource 131 EDR CTLatchAll 137 EDR CTRead 132 EDR CTSoftGate 133 EDR CTWrite 133 EDR DAOutBin 142 EDR DAOutBinBackground 143 EDR DAOutBinOneSample 143 EDR DAOutBinReadback 144 EDR DAOutBinToVoltage 144 EDR DAOutUpdate 145 EDR DAOutVoltage 145 EDR Software Development Kit EDR_DAOutVoltageReadback 146 EDR_DAOutVoltageToBin 146 EDR_DAOutVoltageToBinBlock 147 EDR Decimatelnt Array 160 EDR DefaultADInGain 174 EDR DefaultADInRange 174 EDR DefaultADInType 174 EDR DefaultDAOutFixedRef 175 EDR DefaultDAOutRange 175 EDR DefaultDAOutTriggerSourc e 175 EDR DefaultDMALevels 175 EDR DefaultIRQLevel 176 EDR DetectBoard 62 EDR DIOConfigurePort 153 EDR DIOGetPortConfig 154 EDR DIOLinelnput 154 EDR DIOLineOutput 155 EDR DIOPortInput 155 EDR DIOPortOutput 156 EDR DIOPortInput16 156 EDR DIOPortOutput16 157 EDR Enablelnterrupt 179 EDR Factorize 134 EDR FreeBoardHandle 63 EDR FreeMem 161 EDR GetADBurstLen 106 EDR_GetADCClockTrigger 106 EDR_GetADChanListIndex 106 EDR_GetADChanListLen 107 EDR GetADChanTrigger 107 EDR GetADChanTriggerType 108 EDR GetADCIockmilliHz 134 EDR GetADDisableAlllnts 109 EDR GetADInGain 63 200 Index EDR GetADInRange 64 EDR GetADInRangeMinMax 64 EDR GetADInType 65 EDR GetADKeyAbort 109 EDR GetADNoDelay 109 EDR GetADT
60. Num16BitDAOutputs 165 EDR NumADInputs 165 EDR NumCounters 166 EDR NumDAOutputs 166 EDR NumbDIOPorts 166 EDR NumlOLocations 176 EDR PadFile 114 EDR ParseChanGainList 88 EDR ResetBoardNumber 76 EDR ResetInterrupt 182 201 Index EDR RestoreDefaults 76 EDR RTDs converting voltages 104 EDR SaveConfiglIni 77 EDR SaveConfiguration 77 EDR SetADBurstLen 115 EDR SetADCClIockTrigger 115 EDR SetADChanListIndex 116 EDR SetADChanListLen 116 EDR SetADChanTriggerType 117 EDR SetADCIockmilliHz 137 EDR SetADDisableAlllnts 117 EDR SetADInConfig 78 EDR SetADInGain 79 EDR SetADInRange 79 EDR SetADInType 80 EDR SetADKeyAbort 118 EDR SetADNoDelay 118 EDR Set ADTransferMode 119 EDR SetADTriggerType 120 EDR SetADUseTClInts 120 EDR SetBoardType 81 EDR SetCTInputFreqHz 138 EDR SetDAChanListIndex 149 EDR SetDAChanListLen 149 EDR SetDAClIlockmilliHz 139 EDR SetDADisableAlllnts 150 EDR SetDAKeyAbort 150 EDR SetDAOutConfig 82 EDR SetDAOutFixedRef 83 EDR SetDAOutGain 83 EDR SetDAOutMode 84 EDR SetDAOutRange 84 EDR SetDAOutTriggerSource 85 EDR SetDATransferMode 151 EDR SetDMALevels 85 EDR SetIRQLevel 86 EDR SetNotificationWindow 121 EDR Software Development Kit EDR SetStreamBlockSize 121 EDR SetStreamBuffer 123 EDR SetStreamFile 122 EDR StopBackgroundADIn 123 EDR StopBackgroundDAOut 151 EDR StrADType 89 EDR StrBoardType 89 EDR StrDATriggerSource 89 EDR StrDAUpdateMode 90 ED
61. ORE Re DAOT PE 144 11 10 EDR SDA Out Voll ger Lasser duene 144 0 2 EDR DAOutVoltageReadback ernrrrrorrrnvnrrnnrnvennrrvnrrnnnneennnn 145 11 12 EDR DAOutVoltageToBin rrroronnrnnonnrnvnrennrnsennrrvsrrnnnnsennrne 145 11 13 EDR DAOutVoltageToBinBlock esnrrrnrrnnrnvennrrvnrnrnnnsennnn 146 11 14 EDR GetDAChanListIndex roooronnonornnnnvvennnvnssnnrnvennnnvesennsne 146 11 15 BEDR Ge DAChanListLenuoksyasasesertakesslendk 147 11 16 EDR GetDADisableAllInts esonnrnrononnvrrennvnrsnnrnvennnnvssennsne 147 11 17 EDR GeEDAKeyAbortusuarmsormuanveisan nnvnuin 147 11 18 EDR GetDATransferMode rrrrrrnnrnvennrrvnrennnnesnnrnverennenssnnrne 147 11 19 EDR SetDAChanListIndex ssnener rverernnvrsvarrersennvnssnnsnrssenneee 148 11 20 EDR Set A Chan Li stem ssussconesnasaavsvadeentessineanvaowsstontvaresounetes 148 11 21 EDR SetDADisableAllInts srorrosesonvvseransvrernsvnsenarnrssvenese 149 11 22 EDR_SetDAKeyAbort sopper iedsbetase dage 149 11 23 EDR SeDATranster Mode ives sccssdescastesics vdbvacscescveusiucsdeeveceess 150 11 24 EDR_StopBackgroundDA Out eeennrnvennrrvnrennnneennrrverernnneennnne 150 11 25 EDR ValidDATransferMode eerennrnvonnrrvnnrnnnnvennrnvsernnnnsennrne 151 12 Digital input output functions sevoossssrsvvvvvsnennvvvvveesnsnvvveveeer LOD 12 I EDR DIGG Onis Ure ROL saa 152 12 2 EDR_DIOGetPortConfig acidilactici Nem aed tere 153 123 EDR DiO bine ln pu sa e cand LANG 153 12 EDR DIOL Me
62. Output Lasses 154 VEDR DIOR Or Inputs NS 154 12 6 EDR DIOPOrOufpatuuasasnadsraaka eee 155 12 7 EDR_DIOPortInput1 Gausa bedre 155 12 8 EDR DIOPortOutput16 rsrrrronvvrrnrrrrnvrnrrrrrsnnrnrersrssnrssennnesnne 156 12 9 EDR_HasDOReadback Lua ei 156 13 Memory functions XMS e eseessvvvvesnsnsrvvsvseenensvnnnneessennnnvneeeee L57 13 EDR AlocMeM konenn heie 157 13 2 EDR Cop FromM en saja 158 13 3 EDR CopyFromMemToMem rrnoronnrnvonnrrnnernrnnesnnrnverrrnnnsennrne 158 13 4 EDR Cop IT MEN 159 13 5 EDR_DecimateIntArray wc scdsasecececaccists tsateveccase aksene GN 159 13 6 EDR FreMenu Lasser esac iStariapeiuoticateaauebceaessouss 160 13 7 EDR Gethree MEM x siehe tii acsaessetad budskap 160 13 8 EDR_GetMemBlockSize uueresnsssenersmkium Gata 160 14 Validation functions scccccccssssssssssssssssssssccsssssssssssseees LOL 14 1 EDR HasADInClock eroerorornnnonornvrvnvnsrsrnennnnnnnnvnvnvnssserennnnnenes 161 14 2 EDR HasBirscM desuussaarsaossuaas de d 161 14 3 EDR HasDAOutClock vevsciscsccavecseaeisncssaavecs iaakente cde bunrsekvsnnndene 161 14 4 EDR HasDAQOUUR O vs NG 162 12 BDI HasSHH aS 162 14 6 EDR GetDAOutNumBits rrrrnnrrrrronnrrrnnnvrrrennvrrrrnnrrrrrnnvrsrennrnr 162 14 7 EDR GetDAOutRefChannel rorornrrerornrnnnnnnnnvnnnnnserensnnnnnener 163 14 8 EDR NextADInGain rorsrsssoonorvvrssnnnnrvenssrennrvesssesnnrsvnssssnnrsene 163 14 9 EDR NextDAQutGai nis ass 164 14 10 EDR Num16BitDAOutputs soroonnnronvve
63. R StreamToDisk 123 EDR StreamToDiskBackground 124 EDR StreamToDiskCircularBuffe r 125 EDR StrError 90 EDR StrRange 90 EDR StrTCType 90 EDR StrTransferMode 90 EDR TRIG NONE 46 EDR UninstallBoardISR 183 EDR UninstallI SR 183 EDR UsesPCTimerInterrupts 126 EDR UVoltsToUAmps 127 EDR ValidADBurstLen 128 EDR_ValidADCClockTrigger 167 EDR_ValidADInGain 168 EDR_ValidADInRange 168 EDR_ValidADInType 168 EDR_ValidADTransferMode 128 EDR_ValidBoardType 168 EDR_ValidClockSource 169 EDR_ValidDAOutChan 169 EDR_ValidDAOutFixedRef 169 EDR_ValidDAOutGain 170 EDR_ValidDAOutMode 170 EDR_ValidDAOutRange 170 202 Index EDR ValidDAOutTriggerSource 171 EDR ValidDATransferMode 152 EDR ValidDIOPortConfig 171 EDR ValidDMALevels 171 EDR ValidGateSource 172 EDR ValidInterruptID 172 EDR ValidInterruptSource 172 EDR ValidIRQLevel 173 EDR Version 86 EDR Version32 86 EDR32 DLL 4 EDRVXD 386 4 fine tuning 194 features 2 frequency A D sampling 40 generating voltages 56 generating waveforms 57 guidelines 22 header file 8 input expansion 50 51 interrupts A D sampling 36 functions 177 ID numbers 177 192 languages supported DOS 8 Windows 8 MaxPhysicalAddr 194 measuring temperatures 54 memory functions 158 Microsoft C C EDR Software Development Kit DOS 14 Windows 18 Microsoft QuickBasic 17 multiple boards 50 multiplexors 51 notification messages 41 45
64. RAN NE 90 SLEDR ST 90 8 9 EDR_StrTransferMode gs ra4vv4r44 eh aon 90 9 Analogue to digital input functions esossssvvevssvvvveessvvveeessvvveers P 9 1 IDR Ada OAD C Wan Lists iscesncsccuslersatvanecncnbacsiaesdoeenenecei asa bulaeedons 91 92 TDI DIM B Ne 91 9 3 EDR ADInBinB ckeround 34 scicvsssdccsepanseoctasteqedeiobanbenadelacseseeazene 92 9 4 EDR ADInBinCircularBuffer sssoorarrerasonvrsenennvrsensnernsnnssasenneseee 93 OS EDR ADHBIKMeEnvasrssa een 94 9 6 EDR ADInBinMemBackground eerreveerrrrvvrrrrvneerrrrvsrrrrnneernnneen 95 9 7 EDR ADInBinMemCircularBuffer snnrrrororrnnrrnnrnnrnnrrnnrrnnnner 96 9 8 EDR ADIIBHOreSample ruavsvvqponseeaee dear 98 9 9 EDR ADInBinToVoltage ssoressenssrranrrrersnvnessavnersrensersnnssresernereee 98 9 10 EDR ADINBinToVoltageBlock nrrnronnrnvnrornnnrennrrvennrrnneennnneer 99 9 ALEDR AD nO nie Volaseasuratosess eee 100 9 12 EDR ADInStreamBufStatus rrraronnrnoonnrrvnrennnnsennrrvernnnnneennnn 100 9 13 EDR ADIn Volt ge TOBIN 6 ei occ vcceecteeestc dectncseavseeccuenenecsaneeresben 101 O74 EDR AlsnBuffekuan seas ed 101 9 15 EDR BackgroundADInStatus eeronrrnrrnnrrvrrenrnnernnrresrrrrnnsennnne 102 9 16 EDR BackgroundADInType ernnnronnonnrnnrrnnrennnneennrrnsrrnnnnsennrne 103 9 17 EDR BackgroundADInWraps eeennonoonnrrvnrennnnssnnrrnsersrnneennnne 103 9 TS ERC ale ICG isone ara Aa 104 919 EDR ER IDAE vere 104 9 20 EDR CATE ee ane saan eeina e aiai 105 9 21 EDR
65. S The buffer needs only to have enough space for the data it does not have to be bigger as for single channel DMA The buffer can also be in XMS memory allowing megabytes of data to be collected in one block This mode can be used for background sampling Windows This mode can be used very efficiently under Windows but streaming is more reliable The 2 channels can be used to cope with non contiguous areas of the buffer This means that dual channel transfers are not normally buffered and are therefore more efficient However dual channel DMA does require the processor to reprogram the DMA controller between blocks If you need to sample at throughputs of more that 40 KHz you should read appendix B and configure EDRVXD 386 and your board accordingly 4 4 5 Streaming EDR_STREAM Streaming uses a single DMA channel programmed for circular buffer mode In circular buffer mode the buffer is continuously filled with data looping back to the start of the buffer when the end is reached As data is transferred into the buffer from the board it is copied to somewhere else in memory or to a disk file Unlimited amounts of data can be captured using this method even from boards without dual channel DMA If you are using Windows and need to capture more than 32000 samples in a block you should use this mode even if you only want to transfer to memory it is more reliable than dual channel DMA Software triggering on A D input channels only works with
66. S languages are supported Borland C C 3 x or 4 x C VEDR EXAMPLES C DOS directory e Microsoft C C 6 0 or 7 0 C EDR EXAMPLES C DOS directory e Borland Pascal Turbo Pascal version 6 0 or 7 0 C EDR EXAMPLES C DOS directory Newer versions of these languages may also work but have not been tested Other languages especially C compilers may be able to use a version of the driver meant for a different language 1 8 Windows languages supported The Windows languages all use the same version of the EDR library only the header files differ They call functions in EDR DLL 16 bit applications under Windows 3 1x and Windows 95 or EDR32 DLL two different versions one for Windows 95 and one for Windows NT Demo programs for each of the languages are in separate directories off the Examples directory The header files for Windows 3 1x Windows 95 and Windows NT are in the INCLUDE directory As the API is the same as for the DOS version of EDR the DOS demos may also be useful The following languages are supported Microsoft C C 6 0 or 7 0 C EDR EXAMPLES C WIN 16 directory EDR Software Development Kit Introduction Microsoft Visual C 4 0 C EDR EXAMPLES C WIN32 directory e Borland C C 3 x or 4 x C VEDR EXAMPLES C WIN 16 directory and C EDR EXAMPLES C WIN32 directory e Borland Pascal Turbo Pascal version 6 0 or 7 0 C EDR EXAMPLES TPAS directory Delphi version 1 0 and 2 0 C EDR EXAMPLES DELPHI directory
67. Windows NT This function is not required It always returns 1 board number 1 for compatibility reasons Windows Any board handles not released when the program terminates will be lost until Windows is restarted or EDR DLL is unloaded Any boards initialised to these handles will be unavailable to all applications You can avoid having to restart Windows by using a tool such as WPS to unload EDR DLL If you do this make sure that no programs that use EDR are running Demos INIT PAS INIT C INIT BAS 58 EDR Software Development Kit Configuration functions 7 2 EDR_CanBeDetected Parameter Type Comment boardtype integer Board type code Returns integer result Error code Comment 1 Invalid boardtype parameter 0 Cannot be detected from software 1 Can be detected but several different models are detected as the same model 2 Can be detected Checks if the specified board model can be reliably detected from software If 1 is returned then the board can be detected but several models are detected as the same board e g PC26 and PC30 59 EDR Software Development Kit Configuration functions 7 3 EDR_ConfigDialog Parameter Type Comment bh integer Board handle X integer X coord y integer Y coord bordc integer Border colour winc integer Inside win colour textc integer Text colour keyc integer Key colour hwnd or setc integer Parent window for dialogue box 0 if none or settings Note The hwnd parameter sho
68. age on each thermocouple in a system is read using the normal simple A D input functions such as EDR_ADInOneVoltage 9 11 The voltage from a cold junction compensation channel is read in the same manner EDR also supports interrupt sampling from the PC73 and PC73C This is done using the PC s timer tick interrupt You need to call EDR_SetADClockmilliHz 10 15 to set the frequency EDR_SetADTransferMode 9 49 with EDR_INTR to use interrupt sampling and then EDR_ADInBinBackground 9 3 or EDR ADInBinCircularBuffer 9 4 to start sampling data You may want to use EDR SetADBurstLen 9 41 as well to scan multiple channels on each strobe EDR_GetCJCChannelNumber 15 9 returns the channel number of a boards CJC input or 1 if the board has none This is normally one more than the number of the highest TC channel available on the board For example on the PC73A this function returns 8 as this board has 8 TC channels numbered from 0 to 7 Use this function rather than hard coding 8 into your code If we bring out a TC board with more or less channels then you should be able to run your program unchanged using the new board 5 2 Converting a CJC voltage into the ambient temperature EDR_CalcCJCmC 9 18 converts a microvolt value read from the board s CJC channel into a value in milli C Milli C values are used to avoid having to use floating point numbers To convert to C just divide by 1000 53 EDR Software Development Kit Mea
69. and place a null byte CHRS 0 after the last character used If the string is just going to be printed or passed to a function such as MsgBox this is fine as the extra spaces after this null byte will be ignored If required these extra spaces and the null byte can be removed by calling RTrimZ to remove the extra spaces and the null byte This function is in EDR BAS Here is an example of its use s SpaceS 80 make space in string for T message EDR_StrError error s convert error number into a string s RTrimZ s get rid of extra spaces and null byte 87 EDR Software Development Kit String functions 8 1 EDR_ParseChanGainList Parameter Type Comment S string Channel list string maxlen long Maximum number of channels to parse chans long Array for channel numbers gains long Array for gain values edges long Array for trigger edge values levels long Array for trigger level uV values count long Variable to hold number of channels parsed Returns integer error code Error code Comment EDR_OK No error EDR_TOOMANYCHANS Number of channels parsed exceeds maxlen EDR_BADPARAM Syntax error in channel list 32 bits only This function parses a string list of channels with optional gain trigger edge and trigger level values into arrays The format of the channel list is as follows lt chan gt lt gain gt lt edge gt lt level gt lt chan gt lt chan gt decimal integ
70. application This is a full Windows application It can be used to sample data and save as text for later import into a spreadsheet It demonstrates features unique to the Windows version of EDR such as notification messages sent when background sampling operations complete The demo programs provided for the DOS version of the driver in the C EDR EXAMPLES C DOS directory can be built as 16 bit EASYWIN apps and 32 bit CONSOLE apps and will work with small modifications They are also simpler and shorter than a full Windows application written in C and make better demos To build one of these as an EASYWIN application just load the project file for the demo into Borland s Windows IDE or Microsoft s PWB and run it as a Windows application 19 EDR Software Development Kit Building applications using EDR Two of the DOS demos STREAM and ADINDEMO have been built as 32 bit CONSOLE mode apps with very few changes They are in EDR EXAMPLES WIN 16 2 2 2 Borland Turbo Pascal and Delphi Follow these steps 1 Copy EDR TPW or EDR DCU or EDR32 DCU from C EDR LIB to your units directory EDR TPW is for Borland Pascal 7 0 EDR DCU is for Delphi 1 0 and EDR32 DCU is for Delphi 2 0 These units are just import units that tell the compiler that the functions are in EDR DLL or EDR32 DLL 2 Add EDR or EDR32 for Delphi 2 0 to the uses clause of each program or unit in your application that uses EDR procedures functions or constants e g use
71. are Development Kit Counter Timer functions 10 7 EDR Factorize Parameter Type Comment n long Unsigned 32 bit integer to factorize f1 unsigned Variable to hold first factor f2 unsigned Variable to hold second factor Returns integer 1 successful 0 cannot factorize Breaks an unsigned 32 bit number down into two 16 bit factors This function is useful when calculating the correct values for a prescaler and divider cascaded counter setup to generate a given frequency This function tries to preserve the current value of f1 if possible 10 8 EDR_GetADClockmilliHz Parameter Type Comment bh integer Board handle millihz long Variable to hold current frequency in milli Hz Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADBOARD Board does not have hardware clocked A D Gets the A D conversion clock frequency 134 EDR Software Development Kit Counter Timer functions 10 9 EDR GetCTClockSource Parameter Type Comment bh integer Board handle num integer Counter timer number source integer Variable to hold source of timers clock input listed in 17 10 Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Counter timer number is invalid Gets the clock source of the specified counter timer channel 10 10 EDR GetCTGateSource Parameter Type Comment bh integer Board handle num
72. at the PC runs very slightly slower while the acquisition takes place Variable Default Comments AlwaysBufferDMA Forces every DMA transfer to be buffered Set this option to 1 to see if your application still runs quickly enough when the DMA transfers have to be buffered MaxP hysicalAddr Maximum physical address that your motherboard can do DMA to in MB If your PC crashes when you try to do DMA set this to 1 and try again The VxD will allocate its DMA buffers below this address and will buffer any transfers above it 193 EDR Software Development Kit DMABufferS ize Timerinterval DMACopylnterval DirectDMA Appendix B Fine tuning EDRVXD 386 KB of memory reserved for the drivers DMA buffers The default setting is enough for one 32000 sample single channel transfer If you are using parallel boards add 64K per additional board to be safe If all your transfers are small you can save memory by reducing this figure A 10000 sample transfer may require 20000 bytes about 20 KB of buffer space If you get error 36 not enough free dma buffer space you need more Sets the resolution of the system PC s timer in milliseconds The fastest value is 1 This increases the accuracy of all software timing This should be set to 5 or less when doing high speed gt 40 KHz dual channel DMA without TC interrupts Time in ms between copies for buffered transfers and checks for non TC dual channel transfers
73. ay be different to its configuration as set in Control Panel It does make any attempts at detection 71 EDR Software Development Kit Configuration functions Important note The board detection process cannot detect simple digital IO boards without changing the state of the boards outputs You should use EDR_InitBoardType 7 24 instead if this is a problem This function just initialises the board by programming all DIO ports as inputs as on power up and does not output anything EDR sets all its configuration information on the board to the factory default settings You should call the appropriate functions if you have changed any of the boards jumpers EDR_ConfigDialog 7 3 displays a dialogue box that allows the user to select many board settings EDR_LoadConfiguration can be used to initialise a board from a configuration file Demos INIT PAS INIT C INIT BAS 7 24 EDR_InitBoardType Parameter Type Comment bh integer Board handle baseaddr integer Base address of board boardtype integer Type of board present at the base address Returns integer error code Error code Comment EDR_OK No errors EDR_BADHANDLE Board handle is invalid EDR BADPARAM A board has already been initialised at the base address EDR BADTYPE The board type parameter is invalid Initialises a board and attaches it to a board handle Once a board has been initialised to a board handle it cannot be initialised to any other board handle until the han
74. ays the temperature on TC board inputs Continuously displays the temperature on RTD board inputs 16 EDR Software Development Kit dioloop mak tclogger mak extint mak Building applications using EDR Walks a bit through DIO port 0 while displaying the others Complete temperature logging application for multiple TC boards Counts external interrupts 2 1 3 Borland Turbo Pascal Follow these steps 7 Copy EDR60 TPU or EDR70 TPU from C EDR LIB to your units directory as EDR TPU EDR60 for version 6 0 and EDR70 is for version 7 0 8 Add EDR to the uses clause of each program or unit in your application that uses EDR procedures functions or constants e g uses DOS EDR If you get a unit file format error when compiling you application then you are using the wrong version of EDR Contact us if you get this error when using a version of Turbo Borland Pascal newer than 7 0 Note that Turbo Pascal version 5 5 or earlier is not supported The demos in the C EDR EXAMPLES TPAS directory are as follows Demo voltmetr pas init pas adindemo pas stream pas XMs pas voltgen pas wavegen pas wavegen2 pas bitwalk pas xcheck pas Comments Continuously displays the voltage on all A D channels Detects which board is at a particular base address and initialises it Samples data using polled IO DMA and Interrupts Streams data to disk or memory Samples data using streaming or dual channel DMA into XMS
75. box on the stack If the PC crashes when you call this function then you most likely need to increase the stack size The dialogue will pop up in mono and colour text modes Do not call this function when in a graphics mode Demos Nearly all of the DOS demos C BAS and PAS and NOTDEMO C 7 4 EDR DetectBoard Parameter Type Comment baseaddr integer Base address to check Returns integer error code or board number Error code Comment gt 0 No error the number is the type of board found see below EDR BADHANDLE Board handle is invalid 61 EDR Software Development Kit Configuration functions Error code board Boards that may be present NOBOARD None PC26 PC26 or PC30 PC30B PC30B or PC30C PC30D PC30D PC30DS or PC30DS4 PC30PGL PC30PGL or PC30PGH PC126 PC126 or PC126A PC66 PC66 PC66A or PC63 PC14 PC14 PC14A PC36 or PC36B Others The type given is probably present Tries to determine the type of board installed at the specified base address If there is a board there but it is already being used by EDR then this function will return NOBOARD Windows NT This function is not supported For compatibility reasons if a board has been configured at the specified base address it will return the type of board installed It does not actually attempt to detect anything Important note It is not possible to detect digital IO boards without changing the state of the boards outputs Do not attempt to detect a digital IO b
76. corscrascosadcasweraneadanunopscecsenancotissacnenneeds 192 17 24 Trigger mode settmes suvrsvvevcqarsearsetnsesrennseke 192 18 Appendix B Fine tuning EDRVXD 386 sseesseeeee 193 18 1 Single channel DMA sssssssesssessesseesssseesseresssressrresssresseressseesseee 193 18 2 Dual channel DMA ssssssssesssesssssessssseesseresssresseressseesseressseessere 194 19 Appendix C EDR SYS Event log messages 196 20 TINDER ss LO EDR Software Development Kit Introduction 1 Introduction This manual is for the EDR software package EDR is a powerful application programming interface API between your data acquisition and control application and Eagle Technologies line of plug in boards for PC s Your application can be written in any of several popular languages and can run under DOS Windows 3 1 386 enhanced mode Windows for Workgroups 3 11 386 enhanced mode Windows 95 16 and 32 bit and Windows NT 4 0 Source code for numerous demonstration programs is provided for DOS and Windows in several different languages The API insulates you from the actual hardware details of the board s in use This makes it easier to write applications and to change boards as new models are released EDR are supplied free with all supported boards and is available for download on our web site http www eagle co za 1 1 About EDR version 2 35 This release includes support for our new range of PC104 30FG boards
77. ctual byte offsets and sizes will be double these 13 5 EDR DecimatelntArray Parameter Type Comment SIC long Source array dest long Destination array first long First value to copy skip long Interval between values to copy num long Total number of values in src 32 bits only Extracts a series of 32 bit values from an array into another array Example for a src array containing num values dest O sre first dest I sre first skip dest 2 sre first skip 2 159 EDR Software Development Kit Memory functions XMS dest num first skip src first skip num first skip 13 6 EDR FreeMem Parameter Type Comment handle long Handle of memory block Returns integer error code Error code Comment EDR OK No error EDR BADMEMHANDLE Memory handle is invalid Frees a block of memory allocated with EDR AllocMem 13 7 EDR_GetFreeMem Returns long free memory in samples Returns the amount of free memory in samples The byte size is double this 13 8 EDR_GetMemBlockSize Parameter Type Comment handle long Handle of memory block Returns long size of block in samples Returns the size of a block in samples The byte size is double this 160 EDR Software Development Kit Validation functions 14 Validation functions The functions listed in this chapter are used internally by EDR for parameter checking They are useful in interactive programs for checking user input and in programs that work with different types
78. d Sets the size of blocks written out by the streamer If the size given is 0 then EDR chooses a default size EDR may adjust the size when streaming starts depending on the size of the streaming buffer 121 EDR Software Development Kit Analogue to digital input functions 9 54 EDR SetStreamBuffer Parameter Type Comment bh integer Board handle buf unsigned Buffer for streaming bufsize long Size of buffer in samples Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADPARAM One of the parameters is invalid DOS Sets the buffer used for streaming to disk and memory This buffer must be in conventional memory If you are doing high speed streaming to disk using a big buffer 16384 samples and up reduces the risk of an overflow Using a bigger buffer also helps when doing streaming to disk in the background as the status function EDR BackgroundADInStatus can be called less often Windows This buffer is only used when streaming to disk If this function is called with a buf parameter of 0 then the driver allocates a default 256K buffer Windows 3 1x and Windows 95 or 1024K Windows NT before streaming and frees it afterwards If you provide your own buffer then it is not freed after streaming completes 9 55 EDR SetStreamFile Parameter Type Comment bh integer Board handle filename string Name of the file to stream to Returns integer error code 122 EDR Softwar
79. d any particular value The event codes are as follows e EDR MSG ADINDONE is sent when a background A D operation completes e EDR MSG ADINERROR is sent when a background A D operation fails due to an error for example EDR BUFFEROVERRUN EDR Background ADInStatus can be called to find out what the error was e EDR_MSG_ADTRIGGER is sent when an A D channel has triggered Call EDR_GetADTrigger to find out which channel triggered and the trigger sample number See chapter 4 for more information and NOTDEMO C or STREAMER for demo programs that use these messages Notification messages cannot be used from languages such as Visual Basic that do not allow messages to be processed directly 112 EDR Software Development Kit Analogue to digital input functions 9 36 EDR_GetNotificationWindow Parameter Type Comment bh integer Board handle hwnd unsigned Variable to hold handle of window to receive messages Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid Gets the handle of the window to receive notification messages for the board 9 37 EDR_GetStreamBlockSize Parameter Type Comment bh integer Board handle blocksize integer Variable to hold the streamer block size Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid Returns the size of blocks used by the streamer when streaming to disk or memory 9 38 EDR GetS
80. d the null byte can be removed by calling RTrimZ This function is in EDR BAS Here is an example of its use s Spaces 80 make space in string for message EDR_StrError error s convert error number into string s RTrimz s get rid of extra spaces and null byte Here is the Visual Basic definition for the example function Declare Function EDR Function Lib EDR32 DLL BYVAL a As Long BYVAL s As String buf as Integer b as Long BYVAL c as Long As Long It could be called as shown in this code fragment DIM a As Long b As Long err As Long DIM s As string DIM buf 0 TO 99 As Integer 100 16 bit samples DIM c As Long ae Spaces 80 31 EDR Software Development Kit Programming guidelines err EDR_Function a s buf 0 b c s RTrimZ s Note that the first location in the array buf is passed to EDR_Function not the actual array itself 32 EDR Software Development Kit Acquiring analogue data 4 Acquiring analogue data The EDR API provides several different ways to collect A D data This chapter reviews the issues problems and functions involved with each method Which method you choose will depend on your board s and application The A D functions are described in detail in chapter 9 4 1 A D data format When raw data is read from a board it is stored in the binary format used by that board This format varies depending on the board in use and you should consult your board manual fo
81. d Turbo Pascal and Quick Basic 4 5 respectively 1 5 2 Windows 3 1 and Windows 95 The Windows 3 1x and Windows 95 version of EDR is split into three parts a 16 bit dynamic link library EDR DLL a 32 bit DLL EDR32 DLL and a VxD or virtual device driver EDRVXD 386 The VxD does interrupt and DMA data acquisition and the 16 bit DLL handles all other functions The 32 bit DLL is only used from 32 bit applications running under Windows 95 It translates calls thunks down to EDR DLL to do most of its work There is no real loss of speed due to this thunking process as all the speed critical code is in the 32 bit VxD and not the 16 bit DLL Large parts of Windows 95 itself are implemented in exactly the same way The distinction between EDR DLL and EDRVXD 386 is usually invisible to your applications as they call EDR DLL or EDR32 DLL which in turn calls the VxD if necessary However some extra functions have been added to optimise high speed DMA data acquisition using the VxD The DLL s and VxD are in the C EDR DLL directory 1 5 3 Windows NT The Windows NT version of EDR is split into two parts a 32 bit dynamic link library EDR32 DLL and a kernel mode device driver EDR SYS All direct access to hardware is done by EDR SYS The DLL checks parameters and calls EDR SYS to perform operations that require direct hardware access This is very different to the Windows 3 1x and Windows 95 DLL s which access the hardware themselves
82. d handle is invalid Restores the factory default configuration for the board attached to the handle All the settings saved by EDR SaveConfiguration are reset to their default values Windows NT and Windows 95 This is not the same as the boards Control Panel configuration 7 30 EDR SaveConfiguration Parameter Type Comment bh integer Board handle filename string Name of file for config info Returns integer Windows NT This function is not supported and always returns EDR NOTIMPLEMENTED Windows NT This function is not supported and always returns EDR NOTIMPLEMENTED Writes configuration information to a file for later loading with EDR LoadConfiguration The following board details are saved to the file Base address board type DMA level s IRQ level s A D ranges A D types A D gains A D use TC ints flag D A ranges D A modes D A gains D A fixed reference D A trigger source counter clock and gate sources programmable interrupt source and A D clock trigger setting Note that the voltages currently set on D A channels are not saved The file is a binary file and the file format is reserved as it may change with future versions of EDR Future versions of EDR will be able to detect and convert configuration files written using previous versions Demos NOTDEMO C 76 EDR Software Development Kit Configuration functions 7 31 EDR_SaveConfigIni Parameter Type Comment bh integer Board handle filename string Name
83. de Comment EDR BADHANDLE Board handle is invalid EDR BADTRANS Transfer mode is invalid EDR NOCHANS There are no channels in the channel list EDR BADCHAN The channel list contains an invalid channel number EDR BADNUM The number of samples specified is invalid EDR BADBOARD Board cannot do function EDR BADPARAM Invalid parameter detected Acquires a block of A D data from the channels in the channel list You should read chapter 4 before using this function This function uses the current sampling frequency burst setting and transfer mode and only returns when the data has been collected EDR ADInBinBackground is a more flexible function and is better suited to Windows DOS The buffer for the binary data must be at least twice as big as for the number of samples required if EDR_SINGLEDMA is being used The number of samples acquired may be less than the number specified if EDR_SetADKeyAbort is on and the user pressed a key 9 3 EDR_ADInBinBackground Parameter Type Comment bh integer Board handle num long Number of samples to acquire buf unsigned Buffer to hold the binary data Returns long error code 92 EDR Software Development Kit Analogue to digital input functions Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADTRANS Transfer mode is invalid EDR_NOCHANS There are no channels in the channel list EDR_BADCHAN The channel list contains an invalid channel number EDR_BADNUM The numbe
84. dle is released using EDR_FreeBoardHandle or a different board is attached to the handle When running under Windows the board is unavailable to other applications that use EDR 72 EDR Software Development Kit Configuration functions Windows NT This function checks that the base address and type of specified board number match the input parameters If they do not an error is returned The board is reset to its factory default state This may be different to its configuration as set in Control Panel Unlike EDR_InitBoard this function does not attempt to detect what board is actually present at the base address as it is not possible to detect simple digital IO boards without changing the state of the boards outputs This could have serious consequences if the board was controlling some sort of equipment The board is only initialised all digital IO ports are programmed as inputs as on power up EDR maintains a flag that is set when a board is initialised with this function This flag is saved by EDR_SaveConfiguration so EDR_LoadConfiguration will not attempt to check the board type parameter by board detection when loading the configuration info EDR sets all its configuration information on the board to the factory default settings You should call the appropriate functions if you have changed any of the boards jumpers EDR_ConfigDialog see Error Reference source not found displays a dialogue box that allows the user to select man
85. e 129 EDR Software Development Kit Counter Timer functions When setting the source of counter 0 the ECLK and other bits in the CLKSRC register are not altered It is important to remember that when counter 2 is programmed to use the 2 MHz or 8 MHz clock it shares a common input with counter 0 That is if you program counter 2 to use the 2 MHz clock then so will counter 0 and visa versa If counter 2 is programmed for a source other than 2 MHz or 8 MHz then the source for counter 0 is unchanged and likewise changing the source for counter 0 has no effect on the source for counter 2 Source parameter ECLK Clock input of counter EDR_CS_2MHZ Output of counter 2 MHz EDR CS 8MHZ Output of counter 8 MHz EDR CS EXT Input ECLK line counter 2 only EDR CS GND Output of counter Ground counter does not count counter 2 only EDR CS DIVIDER Output of counter Divider output of counter 1 counter 2 only 10 2 EDR CTConfigure Parameter Type Comment bh integer Board handle num integer Counter timer number cmode integer Mode listed in 17 5 bed integer Count in binary 0 or BCD 1 Returns integer error code 130 EDR Software Development Kit Counter Timer functions Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Counter timer number is invalid EDR BADMODE Mode is invalid EDR BADPARAM BCD parameter is invalid EDR BADBOARD Board cannot do function Configures a counter timer Note
86. e Development Kit Analogue to digital input functions Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid Sets the name of the file to hold streamed data 9 56 EDR StopBackgroundADIn Parameter Type Comment bh integer Board handle Returns long number of samples collected or negative error code If the return value is lt 0 then an error has occurred and the return value holds the error code Error code Comment EDR BADHANDLE Board handle is invalid EDR BADPARAM Undefined error EDR WRITEERROR Error writing to streamer file EDR BUFFEROVERRUN Streamer buffer has overflowed Stops background A D on the board and returns the total number of samples collected 9 57 EDR StreamToDisk Parameter Type Comment bh integer Board handle num long Number of samples to capture Returns long error code If the return value is gt 0 then that many samples were acquired Otherwise it holds one of the following error codes 123 EDR Software Development Kit Analogue to digital input functions Error code Comment EDR BADHANDLE Board handle is invalid EDR BADTRANS Transfer mode is invalid EDR NOCHANS There are no channels in the channel list EDR BADCHAN The channel list contains an invalid channel number EDR BADNUM The number of samples specified is invalid EDR BADBOARD Board cannot do function EDR BADPARAM Invalid parameter detected EDR NOSTREAMBUF Stream buffer has not been set DOS EDR CANTOPENFI
87. e are no channels in the channel list EDR BADCHAN The channel list contains an invalid channel number EDR BADNUM The number of samples specified is invalid EDR BADBOARD Board cannot do function EDR BADPARAM Invalid parameter detected EDR NOSTREAMBUF Stream buffer has not been set DOS EDR BUFFEROVERRUN Streamer buffer has overflowed Acquires a block of A D data from the channels in the channel list You should read chapter 4 before using this function This function uses the current sampling frequency burst setting and transfer mode and only returns when the data has been collected This function transfers data into memory blocks allocated with EDR AllocMem 13 1 For DOS versions of EDR these memory blocks are in XMS For Windows versions they are normal global memory blocks EDR ADInBinMemBackground is a more flexible function and is better suited to Windows 9 6 EDR ADInBinMemBackground Parameter Type Comment bh integer Board handle num long Number of samples buf long Handle of buffer for data 95 EDR Software Development Kit Analogue to digital input functions Returns long error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADTRANS Transfer mode is invalid EDR NOCHANS There are no channels in the channel list EDR BADCHAN The channel list contains an invalid channel number EDR BADNUM The number of samples specified is invalid EDR BADBOARD Board cannot do function
88. e of the destination disk for high speed streaming When doing circular buffer streaming to disk the size of the buffer must be a multiple of the block size The streamer always waits until a full block of data has been collected before writing it out If you are doing slow speed streaming you may want to use a small block size This will reduce the number of extra samples that 42 EDR Software Development Kit Acquiring analogue data are taken at the end to fill up the last block These extra samples are discarded but still take time to collect An alternative way to avoid this effect is to collect a total number of samples that is a multiple of the block size EDR ADInStreamBufStatus 9 12 returns the buffer fullness as a percentage It also returns the highest value for this statistic so far for the current streaming operation You can use this to check that your second buffer is big enough The streamer has been tested on a 486 DX50 with a VESA local bus IDE controller running Windows 95 and maintained 200 KHz throughput with a 1024 KB buffer It has been tested on a similar machine with a 100 MHz DX4 processor running Windows for Workgroups 3 11 This machine achieved 330 KHz easily Using 32 bit file access an option in Windows for Workgroups 3 11 improves streaming performance significantly Streaming to disk under Windows NT is not fully reliable at speeds exceeding 100 KHz It will be fully supported in the next release Str
89. eaming takes place in the background allowing other programs to run However you should be careful what you run while doing high speed streaming If a program takes control of the CPU for a long period of time you may get a buffer overrun error Starting a new application or a DOS box may produce a lot of disk activity and cause a buffer overrun You also need to have enough physical memory for your streaming buffer and the applications you run while streaming If Windows starts thrashing the heavy disk activity may disrupt streaming 4 10 Software triggering Windows 3 1x 95 only Software triggering allows you start or stop capturing data based on the voltage on one or more A D input channels This feature allows you to sample data in a manner similar to a conventional digital storage oscilloscope This should not be confused with the hardware trigger feature found on most data acquisition cards This is just a TTL input line that gates the counter timer channel used to clock conversions 43 EDR Software Development Kit Acquiring analogue data Software triggering only works with the Windows version of EDR and only with the streaming transfer mode Streaming requires a board with DMA or REPSTRING to work Using an A D card and software triggering may be slower than a digital storage scope but unlimited amounts of data can be collected EDR can even trigger on data being streamed to disk The oscilloscope demo program in EDR EXAMPLES DELP
90. en ire SR 130 T03 EDR CTG te SOU E eie 131 VJEDR C Y ELET a EE E S 132 VEDR TS 133 106 EDR CPW ME eee en ia 133 10 7 EDR _Factorize me 134 10 8 EDR GetADClockmilliHz ooovnrnnnnrrnnnnvvnnnnernnnnernnnnevnnnnenennne 134 10 9 EDR GetC PCIGCKSOURCE Lukas 135 10 10 EDR_GetCTGateSource sscciues susaisivlosnidertunadeayeencivea es ivsanleeaions 135 10 11 PDR GetC Tal Valle save 136 10 12 EDR GetC Tipu hreq Hz vscec tssctessidesaceniscane sad 136 10 13 EDR GetDAC locking ai ccbccriessateseirncegis tauieienenstepteeteabsnetes 136 10 04 EDR CTECA aent 137 10 15 EDR SetADClockmilliHz cece ccecceesteceeeeeeseeeeneeeees 137 10 16 EDR Se TinputFreqQHassasasatkasa nese 138 10 17 EDR SetDAC loc kimi itz gsvsmejnnmie coceienepicvtoreneielesnss 139 11 Analogue output fUNCTIONG ccccssrsccccsssssssrsccssssssssrreees 140 11 1 EDR AddToDAChanList reroronnnnvorennvnrennrerernnenssnnrnvennnnessennsee 140 11 2 EDR BackgroundDAOQutStatus errrerorrvrrrrronvrnnraverrrnnnsennrne 140 0 1 EDR BackgroundDAOQutType eennrrrerrrrvnvennrnvennrrvsrrnrnneennnne 141 LT EDR DAO UC enenatis aaier 141 11 5 EDR DAOutBinBackground eeennvnvenerrvvernnrnesnnravernnnnnsennrne 142 11 6 EDR DAOutBinOneSample srrraronnrnnannrnvnernrnnesnnranerernnnsennrne 142 11 7 EDR DAOutBinReadback eesesorsosnrovesnennsnsannerernnnvnesennrseennese 143 11 8 EDR DAOutBinToVoltage enrrnvonnrnvennrrvnrrnrenernnrnnsrrrnnneennnne 143 1 1
91. eports errors boards not found etc to the system event log Use the event viewer in Start Programs Admin tools to view these Appendix lists all possible event log errors with explanations If no boards have been configured or no boards can be found EDR Software Development Kit Introduction EDR SYS will not load and NT will display a some services failed to start dialog box on boot Advanced users You can avoid rebooting your PC when making further changes to your board setup You need to stop EDR SYS if it started change your configuration and restart it To stop EDR SYS from the command linedo net stop edr To start EDR SYS do net start edr This only works if your PC has been rebooted at least once since SETUP EXE has completed successfully NT caches registry entries concerned with device drivers forcing the need to reboot 1 6 2 Windows 3 1x Windows 95 and DOS The setup batch file in the EDR WIN95 directory will install the win95 drivers by default See instructions below for Windows 3 11 In this manual C EDR will be used to refer to this directory If you installed to drive D then take all references to C EDR to mean D EDR 1 6 2 1 Windows 3 1 or 3 11 Run WIN31 EXE found in your C EDR WIN95 directory This will mark EDR DLL as a Windows 3 1 executable Copy EDR DLL and EDRVXD 386 from the C EDR WIN95 directory to your WINDOWS SYSTEM directory Add the following line to SYSTEM INI found in your WINDOWS
92. er gain value exists or the channel number is invalid 0 is returned 14 10 EDR Num16BitDA Outputs Parameter Type Comment boardtype integer Board type Returns integer number of 16 bit D A output channels Gets the number of 16 bit D A outputs a board has 14 11 EDR_NumADInputs Parameter Type Comment boardtype integer Board type adtype integer Type of inputs EDR_SINGLEENDED or EDR_DIFFERENTIAL Returns integer number of A D input channels Gets number of A D inputs a board has 164 EDR Software Development Kit Validation functions 14 12 EDR NumCounters Parameter Type Comment boardtype integer Board type Returns integer number of counter timer channels Gets the number of counter timer channels a board has Note that several of these channels may have dedicated functions such as timing A D input and so on Check your board manual for the exact function of each counter timer channel 14 13 EDR NumDAOutputs Parameter Type Comment boardtype integer Board type Returns integer number of D A output channels Gets the total number of D A outputs a board has 8 bit 12 bit and 16 bit 14 14 EDR NumDIOPorts Parameter Type Comment boardtype integer Board type Returns integer number of digital input output ports Gets the number of DIO ports a board has 165 EDR Software Development Kit Validation functions 14 15 EDR_MaxADInThroughputHz Parameter Type Comment boardtype integer Board type Returns
93. er channel number lt gain gt decimal integer channel gain lt edge gt r or R for a rising edge f or F for a falling edge lt level gt floating point voltage e g 1 75 or 3 1 If lt gain gt is not present then a gain of 1 is assumed If lt edge gt is not present then an edge of EDR_EDGE_NONE 0 is assumed If lt level gt is not present then a level of 0 UV is assumed Example s 0 3 10 4 1 R 2 3 5 10 F 0 1 Result count 4 88 EDR Software Development Kit String functions Index chans gains edges levels 0 0 1 EDR_EDGE_NONE 0 1 3 10 EDR_EDGE_NONE 0 2 4 1 EDR_EDGE_RISING 2300000 3 5 10 EDR_EDGE_FALLING 100000 8 2 EDR_StrADType Parameter Type Comment adtype integer Type code listed in 17 4 S string String to hold result up to 15 characters 8 3 EDR_StrBoardType Parameter Type Comment boardtype integer Board type number listed in 17 1 S string String to hold result up to 20 characters 8 4 EDR_StrDATriggerSource Parameter Type Comment source integer Trigger source number codes listed in 17 9 S string String to hold result up to 20 characters 89 EDR Software Development Kit String functions 8 5 EDR StrDAUpdateMode Parameter Type Comment tmode integer Update mode number listed in 17 8 S string String to hold result up to 15 characters 8 6 EDR_StrError Parameter Type Comment enumber integer Error code listed in 17 2 S string String to hold the resu
94. er sampling When circular buffer sampling is used data is continually placed in a buffer by EDR operating in the background When the end of the buffer is reached the transfer loops around to the start without losing any data This can be done using interrupts EDR_INTR single channel DMA EDR_SINGLEDMA and streaming to disk or memory EDR_STREAM When using streaming to disk or memory in circular buffer mode huge ring buffers megabytes of data DMA can be created Circular buffer sampling can be used Controller very effectively with software triggering Read Small VxD or SYS Buffer VxD Routine EDR ADInBinCircularBuffer 9 4 EDR ADInBinMemCircularBuffer 9 7 and EDR StreamToDiskCircularBuffer 9 59 as well as appendix B Large Streaming Buffer DLL The Windows version of EDR supports a function Routine called EDR_BackgroundADInWraps that counts the number of times the buffer has been completely filled so far This is useful for detecting buffer overflows and calculating sample times It only works when doing circular buffer streaming EDR_STREAM transfer mode Under Windows NT it also works with interrupt and DMA sampling Figure 3 Windows streaming 41 EDR Software Development Kit Acquiring analogue data 4 9 Streaming to disk Streaming to disk is done by setting the transfer mode to EDR_STREAM and calling EDR_StreamToDiskBackground 9 58 or EDR_StreamToDiskCircularBuffer 9 5
95. er what is done to the interrupts in the system VM 6 3 6 Background waveform generation This feature is not supported by this version of EDR The background D A functions are present in the reference section but have not been implemented 57 EDR Software Development Kit Configuration functions 7 Configuration functions EDR keeps information on all jumper settings and programmable features for each board handle Storing this information in the driver simplifies programming using the API It reduces the number of parameters functions required and removes the burden of managing this information from your application It also makes high level functions that need to know how the board has been jumpered and programmed possible e g scaling functions to convert binary codes to voltages need to know the current voltage ranges gains and so on Functions are also provided to return the factory default settings for a board and to validate board settings against a particular board type Most applications will only have to use a small subset of these functions 7 1 EDR_AllocBoardHandle Returns integer board handle Allocates a new board handle and returns it If no board handles are available then 0 is returned All board handles allocated must be released using EDR_FreeBoardHandle 7 5 before the program terminates Once a board handle has been obtained it can be used to initialise a board for data acquisition and other EDR functions
96. erType rrerennrnronnrrvnrennnnrsnnrnvnennnnnsennnne 117 9 46 EDR SetADDisableAllInts srnnnnnnnnnnnnnnnnnnnnennnnnennnnnnnenenenener 117 DAT EDR SetADKeyAboft ursaeavsn keiseren 118 948 EDR SetADNoDElA haa 118 9 49 EDR SetADTransferMode ennnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnenes 119 9 S0EDR SetADTnegerType u usuavasnuannipisennnrded 120 OSL BDR Sera se FCs Le de 120 9 52 EDR_SetNotification Window cccccccceceeeeeeeeeeeeecseeeeeeeeeeee 121 9 53 EDR SeStreamBl ckSizeuuasv dd 121 954 EDR SetStreamBurt ert sunscntednvistestoanci nema knr 122 9 55 EDR_SetStreamFile iGitecbs susie svnhesi adarccaniasscatappacesbiasuehendendesaahts 122 9 56 EDR_StopBackgroundADIN 0 0 cece eeeeceeeeneceesteeeeeeneeeeenes 123 9 57 EDR Sted PG OISK asics svitastiuetvapisasiuselaccanndactaninetaadiieaned 123 9 58 EDR StreamToDiskBackground rrveennrrvnvernvnvennrrverrrrnnsennnne 124 9 59 EDR StreamToDiskCircularBuffer rornnnnnnnnnnnnnnnnnnnnnnnnenener 125 9 60 EDR UsesPCTimerInterrupis Luauunaraatsdmasktde 126 9 61 EDR U V Olts TOU Amin ss sit siecsets ty covssvlecncestuaarsaknogaveen tageveemsesatens 127 9 62 EDR ValidADBurstLen cccccccccescsceeeceesesesesescseseseeeees 128 9 63 EDR ValidADTransferMode cccccccccceceeseeeeeeeeeeeeeeeees 128 10 Counter Timer functions cccccccssssserscsssscccccccccccececees 129 10 1 EDR CTClockS EF 129 10 2 EDR CTCOnfi s re pret serierne rir
97. ering functions C EDR EXAMPLES DELPHI STREAMER STREAMER EXE Streams data from A D channels to a disk file C EDR EXAMPLES DELPHINKTEMPLOG TEMPLOG EXE Logs temperatures from TC s and RTD s to disk and displays them on screen C EDR EXAMPLES C WIN 16 NOTDEMO EXE Samples waveforms from selected A D channels in the background if possible and saves the data in a text file C EDR EXAMPLES VB LOGGER LOGGER EXE Simple voltmeter type application Measures and displays the voltage on selected A D channels at specific intervals If you do not have Visual Basic installed on your system you will need to copy VBRUN300 DLL from the C EDR EXAMPLES VB directory into your WINDOWS S YSTEM directory C EDR EXAMPLES VB WAVEIN WAVEIN EXE Samples waveforms from selected A D channels in background if possible and graphs the data using Visual Basic s graph control If you do not have Visual Basic installed on your system you will need to copy VBRUN300 DLL GSW EXE and GRAPH VBX from the C EDR EXAMPLES VB directory into your WINDOWS SYSTEM directory C EDR EXAMPLES VB DIO DIO EXE Allows all DIO ports to be individually configured as input or output ports Displays all ports and allows values to be sent to output ports If you do not have Visual Basic installed on your system you will need to copy VBRUN300 DLL and GRID VBX from the C EDR DLL VB directory into your WINDOWS SYSTEM directory C EDR EXAMPLES VB LOGGER TEMPMETR EX
98. et Read 4 for more details 9 46 EDR SetADDisableAllInts Parameter Type Comment bh integer Board handle onflag integer 0 turn off 1 turn on 117 EDR Software Development Kit Analogue to digital input functions Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid If this flag is on then all interrupts are disabled when doing EDR POLLED mode sampling Windows This flag has no effect on Windows sampling operations 9 47 EDR SetADKeyAbort Parameter Type Comment bh integer Board handle onflag integer 0 turn off 1 turn on Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid Turns keyboard aborting of sampling on or off When on sampling of data with EDR ADInBin can be interrupted by a keypress Windows This flag has no effect on Windows sampling operations 9 48 EDR_SetADNoDelay Parameter Type Comment bh integer Board handle onflag integer 0 turn off 1 turn on Returns integer error code 118 EDR Software Development Kit Analogue to digital input functions Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid Some boards such as the PC73A require long delays after the channel selection multiplexor is programmed to allow inputs to settle If this flag is on then these delays are skipped This means that the channel must have already been programmed or the data may be inva
99. ettings are The newer PC30Fxx and PC30Gxx boards allow the A D input range to be toggled between unipolar and bipolar mode from software A jumper is still used to select the span 10V or 20V If this jumper is in the 10V position the range can be set to 0 to 10V EDR_RANGEIOU or 5V EDR_RANFESB using this function 7 33 EDR_SetADInGain Parameter Type Comment bh integer Board handle chan integer Channel to configure gain integer Gain value Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid EDR BADGAIN Gain is invalid Configures the gain for an A D channel For boards with programmable gain e g PC30PGL PC30PGH PC30FA PC30F PC30GA and PC30G 78 EDR Software Development Kit Configuration functions the gain registers for the specified channel are programmed Note that this function uses actual gain values e g 1 10 100 or 1000 not gain codes 7 34 EDR_SetADInRange Parameter Type Comment bh integer Board handle chan integer Channel to configure range integer Input voltage range code listed in 17 3 Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid EDR BADRANGE Range is invalid Configures the range for an A D channel Note that for all A D boards currently supported by EDR there is one jumper to control the range for all A
100. eturns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR NOCHANS No channels in the channel list EDR BADCHAN Channel list contains an invalid channel EDR BADNUM Invalid number of samples specified Converts a block of binary data to a block of microvolt values The channels used to sample the block are assumed to be those in the channel list The channel gains and ranges must all be as they were when the data was captured The firstsample parameter is useful when the block to be converted is part of a larger block EDR uses this parameter to calculate which channel in the channel list occupies the first entry in the block Example Assume you have captured 1000 samples from channels 4 6 and 7 and want to convert only 99 EDR Software Development Kit Analogue to digital input functions samples 500 to 749 to microvolt values You would call this function with firstsample 500 and num 250 EDR uses firstsample to figure out that the first entry in the block is actually the channel in position 500 mod 3 2 in the channel list i e channel 7 9 11 EDR_ADInOneVoltage Parameter Type Comment bh integer Board handle chan integer Channel to sample uvolts long Variable to hold microvolt value Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid Returns the voltage on the specified A D channel Note
101. ewtype integer New board type 167 EDR Software Development Kit Validation functions Returns integer O invalid 1 valid Checks a board type parameter against a given type For example If a PC30D is detected at a base address the actual board may be a PC30DS this function returns 1 but is definitely not a PC126 this function returns 0 14 22 EDR ValidClockSource Parameter Type Comment boardtype integer Board type num integer Counter timer channel number src integer Clock source listed in 17 10 Returns integer O invalid 1 valid Checks if the specified clock source constant is valid for a particular counter timer channel and board 14 23 EDR_ValidDAOutChan Parameter Type Comment boardtype integer Board type chan integer D A channel number Returns integer O invalid 1 valid Checks an D A channel number 14 24 EDR ValidDAOutFixedRef Parameter Type Comment boardtype integer Board type uvolts long Fixed reference value in microvolts Returns integer 0 invalid 1 valid Checks a D A channel s fixed reference value 168 EDR Software Development Kit Validation functions 1425 EDR ValidDAOutGain Parameter Type Comment boardtype integer Board type chan integer Channel number gain integer Gain value Returns integer 0 invalid 1 valid Checks a D A gain value 14 26 EDR ValidDAOutMode Parameter Type Comment boardtype integer Board type chan integer Channel number tmode integer Update m
102. fication codes 192 thermocouple types 193 transfer modes 188 trigger edges 193 trigger modes 193 voltage ranges 187 VxD flags 193 Control Panel 7 converting DAC voltages 56 counter timer functions 129 D A channel numbers 56 D A data format 57 D A functions 141 DAC numbers 56 data format EDR Software Development Kit A D 34 data types 24 Borland Turbo Pascal 26 C C 25 Delphi 2 0 27 QuickBasic 29 Visual Basic 16 bit 30 32 bit 32 demos exe s 9 DOS 10 Windows 16 bit 9 Windows 32 bit 9 DIO functions 153 DirectDMA 195 DMA dual channel 195 DMABufferSize 195 DMACopylnterval 195 dual channel DMA 195 dual DMA A D sampling 37 EDR DLL 4 EDR_AddToADChanList 91 EDR_AddToDAChanList 141 EDR_ADInBin 91 EDR_ADInBinBackground 92 EDR ADInBinCircularBuffer 93 EDR ADInBinMem 94 EDR ADInBinMemBackground 95 EDR ADInBinMemCircularBuffe r 96 EDR ADInBinOneSample 98 EDR ADInBinToVoltage 98 EDR ADInBinToVoltageBlock 99 199 Index EDR ADInOneVoltage 100 EDR ADInStreamBufStatus 100 EDR ADInVoltageToBin 101 EDR AlignBuffer 101 EDR AllocBoardHandle 59 EDR AllocMem 158 EDR BackgroundADInStatus 102 EDR BackgroundADInType 103 EDR BackgroundADInWraps 103 EDR BackgroundDAOutStatus 141 EDR BackgroundDAOutType 142 EDR CalcCJCmC 104 EDR CalcRTDmC 104 EDR CalcTCmC 105 EDR CanBeDetected 60 EDR Clear ADTrigger 105 EDR ConfigDialog 61 EDR CopyFrom
103. fter either channel 0 or 2 has triggered Mid triggering EDR TRIG MID 45 EDR Software Development Kit Acquiring analogue data Mid triggering is more flexible than pre triggering The trigger can be anywhere in the waveform you want to capture see Figure 7 This mode should be used with circular buffer streaming as EDR continuously transfers data into your buffer while looking for a trigger You specify the number of samples that must be captured after a channel has triggered Once these have been captured Figure 7 Mid and stored in your buffer sampling stops and you have triggering data before and after the trigger You should set the size of your circular buffer to the number of samples you want to capture in total Remember that the buffer size must be a multiple of the streamer block size or you will get an error from EDR_ADInBinCircularBuffer You can use EDR_SetStreamBlockSize 9 53 to change this Use the postsamples parameter of EDR_SetADTriggerType to set the number of samples to capture on and after the scan containing trigger Note that the scan containing the trigger is included in this count The following pseudocode example shows how to do this set the transfer mode to EDR STREAM set sampling frequency gains etc as normal EDR SetADChanListLen bh 0 EDR AddToADChanList bh 1 EDR AddToADChanList bh 3 Sample channels 1 and 3 EDR SetADChanT
104. ftware Development Kit Configuration functions 7 12 EDR GetDAOutFixedRef Parameter Type Comment bh integer Board handle uvolts long Variable to hold microvolt reference value Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid Gets the reference voltage used to convert voltages into binary codes for D A channels This is only used when the D A channel range is set to EDR RANGEFVU or EDR RANGEFBU pot selectable as with the PC66 7 13 EDR GetDAOutGain Parameter Type Comment bh integer Board handle chan integer Channel gain integer Variable to hold the gain for the channel Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid Gets the gain of the specified D A channel 66 EDR Software Development Kit Configuration functions 7 14 EDR GetDAOutMode Parameter Type Comment bh integer Board handle chan integer Channel tmode integer Variable to hold the update mode listed in 17 8 Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid Gets the update mode of the specified D A channel 7 15 EDR GetDAOutRange Parameter Type Comment bh integer Board handle chan integer Channel range integer Variable to hold range code listed in 17 8 Returns integer error code Error c
105. gger EDR captures postcount samples from this point not from the trigger sample itself Once the done value reaches your postcount value you can call EDR StopBackgroundADIn EDR AlignBuffer 9 14 can be used to move all the data in the buffer around so that the oldest sample is in the first position in the buffer This simplifies working with the data It is possible that a trigger will occur soon after sampling starts i e before the buffer has been completely filled once In this case you will get less data before the trigger You can call EDR BackgroundADInWraps to find out how many times the buffer has been filled to check for this Post triggering EDR TRIG POST This mode is identical to mid triggering with a postsamples value of 0 The trigger immediately follows the data see Figure 8 Note that this means that the scan containing the trigger sample is not stored in the buffer Figure 8 Post User triggering EDR_TRIG_USER triggering 47 EDR Software Development Kit Acquiring analogue data When triggering in this mode EDR does not start or stop sampling when channels trigger It just looks for triggers and reports them using notification messages You can also check by calling EDR_GetADTrigger 9 32 Remember that once a trigger has been detected EDR disables trigger detection until you call EDR_ClearADTrigger 9 21 Triggers closely following the first trigger may be missed 4 10 4 Performance Naturally sampling w
106. gned Variable to hold binary voltage Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid Gets the last voltage set on the specified D A channel in binary form Note that some boards do not support readback from the D A registers and EDR returns the last value written using EDR DAOutBinOneSample or EDR DAOutVoltage instead 11 8 EDR DAOutBinToVoltage Parameter Type Comment bh integer Board handle chan integer Channel number uvolts long Variable to hold microvolt value bin unsigned Binary voltage to convert Returns integer error code 143 EDR Software Development Kit Analogue output functions Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Invalid channel in channel list Converts a single binary voltage for a DAC into a microvolt value 11 9 EDR_DAOutUpdate Parameter Type Comment bh integer Board handle Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid Updates the voltages on all D A channels programmed for parallel preload update 11 10 EDR DAOutVoltage Parameter Type Comment bh integer Board handle chan integer Channel number uvolts long Microvolt value for channel Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid Sets the v
107. gth for sampling blocks of A D data Note that simultaneous sample and hold only takes place when sampling in burst mode If the burst length given is EDR ADNOBURST or 0 then burst sampling is disabled If it is EDR ADBURSTNUMCHANS then the burst length is set to the number of channels in the channel list when sampling starts See chapter 4 for more details 9 42 EDR_SetADCClockTrigger Parameter Type Comment bh integer Board handle SIC integer Clock trigger setting listed in 17 7 Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADPARAM Src parameter is invalid This function controls the action of the ETRIG line on the PC30Fxx and PC30Gxx boards and sets the source of strobes for the ADC converter This function can be used to configure multiple boards so that their clocks are synchronised and to enable external triggering and clocking of ADC 115 EDR Software Development Kit Analogue to digital input functions conversions On the older series boards PC30D et al this has to be done by setting jumpers on the board The source parameter must be one of the codes shown in the table below Src parameter ETRIG Comment EDR_ADC_MASTER Output Internal clock to ADC and ETRIG EDR ADC NORMAL Input ETRIG disconnected Internal clock to ADC EDR ADC SLAVE Input ETRIG as A D clock Internal clock disconnected EDR ADC EXTTRIG Input Internal clock to ADC gated by ETRIG 9 43
108. iggers within the same streamer block EDR detects all the triggering channels You can use this function to get trigger details for each sampled channel 9 27 EDR_GetADChanTriggerType Parameter Type Comment bh integer Board handle chan integer Channel number edge integer Variable to hold edge type level long Variable to hold level in uv Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Invalid channel number Gets the trigger settings for a channel 9 28 EDR GetADTransferMode Parameter Type Comment bh integer Board handle Returns integer error code or transfer mode 108 EDR Software Development Kit Analogue to digital input functions Error code Comment gt 0 Transfer mode constant listed in 17 5 EDR BADHANDLE Board handle is invalid 9 29 EDR GetADDisableAllInts Parameter Type Comment bh integer Board handle Returns integer error code or the status of the flag Error code Comment 0 Flag is off 1 Flag is on EDR BADHANDLE Board handle is invalid Gets the status of the interrupt disable flag see 17 22 9 30 EDR GetADKeyAbort Parameter Type Comment bh integer Board handle Returns integer error code or the status of the flag Error code Comment 0 Flag is off 1 Flag is on EDR BADHANDLE Board handle is invalid Gets the status of the keyboard abort flag 9 31 EDR GetADNoDelay Parameter Type Comment bh integer Board handle
109. ile interrupts are processed all interrupts should be disabled if the A D frequency is greater than 1000 Hz This will shut down the keyboard mouse real time clock and any serial port activity 34 EDR Software Development Kit Acquiring analogue data for the duration of the sampling operation The EDR_SetADDisableAlIInts 9 46 function can be used to control this behaviour The Windows version of EDR ignores this function hence this transfer mode should not be used from Windows applications if any of the other modes are available A maximum of 32000 samples can be captured in one block using this mode for DOS and Windows Windows NT Polled sampling for a block of data is not supported under Windows NT 4 4 2 Interrupts EDR_INTR Interrupt sampling is excellent for low speed applications lt 10 KHz as it works very well in the background allowing the PC to get on with other work The board generates an interrupt when each conversion completes The processor suspends the currently executing program and calls an interrupt service routine which reads the data from the board and stores it in memory The program that was running is resumed on exit from the service routine A maximum of 32000 samples can be captured in one block using this mode for DOS and Windows There is no limit for Windows NT EDR will emulate interrupt sampling using the PC s counter timer interrupts for some boards that do not have interrupt hardware The PC7
110. integer Line number or bit number value integer Value for line 0 or 1 Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADPORT Port number is invalid EDR BADLINE Line number is invalid EDR BADPORTCFG Not an output port Changes a single line bit in a digital output port 12 5 EDR DIOPortInput Parameter Type Comment bh integer Board handle portnum integer Port number value integer Variable to hold data from port Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADPORT Port number is invalid Reads a byte of data from a digital input port If the port is an output port then the last value written to the port is returned 154 EDR Software Development Kit Digital input output functions 12 6 EDR DIOPortOutput Parameter Type Comment bh integer Board handle portnum integer Port number value integer Byte of data for port Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADPORT Port number is invalid EDR BADPORTCFG Not an output port Writes a byte of data to a digital output port 12 7 EDR DIOPortInput16 Parameter Type Comment bh integer Board handle portnum integer Port number value integer Variable to hold data from port Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR
111. ions using EDR Comments Continuously displays the voltage on all A D channels Detects which board is at a particular base address and initialises it Samples data using polled IO DMA and Interrupts Streams data to disk or memory Samples data using streaming or dual channel DMA into XMS Allows the voltages on all D A channels to be set Generates a waveform on a single D A channel Generates two waveforms on different D A channels bitwalk prj Walks a bit through all digital output ports xcheck pr Checks the A D input channels of a board using its D A outputs freqcnt pr Frequency counter for the PC14B ctread prj Simple demo to read counter timers and software gate them tempmetr prj Continuously displays the temperature on TC board inputs rtdmeter prj Continuously displays the temperature on RTD board inputs dioloop prj Walks a bit through DIO port 0 while displaying the others tclogger prj Complete temperature logging application for multiple TC boards extint prj Counts external interrupts 2 1 2 Microsoft C C Follow these steps 4 Make sure you are using the large memory model 5 Include EDR INCLUDE DOS EDR H in all files that call EDR functions or use constants defined in EDR H You can do this by putting the following line at the top of each file include c edr include dos edr h 15 EDR Software Development Kit Building applications using EDR 6 Link your application with C EDR LIB
112. ith trigger detection uses more CPU cycles than normal streaming This effect is not noticeable on today s machines A 133 MHz Pentium sampling at 200 KHz with trigger detection on all channels only spends about 10 of CPU doing the acquisition 4 10 5 Quick reference EDR_ClearADTrigger Clear trigger info and look again 4 11 Using XMS memory DOS and memory blocks Windows EDR_GetADChanTriggerType EDR provides functions to access XMS memory from DOS and global memory blocks from Windows These functions behave in the same way to provide compatibility EDR_ADInBinMem 9 5 and EDR ADInBinMemBackground 9 6 are equivalent to the normal ADInBin functions except that they transfer data into a memory block 48 EDR Software Development Kit Acquiring analogue data 4 12 Aborting sampling with a keypress DOS only DOS programs can set a flag that allows users to abort non background sampling operations by pressing a key The data collected up to the keypress is left in the buffer and can be used normally This feature is controlled by EDR_SetADKeyAbort see 9 47 4 13 Using parallel boards to access more than 16 channels EDR supports the use of multiple boards in parallel when using background sampling Each board must be jumpered for a different DMA level For example 3 PC30D s or PC30Dxx PC30PGx PC30Fxx and PC30Gxx could be used in parallel on DMA levels 5 6 and 7 respectively It is possible to synchroni
113. k frequency 10 14 EDR CTLatchAll Parameter Type Comment bh integer Board handle Returns integer error code Error code Comment EDR OK No error EDR BADBOARD Board does not support this feature Latches all counter timers on a board Reading from each counter will return the count at the time the counters were latched 10 15 EDR SetADClockmilliHz Parameter Type Comment bh integer Board handle millinz long Conversion frequency in milli Hz Returns integer error code 137 EDR Software Development Kit Counter Timer functions Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADBOARD Board does not have hardware clocked A D EDR BADFREQ Frequency specified is invalid Programs the appropriate counter timer channels to achieve the A D conversion frequency specified The counter timer channels are configured by this routine so there is no need to call EDR CTConfigure Note that the frequency programmed may differ slightly from the requested frequency Call EDR GetADClockmilliHz to get the actual programmed frequency This effect is most noticeable when setting high or very low frequencies Note that on some boards e g PC126 and PC127 the A D and D A timing circuitry share a common prescaler This means that a change in the A D frequency may affect the D A frequency and visa versa EDR tries not to change the prescaler but this is not always possible if the A D and D A frequencies are far apa
114. lates it by setting the gate source to EDR_CT_ENABLED and using clock source to start and stop counting When counting is stopped using EDR_CTSoftGate the clock input is connected to ground When counting is started the clock source is restored 10 4 EDR CTRead Parameter Type Comment bh integer Board handle num integer Counter timer number value unsigned Variable to hold current count Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADCHAN Counter timer number is invalid EDR_BADBOARD Board cannot do function Reads the current value of the counter 132 EDR Software Development Kit Counter Timer functions 10 5 EDR CTSoftGate Parameter Type Comment bh integer Board handle num integer Counter timer number gate integer Stops 0 or starts 1 the counter Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Counter timer number is invalid EDR BADPARAM Gate parameter is invalid EDR BADBOARD Board cannot do function Starts or stops the specified counter 10 6 EDR CTWrite Parameter Type Comment bh integer Board handle num integer Counter timer number value unsigned Newcount Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Counter timer number is invalid Writes the specified value to the counter timer 133 EDR Softw
115. ld be called as shown in this code fragment DIM a As Integer b As Integer err As Integer DIM s As string DIM buf 0 TO 99 As Integer DIM c As Long s Spaces 80 err EDR Function a s buf 0 b c s RTrimZ s Note that the first location in the array buf is passed to EDR Function not the actual array itself 3 3 6 Visual Basic 4 0 amp 5 0 32 bit The following table shows the correspondence between the listed parameter types and actual Visual Basic data types Note that most parameters have been expanded from 16 bit integers to 32 bit integers The only parameters that have not are 16 bit sample buffers 30 EDR Software Development Kit Programming guidelines Parameter type Visual Basic parameter type integer long or amp long long or amp unsigned long or amp string string or variable integer long or amp variable long long or amp variable unsigned long or amp variable Special care has to be taken when using EDR functions that return information in strings You must fill your string with enough spaces to hold the result of the call before calling the function The built in function Space 0 is useful for this EDR will store the result in the string and place a null byte Chr 0 after the last character used If the string is just going to be printed or passed to a function such as MsgBox this is fine as the extra spaces after this null byte will be ignored If required these extra spaces an
116. les would be spaced if taken on a PC30DS which uses simultaneous sampling and hold in burst mode The PC30D has a maximum throughput of 200 KHz 4 7 Background sampling Background sampling can be done using any transfer mode except polled EDR_ADInBinBackground 9 3 is used to start sampling EDR_BackgroundADInStatus 9 15 can be used to check how many samples have been acquired so far These samples will be in the buffer or file and can be processed or graphed while the rest of the data is acquired When all or enough of the data has been acquired EDR_StopBackgroundADIn 9 56 must be called to stop sampling This 39 EDR Software Development Kit Acquiring analogue data function makes sure that all acquisition is stopped and releases DMA IRQ levels and buffers DOS When the transfer mode is set to EDR DUALDMA or EDR STREAM then EDR BackgroundADInStatus must be called periodically so that the DMA controller can be reprogrammed or data copied out of the stream buffer When doing dual channel DMA at 200 KHz the status function must be called at least every 150 ms or sampling will stop How often the status function needs to be called when doing streaming depends on the size of the stream buffer Using a 16384 sample buffer at 200 KHz allows up to about 80 ms between calls Slower speeds and bigger buffers allow proportionately more time For high speed disk streaming it is best to call the function as often as possible Windows The s
117. lid If you are only sampling from one channel or need to overlap the settling time with some other processing then use this function to skip the delays The general procedure is as follows 1 Call EDR ADInBinOneSample to select the correct channel and discard the invalid data received 2 Do whatever processing you need to do but make sure you delay long enough for the mux to settle check your hardware manual 3 Call EDR_ADInOneVoltage or EDR_ADInBinOneSample to read the correct data 9 49 EDR SetADTransferMode Parameter Type Comment bh integer Board handle tmode integer Transfer mode listed in 17 5 Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADTRANS Transfer mode is invalid Changes the transfer mode for the board 119 EDR Software Development Kit Analogue to digital input functions 9 50 EDR_SetADTriggerType Parameter Type Comment bh integer Board handle tp integer Type of triggering to do postsamples long Number of samples to capture after the trigger EDR_TRIG_MID only Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADTRIGTYPE Invalid trigger type specified Sets the type of triggering to do Remember that unless at least one of the sampled channels is set to trigger no triggers will be detected Read chapter 4 for more details on trigger types modes 9 51 EDR SetADU
118. ls e g PC266 For example the PC167B has 8 12 bit channels numbered 0 to 7 and one 16 bit channel numbered 16 6 2 Generating voltages on D A channels The easiest way to generate a voltage on a D A channel is to call EDR_DAOutVoltage 11 10 This function sets the voltage on a single DAC 6 2 1 Parallel update If a D A channel has been configured for preload parallel update mode then the voltage set on the DAC will only be reflected on the output pin when an update trigger is received This feature is used to change the voltage on several channels simultaneously Update triggers can be generated from software by calling EDR_DAOutUpdate 11 9 Note that not all boards support preload mode 6 2 2 Converting microvolt values to binary The simple voltage output function EDR_DAOutVoltage 11 10 converts the microvolt value it is given to a binary value before outputting it If you need quick updates from within a loop use EDR_DAOutVoltageToBin 11 12 to convert the microvolt value to binary outside of the loop Then call EDR_DAOutBinOneSample 11 6 to set the voltage inside loop EDR_DAOutBinToVoltage 11 8 can be used to reverse the process 55 EDR Software Development Kit Measuring temperatures The actual binary format used depends on the board in use see your board manual for details The exception is data for the PC30 series boards The DAC s on these boards require that data for a DAC be inverted if the DAC is jum
119. lt up to 80 characters 8 7 EDR_StrRange Parameter Type Comment r integer Range code listed in 17 3 S string String to hold the result up to 20 characters 8 8 EDR_StrTCType Parameter Type Comment tctype integer Thermocouple type code listed in 17 21 S string String to hold result up to 3 characters 8 9 EDR StrTransferMode Parameter Type Comment tmode integer Error code listed in 17 5 S string String to hold the result up to 30 characters 90 EDR Software Development Kit Analogue to digital input functions 9 Analogue to digital input functions General guidelines for using the functions in this chapter are given in chapter 4 9 1 EDR_AddToADChanList Parameter Type Comment bh integer Board handle chan integer Channel to add Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR TOOMANYCHANS Too many channels in the list EDR BADCHAN Channel number is invalid Adds a channel to the end of the channel list increasing its length by 1 9 2 EDR ADInBin Parameter Type Comment bh integer Board handle num long Number of samples to acquire buf unsigned Buffer to hold the binary data Returns long error code or the number of samples acquired If the return value is gt 0 then that many samples were acquired Otherwise it holds one of the following error codes 91 EDR Software Development Kit Analogue to digital input functions Error co
120. lts uvmax long Variable to hold upper end of range in microvolts Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Invalid channel Gets the microvolt range of an A D channel This function considers the jumpered range and the gain Example If a channel is programmed with a gain of 10 on a PC30PGL jumpered for the 5 to 5v range then this function will return a range of 500000 uV to 500000 uV 0 5 V to 0 5 V 79 EDR GetADInType Parameter Type Comment bh integer Board handle chan integer Channel adtype integer Variable to hold type Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid 64 EDR Software Development Kit Configuration functions Gets the type of the A D input either EDR_SINGLEENDED or EDR DIFFERENTIAL 7 10 EDR GetBase Parameter Type Comment bh integer Board handle baseaddr integer Variable to hold the base address Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid Gets the base address of the board 7 11 EDR GetBoardType Parameter Type Comment bh integer Board handle boardtype integer Variable to hold board type listed in 17 1 Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid Gets the board type 65 EDR So
121. nctions just call the normal Windows API global memory functions They are still useful for languages like Visual Basic that do not have built in dynamic memory allocation functions The memory blocks are accessed using memory block handles long integers that identify the block to EDR The sampling functions EDR_ADInBinMem 9 5 and EDR_ADInBinMemBackground 9 6 recognise these handles and will capture data into these buffers transparently All of these functions accept all parameters in samples and not bytes A sample is 2 bytes long This does not mean that you cannot store other forms of data in these memory blocks Under Windows 3 1x and 16 bit Windows 95 apps these handles are just far pointers to the data block Under 32 bit Windows 95 apps and Windows NT they are 32 bit flat pointers near to the data block You can freely cast them to pointers to access the data 13 1 EDR_AllocMem Parameter Type Comment num long Number of samples Returns long memory block handle or 0 if not enough memory Allocates a block of memory and returns its handle The size of the block will be at least num 2 bytes 157 EDR Software Development Kit Memory functions XMS 13 2 EDR_CopyFromMem Parameter Type Comment handle long Handle of memory block first long Starting sample to copy first in block is 0 num long Number of samples to copy buf unsigned Buffer for the samples Returns integer error code Error code Comment EDR_OK No err
122. nneennrrvsrrrnnneennrne 170 14 31 EDR Valid GateS Ounce ic vc cxceseussecsoeteietadvoseluics an savints een 171 14 32 EDR ValidInterruptID rooorsorvrsvssrrrsenennseranserersnnssesnrnrsssnneee 171 14 33 EDR ValidInterruptSource iss rsernresarsasssasannerssensesnsensesvennere 171 14 34 EDR V alid RODE ve ve 172 15 Default PUN CUONS wiiiccsiccdscescscsnesncccdsssstscsnscdsdscecescsecenisesdestcsscin III 15 1 EDR_DefaultADInGain saa saceedannesuvateeseateebavius oes taubedeaheaanetics 173 15 2 EDR Default A DIMR an Se x notable kite 173 15 3 EDR DetaultA DIGT ype ued cage SN 173 0 3 EDR DefaultDAOutFixedRef osnnrnrornnnvnrennrnvenrrrvnernnnnsennnn 174 15 5 EPR Default AQutR se GR 174 15 6 EDR DefaultDAOQutTriggerSource rrrrrrrrnnrnvrnrrrvsvrrnnneennrne 174 15 7 EDR_DefaultDMALevels ve vscesnceredvesmevaneedteuhoasenneceenoneceduncaenacets 174 15 8 EDR_DefaultIRQLevel Lae Gr 175 15 9 EDR GetCJCChannelNumber eoronnrnronnrnvnrrnnnnesnnrnnnrnnrnnsennrne 175 15 10 BDR NumlIOLocationssssagnganeennea r e 175 16 Interrupt functions e sssoesssooccssoccessooecsocsesooesssoossesosssssossese 170 0 4 EDR E ablelnterrupt ereina i a 178 16 2 EDR_GetInterruptSource sssesseeeseeeesseeesssresseresssresseressseesseee 178 16 3 EDR_InstallBoardISR van ve 179 16 4 EDR_InstalllSR des 179 16 5 EDR_MaskBoardIRQ seseseseessesesrrrerrrrrrrrrcrrrcrrrcrcrrerrerrrrereeeeeee 180 6 6 EDR MaskIRO gere 180 16 TEDR ReTiernp
123. nt boardtype integer Board type Returns integer A D input type code EDR SINGLEENDED or EDR DIFFERENTIAL Returns the default type of A D inputs 173 EDR Software Development Kit Default functions 15 4 0 3 EDR DefaultDA OutFixedRef Parameter Type Comment boardtype integer Board type Returns long microvolt value Return the default reference value for boards with pot selectable references 15 5 EDR DefaultDA OutRange Parameter Type Comment boardtype integer Board type chan integer Channel number Returns integer range code Returns the default output range for the specified D A channel 15 6 EDR DefaultDAOutTriggerSource Parameter Type Comment boardtype integer Board type Returns integer trigger source code codes listed in 17 9 Returns the default source of D A update triggers 15 7 EDR DefaultDMALevels Parameter Type Comment boardtype integer Board type pri integer Variable to hold default primary DMA level Sec integer Variable to hold default secondary DMA level 174 EDR Software Development Kit Default functions Gets default DMA settings for board If the board does not have DMA then pri and sec are set to 0 15 8 EDR_DefaultIRQLevel Parameter Type Comment boardtype integer Board type id integer Interrupt ID number Returns integer hardware IRQ level or 0 if none Returns 0 if the board does not support the specified interrupt function ID 15 9 EDR GetCJCChannelNumber Pa
124. nt _ _ _ _ EDR_ADC_MASTER O interalclockto ADC and ETRIG 17 8 D A update modes Constant Number Comment EDR IMMEDIATE 0 immediate update EDR PRELOAD buffered parallel update 188 EDR Software Development Kit Appendix A Constants 17 9 D A update trigger sources Constant Number _ Comment DR UTS SOFTWARE software triggering hardware from internal clock hardware from external clock E og EDR UTS CLOCK EDR UTS EXTCLOCK 17 10 Counter timer clock sources Constant Number Comment _ _ _ EDR_CS_PCIO64 O PCbusclock 64 PC14B EDR CS GND 4 ground PC30Fxx Gxx 17 11 Counter timer gate sources Constant Number Comment EDR CT SOFTGATE 0 normal counting controlled by s w DR CT EXTGATE counting controlled by pin on edge con DR CT ENABLED counting always enabled P C30F xx Gxx EDR CT DIVOUTPUT counter gated by divider output P C30F xx G xx 17 12 Counter timer gating Constant Number Comment EDR CT STOP O fstopcounter EDR CT COUNT 17 13 Counter timer modes Constant Number Comment a sd EDR CT INTONTC 0 Jinterrupt on terminal count EDR CT ONESHOT 189 EDR Software Development Kit Appendix A Constants EDR CT DIVIDEBYN EDR CT SQUAREWAVE 4 o normal mode for most AD and DA boards EDR CT SOFTSTROBE strobe triggered by software EDR CT HARDSTROBE strobe triggered by hardware Constant Number Comment EDR_CT_B
125. o be configured by changing jumpers on the board If TC interrupts cannot be used then the driver has to check on the transfer periodically At 200 KHz these checks have to be done at least every 10 ms to prevent data loss 195 EDR Software Development Kit Appendix C EDR SYS Event log messages 19 Appendix C EDR SYS Event log messages EDR SYS the Windows NT device driver reports errors and other information in the system event log This appendix lists all possible messages with explanations of each Num Type Text Explanation 1 Error The allocation of the driver object Not enough memory to load failed Possibly not enough memory EDR SYS 2 Error The name for this device could not Some other driver has given a device be created 2 Another driver the same name as an EDR SYS using the same name may already board be running 4 Error The driver could not create board EDR SYS was unable to create a 2 device for one of the boards This message is normally displayed along with another message giving reasons for the failure 5 Error Unable to read board 2 details from The board s settings in the registry are the registry corrupt You need to go to Control Panel and reconfigure your boards 6 Error Unable to map IO ports for board 2 The board s port addresses clash with There may be a conflict with another another device Change your board device base add
126. o the chip EDR has no way of knowing this if you program the chip directly and then use an EDR function to change something later 3 3 Parameters and data types The function descriptions in the following chapters all list their parameters in the same format Generic names are used for the type of each parameter rather than having a separate table for each language Here is a parameter listing for a hypothetical driver function called EDR_Function Parameter Type Comment i16 integer 16 bit integer sparam string Character string uarray unsigned Array of unsigned integers i16ptr integer Variable to hold a 16 bit integer i32 long 32 bit integer Returns integer error code 24 EDR Software Development Kit Programming guidelines Each of the following sections will show how to call this function from a different language and any special techniques required Note that the header files provided for each language are also useful references for the parameters required for each function and the calling syntax 3 3 1 Borland and Microsoft C C 16 bit The following information assumes that you are using the large memory model and are building a 16 bit application This table shows the correspondence between the listed parameter types and actual C C data types Parameter type C C parameter type integer int long long unsigned unsigned string char far integer int far long long far unsigned unsigned far Here is
127. o the version number of the VxD or 0 if it is not installed or is old version mismatch with EDR DLL If EDRVXD 386 is old then needed is set to the version required If it is not present at all or we are running under Windows NT then installed and needed will both be 0 70 EDR Software Development Kit Configuration functions 7 22 EDR_HasADGain Jumper Parameter Type Comment boardtype integer Board type code Returns integer result Error code Comment 0 Does not have a gain jumper 1 Does have a gain jumper Checks if the specified board type has an A D gain jumper e g PC73C that sets the gain for all A D inputs 7 23 EDR_InitBoard Parameter Type Comment bh integer Board handle baseaddr integer Base address of board Returns integer error code Error code Comment EDR_OK No errors EDR BADHANDLE Board handle is invalid Initialises a board and attaches it to a board handle Once a board has been initialised to a board handle it cannot be initialised to any other board handle until the handle is released using EDR_FreeBoardHandle 7 5 or a different board is attached to the handle When running under Windows the board is unavailable to other applications that use EDR You can use EDR_GetBoardType 7 11 to find out what board if any was detected at the base address and EDR_SetBoardType 7 36 to set the correct board type Windows NT This function resets the specified board back to its factory default state This m
128. oard if you have anything connected to its outputs 7 5 EDR FreeBoardHandle Parameter Type Comment bh integer Board handle Returns integer error code Error code Comment EDR OK No errors EDR BADHANDLE Board handle is invalid Windows NT This function is not required and is not supported Releases a board handle making it and any board attached to it available to other applications All board handles allocated by a program must be released before it terminates 62 EDR Software Development Kit Configuration functions Demos INIT PAS INIT C INIT BAS 7 6 EDR_GetADInGain Parameter Type Comment bh integer Board handle chan integer Channel gain integer Variable to hold gain Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid Gets the gain of the A D input 7 7 EDR GetADInRange Parameter Type Comment bh integer Board handle chan integer Channel range integer Variable to hold range code listed in 17 3 Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid Gets the range code for the A D channel specified 63 EDR Software Development Kit Configuration functions 7 8 EDR_GetADInRangeMinMax Parameter Type Comment bh integer Board handle chan integer Channel uvmin long Variable to hold lower end of range in microvo
129. ode listed in 17 8 Returns integer 0 invalid 1 valid Checks a D A update mode 14 27 EDR_ValidDAOutRange Parameter Type Comment boardtype integer Board type chan integer Channel number r integer Range code listed in 17 3 Returns integer 0 invalid 1 valid Checks a D A channel range 169 EDR Software Development Kit Validation functions 14 28 EDR ValidDAOutTriggerSource Parameter Type Comment boardtype integer Board type trig integer Update trigger source code codes listed in 17 9 Returns integer 0 invalid 1 valid Checks a D A update trigger source code 14 29 EDR ValidDMALevels Parameter Type Comment boardtype integer Board type pri integer Primary DMA level 0 if none sec integer Secondary DMA level 0 if none Returns integer O invalid 1 valid Checks validity of DMA jumper settings 14 30 EDR_ValidDIOPortConfig Parameter Type Comment boardtype integer Board type port integer Port number tmode integer Mode listed in 17 5 io integer Direction 0 output 1 input Returns integer 0 invalid 1 valid Checks the configuration of a digital port 170 EDR Software Development Kit Validation functions 14 31 EDR_ValidGateSource Parameter Type Comment boardtype integer Board type num integer Counter timer channel number src integer Gate source listed in 17 11 Returns integer O invalid 1 valid Checks if the specified gate source constant is valid for a particular c
130. ode Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid Gets the range code for the specified D A channel 67 EDR Software Development Kit Configuration functions 7 16 EDR GetDAOutRangeMinMax Parameter Type Comment bh integer Board handle chan integer Channel uvmin long Variable to hold lower end of range in microvolts uvmax long Variable to hold upper end of range in microvolts Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADCHAN Invalid channel Gets the microvolt range of an A D channel This function considers the range and the gain of the channel 7 17 EDR GetDAOutTriggerSource Parameter Type Comment bh integer Board handle source integer Variable to hold source for update triggers listed in 17 9 Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid Gets the source of D A update triggers for channels configured for EDR PRELOAD mode 68 EDR Software Development Kit Configuration functions 7 18 EDR GetDMA Levels Parameter Type Comment bh integer Board handle pri integer Variable to hold primary DMA level sec integer Variable to hold secondary DMA level Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid Gets the boards DMA level s If the board has no primary and or sec
131. of boards to find out what features a board has Most of these functions accept a board type number instead of a board handle 14 1 EDR HasADInClock Parameter Type Comment boardtype integer Board type Returns integer 0 has no A D clock 1 has A D clock Checks if a board supports hardware clocked A D using counter timers on the board 14 2 EDR HasBurstMode Parameter Type Comment boardtype integer Board type Returns integer 0 does not have burst mode 1 does have burst mode Checks to see if the board supports burst block mode A D input 14 3 EDR HasDAOutClock Parameter Type Comment boardtype integer Board type Returns integer 0 has no D A clock 1 has D A clock Checks if a board supports hardware clocked D A using counter timers on the board If it does then it can be used for waveform generation 161 EDR Software Development Kit Validation functions 14 4 EDR_HasDAOutIRQ Parameter Type Comment boardtype integer Board type Returns integer 0 has no D A IRQ 1 has D A IRQ Checks if a board can be programmed to generate an interrupt after each D A update trigger 14 5 EDR_HasSHH CParameter Type omment boardtype integer Board type chan integer Channel number Returns integer 0 no SSH on channel channel has SSH Checks to see if a channel is sampled simultaneously with other SSH channels when doing burst block mode A D If it is not then it is sampled just like non SSH channels 14 6 EDR_
132. of ini file for config info section string Section name in ini file Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_WRITEERROR Error writing to ini file Windows NT This function is not supported and always returns EDR_NOTIMPLEMENTED Windows 3 1x and Windows 95 only function This function is similar to EDR_SaveConfiguration but writes the info to a Windows ini file section and not to a binary file 7 32 EDR_SetADInConfig Parameter Type Comment bh integer Board handle chan integer Channel to configure range integer Input voltage range code listed in 17 3 adtype integer Input type code listed in 17 4 gain integer Input gain value Returns integer error code 71 EDR Software Development Kit Configuration functions Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADTYPE Type is invalid EDR BADCHAN Channel number is invalid EDR BADRANGE Range is invalid EDR BADGAIN Gain is invalid Configures an A D channel Note that for all A D boards currently supported EDR only the gain can be individually set This means that changing the type setting for one channel changes the type for all channels On the older series boards PC30B PC30D et al most of these parameters are set by jumpers and cannot be changed from software This function still needs to be called if you are using non default jumper settings to tell the driver what the s
133. oltage on the specified D A channel using a microvolt value 144 EDR Software Development Kit Analogue output functions 11 11 0 2 EDR DAOutVoltageReadback Parameter Type Comment bh integer Board handle chan integer Channel number uvolts long Variable to hold channel voltage in microvolts Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid Gets the last voltage set on the specified D A channel as a microvolt value Note that some boards do not support readback from the D A registers and EDR returns the last value written using EDR DAOutBinOneSample or EDR DAOutVoltage instead 11 12 EDR DAOutVoltageToBin Parameter Type Comment bh integer Board handle chan integer Channel number uvolts long Microvolt value bin unsigned Variable to hold binary value Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid EDR BADPARAM Voltage is out of range Converts a microvolt value for a specific DAC into a binary value for the DAC 145 EDR Software Development Kit Analogue output functions 11 13 EDR_DAOutVoltageToBinBlock Parameter Type Comment bh integer Board handle uvolts long Interleaved microvolt waveform s bin unsigned Buffer for interleaved binary waveform s num integer Total number of steps in all waveforms Returns integer erro
134. ondary DMA level then the corresponding variables will be set to 0 7 19 EDR_GetIRQLevel Parameter Type Comment bh integer Board handle id integer Interrupt ID number listed in17 19 irq integer Variable to hold hardware IRQ number Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADINTID Interrupt ID number is invalid Gets the hardware IRQ level for the interrupt ID specified 69 EDR Software Development Kit Configuration functions 7 20 EDR_GetSysVersion Parameter Type Comment major integer Variable to hold major version number minor integer Variable to hold minor version number build integer Variable to hold build number Returns integer error code Error code Comment EDR OK No error EDR BADPARAM Running under Windows 95 and not NT EDR VXDNOTPRESENT EDR SYS is not loaded Gets the version information for EDR SYS EDR SYS is the Windows NT kernel mode device driver half of the NT version of EDR This function always returns EDR BADPARAM under Windows 95 7 21 EDR GetVxD Version Parameter Type Comment installed integer Variable to hold installed version number needed integer Variable to hold version required Returns integer error code Error code Comment EDR OK No error Gets the version number of EDRVXD 386 EDRVXD 386 is the 32 bit virtual device driver part of the Windows 3 1x and Windows 95 version of EDR The installed parameter is set t
135. or EDR BADMEMHANDLE Memory handle is invalid EDR_NOXMS No XMS driver has been installed Copies data from the memory block into a buffer This is useful when you need to extract part of a data set to work on Note that all the parameters are in samples and the actual byte offsets and sizes will be double these 13 3 EDR_CopyFromMemToMem Parameter Type Comment srchandle long Handle of source memory block srcfirst long Starting sample in source num long Number of samples to copy desthandle long Handle of destination memory block destfirst long Starting sample in dest Returns integer error code Error code Comment EDR OK No error EDR BADMEMHANDLE Memory handle is invalid EDR NOXMS No XMS driver has been installed 158 EDR Software Development Kit Memory functions XMS Copies data from one memory block to another or to another location in the same block Note that all the parameters are in samples and the actual byte offsets and sizes will be double these 13 4 EDR_CopyToMem Parameter Type Comment handle long Handle of memory block first long Starting sample to copy to first in block is 0 num long Number of samples top copy buf unsigned Buffer holding the samples Returns integer error code Error code Comment EDR_OK No error EDR BADMEMHANDLE Memory handle is invalid EDR NOXMS No XMS driver has been installed Copies data from a buffer into a memory block Note that all the parameters are in samples and the a
136. ou should read the section for your language before looking at the other parts of this manual Chapter 3 gives general information on programming using the API It is important that you read and understand this chapter Chapter 4 describes how to use the A D input functions Chapter 5 describes how to measure temperatures Chapter 6 describes how to use the D A output functions Chapter 7 is a reference for functions for configuring and initialising boards Chapter 8 is a reference for functions that convert numeric error codes board names and so on into strings Chapter 9 is a reference for functions for analogue to digital input Chapter 10 is a reference for counter timer functions Chapter 11 is a reference for functions for do digital to analogue output Chapter 12 is a reference for functions for digital input and output Chapter 13 is a reference for functions for working with blocks of memory XMS for DOS Chapter 14 is a reference for validation functions Chapter 15 is a reference for default functions Chapter 16 is a reference for functions that install interrupt routines and control interrupt generation 12 EDR Software Development Kit Introduction 6 Appendix A lists all the constants used by EDR 6 Appendix B provides detailed information how to configure the VxD for maximum performance under windows 13 EDR Software Development Kit Building applications using EDR 2 Building applications using EDR
137. ounter timer channel and board 14 32 EDR_ValidInterruptID Parameter Type Comment boardtype integer Board type id integer Interrupt ID number Returns integer O invalid 1 valid Checks to see if the board supports the ID specified 14 33 EDR ValidInterruptSource Parameter Type Comment boardtype integer Board type id integer Interrupt ID number Returns integer 0 invalid 1 valid Checks to see if the board supports the interrupt source specified 171 EDR Software Development Kit Validation functions 14 34 EDR_ValidIRQLevel Parameter Type Comment boardtype integer Board type id integer Interrupt ID number listed in 17 17 irq integer Hardware IRQ level Returns integer O invalid 1 valid Checks an IRQ level 172 EDR Software Development Kit Default functions 15 Default functions The functions listed in this chapter return the factory default settings for different boards These functions all take a board type code as their first parameter Note that EDR_RestoreDefaults see 7 29 can be used to restore default settings to a board handle 15 1 EDR_DefaultADInGain Parameter Type Comment boardtype integer Board type Returns integer A D gain Returns the default gain of A D inputs 15 2 EDR DefaultADInRange Parameter Type Comment boardtype integer Board type Returns integer range code Returns the default range for A D input channels 15 3 EDR DefaultADInType Parameter Type Comme
138. ow sampling frequencies to be set by calling a function with a value in milli Hz The function calculates the correct values to write to the counter timer registers Note that most of these functions work with milli Hz values to avoid having to use floating point numbers All the counter timer channels on a board are numbered consecutively from 0 in chip order The channels on the first chip will be 0 1 and 2 and those on the second 3 4 and 5 for a board with two counter timer chips For convenience some constants have been defined that give the channels names These are listed in 17 11 10 1 EDR CTClockSource Parameter Type Comment bh integer Board handle num integer Counter timer number source integer Source of timers clock input listed in 17 10 Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADCHAN Counter timer number is invalid EDR BADPARAM Source parameter is invalid EDR BADBOARD Board cannot do function Sets the source the specified counter timer channels clock input Note that currently the only boards supported by EDR that supports this function are the PC14B the PC30Fxx and PC30Gxx On the PC30Fxx and PC30Gxx the valid source settings and their effects on the clock source and ECLK line are shown in the following table Note that the num parameter must be 0 or 2 for these boards Also remember that the EDR CTGateSource function sets the direction of the ECLK lin
139. pered for bipolar operation EDR inverts the binary data for bipolar DAC s before writing it out 6 3 Generating waveforms on D A channels If your board has hardware clocked D A then you can use EDR functions to generate waveforms The following points describe the function calls necessary for waveform generation 6 3 1 Setting the transfer mode The transfer mode defines how EDR transfers data from the PC to the DAC s when generating waveforms With the present version of EDR only program transfer polled IO is supported With this mode the CPU has to transfer the data to the D A channels and cannot do anything else The transfer mode is set by calling EDR_SetDATransferMode 11 23 with EDR_POLLED Windows Glitch free high speed waveform generation is not possible under Windows as control of the CPU may not be maintained for long periods of time DOS boxes always get to run 6 3 2 Choosing channels for the waveforms EDR maintains a channel list containing the channels that waveforms will be generated on EDR_SetDAChanListLen 11 20 can be used to empty the channel list EDR AddToDAChanList 11 1 i Position Waveform is used to add channels to the end of the list O DAC 1 voltage 0 6 3 3 Data format 1 DAC 2 voltage 0 2 DAG5 voltage 0 The waveform generation functions only 3 BG oaos 1 accept binary data You need to convert the 5 DAC5 voltage I FE FE voltage steps that make up the waveform into binar
140. ported Contact You may have an older version of Eagle Technology EDR SYS eagle eagle co za for an updated driver 15 Info Allocated 3K DMA buffer for board Informs you of the size of the DMA 2 buffer allocated for your board This will normally be 16K 197 EDR Software Development Kit 20 Index 32 bit 7 A D channels 39 A D data format 34 A D functions 91 aborting sampling 50 acquiring A D data 34 AlwaysBufferDMA 194 background sampling 40 background waveform generation 58 block A D input 35 block mode 40 board handles 22 board number 7 24 board numbers 22 23 boards supported 2 Borland C C DOS 13 Windows 18 Borland Pascal DOS 16 Windows 20 building applications 13 burst mode 40 bypassing EDR 24 calling EDR functions Borland Turbo Pascal 26 C C 25 Delpi 2 0 27 QuickBasic 29 Visual Basic 16 bit 30 198 Index 32 bit 32 channels to sample 39 circular buffer A D 42 configuration functions 59 configuring boards 7 constants 184 A D input types 187 ADC clock trigger settings 188 burst settings 188 counter timer clock sources 189 counter timer gate sources 189 counter timer gating 189 counter timer modes 191 counter timer numbers 191 D A update modes 188 D A update trigger sources 189 DIO port modes 191 DIO port settings 191 error codes 187 interrupt enable disable 192 interrupt ID s 192 IRQ mask values 192 noti
141. pported in this way This means that the highest sampling frequency possible is 18 2 Hz this is also the resolution of the timer 9 61 EDR_UVoltsToUAmps Parameter Type Comment boardtype integer Type of board uvolts long uV value from card uamps long Variable to hold uA result Returns integer error code Code Comment EDR OK No error EDR BADHANDLE Invalid board handle EDR BADBOARD Invalid board type Converts microvolt values read from mA boards e g the PC61 to actual microamp units 127 EDR Software Development Kit Analogue to digital input functions 9 62 EDR_ValidADBurstLen Parameter Type Comment bh integer Board handle burst integer Burst length or constant listed in 17 6 Returns integer error code Error code Comment 1 Burst length is valid 0 Burst length is not valid EDR BADHANDLE Board handle is invalid Checks the validity of a burst length 9 63 EDR_ValidADTransferMode Parameter Type Comment bh integer Board handle tmode integer Transfer mode to check listed in 17 5 Returns integer error code or result Error code Comment 0 Transfer mode is not valid 1 Transfer mode is valid EDR BADHANDLE Board handle is invalid Tests to see if a particular transfer mode is valid for the board in its current configuration 128 EDR Software Development Kit Counter Timer functions 10 Counter Timer functions These functions program the counter timer chips found on most boards They all
142. r EDR BADHANDLE Board handle is invalid Changes the disable all interrupts flag for waveform generation If this flag is on then all interrupts are disabled when waveforms are generated This flag should be turned on for high speed waveform generation gt I KHz Windows This flag is ignored by the Windows version of EDR 11 22 EDR SetDAKeyAbort Parameter Type Comment bh integer Board handle onflag integer 0 Turn off 1 turn on Returns integer error code 149 EDR Software Development Kit Analogue output functions Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid Changes the key abort flag for waveform generation If this flag is on then any keypress will stop waveform generation 11 23 EDR SetDATransferMode Parameter Type Comment bh integer Board handle tmode integer Transfer mode listed in 17 5 Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid Changes the transfer mode used by the waveform generation functions 11 24 EDR StopBackgroundDAOQut Parameter Type Comment bh integer Board handle num integer Variable to hold position in waveform cycles unsigned Variable to hold number of cycles done Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid This function is not supported by this version of EDR 150 EDR Software Development Kit Analogue output functions 1
143. r a particular mode and direction Note that ports on some boards may be fixed as inputs or outputs EDR only directly supports mode 0 EDR_DIO_SIMPLE with driver functions Other modes can be used but you will need to write your own support code 152 EDR Software Development Kit Digital input output functions 12 2 EDR DIOGetPortConfig Parameter Type Comment bh integer Board handle portnum integer Port number dmode integer Variable to hold mode listed in 17 15 io integer Variable to hold direction 0 output 1 input Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADPORT Port number is invalid Gets the current configuration for the port 12 3 EDR DIOLinelnput Parameter Type Comment bh integer Board handle portnum integer Port number linenum integer Line number or bit number value integer Variable to hold value of the line bit either 0 or 1 Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADPORT Port number is invalid EDR BADLINE Line number is invalid Gets the status of a single line bit in a digital input port If the port is an output port then the last value written to the line bit is returned 153 EDR Software Development Kit Digital input output functions 12 4 EDR DIOLineOutput Parameter Type Comment bh integer Board handle portnum integer Port number linenum
144. r code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR NOCHANS No channels in the channel list EDR BADNUM Invalid number of steps EDR BADCHAN Invalid channel in channel list EDR BADPARAM Out of range voltage found Converts microvolt waveforms into binary waveforms ready for EDR DAOutBin The channel for each waveform must be in the channel list 11 14 EDR GetDAChanListIndex Parameter Type Comment bh integer Board handle i integer Index of entry to get first is 0 Returns integer error code or the channel number at the specified position Error code Comment gt 0 Channel number EDR_BADHANDLE Board handle is invalid EDR_BADINDEX Index is invalid Gets an entry from the channel list 146 EDR Software Development Kit Analogue output functions 11 15 EDR GetDAChanListLen Parameter Type Comment bh integer Board handle Returns integer error code or the length of the channel list Error code Comment gt 0 Length of channel list EDR BADHANDLE Board handle is invalid Gets the number of channels currently in the channel list 11 16 EDR GetDADisableAllInts Parameter Type Comment bh integer Board handle Returns integer 0 flag is off 1 flag is on Gets the status of the disable all ints flag 11 17 EDR GetDAKeyAbort Parameter Type Comment bh integer Board handle Returns integer 0 flag is off 1 flag is on Gets the status of the key abort flag 11 18 EDR_GetD
145. r details The exception is data from the PC126 and PC127 which is converted from two s complement to offset binary by EDR before being stored in memory The binary data is usually scaled to voltages before processing EDR provides 2 scaling functions to convert from binary to voltages EDR_ADInBinToVoltage 9 9 converts single binary values into voltages EDR_ADInBinToVoltageBlock 9 10 converts blocks of binary values from multiple channels into voltages These scaling functions use the configuration information for the board input ranges gains etc to do the conversion so it is important that these settings are correct These functions actually return microvolt values instead of floating point data e g 1 5 V is returned as 1500000 UV This avoids the problems associated with the different floating point formats used by various languages Also integer values are faster to work with than floating point values 4 2 Simple A D EDR provides two simple functions that get the voltage on a single A D input channel EDR_ADInOneVoltage 9 11 reads the data and converts it to a voltage while EDR_ADInBinOneSample 9 8 returns the binary data Use these functions when exact timing is not important or when very slow sampling is required 33 EDR Software Development Kit Acquiring analogue data 4 3 Sampling blocks of A D data The block sampling functions samples blocks of accurately timed A D data using the timing hardware on the board
146. r graphed as required When the required number of samples have been collected EDR StopBackgroundADIn must be called See chapter 4 for more information on using this function Windows When dual channel DMA is used the number of samples collected will rise in jumps as blocks are completed These blocks may be up to 65536 samples in size so long pauses between increases in samples collected are possible 102 EDR Software Development Kit Analogue to digital input functions Windows 95 32 bit streaming to disk only You must call EDR_BackgroundADInStatus at regular intervals to ensure data is written to disk and the buffers do not overflow When doing high speed streaming in interval of 10 ms is OK The easiest way to do this is to set up a Windows timer to do the calls 9 16 EDR_BackgroundADInType Parameter Type Comment bh integer Board handle Returns integer transfer mode or error code Error code Comment EDR_INTR Interrupt sampling in progress EDR_SINGLEDMA Single channel DMA sampling in progress EDR DUALDMA Dual channel DMA sampling in progress EDR_STREAM Streaming in progress EDR_OK No background sampling EDR BADHANDLE Board handle is invalid Returns the type of A D sampling in progress on the board as a transfer mode code 9 17 EDR BackgroundADInWraps Parameter Type Comment bh integer Board handle Returns long number of wraps Windows only function For circular buffer streaming operations to disk or memor
147. r multiplexed input it calls the find function and outputs to port 0 You must configure port 0 as output before calling EDR_ADInPC81 Voltage Figure 11 shows the encoding used by EDR_FindPC81Channel The comparator on the PC81 compares the PC81 number field to the number set on the Single ended 9 81 7 61514 3 2 1 0 0 1023 PC81 s dip switches Switch Differential 8 7 6 5 4 3 2 1 0 0 511 1 on the PC81 is the least Seen s pie Multiplexed channel number PC81 Number PC81 Mux Input channel on A D board significant Switches 5 6 7 and 8 must all be off as unconnected address inputs Figure 11 Multiplexed channel encoding 51 EDR Software Development Kit Acquiring analogue data to the PC81A are pulled low For example If you call EDR_ADInPC81 Voltage with a channel number of 132 and your board is jumpered for single ended A D inputs then the PC81 with 517 256 2 set on its dip switches will be selected switch 3 on all others off The voltage could be read on channel 0 of the PC30 52 EDR Software Development Kit Measuring temperatures 5 Measuring temperatures This chapter describes EDR support for thermocouple linearization cold junction compensation and RTD measurement It is assumed that you have some knowledge of these concepts If not please refer to the hardware manual for your board before reading this chapter 5 1 Reading thermocouple and CJC voltages The volt
148. r of samples specified is invalid EDR_BADBOARD Board cannot do function EDR BADPARAM Invalid parameter detected Acquires a block of A D data from the channels in the channel list You should read chapter 4 before using this function This function uses the current sampling frequency burst setting and transfer mode It returns immediately after sampling has started The transfer mode cannot be EDR POLLFD You need to call EDR BackgroundADInsStatus periodically to check to see if the transfer has finished When the transfer has completed or if you need to stop it early you must call EDR StopBackgroundADIn This process is described in more detail in chapter 4 DOS The buffer for the binary data must be at least twice as big as for the number of samples required if EDR SINGLEDMA is being used 9 4 EDR ADInBinCircularBuffer Parameter Type Comment bh integer Board handle num long Length of the buffer in samples buf unsigned Buffer for data start unsigned Variable to hold position of first sample used in the buffer Returns integer error code 93 EDR Software Development Kit Analogue to digital input functions Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADTRANS Transfer mode is invalid EDR_NOCHANS There are no channels in the channel list EDR_BADCHAN The channel list contains an invalid channel number EDR_BADNUM The length of the buffer is invalid EDR_BADBOARD Board cannot do func
149. r timer boards The PC60 mV input and PC61 mA input boards The PC62B PC62C and PC65 optically isolated digital IO boards The PC104 72A Digital I O Board The PC104 30FG range of Analog Boards Not yet supported under Windows NT t Only supported under Windows NT As new boards are developed support will be added to the driver Note that some boards with different names such as the PC36 PC36B and the PC14 PC14A are identical from a software perspective These boards are given the same ID number in the driver PC36 and PC14 respectively The PC73A is unreliable in some fast computers 486 It has been replaced by the PC73C 8 TC or RTD inputs 8 digital outputs and 8 digital inputs 1 4 Features The major features of EDR include e Extensive A D D A DIO and configuration functions are provided EDR Software Development Kit Introduction e Polled interrupt single channel DMA and dual channel DMA data acquisition fully supported at full throughput e Software triggering level edge on multiple A D input channels Windows 3 1x and Windows 95 only e Speed critical routines such as polled sampling and waveform generation have been coded in assembler for maximum speed e Streaming to disk and memory using only one DMA channel This allows unlimited amounts of data to be collected from all boards with DMA e Circular buffer sampling has now been extended to work with interrupt sampling and streaming to memory and di
150. rameter Type Comment boardtype integer Board type Returns integer number of boards CJC channel or 1 if it has none Returns the number of the boards cold junction compensation channel if it has one or 1 if it does not 15 10 EDR NumIOLocations Parameter Type Comment boardtype integer Board type Returns integer number of IO locations Returns the number of IO locations addresses a board uses in the IO address space of the processor 175 EDR Software Development Kit Interrupt functions 16 Interrupt functions These functions can only be used from C C Borland Turbo Pascal and Delphi They cannot be used from 32 bit applications under Windows 95 or Windows NT These routines make it easy to set up a function that gets called when the board generates a particular interrupt The routine must be an interrupt service routine ISR and must preserve all registers The general procedure for installing an ISR for a board interrupt is as follows 1 Install the ISR with EDR_InstallBoardISR 2 Unmask the IRQ by calling EDR_MaskBoardIRQ with a mask value of 0 3 Interrupts from the board can now be enabled disabled using EDR Enablelnterrupt The following steps must be done to uninstall the ISR before the application terminates 1 Make sure the board will not generate interrupts by calling EDR Enablelnterrupt with 0 2 Mask the IRQ by calling EDR MaskBoardIRQ with a mask value of 1 3 Uninstall the ISR with EDR Unin
151. ransferMode 108 EDR GetADTrigger 110 EDR GetADTriggerType 111 EDR GetADUseTClInts 111 EDR GetBase 65 EDR GetBoardType 66 EDR GetCJCChannelNumber 176 EDR GetCTClockSource 135 EDR GetCTGateSource 135 EDR GetCTInitial Value 136 EDR GetCTInputFreqHz 136 EDR GetDAChanListIndex 147 EDR GetDAChanListLen 148 EDR GetDAClockmilliHz 136 EDR GetDADisableAlllnts 148 EDR GetDAKeyAbort 148 EDR GetDAOutFixedRef 66 EDR GetDAOutGain 67 EDR GetDAOutMode 67 EDR GetDAOutNumBits 163 EDR GetDAOutRange 68 EDR GetDAOutRangeMinMax 68 EDR GetDAOutRefChannel 164 EDR GetDAOutTriggerSource 69 EDR GetDATransferMode 148 EDR GetDMAaLevels 69 EDR GetFreeMem 161 EDR GetInterruptSource 179 EDR GetIRQLevel 70 EDR GetMemBlockSize 161 EDR GetNotificationMsg 112 EDR Software Development Kit EDR_GetNotificationWindow 113 EDR_GetStreamBlockSize 113 EDR_GetStreamBuffer 113 EDR_GetStreamFile 114 EDR_GetSysVersion 70 EDR_GetVxDVersion 71 EDR HasADGainJumper 71 EDR HasADInClock 162 EDR HasBurstMode 162 EDR HasDAOutClock 162 EDR HasDAOutIRQ 163 EDR HasDOReadback 157 EDR HasSHH 163 EDR InitBoard 72 EDR InitBoardType 72 73 EDR InstallBoardISR 180 EDR InstalllSR 180 EDR IsBaseAddressInUse 74 EDR LoadConfiglIni 75 EDR LoadConfiguration 74 EDR MaskBoardIRQ 181 EDR MaskIRQ 181 EDR MaxADlInThroughputHz 167 EDR MaxDAOutThroughputHz 167 EDR NextADInGain 164 EDR NextDAOutGain 165 EDR
152. rds or work with configuration information require a board handle or board number as their first parameter The board handle or board number defines which board is affected by the function call This scheme has several advantages There is no need for a select board function Working with parallel boards is much easier The Windows API itself uses handles for many of its own objects Different applications using EDR at the same time cannot interfere with each other Windows 3 1 1 Board handles Board handles are integers obtained by calling EDR_AllocBoardHandle see 7 1 32 bit applications running under Windows 95 should use board numbers instead see 3 1 2 Applications running under Windows NT have to use board numbers For compatibility reasons EDR_AllocBoardHandle always returns 1 under Windows NT Windows NT Ignore the rest of this section Read 3 1 2 on board numbers instead Once allocated a board handle must be initialised to a particular board before the board can be accessed This is done by calling EDR InitBoard 7 23 or EDR_InitBoardType 7 24 with the base address or EDR_LoadConfiguration 7 26 These functions link the board handle to the board and fill in configuration information for it The board handle can now be used to access the board using EDR functions 22 EDR Software Development Kit Programming guidelines EDR_InitBoard attempts to detect what board is present at the base address specified It is no
153. requency burst setting transfer mode streamer buffer and block size It returns immediately after sampling has started The transfer mode must be EDR STREAM You need to call EDR_BackgroundADInStatus periodically to check to see if the transfer has finished or an error has occurred When the transfer has completed or if you need to stop it early you must call EDR_StopBackgroundADIn This process is described in more detail in chapter 4 Windows 95 32 bits only You must call EDR_BackgroundADInStatus at regular intervals to ensure data is written to disk and the buffers do not overflow When doing high speed streaming in interval of 10 ms is OK The easiest way to do this is to set up a Windows timer to do the calls 9 59 EDR StreamToDiskCircularBuffer Parameter Type Comment bh integer Board handle num long Number of samples 125 EDR Software Development Kit Analogue to digital input functions Returns long error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADTRANS Transfer mode is invalid EDR NOCHANS There are no channels in the channel list EDR BADCHAN The channel list contains an invalid channel number EDR BADNUM The number of samples specified is invalid EDR BADBOARD Board cannot do function EDR BADPARAM Invalid parameter detected EDR NOSTREAMBUF Stream buffer has not been set DOS EDR CANTOPENFILE Unable to open or create streamer file Starts sampling data continuously
154. ress and reconfigure 7 Error Unable to connect interrupts for The board s IRQ levels clash with board 2 There may be a conflict another device Change your board with another device IRQ jumpers and reconfigure 8 Error Unable to allocate DMA adapter for The board s DMA levels clash with board 2 There may be a conflict another device Change your board with another device DMA jumpers and reconfigure 9 Warn Only able to allocate 4K DMA buffer You may get this message when for board 2 Starting EDR SYS from the command line A D sampling will be less reliable Start EDR SYS at boot time instead 10 Error Unable to allocate DMA buffer for You may get this message when board 2 DMA sampling Starting EDR SYS from the command unavailable line Start EDR SYS at boot time instead 12 Error Resource conflict between board 2 One or more of the board s port and one or more other devices addresses IRQ levels and DMA levels is clashing with another device Find 196 EDR Software Development Kit Appendix C EDR SYS Event log messages free settings jumper your board accordingly and reconfigure 13 Error Unable to detect board 2 Make Your board can be detected from Sure it is properly installed and software and was not found Make configured correctly Sure your board model and base address settings in Control Panel match its jumper settings 14 Error Board 2 not yet sup
155. riggerType bh 3 EDR EDGE FALLING 1000000 Trigger on a falling edge at 1000000 uv 1 V on channel 3 EDR SetADTriggerType bh EDR TRIG MID 30000 Capture 30000 samples after the start of the trigger scan EDR SetStreamBlockSize bh 1000 Note that the buffer size 100000 is a multiple of the block size and also of the number of channels being sampled EDR ADInBinCircularBuffer bh 100000 Start circular buffer background sampling into a 100 000 sample circular buffer When sampling stops 30000 samples will be on and after the trigger scan and 70000 before it 46 EDR Software Development Kit Acquiring analogue data Normally it is easiest to use buffer sizes and postsample figures that are multiples of the number of channels being sampled This avoids any messy half scans in the buffer You can call EDR_GetADTrigger 9 32 to find out if a channel has triggered yet and the position of the trigger if any in the buffer This information can be used to decide when sampling has completed i e when the required number of samples have been captured after the trigger The following pseudocode example shows this calculation if EDR GetADTrigger bh trig chan EDR_OK then trig trig trig mod EDR_GetADChanListLen bh done EDR_BackgroundADInStatus bh trig if done lt 0 then done done 100000 else done 0 Note how the trigger sample position trig is adjusted to the start of the scan containing the tri
156. riggers for D A channels configured for EDR PRELOAD mode 7 43 EDR SetDMA Levels Parameter Type Comment bh integer Board handle pri integer Primary DMA level or 0 if none sec integer Secondary DMA level or 0 if none Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADPARAM The DMA level s specified are not valid Sets the DMA level s EDR will use for the board These must match the boards jumper settings If DMA sampling does not work then there may be a mismatch 84 EDR Software Development Kit Configuration functions 7 44 EDR SetIRQLevel Parameter Type Comment bh integer Board handle id integer Interrupt ID number listed in 17 17 irq integer New hardware IRQ level Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADINTID Interrupt ID number is invalid EDR BADPARAM The IRQ level specified is not valid Sets the IRQ level EDR will use for the interrupt ID specified Interrupt ID s are used as some boards have several independent IRQ settings for different functions Using ID s avoids having a separate function for each type of interrupt This setting must match the boards jumper settings 7 45 EDR Version Returns integer version Gets EDR s version number as an integer Divide by 100 to get the major version number The remainder is the minor version number Example If EDR_Version returns 201
157. rrrrrrnnrnrersvrsnrrrennnernnne 164 14 11 EDR NumAD Inputs seduce at ation eer aiavatieekes 164 14 12 EDR NamCounters uuucedenssdalsb vdmlmtrumnish 165 14 13 EDR NumDAOutputs oessnvesennsssnnsssnnsssnnsennnssssnnsennssesnnessnnse 165 14 14 EDR NomDIOPortsLaasavavssta r te 165 14 15 EDR MaxADInThroughputHz esrorrororrvrernrrnernnrrnsrrrrnneennrne 166 14 16 EDR MaxDAOutThroughputHz eesernrrvnornnrnernnrrvernrrnneennrne 166 14 17 EDR_ValidADCClock Trig get eronrrrronrrvrernrrnernnrrvnrrrnnneennrne 166 14 18 EDR VakdADInGaituuvkdsvssssaeaee sanse 167 14 19 EDR Valid ADI Ran Ge is scclcoziuens csusteanden eneavsavancadeensucevsaadnesees 167 14 20 EDR_Valid ADIT ype sscccsssssseesssssseesssssssesscessseessessseeseesen 167 14 21 EDR_ValidBoardType unncio ied nde acd edews 167 14 22 EDR Valid Clock Source succes caectasdtieindsdesthieea isiels 168 14 23 EDR_ValidDAOutChan nw ccc ceeccccessecsseceeseecesecesseeeseneeeees 168 14 24 EDR ValidDAOutFixedRef roronroronnoroonnrennrnrennerenrerennessnnne 168 14 25 EDR ValidDAOutGan isemeesnersernnissstrsssresaskereseredeseder 169 14 26 EDR ValidDAOutMode eonroronrvrenrnrsnnereennrsnnrnsennesesresennessnnne 169 14 27 EDR ValidDAOutRange eeoonnovorennvnsennnnevennnvnssnnrnvesnnnvssennree 169 14 28 EDR ValidDAOQutTriggerSource rrrrannrrvnrrnvrnvennrrvsrrrnnnsennrne 170 14 29 EDR VildDMAEevds saved 170 14 30 EDR ValidDIOPortConfig srrroronnrnvonnrrvrrrnn
158. rrupt ID number listed in 17 17 onflag integer Enable 1 or disable 0 flag Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADINTID Interrupt ID number is invalid EDR BADPARAM Onflag parameter is invalid Enables or disables the specified interrupt on the board Note that this function just programs the boards registers so that it will will not generate the interrupt If the interrupt is masked then interrupts from the board will be blocked Disabling interrupts or enabling interrupts when they are already enabled may generate extra interrupts on some boards Make sure your ISRs are prepared to handle these rogue interrupts 16 2 EDR GetInterruptSource Parameter Type Comment bh integer Board handle id integer Variable to hold interrupt ID number listed in 17 17 Returns integer error code 178 EDR Software Development Kit Interrupt functions Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid Gets the source of interrupts from the board for boards with a programmable interrupt source such as the PC30F G models 16 3 EDR_InstallBoardISR Parameter Type Comment bh integer Board handle id integer Interrupt ID number listed in 17 17 isr void Pointer to ISR for the interrupt ID Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADPARAM Interrupt ID number is invalid
159. rt Some boards such as the PC26 and PC30 do not have an onboard oscillator These boards divide the PC s bus clock speed and use this as an input to the counter timer chip EDR assumes the bus clock speed is 8 MHz If yours is different then you need to call EDR_SetCTInputFreqHz or this routine will not produce correct frequencies The bus clock speed is not the same as the CPU clock speed Normally there is a BIOS setup option that lets you choose the bus clock speed as a function of the CPU clock speed e g CPU clock 5 Look for this option to calculate what your bus clock speed is 10 16 EDR_SetCTInputFreqHz Parameter Type Comment bh integer Board handle num integer Counter timer number hz long Input frequency in Hz Returns integer error code 138 EDR Software Development Kit Counter Timer functions Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Counter timer number is invalid Tells EDR what the input frequency of the specified counter timer usually the prescaler or counter 0 is This value is used by the EDR SetXXClockmilliHz functions Most cards have an onboard oscillator and this function need not be used However if you are using a board which does not or are using an external clock source you need to call this function 10 17 EDR_SetDA ClockmilliHz Parameter Type Comment bh integer Board handle millinz long Update frequency in milliHz for waveform generation Re
160. s initialised and configured with information stored in the system registry when EDR32 DLL is first loaded Windows 95 or when EDR SYS is loaded Windows NT Applications can restore the board to its registry defined state by calling EDR_ResetBoardNumber see x 3 1 2 1 Windows 95 If a 16 bit application is running and has initialised a board configured in Control Panel then that board cannot be accessed from 32 bit applications loaded after the 16 bit application 23 EDR Software Development Kit Programming guidelines If a 32 bit application is running then no 16 bit application loaded after it can initialise the same board However 16 bit applications loaded after the 32 bit application can access the board using its board number instead of allocating and initialising a board handle 3 2 Software register copies Many boards have some registers that are write only EDR keeps a copy of the last value written to these registers using an EDR function for use in future calls that may need this value This means that if you sometimes bypass EDR and program the board directly problems may occur when you do use EDR functions Example When configuring the direction of a port on an 8255 it is necessary to set the direction and mode of all 3 ports on the chip simultaneously EDR allows the direction of all programmable DIO ports to be set independently of each other To do this it needs to know the last configuration byte that was written t
161. s wincrt EDR If you get a unit file format error when compiling you application then you are using the wrong version of EDR Contact us if you get this error when using a version of Turbo Borland Pascal newer than 7 0 or Delphi newer than 3 0 The DOS demos in the C EDR EXAMPLES TPAS directory can be recompiled as Windows applications by adding wincrt to the uses clause of each one and rebuilding them using the Windows compiler 2 2 3 Visual Basic 16 and 32 bit If you are using VB 16 bit you just have to add EDR INCLUDE EDR BAS to your project If you are using VB 32 bit just add EDR32 BAS to your project The following demos each in directories off C EDR EXAMPLES VB show how to use EDR from Visual Basic Demo Comments wavein 16 bit Acquires and graphs waveforms from A D channels wavein32 32 bit Port of 16 bit wavein 20 EDR Software Development Kit Building applications using EDR logger 16 bit Simple voltmeter type application logger32 32 bit Port of 16 bit logger dio 16 bit Input values from and output values to DIO ports tempmetr 16 bit Simple temperature meter type application 21 EDR Software Development Kit Programming guidelines 3 Programming guidelines This chapter gives the basic information you will need to know to successfully program using EDR You should read this chapter before reading the rest of the manual 3 1 Board handles and board numbers All EDR functions that program boa
162. se the boards by setting jumpers so one operates as the master and the others as slaves all off the same A D clock The master should PC30Dxx and PGx PC30Fxx and PC30Gxx be jumpered so that Jumpers EDR_SetADCClockTrigger the clock strobes for Mee Mie NED parameter the ADC converter Master_ i in out EDR_ADC_MASTER i t EDR_ADC_SLAVE Figure 9 Master slave configuration are outputted on the external trigger line on the connector see figure 9 Each of the slaves should be jumpered for external clocking see figure 9 and the external trigger lines of all boards connected together The master board clocks the slave boards The newer PC30Fxx and PC30Gxx boards do not require any jumper changes as EDR_SetADCClockTrigger 9 42 can be used to configure ADC strobes as required All the normal sampling parameters for each board should then be set normally with the exception of the sampling frequency This only has to be set on the master as all the slave boards will use this clock Then start sampling on the slave boards using EDR_ADInBinBackground or one of the other background sampling functions and then on the master The slave boards will only begin converting when the master starts and stop when the master stops Each conversion strobe from the master will result in one 49 EDR Software Development Kit Acquiring analogue data channel being converted on each board The FIFO s on each board ensure that any conflict for DM
163. se this utility 1 6 3 1 Windows 95 specific information Remember that this utility only configures boards for use with 32 bit applications The settings for each board are stored in the Windows 95 registry and the boards are initialised when EDR32 DLL is first loaded by a 32 bit application The boards are not initialised when EDR DLL is loaded by a 16 bit application This allows 16 bit applications to run and initialise boards configured for 32 bit applications so long as no 32 bit applications have loaded EDR32 DLL If a 16 bit application is running and has initialised a board configured in Control Panel then that board cannot be accessed from 32 bit applications loaded after the 16 bit application EDR Software Development Kit Introduction If a 32 bit application is running then no 16 bit application loaded after it can initialise the same board However 16 bit applications loaded after the 32 bit application can access the board using its board number instead of allocating and initialising a board handle 1 7 DOS languages supported Each of the DOS languages has its own version of the EDR library and a header or interface file The header file tells the compiler what functions are in the library and the calling syntax for each function The library provides the actual code that is placed in you application at link time Each DOS language has its own directory that contains its library header file and demo programs The following DO
164. seTCInts Parameter Type Comment bh integer Board handle onflag integer 0 turn off 1 turn on Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid If this flag is on then all EDR will use TC terminal count interrupts to detect the end of blocks when doing dual channel DMA The board must be configured correctly for this to work On the new PC30Fxx and PC30Gxx series EDR SetInterruptSource see can be used to configure the board to generate TC interrupts On older boards PC30D et al this has to be done by changing jumpers on the board 120 EDR Software Development Kit Analogue to digital input functions DOS This flag has no effect on DOS sampling operations 9 52 EDR SetNotificationWindow Parameter Type Comment bh integer Board handle hwnd unsigned Handle of window to receive messages Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid Sets the window that will receive notification messages for the board If the hwnd parameter is 0 then no notification messages are sent Please note that you must call this function with 0 or another window handle before you destroy the window 9 53 EDR SetStreamBlockSize Parameter Type Comment bh integer Board handle blocksize integer Size of a streamer block in samples Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invali
165. sk This allows huge ring buffers to be created in memory or on disk e Interrupts are handled in a VxD under Windows 3 1x and Windows 95 This minimises Windows interrupt latencies Interrupt and DMA sampling can be done completely in the background e Status functions provide a samples done count for background sampling operations If 1000 samples have been acquired out of a block of 200000 then these samples can be processed while the rest of the data is acquired e Parallel boards are fully supported allowing 32 or 48 channel systems to be created Scaling functions convert binary values into voltages and visa versa e IRQ functions make it easy to write and install interrupt handlers from C and Pascal under DOS and Windows 16 bit only Thermocouple linearization functions are provided e Driver functions provide extensive error reporting 45 different error codes and parameter checking making it easier to debug programs e The DOS and Windows 16 and 32 bit versions of EDR provide the same API You only need to learn one set of functions for DOS Windows and Windows NT 1 5 EDR Driver structure There are 3 main versions of EDR for DOS Windows 3 1 95 and Windows NT respectively EDR Software Development Kit Introduction 1 5 1 DOS The DOS versions of EDR consist of libraries of compiled code that are linked into your executable at build time The same library of functions is provided in 3 different forms for C C Borlan
166. stallBoardISR The ISR itself must call EDR ResetInterrupt 16 7 just before it returns This function resets the interrupt latch on the card if any and sends an EOI end of interrupt command to the PC s interrupt controller Most of these functions use PC14B Interrupt interrupt ID numbers rather EDR INT EXTINPUT than IRQ levels These EDR MI SO MER ener EDR INT COUNTER 1 interrupt ID s are listed in EDR INT COUNTER 2 17 17 ID s provide a board 1st 8255 Port A port 0 EDR INT DIO independent interface For 1st 8255 Port B port 1 EDR INT DIO 1 2nd 8255 Port A port 3 EDR INT DI0 3 example EDR_INT_ADIN 2nd 8255 Port B port 4 EDR_INT_DIO 4 Figure 14 PC14B interrupt IDs always refers to the interrupt generated by a 176 EDR Software Development Kit Interrupt functions board when it has completed a conversion even if the board can generate several other interrupts Counter timer or digital IO generated interrupts are handled by adding the counter timer channel number or DIO port number to the base interrupt ID Figure 14 lists the interrupt ID s for the PC14B interrupts The demo programs FREQCNT and EXTINT show how to install ISRs for counter timer and external interrupts Some boards such as the PC30Fxx Gxx Interrupt source IDnumber PC30Fxx and PC30Gxx allow the End of A D conversion EDR INT ADIN End of DMA block TC EDR_INT TC ee St EDR INT COUNTER Fe Re is eine om EDR call Figure 15 PC30Fx
167. suring temperatures 5 3 Converting a TC voltage into a temperature EDR CalcTCmC 9 20 converts a microvolt value read from a TC channel into a temperature in milli C compensating for the ambient temperature at the junction block It requires that you specify what type of thermocouple is being used and the ambient temperature EDR supports 8 different TC types listed in 17 21 5 4 Converting a RTD voltage into a temperature EDR CalcRTDmC 9 19 converts a microvolt value read from a RTD channel into a temperature in milli C This function assumes that you are using our RTD auxiliary board 5 5 Using a non TC board to measure temperatures There is nothing to stop you from using a board with enough gain such as a PC30GA to measure temperature You can still use EDR_CalcTCmC to convert the voltages from the thermocouples into temperatures A channel connected to a CJC chip is not necessary if you can control the temperature of the junction block or have some other means of measuring it 54 EDR Software Development Kit Measuring temperatures 6 Generating voltages and waveforms EDR provides functions to set the voltages on D A channels and to generate waveforms Note that many boards do not support hardware clocked waveform generation on their DAC s e g PC30 series 6 1 D A Channel numbers 8 bit and 12 bit D A channels DACS are numbered from 0 16 bit channels are numbered from 16 even if the board only has 16 bit channe
168. t possible to do this with simple digital IO boards such as the PC36 without changing the state of the outputs This is not safe as the board may be controlling external equipment EDR InitBoardType takes an extra parameter specifying the type of board installed and does not make any attempt to check if it is present or not In addition EDR_LoadConfiguration does not attempt to check the board type if the board was originally initialised using EDR_InitBoardType All board handles allocated must be released using EDR_FreeBoardHandle 7 57 before the application terminates If a board handle is not freed then it is lost and any board initialised to it cannot be accessed using EDR The current version EDR supports up to 8 board handles When a board handle is initialised using EDR_InitBoard or EDR_InitBoardType the driver assumes that the board detected at the base address is jumpered for the factory default settings If any of the jumpers have been changed then the configuration functions in chapter 7 must be used to inform EDR of the correct settings 3 1 2 Board numbers Board numbers refer to boards configured via our control panel applet see 1 6 3 They are normally only available to 32 bit applications running under Windows 95 and Windows NT A board number can be used in place of a board handle when calling EDR functions When accessing a board via a board number there is no need to initialise the board using EDR_InitBoard The board i
169. tLength to make sure the string has enough space to hold the result For EDR functions a length of 80 is fine Example v r s Peering use AnsiString if using H SetLength s 80 space for result EDR StrBoardType PC30F PChar s now s PC30F with a chr 0 appended to it Here is the pascal function prototype for the example function function EDR_Function pl integer p2 PChar var p3 word var p4 integer pdS integer integer It could be called as shown in this code fragment var a b err c integer var s string var buf array 0 99 of word SetLength s 80 err EDR Function a PChar s buf 0 b c 28 EDR Software Development Kit Programming guidelines Note that the first location in the array buf is passed to EDR_Function not the actual array itself 3 3 5 Visual Basic 3 0 amp 4 0 16 bit This table shows the correspondence between the listed parameter types and actual Visual Basic data types Parameter type Visual Basic parameter type integer integer or long long or amp unsigned integer or string string or variable integer integer or variable long long or amp variable unsigned integer or variable Note that since Visual Basic does not support unsigned integers normal integers have to be used instead If a number higher that 32767 is required it has to be converted to a negative integer before being passed to the function as in the following code fragment
170. ta ea tase vandelae ske sve sacs 74 728 EDR Reset Board NUMER sc castacesee sdetertecscde he Busraaceneeseus sistaccedt 75 7 29 EDR_RestoreDefaults peenctctonchtan cee neasesseaet aeseiotigheaoacseeaeuene 75 7 30 DR SaveC Onis uration ais 2 siebsachesanetcetutecsnewnes Bumieaneeeees 76 7131 BEDR SAVE C ofre rots rosettes uarncvee cust e E a 77 TIL EDROSCADIMC OMB rads n einer csitcadeahat eats NT TT Veo ER SED NGI vara 78 7 34 EDR Ct uM RAIN Csi ov oa Sons taie dats eaten eave Dn tantra xtate 79 TIJ EDR S tADINT Ype ses asart a E A A esate 79 T36 EDR A SELB OAC Ty Pe senen erena a a N 80 7 317 BOR Ser A Quilon ens casinos cantata SSS 81 7 38 EDR SetDAQuthixcdRe f o c cssccceinecscessis sid ecatnorssedeaeceesnetdoace 82 7139 EDR Set A OutGaim ise iires a wate aan 82 740 EDR Set DA OUtM Ode is isicscosssdcaasadscssaseedusnantescsetaccadenteedsestvenedecs 83 7 41 EDR_SetDAOutRange HEN 83 7 42 EDR_SetDAOutTriggerSource mansnrrerrrrvrrernvnrennrrvsernrnnsernrsser 84 TAS EDR_SetDMALevels eee set dass 84 TAA EDR S4ROUE vek jussen Ak 85 TAS DIRE Ne 85 TAG EDR Version vassere eee 85 SAS UES PUN CONS oana aaan naai OD EDR P rseChanGamn isteti 88 SJEDR SUA Py Perene a s e EEEE it 89 8 3 EDR SB OAR PY Pe cit ieee itakora aan ER EEA ES 89 8 4 EDR_StrDATriggerSource rrrrvrrrnnrnvrrnrrvrrrrnenernnrnesrrrrnerennensennn 89 8 5 EDR cS DA Update M Ode susnrtainndaeemassedeestenenbeser 90 6 6 EDR STENA seedet eae hee 90 SA EDR OU
171. tatus function does not need to be called at any particular rate or even called at all if notification messages are used The VxD takes care of this task if configured correctly see appendix B Note that other programs may cause background streaming and dual channel DMA to fail if they are ill behaved and do not release the CPU for long periods of time EDRVXD 386 has been written so as to minimise this possibility but it is best to test your application with other programs it may run with to make sure that this does not happen Windows NT The status function does not need to be called at any particular rate or even called at all 4 7 1 Windows notification messages EDR can send messages to your application when background sampling operations complete and when channels trigger Unfortunately this feature cannot be used from languages such as Visual Basic that do not let you process messages directly Windows NT Notification messages are not yet supported These messages are sent to a window in your application EDR_GetNotificationMsg 9 35 gets the ID number used for all EDR messages See the description of this function for details on how the messages are formatted EDR_SetNotificationWindow 9 36 sets the 40 EDR Software Development Kit Acquiring analogue data window that receives messages for a particular board NOTDEMO C and STREAMER demonstrate the use of these messages from C and Delphi respectively 4 8 Circular buff
172. the specified A D input channel This is useful in situations where you need to work with binary data for speed or space reasons 9 14 EDR_AlignBuffer Parameter Type Comment buf unsigned Buffer holding data to be aligned num long Number of samples in buf first long Sample number to place first in buf Returns integer error code 101 EDR Software Development Kit Analogue to digital input functions Error code Comment EDR_OK No error EDR MEMERROR Not enough memory for temp buffer Windows only This function shifts all the data in the specified buffer around so the sample specified by the first parameter occupies the first position in the buffer This is useful when doing circular buffer sampling where the oldest sample is often somewhere in the middle of the buffer 9 15 EDR BackgroundADInStatus Parameter Type Comment bh integer Board handle Returns long number of samples collected so far or negative error code If the return value is lt 0 then an error has occurred and the return value holds the error code Error code Comment EDR BADHANDLE Board handle is invalid EDR BADPARAM Undefined error EDR WRITEERROR Error writing to streamer file EDR BUFFEROVERRUN Streamer buffer has overflowed Reports the number of samples that have been collected for the background A D transfer in progress on the board If no transfer is in progress then 0 is returned These samples are actually present in the buffer and can be processed o
173. then you are using EDR version 2 01 Demos INIT PAS INIT C INIT BAS 7 46 EDR Version32 Returns integer version of EDR32 DLL 85 EDR Software Development Kit Configuration functions Gets EDR32 s version number as an integer Divide by 100 to get the major version number The remainder is the minor version number This should be the same as EDR Version 86 EDR Software Development Kit String functions 8 String functions Each of these function convert numeric codes for ranges board types etc into strings They are useful for displaying error messages and so on If the numeric code passed to the function is invalid the string returned is always Error There is also a 32 bit only function to parse a channel gain edge level string into arrays of values QuickBasic You must fill your string with enough spaces to hold the result of the call before calling the function The built in function SPACES is useful for this Afterwards use the RTRIM function to remove excess spaces Here is part of a subroutine to print error messages taken from INIT BAS s SPACES 80 make space in string for message EDR StrError error s convert error number into a string s RTRIMS s get rid of extra spaces Visual Basic You must fill your string with enough spaces to hold the result of the call before calling the function The built in function SPACE is useful for this EDR will store the result in the string
174. tion EDR BADPARAM Invalid parameter detected Starts sampling data continuously into the buffer specified When the end of the buffer is reached sampling continues from the beginning without missing any data This process can continue indefinitely Use EDR BackgroundADInsStatus to see how far sampling has progressed on the current pass and EDR StopBackgroundADIn to stop sampling This function only works with a transfer mode of EDR SINGLEDMA under DOS Under Windows 3 1x Windows 95 and Windows NT it also works with EDR INTR and EDR STREAM DOS Due to DMA alignment restrictions discussed in chapter 4 the buffer must be at least twice as long as the num parameter The start parameter will be set to the number of first sample used in the buffer When EDR_StopBackgroundADIn is called EDR shifts the data in the buffer back down Windows The buffer need not be any bigger than the num parameter and the start variable will always be set to 0 9 5 EDR ADInBinMem Parameter Type Comment bh integer Board handle num long Number of samples buf long Handle of buffer for data 94 EDR Software Development Kit Analogue to digital input functions Returns long error code or the number of samples acquired If the return value is gt 0 then that many samples were acquired Otherwise it holds one of the following error codes Error code Comment EDR BADHANDLE Board handle is invalid EDR BADTRANS Transfer mode is invalid EDR NOCHANS Ther
175. to hold clock trigger setting listed in 17 7 Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid Gets the current A D clock source setting 9 24 EDR GetADChanListIndex Parameter Type Comment bh integer Board handle i integer Index of entry to get first is 0 106 EDR Software Development Kit Analogue to digital input functions Returns integer error code or the channel number at the specified position Error code Comment gt 0 Channel number EDR BADHANDLE Board handle is invalid EDR BADINDEX Index is invalid Gets an entry from the channel list 9 25 EDR GetADChanListLen Parameter Type Comment bh integer Board handle Returns integer error code or the length of the channel list Error code Comment gt 0 Length of channel list EDR BADHANDLE Board handle is invalid Gets the number of channels currently in the channel list 9 26 EDR GetADChanTrigger Parameter Type Comment bh integer Board handle chan integer Channel number sample long Variable to hold sample number Returns integer error code 107 EDR Software Development Kit Analogue to digital input functions Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR NOTRIGGER No trigger has been detected yet EDR BADCHAN Invalid channel number EDR BADBOARD Board type is invalid Returns the trigger sample number for a particular channel If more than one channel tr
176. treamBuffer Parameter Type Comment bh integer Board handle buf unsigned Variable to hold a pointer to the streaming buffer 113 EDR Software Development Kit Analogue to digital input functions Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid Gets a pointer to the streamer buffer This function cannot be used from QuickBasic or Visual Basic as these languages do not support pointers 9 39 EDR GetStreamFile Parameter Type Comment bh integer Board handle filename string Variable to hold the filename Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid Gets the name of the current stream file 9 40 EDR PadFile Parameter Type Comment filename string Name of file to pad filelen long Required length of file in samples Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR CANTOPENFILE Unable to open create the file EDR WRITEERROR Error padding the file Expands or contracts the file as needed 114 EDR Software Development Kit Analogue to digital input functions 9 41 EDR SetADBurstLen Parameter Type Comment bh integer Board handle burst integer Burst length or constant listed in 17 6 Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADBURST Burst length is invalid Sets the burst len
177. turns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADBOARD Board does not have hardware clocked D A output EDR BADFREQ Frequency specified is invalid Programs the appropriate counter timer channels to achieve the D A update frequency specified The counter timer channels are configured by this routine so there is no need to call EDR CTConfigure Note that the frequency programmed may differ slightly from the requested frequency Call EDR GetDAClockmilliHz to get the actual programmed frequency This effect is most noticeable when setting high or very low frequencies Note that on some boards e g PC126 and PC127 the A D and D A timing circuitry share a common prescaler This means that change the D A frequency may affect the A D frequency and visa versa EDR tries not to change the prescaler but this is not always possible if the D A and A D frequencies are far apart 139 EDR Software Development Kit Analogue output functions 11 Analogue output functions 11 1 EDR_AddToDAChanList Parameter Type Comment bh integer Board handle chan integer Channel Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR TOOMANYCHANS Too many channels in the list EDR BADCHAN Channel number is invalid Adds a channel to the end of the channel list increasing its length by 1 11 2 EDR BackgroundDA OutStatus Parameter Type Comment bh
178. type integer integer long longint unsigned word string string integer var integer long var longint unsigned var word Here is the pascal function prototype for the example function function EDR Function pl integer p2 string var p3 word var p4 integer pdS longint integer It could be called as shown in this code fragment var a b err integer var s string var buf array 0 99 of word var c longint err EDR_Function a s buf 0 b c Note that the first location in the array buf is passed to EDR_Function not the actual array itself 3 3 4 Delphi 2 0 amp 3 0 32 bit All value parameters have been expanded to 32 bits All pointers to 16 bit quantities except actual samples have been expanded to 32 bits This table shows the correspondence between the listed parameter types and actual Delphi 2 0 data types 2 EDR Software Development Kit Programming guidelines Parameter type Delphi 2 0 parameter type integer integer long integer unsigned cardinal string PChar integer var integer long var integer unsigned var cardinal Pointers to sample buffers are left in 16 bit form This means that an unsigned becomes a var word Special care has to be taken when using EDR functions that return information in strings You need to use a long string variable AnsiString to hold the result By default variables declared as string are long strings H compiler option You also need to call Se
179. uld be the window handle of the window creating the dialogue This window will be disabled while the dialogue is displayed Returns integer error cod e Error code Comment 0 Cancel pressed 1 OK button or enter pressed to exit dialogue box EDR BADHANDLE Board handle is invalid colour DOS Base address hex 0700 Type PC30GA A D input Sande E Setup channei 0 12 ba Seto ir 8 2 D A output Range 10v to 10v 2 Digital 0 7 Trig Setup port CO Use TC ints for dual DM Port IRQ Counter Timers Setup channel IRQ Clock src Enctory default Figure 13 Windows EDR configuration dialogue box Interrupts Interrupt source Windows NT This function is not supported Configure your boards from Control Panel Displays a dialogue box that allows the user to configure the driver for his board Figure 13 shows the dialogue box displayed by the Windows version 60 EDR Software Development Kit Configuration functions of this function This DOS dialogue box is less comprehensive due to memory restrictions You should call EDR_LoadConfiguration or EDR_InitBoard before calling this function If this is not done then the base address field will be 0 and this may confuse the user DOS It is important that your programs stack size be at least 1200 bytes greater than what you need if you call this function as EDR stores the screen under the dialogue
180. umber is invalid EDR BADGAIN Gain is invalid Configures the gain for a D A channel Note that this function uses actual gain values e g 1 or 2 and not gain codes 82 EDR Software Development Kit Configuration functions 7 40 EDR SetDAOutMode Parameter Type Comment bh integer Board handle chan integer Channel to configure tmode integer Update mode for the channel listed in 17 5 Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADCHAN Channel number is invalid EDR_BADMODE Mode is invalid Configures the update mode for a D A channel See EDR_SetDAOutConfig for an explanation of D A update modes 7 41 EDR_SetDAOutRange Parameter Type Comment bh integer Board handle chan integer Channel to configure range integer Output voltage range listed in 17 3 Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_BADCHAN Channel number is invalid EDR_BADRANGE Range is invalid Configures the voltage range for a D A output channel 83 EDR Software Development Kit Configuration functions 7 42 EDR_SetDAOutTriggerSource Parameter Type Comment bh integer Board handle source integer Source for update triggers codes listed in 17 9 Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADPARAM Update source is invalid Sets the source of update t
181. umper settings in this case Check your board manual before trying to change a setting with software The update mode setting can be EDR IMMEDIATE or EDR PRELOAD If immediate mode is selected then any writes to the D A channels are immediately reflected as voltage changes on the outputs If preload or parallel mode is used then the output voltage is only updated when an update trigger occurs This trigger can come from several hardware sources see EDR SetDAOutTriggerSource or can be generated by software This feature can be used to change the voltage on several channels simultaneously The gain parameter is an actual gain value e g I or 2 not a gain code 81 EDR Software Development Kit Configuration functions 7 38 EDR SetDAOutFixedRef Parameter Type Comment bh integer Board handle uvolts long Fixed reference voltage in microvolts Returns integer error code Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADPARAM Reference voltage is invalid Sets the reference voltage used to convert voltages into binary codes for D A channels This is only used when the D A channel range is set to EDR RANGEFVU or EDR RANGEFBU pot selectable as with the PC66 7 39 EDR SetDAOutGain Parameter Type Comment bh integer Board handle chan integer Channel number gain integer Gain value Returns integer Error code Comment EDR OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel n
182. uvv2v4v44rvrvr er 181 16 8 EDR Setinterripts Ouree a cssebdas ounces GREENE 181 16 9 EDR SetIntteruptMode meeis essvserersreasernsensvnetnesensensennenetenesr 182 16 10 EDR UninsallBosrdSRikavssvaaekardkndsite 182 16 11 EDR_UninstalllSR su sddeteiskadaeeoessneknvnnletr 182 17 Appendix A Constants cccccsscccssssssssccscssessssccsssssssssccees 184 LE Board types eee 184 172 Erro COGS SEE EE RE EN 186 SVs rn AS 187 TJA D APU LY PES soso 474 188 17 5 Transfer Modes vr vl 188 IE SEE EE EEE 188 17 7 ADC clock trigger seng Siccssid sce tvecscBesolencelundeebecoosisbenteuseebsactes 188 17 8 D A pd te Mod sa 188 17 9 D A update trigger SOuUrces eeesseesseeeessereseseesserssssresseressseesse 189 17 10 Counter timer clock SOUTCES v3 co dscsecuceessduetececavencageenadernetanesies 189 17 11 Counter timer gate SOURCES i achencacteeanritenenes ie atatenneteitess 189 1731 2 Counter Mer sanne svavjadedas Jade 189 17 13 Counter timer modes 9 cecassnt ost ai ioaicon eniusetecadsem edu 189 17 14 Counter timer MUMIDEES 00 necdevesatan Garcia cavedeth ra cqyatetneep es 190 17 15 DIO port mode vr 190 FANON port Seting Sonreesse re renier e Eer E EER EERE ENS 190 LIT Interrupt DS reter a e E EEE EE 191 17 18 Interrupt enable and disable values srrrrronnrnvonnrrnnrvrnnnvennrne 191 17 19 IRO Task Valle S a e en a iaaah 191 17 20 Notification CODES cicer EE 191 1721 Thermos RAN 191 EAE DUR 192 17 23 Trigger edge SCL Ss soscc
183. x Gxx interrupt EDR SetInterruptSource 16 8 with an interrupt ID corresponding to the interrupt type you want to receive Figure 15 lists interrupt ID s and types sources DOS Generally the only thing you should do in an ISR is update global variables You should not call any DOS functions this includes runtime library functions that call DOS from within the ISR unless you really know what you are doing You can call most EDR functions safely Do not call any EDR functions that do disk access as these functions use DOS Windows Any interrupt handlers installed by these functions must be in a fixed code segment The easiest way to do this is to put the ISR in a fixed code segment in a DLL Note that interrupt latencies for interrupts handled in this way ring 3 may exceed I millisecond The interrupt service routines built in to EDR are in a VxD EDRVXD 386 mainly to reduce this latency time Windows Also remember that the only Windows API function you can safely call from an ISR is PostMessage You can call most EDR functions except those that do disk access If you are using the PC73A you should turn off all sampling delays as explained in EDR_SetADNoDelay 9 48 EDR does a PeekMessage loop if it has to delay for a while This causes Windows to crash if done from an ISR 177 EDR Software Development Kit Interrupt functions 16 1 0 4 EDR Enablelnterrupt Parameter Type Comment bh integer Board handle id integer Inte
184. y this function returns the number of times the transfer has completely filled the destination buffer i e wrapped round to the start from the end of the buffer For other transfers and DOS the return value is undefined 103 EDR Software Development Kit Analogue to digital input functions Note You must call EDR_BackgroundADInStatus before calling this function or the wrap count will be incorrect 9 18 EDR CalcCJCmC Parameter Type Comment bh integer Board handle cjcuv long Voltage from CJC chip in microvolts ambientmc long Variable to hold temperature of junction block in milli C Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid Converts a microvolt value read from a cold junction compensation chip into a temperature This temperature is needed to compensate for the effect of the junction block temperature on the voltages read from thermocouples connected to it 9 19 EDR_CalcRTDmC Parameter Type Comment rtduv long Voltage from RTD channel in microvolts rtdmc long Variable to hold temperature of RTD in milli C Returns integer error code Error code Comment EDR OK No error Converts a microvolt value read from a RTD channel into a temperature The value is divided by 10 to get the resistance of the RTD in accordance with the auxiliary boards supplied with the PC73B and PC73C 104 EDR Software Development Kit Analogue to digital input functions 9 20 E
185. y board settings EDR_LoadConfiguration can be used to initialise a board from a configuration file Demos DIOLOOP C DIOLOOP PAS DIOLOOP BAS 7 25 EDR_IsBaseAddressInUse Parameter Type Comment baseaddr integer Base address to check Returns integer 1 if base address is being used 0 if not Checks to see if any boards initialised with EDR are using the specified IO port address Windows NT This function is not supported and always returns 0 73 EDR Software Development Kit Configuration functions 7 26 EDR_LoadConfiguration Parameter Type Comment bh integer Board handle filename string Name of the file holding the config info Returns integer error code Error code Comment EDR_OK No error EDR_BADHANDLE Board handle is invalid EDR_NOFILE Unable to open file EDR READERR Error reading from file Other lt 0 codes Configuration file is corrupt or does not match card at base address Windows NT This function is not supported and always returns EDR NOTIMPLEMENTED Loads details of a board s configuration from a file created by EDR_SaveConfiguration This function looks for a board at the specified base address and attempts to detect its type If the correct board is found at the address then it is configured using the info in the file If not whatever board is at the address if any is initialised and the driver assumes factory default configuration and returns an error code This function can be used instead of E
186. y values before calling these functions Figure 12 Waveform The microvolt values for the waveform for format 56 EDR Software Development Kit Measuring temperatures each channel must be interleaved Figure 12 shows how voltages for waveforms for channels 1 2 and 5 would be interleaved EDR_DAOutVoltageToBinBlock 11 13 can then be called to convert these microvolt waveforms into binary waveforms The binary data is interleaved in the same way The actual format for each binary voltage depends on the board in use see your board manual for details 6 3 4 Waveform frequency The frequency of the waveform depends on the D A update frequency set using EDR_SetDAClockmilliHz 10 17 and the number of voltage steps making up the waveform EDR_SetDAClockmilliHz sets the frequency of D A update strobes One step is done for each D A update strobe so the frequency of the waveform is the strobe rate number of steps 6 3 5 Generating the waveform EDR_DAOutBin 11 4 will generate the waveform This function can generate the waveform a set number of times or continuously until a key is pressed For glitch free high frequency waveform generation gt 1 KHz all interrupts must be turned off This behaviour is controlled using EDR_SetDADisableAllInts 11 21 Windows Glitch free high speed waveform generation is not possible under Windows as control of the CPU may not be maintained for long periods of time DOS boxes always get to run no matt
187. your board manual for details on the format of the data Note that data from the PC126 and PC127 is converted from 2s complement to offset binary by EDR Data from the PC73A is converted to 2s complement by EDR You can use EDR_ADInBinToVoltage to convert the binary value to a microvolt value Some boards such as the PC73A require long delays after the channel mux is set to allow for the multiplexor s setting time This function includes these delays EDR_SetADNoDelay for details on how to overlap these delays with other processing 9 9 EDR_ADInBinToVoltage Parameter Type Comment bh integer Board handle chan integer Channel number uvolts long Variable to hold microvolt value bin unsigned Raw binary data from the board 98 EDR Software Development Kit Analogue to digital input functions Returns integer error code Error code Comment EDR_OK No error EDR BADHANDLE Board handle is invalid EDR BADCHAN Channel number is invalid Converts a binary sample to a microvolt value The current gain and range settings for the channel are used to do the conversion This function is very fast as integers are used for all calculations 9 10 EDR ADInBinToVoltageBlock Parameter Type Comment bh integer Board handle uvolts long Buffer for the microvolt values bin unsigned Buffer with binary data or part of it num long Number of samples to convert firstsample long Number of the first sample if part of a larger data set or 0 R

User Manual - EAGLE Technology

Contents

Download Pdf Manuals

Related Search

Related Contents