Meilhaus Electronic Manual ME E. Digital I/O Board for ISA Bus

Transcription

1 Meilhaus Electronic Manual ME E Digital I/O Board for ISA Bus

2 Imprint Manual ME-80 Revision 2.0E Revised: Meilhaus Electronic GmbH Fischerstraße 2 D Puchheim/Munich Germany Copyright 30. November 1999 Meilhaus Electronic GmbH All rights reserved. No part of this publication may be reproduced or distributed in any form whether photocopied, printed, put on microfilm or be stored in any electronic media without the expressed written consent of Meilhaus Electronic GmbH. Important note: The information contained in this manual has been reviewed with great care and is believed to be complete and accurate. Meilhaus Electronic assumes no responsibility for its use, any infringements of patents or other rights of third parties which may result from use of this manual or the product. Meilhaus Electronic assumes no responsibility for any problems or damage which may result from errors or omissions. Specifications and instructions are subject to change without notice. IBM and IBM PC AT/XT are trademarks of the International Business Machines (IBM) Corporation Borland Delphi is a trademark of Borland International Inc. Turbo/Borland C is a trademark of Borland International Inc. Visual C++ and VisualBasic are trademarks of the Microsoft Corporation. HP VEE is a trademark of Hewlett-Packard ME-VEC is a trademark of Meilhaus Electronic GmbH Other company names and product names found in the text of this manual are also trademarks of the companies involved.

3 Manual ME-80 Rev. 2.0E Table of Content 1 Introduction Package Contents Features System Requirements Important Note for ISA Models Available Software Installation Hardware Installation Locations of the Jumpers Jumpers Settings Base Address Interrupts Default Settings Driver Installation under Windows 95/98/NT Initial Installation under Windows95/98/NT Updating the Board Driver Changing Board Settings Uninstall Uninstall a Single Board Uninstall the Driver System Hardware Block Diagram General Notes Operation Modes Digital Input/Output Bit Pattern Compare Trigger Modes Switching Register Description Test Program Programming High Level Language Programming Example Programs HP VEE Programming User Objects HP VEE Example Programs The "ME Board"-Menu Meilhaus Electronic Page 3 Table of Content

4 Rev. 2.0E Manual ME LabVIEW -Programming Virtual Instruments LabVIEW Example Programs Register Programming Initialisation Simple Input Simple Output Interrupt Operation Function Reference Functional Overview of the 32 Bit Driver Naming Conventions Description of the API Functions General Functions Digital Input/Output Interrupt Handling Error Handling Appendix A Specifications B Pinout B1 37pin D-Sub female connector C Accessories D Technical Questions D1 Hotline D2 Service address D3 Driver Update E Index Table of Content Page 4 Meilhaus Electronic

5 Manual ME-80 Rev. 2.0E 1 Introduction Valued customer! Thank you for purchasing the ME-80 data acquisition board. You have chosen an innovative high technology board that left our premises in a fully functional and new condition. Please take the time to examine the contents of the package for any loss or damage that may have occurred during shipping. If there are any contents missing or if an item is damaged, contact Meilhaus Electronic immediately. Before you install the board in your computer, read this manual carefully, especially the chapter describing board installation. Pay careful attention to the instructions on how to set the dip switches and jumpers on the board. This will save you having to open your PC case again. 1.1 Package Contents We take great care to make sure that the package is complete in every way when it is shipped. We do ask, that you take the time to examine the contents of the box. Your ME-80 package should consist of: ME-80 This manual 1.2 Features ME-8x driver system for Windows 95/98/NT: 1 disk (3,5 HD) ME-8x Driver System 37pin D-Sub male connector The ME 80 is a high speed digital I/O board for the ISA bus. The 32 digital I/O lines can be configured as 16 or 32 bit ports. Each port can be independently programmed as input or output. A port configured as input can latch the data lines on an internal or external trigger signal. Meilhaus Electronic Page 5 Introduction

6 Rev. 2.0E Manual ME-80 The ME-80 offers a simultaneous 32 bit wide input/output and a 32 bit wide bit pattern comparator which can generate an interrupt on a bit pattern match. The interrupt channels 2, 3, 5, 7, 10, 11, 12 and 15 can be selected by jumpers on the board. An interrupt can also be generated by an external trigger pulse. The software included allows quick integration of the board into user measurement and control applications running under Windows 95/98/NT. Drivers and demo programs are available for HP VEE (Hewlett-Packard) and LabVIEW (National Instruments) both under Windows 95/98/NT. Drivers for Windows 3.1 and DOS are available upon request. 1.3 System Requirements The ME-80 can be installed into any IBM AT/386/486, Pentium or compatible computer. One free ISA 16 bit bus slot is required. 1.4 Important Note for ISA Models For computers with a PCI bus and a BIOS which supports Plug&Play make sure to reserve the interrupt lines for the ISA bus in the BIOS for any boards requiring the interrupt functions. The BIOS menu will vary depending on the manufacturer (consult the motherboard documentation on how to do this). If the interrupt lines are not reserved in the BIOS, the interrupt function will not be guaranteed!! Also note that on some newer computers the frequency on the ISA bus will be more than the specified 8 MHz. Proper functioning of the boards is not guaranteed if this is the case. Check the BIOS setup of your computer to make sure. To avoid excess electrical "noise" the board should be installed in an ISA slot as far away from the video board as possible. Introduction Page 6 Meilhaus Electronic

7 Manual ME-80 Rev. 2.0E 1.5 Available Software Windows 95/98/NT 4.0 Windows 3.x MS-DOS ME-8x system driver on request on request High level languages 32 bit (included) Visual C++ V 4.0 or higher Delphi V 2.0 or higher Visual Basic V 4.0 or higher Graphical programming environments (optional) Test and demo software (included) Meilhaus HP VEE Driver System for HP VEE V3.2 or higher ME-80 Driver System for LabView V4.0 or higher For the newest versions and latest software releases, please consult the README file on the driver disk(s) supplied. Meilhaus Electronic Page 7 Introduction

8 Rev. 2.0E Manual ME-80 Introduction Page 8 Meilhaus Electronic

9 Manual ME-80 Rev. 2.0E 2 Installation 2.1 Hardware Installation Locations of the Jumpers W1 W2 W3 IRQ ADR W5: Interrupt W4: Base address 37pin D-Sub female connector Diagram 1: Simplified illustration of the board On the ME-80 the base address (W4) and interrupt channel (W5), are selected by jumper settings. The positions of these jumpers can be seen in Diagram 1: "Simplified illustration of the board". Detailed description of the jumper settings are given in the next section Jumpers Settings The jumpers W1, W2, and W3 are reserved. Note that pin 2 is connected to pin 3 by factory. Meilhaus Electronic Page 9 Installation

10 Rev. 2.0E Manual ME Base Address The base address (BA) is set by the jumper W4 in the range of 0 1FE0Hex in 32 byte increments. Starting with the base address the ME-80 occupies 16 byte of the I/O address space. Make sure that there are no conflicts with other boards in the system before installing the board in the computer! A jumper that is "on" sets a logic "0" on the address line and a jumper that is "off" sets a logic "1" on the address line. The base address is determined by summing the jumpers which are "off". The following example shows the default setting on the board (700hex). 700Hex A0 A5 A12 A W Interrupts Diagram 2: Setting the base address, e. g. standard setting 700Hex The desired interrupt line is selected by jumper W5. The IRQ lines 2, 3, 5, 7, 10, 11, 12 or 15 can be chosen. Make sure that the selected interrupt is not in use with other boards in the system! Installation Page 10 Meilhaus Electronic

11 Manual ME-80 Rev. 2.0E The following diagram shows, how the jumper has to be set to choose e. g. IRQ line 12:: W Default Settings Diagram 3: Setting the interrupt line, e. g. standard setting IRQ Function Jumper/Switches Settings Base address W4 700Hex Interrupt W5 IRQ 12 Table 1: Default settings of the ME-80 Meilhaus Electronic Page 11 Installation

12 Rev. 2.0E Manual ME Driver Installation under Windows 95/98/NT Initial Installation under Windows95/98/NT To install the driver under Windows 95/98 and Windows NT for the first time, follow this procedure Insert disk "ME-8x Driver System". Choose Run from the Windows 95/98/NT start menu. Under the option Open: enter the path for the file SETUP.EXE on the installation disk, or click Browse Confirm the selection and follow the instructions of the setup program: The installation programm will start. In the window "Install Options", choose "Install a new board" and click OK. Note the dialogs and keep the settings of base address and interrupt channel ("2.1.2 Jumpers Settings" on page 9) ready for input. Pay attention to the fact, that the input values have to match the jumper settings on the board! The following files will be installed: Windows 95/98 only: Kernel driver ME8x_32.VXD into path <Windows-Verzeichnis>\SYSTEM Windows NT only: Kernel driver ME8x_32.SYS into path <Windows-Verzeichnis>\SYSTEM32\DRIVERS API-DLL ME8x_32.DLL under Windows95/98 into path <Windows-Verzeichnis>\SYSTEM; under Windows NT into path <Windows-Verzeichnis>\ SYSTEM32 Dialog DLL MEDLG32.DLL under Windows 95/98 into path <Windows-Verzeichnis>\SYSTEM; under Windows NT into path <Windows-Verzeichnis>\ SYSTEM32 Several files for high level language programming as well as example- and test programs into the directory <Meilhaus working directory>\me-8x (see also README file on driver disk). Installation Page 12 Meilhaus Electronic

13 Manual ME-80 Rev. 2.0E Registry entries will be made. Reboot your computer. Note: The system driver will be loaded automatically. All the boards which were properly installed can be found in the Windows NT diagnostics under Resources. The important entries for the ME boards can be found under "IRQ" and "I/O port". The ME-80 does not have Plug&Play functionality. Therefore they can not be found in the Windows 95/98 device manager! Updating the Board Driver To update the board driver, the same procedure can be followed for Windows 95/98 and Windows NT 4.0: Insert disk "ME-8x Driver System". Choose Run from the Windows start menu. Under the option Open: enter path and file name for the file SETUP.EXE on the installation disk, or click Browse Confirm the selection and follow the instructions of the installation program: The installation program will start. In the windows "Install Options" choose "Update driver and language libraries" and click OK. System drivers, API-DLL as well as libraries for programming languages, demo programs and test programs will all be updated. Reboot your computer Changing Board Settings Use the following procedure to change the settings of base address and interrupt in the Windows registry. Note that the jumper settings on your board have to match the settings in the registry. The same procedure can be followed for Windows 95/98 and Windows NT 4.0: Meilhaus Electronic Page 13 Installation

14 Rev. 2.0E Manual ME-80 Insert disk "ME-8x Driver System". Choose Run from the Windows start menu. Under the option Open: enter path and file name for the file SETUP.EXE on the installation disk, or click Browse Confirm the selection and follow the instructions of the installation program: The installation program will start. In the window "Install Options" choose "Update settings of an installed board" and click OK. Note the dialogs and keep the settings of base address and interrupt channel ("2.1.2 Jumpers Settings" on page 9) ready for input. Pay attention to the fact, that the input values have to match the jumper settings on the board! Reboot your computer 2.3 Uninstall Under Windows NT alternativly choose Settings System Control Devices from Start menu to unload and reload the driver Uninstall a Single Board The install and uninstall program on your "ME-8x Driver System" disk can be used to remove individual boards of the board family ME-8x from the Windows registry. The individual software components, e. g. system driver, API-DLL and the libraries for programming languages, will not be removed in this case. The same procedure can be followed for Windows 95/98 and Windows NT 4.0: Insert disk "ME-8x Driver System". Choose Run from the Windows start menu. Under the option Open: enter path and file name for the file SETUP.EXE on the installation disk, or click Browse Confirm the selection and follow the instructions of the installation program: The installation program will start. Installation Page 14 Meilhaus Electronic

15 Manual ME-80 Rev. 2.0E In the window "Install Options" choose "Uninstall a single board" and click OK. Choose the board you would like to remove from the Windows registry. Reboot your computer. The board will be removed from the registry! Uninstall the Driver System Please note, that this procedure removes the entire ME-8x driver system from your computer. All files will be removed, including the system driver, the API-DLL (for all boards of type ME-63, ME-80 and ME-81), the libraries for programming languages, the demo programs and the test programs, which are installed in the "ME-8x" subdirectory of "C:\MEILHAUS" (if the default install options were used). The same procedure can be followed for Windows 95/98 and Windows NT 4.0: From the Windows start menu under the path Settings System Control Software in the property page Install/Uninstall choose the "ME-8x Driver Uninstall" option and click "OK". The entire ME-8x driver system will be removed from your computer! Meilhaus Electronic Page 15 Installation

16 Rev. 2.0E Manual ME-80 Installation Page 16 Meilhaus Electronic

17 Manual ME-80 Rev. 2.0E 3 Hardware 3.1 Block Diagram ME-80 State Machine (FPGA) 16 bit In/Out ports tristate 16 bit In/Out Digital I/O Driver (BCT 245) Digital I/O Driver (BCT 245) 16 Ext. Trig pin D-Sub female connector Data Bus Control and address signals PC-Interface Bus Interface Logic 3.2 General Notes Diagram 4: Block diagram of ME-80 Important Note: The external connections to the board should only be made or removed in a powered down state. Meilhaus Electronic Page 17 Hardware

18 Rev. 2.0E Manual ME Operation Modes As a special feature, the ME-80 offers the ability to latch a 32 bit word simultaneously on the 16 bit ISA bus. The reading in and writing out is done in 16 bit widths of the ISA bus. This requires a precise combination of operation mode and triggering. The outputs ports of all models can be set to a high impedance state by software. On power up, all ports are set as 32 bit input. The user must program the configuration of the board. It is recommended to use the driver software for Windows 95/98/NT (see chapter 5.3 Description of the API Functions on page 33) Digital Input/Output The following configurations are available (Port A = DIO15 DIO0, Port B = DIO31 DIO16): 32 bit input port The 32 bit word is latched according to the selected trigger mode (see chap on page 20). For reading in data, use the function _me80digetlong. 32 bit output port The 32 bit word is output simultaneously. For writing data, use the function _me80dosetlong. 2 x 16 bit input ports The two input ports can be independently read in using the function _me8xdigetword. For information about the trigger modes see chap on page x 16 bit output ports The two output ports can be independently written out using the function _me8xdosetword. Hardware Page 18 Meilhaus Electronic

19 Manual ME-80 Rev. 2.0E 16 bit input port and 16 bit output port In this configuration, port A is always used for input and port B is always used for output. Use the function _me8xdigetword for read in a 16 bit word according to the trigger mode selected and the function _me8xdosetword for output of a 16 bit word Bit Pattern Compare In the operation mode Bit Pattern Compare, the bit pattern on the input lines is compared with a bit pattern set in the compare register. An internal or external trigger signal can be used (see chap on page 20). On a bit pattern match, an interrupt can be generated (if enabled). The comparison can be done 16 bit or 32 bit wide. There are 2 compare registers each 16 bits wide available for this function. At least one port must be configured as input. When writing to the bit pattern compare register, the following 3 modes are available: 32 bit input port Use the function _me8xdiosetpattern to write the 32 bit compare pattern. 2 x 16 bit input ports In this mode, the comparison with the bit pattern set in the compare register can only be done on input port A. Use the function _me8xdiosetpattern to write the 16 bit compare pattern for port A. 16 bit input port and 16 bit output port In this mode, the comparison with the bit pattern set in the compare register can only be done on input port A. Port B is available for use as an 16 bit output port. Use the function _me8xdiosetpattern to write the compare pattern for port A and the function _me8xdosetword to write to port B. Meilhaus Electronic Page 19 Hardware

20 Rev. 2.0E Manual ME Trigger Modes The following trigger modes are available for the ME-80: Without trigger signal In this mode, when a 32 bit read is done, the input lines are latched on the first read cycle. On a 32 bit write, the output lines are written on the second write cycle. By using the functions _me80digetlong and _me80dosetlong, the driver software handles the input or output and allows a 32 bit simultaneous read or write to be done. When a 16 bit port is accessed, the lines are latched after each port access. Use the constant REGMODE_DIRECT in the function _me80diosetmode. Internal trigger signal The internal trigger signal (2.5 MHz) is primarily for the trigger signal in the bit pattern compare mode. Use the constant REGMODE_INTERNAL in the function _me80diosetmode. External trigger signal When using the bit pattern compare mode, the comparison can be started using an external signal (on pin 10) on the rising edge. The external signal can also be used to latch the input lines for input ports. Use the constant REGMODE_EXTERNAL in the function _me80diosetmode. The external trigger input can also be used as an interrupt input. This signal is passed directly to the interrupt line of the PC. In this case, the constant REGMODE_EXTERNAL can not be used in the function _me80diosetmode. In the function _me8xdiosetintmode use the constant INT_EXTERN. Hardware Page 20 Meilhaus Electronic

21 Manual ME-80 Rev. 2.0E 3.4 Switching Important Note: The external connections to the board should only be made or removed in a powered down state. The input/output ports on the ME-80 are driven by bi-directional bus drivers of type BCT245. When applying signals to the input/output lines or the trigger input, the TTL signal specifications must be maintained and a connection to ground (pin 20) must be made. The pinout of the the 37pin female D-Sub connector is shown in Diagram 5: on page Register Description The ME-80 can be programmed at the register level (e. g. in DOS). The registers are briefly described in this section. We recommend use of the driver software for Windows 95/98 and Windows NT shipped with the board!. The ME-80 requires 16 consecutive bytes of I/O address space starting at the base address BA. The registers are described in the following tables (R = read, W = write) Meilhaus Electronic Page 21 Hardware

22 Rev. 2.0E Manual ME-80 Offset 16 Bit Registers BA+00H R M8_FIDREG contains function ID and INTR bit b15 b9.. 0 reserved b INTR_BIT 1 is set, if interrupt on bit pattern match (EX_INT=0), or on a rising edge of the ext. trigger (EX_INT01) b FID7 1 Function group bit pattern compare b FID6 0 reserved b FID5 Function group Analog Input (AI) b FID4 Function group Analog Output (AO) b FID3 Function group Digital-I/O (DIO) b2 b0... FID2 FID0 PROM version the following Function-ID results in PROM version 1): = 49Hex Table 2: Address space of the ME-80 Hardware Page 22 Meilhaus Electronic

23 Manual ME-80 Rev. 2.0E Offset 16 Bit Registers BA+00H W M8_CONTROL Control Register b15 b8.. 0 reserved b ENIO 1 Digital ports conductive 0 Digital ports tristate b6, b5... EX_INT, EN_INT 0 0 Interrupt disabled 0 1 Interrupt on bit pattern match 1 0 Interrupt disabled 1 1 Interrupt on ext. trigger b4, b3... INL_MOD1, INL_MOD0 0 0 Data are latched on read cycle 0 1 Data are latched on the rising edge of the internal trigger 1 0 Data are latched on the rising edge of the external trigger 1 1 reserved b2 b0... CFG2 CFG x 32 bit input port x 32 bit output port x 16 bit input ports x 16 bit output port x 16 bit input port (Port A) and 1 x 16 bit output port (Port B) BA+02H R M8_RSTINT The interrupt bit INTR_BIT is reset by reading this address. As long INTR_BIT is set, no new interrupt can be generated. BA+04H R/W M8_IOREQ0 Data Register Port A b15 b0.. DIO15 DIO0 16 bit data register port A resp. low word for 32 bit port Table 2: Address space of the ME-80 Meilhaus Electronic Page 23 Hardware

24 Rev. 2.0E Manual ME-80 Offset 16 Bit Registers BA+06H R/W M8_IOREQ1 Data Register Port B b15 b0.. DIO31 DIO16 16 bit data register port B resp. high word for 32 bit port BA+08H W M8_COMP0 Compare Register Port A b15 b0.. Compare bit pattern port A resp. low word for 32 bit compare bit pattern BA+0AH W M8_COMP1 Compare Register Port B b15 b0.. Compare bit pattern port B resp. high word for 32 bit compare bit pattern BA+0CH reserved BA+0EH reserved 3.6 Test Program Table 2: Address space of the ME-80 For test issues a test program is provided. The appropriate test program can be found in a corresponding subdirectory of C:\MEILHAUS\ (Default) and can be run by double clicking on the file. (Condition: system driver correctly installed). Hardware Page 24 Meilhaus Electronic

25 Manual ME-80 Rev. 2.0E 4 Programming 4.1 High Level Language Programming The following high level languages are supported by standard: Visual C++ (version 4.0 or higher). Please read the notes in the respective README files Delphi (version 2.0 or higher). Please read the notes in the respective README files. Visual Basic (version 4.0 or later). Please read the notes in the respective README files. for further high level languages see the respective README files on your driver disk(s). Note: The compilers and linkers require the correct paths to be set to the corresponding files in the high level languages. By linking the high level language specific definition files into your project you can pass many macros and parameters in the form of predefined constants. As an alternative, you can pass the matching Hex value at any time Example Programs We have provided simple demo programs and small projects with source code to help understanding of the functions and how to incorporate them into your project. These demo programs are installed automatically to appropriate subdirectories of C:Meilhaus\ (Default). Please read the notes in the appropriate README files. Meilhaus Electronic Page 25 Programming

26 Rev. 2.0E Manual ME HP VEE Programming HP VEE components for the ME-80 are delivered on (a) seperate disk(s) included with HP VEE from Meilhaus Electronic. The ME-80 is supported by HP VEE full versions 3.2 or higher under Windows 95/98/NT. For installation of HP VEE components and for further infos please note the documentation on the disks delivered with the HP VEE driver system. For basics of HP VEE programming please use your HP VEE documentation and the HP VEE online help index User Objects For convenient use of the driver, predefined User Objects have been developed which internally call API functions. They can be called by the additional menu item ME Board and be included in the HP VEE development environment. They can be placed and wired in your application the same as standard HP VEE objects. The User Objects are self descriptive and based on the API functions documented in the chapter Function Reference. Additionally there are some Expanded User Objects for making programming as easy as possible for you. A short description of every UO is also available under the item Description, if you move the cursor over the UO and push the right mouse button. The UOs can be changed any time for user requirements and can be saved as a user specific object HP VEE Example Programs For demonstration purposes and for easier understanding, demo programs using the important UOs have been written. They can be called by the menu item ME Board Demos. The HP VEE demo programs contain partial additions to the normal UOs and for differentiation from the normal UOs the prefix "x " in their file name is used. Programming Page 26 Meilhaus Electronic

27 Manual ME-80 Rev. 2.0E The "ME Board"-Menu The installation program automatically expands the HP VEE menu by the ME Board entry. It enables a convenient use of all driver functions available in HP VEE. By the ME Board menu you can call the driver and demo User Objects sorted by board families. Note: The UOs installed, depend on the selected board family at the beginning of your HP VEE driver installation. If you call UOs under the ME Board menu which are not installed, an error message occures: File filename was not found. Error number: 700 If necessary, you can install the additional HP VEE components any time. To do this use the disk Meilhaus HP VEE Driver System. 4.3 LabVIEW -Programming LabVIEW components for the ME-80 are delivered optional on (a) seperate disk(s) from Meilhaus Electronic. The ME-80 is supported by LabVIEW full versions 4.x or higher under Windows 95/98/NT. For installation of LabVIEW driver components and for further infos please note the documentation on the disks deliverd with the ME-80 LabVIEW driver. For basics of LabVIEW programming please use your LabVIEW documentation and the LabVIEW online help index Virtual Instruments For convenient use of the driver, predefined Virtual Instruments have been developed. They can be called by the additional menu item File - Open and be included in the LabVIEW development environment. They can be placed and wired in your application the same as standard LabVIEW objects. The source VIs are self descriptive and based on the API functions documented in the chapter Function Reference on Meilhaus Electronic Page 27 Programming

28 Rev. 2.0E Manual ME-80 page 31. Additionally there are some Expanded Virtual Instruments for making programming as easy as possible for you. A short description of every VI is also available in the VI ME-80 Function Tree. This VI is only for documentation purposes and can be opened by the menu File - Open. Under Description you find a short description of every Virtual Instrument. The VIs can be changed any time for user requirements and can be saved as a user specific VI LabVIEW Example Programs For demonstration purposes and for easier understanding, demo programs using the important virtual instruments (VIs) have been written. They can be called by the menu item File - Open. 4.4 Register Programming Note: The ME-80 can also be programmed at the register level (e. g. in DOS). This can be done with high level language input and output port commands, see Register Description on page 21. Consult the manuals for the high level language of your choice for the proper commands and syntax. We recommend however, the use of the driver software for Windows 95/98 and Windows NT, supplied with the board! Initialisation Read the function ID register (M8_FIDREG). The higher 5 bits of the lower byte (b7 b3) will contain the value '10001' while the lower 3 bits (b2 b0) will depend on the PROM version. For example, for the PROM version 1 (001), the value in the ID register will be: binary = 89Hex. If this is not the case, either the base address is not correct or the board is defective. To stop all functions on the board: set the control register (M8_CONTROL) to 00Hex Programming Page 28 Meilhaus Electronic

29 Manual ME-80 Rev. 2.0E To reset the interrupt functions on the board: read a dummy value from the register M8_RSTINT Simple Input Initialise the board (see 4.4.1) Configure the M8_CONTROL register: - Switch the digital ports conductive (ENIO); b7 = 1 - Disable interrupt (EX_INT, EN_INT); b6, b5 = 0, 0) - Select the trigger mode (INL_MOD1, INL_MOD0) (data is read in directly after a read command); b4, b3 = 0, 0 - Configure the port direction to input (CFG2 CFG0); b2 b0 = 0, 0, 0 or 0, 1, 0 Read in the registers (first I/O word and/or second I/O word) Simple Output Initialise the board (see 4.4.1) Set the configuration (see 4.4.2) with the ports set as output instead (CFG2 CFG0); b2 b0 = 0, 0, 1 or 0, 1, 1 Set the outputs by writing to the registers (first I/O word and/or second I/O word) Note: A port set as output can also be read back in Interrupt Operation (alternatively on bit pattern compare or external trigger) Initialise the board (see 4.4.1) INTR_BIT is reset by reading a dummy value out of the M8_RSTINT register If an interrupt is to be generated on bit pattern compare, the bit pattern must be written to the compare register (first compare word, second compare word). Meilhaus Electronic Page 29 Programming

30 Rev. 2.0E Manual ME-80 Configure the M8_CONTROL register: - Switch the digital ports conductive (ENIO); b7 = 1 - Select the interrupt source (EX_INT, EN_INT) for bit pattern compare: b6, b5 = 0, 1; ext. trigger: b6, b5 = 1, 1 - Select the trigger mode (INL_MOD1, INL_MOD0) Note: In interrupt mode with a bit pattern compare, one of the following trigger modes (INL_MOD1, INL_MOD0) must be used: Internal trigger (2.5 MHz): b4, b3 = 0, 1 Ext. trigger: b4, b3 = 1, 0 Configure the port direction (CFG2 CFG0) (see also chapter 3.5 Register Description on page 21) Note: After every interrupt, the INTR_BIT must be dummy read from the M8_RSTINT register to reset the bit, otherwise no further interrupts can occur. Programming Page 30 Meilhaus Electronic

31 Manual ME-80 Rev. 2.0E 5 Function Reference 5.1 Functional Overview of the 32 Bit Driver The 32 bit driver for the ME-80 is written for the Windows 95/98 and Windows NT operating system. It consists of the following files: - VxD driver (ME8x_32.VXD) for Windows 95/98, will be loaded dynamically. - Kernel driver (ME8x_32.SYS) for Windows NT will be loaded automatically on power up. - API-DLL (ME8x_32.DLL) with the API functions for the ME Dialogue DLL (MEDLG32.DLL) with dialogue functions. The installation program for the ME-80 automatically registers every new board of the ME-8x board family with the operating system. The driver supports up to 4 boards of one board family (iboardnumber 0 3) and up to 12 boards as a whole. Upon every start, the driver searches for registered boards but does not check the physical existence (the ME-80 is not Plug&Play compatible). After the driver is successfully loaded, the board can be accessed via the API functions. The API functions allow convenient access to the hardware. Every function that accesses the ME-80 requires an integer value for identification of the board. This integer value will be indicated by <iboardnumber> in the following API function descriptions. 5.2 Naming Conventions The API functions were written specially for the ME-80 board family. For Visual C and Delphi (Pascal) every API function starts with an underscore _ (not so in Borland C and BASIC). The function names were selected to be as descriptive as possible. Each function name consists of a board type specific prefix Meilhaus Electronic Page 31 Function Reference

32 Rev. 2.0E Manual ME-80 and several elements which stand for the corresponding sections (e. g. "DI" for "Digital Input ). _me80 _me8x Function valid for board type ME-80 Function valid for board types ME-80 and ME-81 For the description of the functions, the following standards will be used: function name will be italic in body text e. g. _me8xdigetbit <parameters> will be in brackets as shown and in font Courier <variables> will indicate a predefined constant and will be written in italic text and in brackets as shown [square brackets] variables in square brackets have to be used depending on board type. FILE NAMES or PATHS will be capitalized in font Courier me80 () parts of programs will be in Courier type To identify data types, the following letters will be used: i or dw 32 bit integer value s or w 16 bit short value c or b 8 bit character value p pointer of data type (i, s, l or c) Function Reference Page 32 Meilhaus Electronic

33 Manual ME-80 Rev. 2.0E 5.3 Description of the API Functions The functions will be described by functional groups as listed below. Within each functional group, the individual functions will be described in alphabetical order: General Functions on page Digital Input/Output on page Interrupt Handling on page Error Handling on page 47 Function Short Description Page General Functions _me8xgetdllversion Determine DLL version number 34 _me8xpromversion Determine PROM-ID of board 34 Digital Input/Output _me8xdigetbit Read single bit 35 _me8xdigetword Read word (16 bit) 36 _me80digetlong Read long word (32 bit) 37 _me8xdiosetintmode Select interrupt event 38 _me80diosetmode Port configuration 39 _me8xdiosetpattern Wirte compare bit pattern 40 _me8xdiosettristateoff Activate output port(s) 41 _me8xdiosettristateon Deactivate output port(s) 42 _me8xdosetbit Set single bit 42 _me8xdosetword Write word (16 bit) 43 _me80dosetlong Write word (32 bit) 44 Interrupt Handling _me8xdisableint Disable interrupt control 45 _me8xenableint Enable interrupt control 46 Error Handling _me8xgetdrverrmess Error string corresponding to error code 47 Table 3: Overview of library functions Meilhaus Electronic Page 33 Function Reference

34 Rev. 2.0E Manual ME General Functions _me8xgetdllversion Description Function is used for: ME-80. Determines the version number of the driver DLL. Definitions C: int _me8xgetdllversion(); Delphi: Function _me8xgetdllversion: integer; Basic: Declare Function me8xgetdllversion Lib "me8x_32" Alias () As Long Parameters none Return value The version number is returned as a 32 bit value. The upper 16 bits contain the main version number and the lower 16 bits contain the sub version number. E. g.: Hex indicates the version number 1.03 _me8xpromversion Description Function is used for: ME-80. Returns the board identification and the PROM-ID. Definitions C: int _me8xpromversion (int iboardnumber, int *piversion;) Delphi: Function _me8xpromversion (iboardnumber: integer; Var iversion: integer): integer; Basic: Declare Function me8xpromversion Lib "me8x_32" Alias "_VBme8xPROMVersion@8" (ByVal iboardnumber As Long, ByRef iversion As Long) As Long Function Reference Page 34 Meilhaus Electronic

35 Manual ME-80 Rev. 2.0E Parameters <BoardNumber>Board number for 1., 2., 3. or 4. installed board of type ME-63, ME-80 or ME-81; possible values: 0 3 <Version> Pointer to an integer value with the encoded PROM version. The value is interpreted as a hexadecimal value. Only the lower 8 bits are significant. The meaning of the individual bits is described in the register description (FID register, BA+00Hex). If an error occurs, the function is still executed but an invalid version number (FFHex) is returned. Return value If the function is successfully executed, a '1' is returned. If an error occurs, a '0' is returned. The cause of the error can be determined with the function _me8xgetdrverrmess Digital Input/Output _me8xdigetbit Description Function is used for: ME-80. Returns the status of a single input line. Inportant Note: The function _me80diosetmode must be called first to configure the ports. Definitions C: int _me8xdigetbit (int iboardnumber, int ibitno, int *pibitvalue); Delphi: Function _me8xdigetbit (iboardnumber, ibitno: integer; Var ibitvalue: integer): integer; Basic: Declare Function me8xdigetbit Lib "me8x_32" Alias "_VBme8xDIGetBit@12" (ByVal iboardnumber As Long, ByVal ibitno As Long, ibitvalue As Long) As Long Meilhaus Electronic Page 35 Function Reference

36 Rev. 2.0E Manual ME-80 Parameters <BoardNumber>Board number for 1., 2., 3. or 4. installed board of type ME-63, ME-80 or ME-81; possible values: 0 3 <BitNo> The number the input line whose status is to be read in. Possible values are: 0 15: 16 bit input port A or lower 16 bits of the 32 bit port 16 31: 16 bit input port B or higher 16 bits of the 32 bit port <BitValue> Pointer to an integer value representing the status of the selected input line: 0: input line is set to a logical '0' 1: input line is set to a logical '1' Return value If the function is successfully executed, a '1' is returned. If an error occurs, a '0' is returned. The cause of the error can be determined with the function _me8xgetdrverrmess. _me8xdigetword Description Function is used for: ME-80. This function reads a word from a 16 bit input port of the board. Inportant Note: The function _me80diosetmode must be called first to configure the ports. Definitions C: int _me8xdigetword (int iboardnumber, int iportno, int *ivalue); Delphi: Function _medigetword (iboardnumber, iportno: integer; Var ivalue: integer): integer; Basic: Declare Function me8xdigetword Lib "me8x_32" Alias "_VBme8xDIGetWord@12" (ByVal iboardnumber As Long, ByVal iportno As Long, ivalue As Long) As Long Function Reference Page 36 Meilhaus Electronic

37 Manual ME-80 Rev. 2.0E Parameters <BoardNumber>Board number for 1., 2., 3. or 4. installed board of type ME-63, ME-80 or ME-81; possible values: 0 3 <PortNo> Port name; possible values are: <PortNo> Description PORTA (00Hex) 16 bit input port A PORTB (01Hex) 16 bit input port B <Value> Pointer to an integer value representing the read in value, only the lower 16 bits significant. Return value If the function is successfully executed, a '1' is returned. If an error occurs, a '0' is returned. The cause of the error can be determined with the function _me8xgetdrverrmess. _me80digetlong Description Function is used for: ME-80. This function reads a long word from the 32 bit input port of the board. Inportant Note: The function _me80diosetmode must be called first to configure the ports. Definitions C: int _me80digetlong (int iboardnumber, int iportno, int *ivalue); Delphi: Function _me80digetlong (iboardnumber, iportno: integer; Var ivalue: integer): integer; Basic: Declare Function me80digetlong Lib "me8x_32" Alias "_VBme80DIGetLong@12" (ByVal iboardnumber As Long, ByVal iportno As Long, ivalue As Long) As Long Parameters <BoardNumber>Board number for 1., 2., 3. or 4. installed board of type ME-63, ME-80 or ME-81; possible values: 0 3 Meilhaus Electronic Page 37 Function Reference

38 Rev. 2.0E Manual ME-80 <PortNo> <Value> Return value Port name; possible values are: <PortNo> Description PORTA (00Hex) 32 bit input port Zeiger auf einen Integerwert, der das gelesene 32 Bit Wort enthält If the function is successfully executed, a '1' is returned. If an error occurs, a '0' is returned. The cause of the error can be determined with the function _me8xgetdrverrmess. _me8xdiosetintmode Description Function is used for: ME-80. This function selects the interrupt event. Important Note! In HP VEE this function is not supported! Definitions C: int _me8xdiosetintmode (int iboardnumber, int imode); Delphi: Function _me8xdiosetintmode (iboardnumber: integer; imode: integer): integer; Basic: Declare Function me8xdiosetintmode Lib "me8x_32" Alias "_VBme8xDIOSetIntMode@8" (ByVal iboardnumber As Long, ByVal imode As Long) As Long Parameters <BoardNumber>Board number for 1., 2., 3. or 4. installed board of type ME-63, ME-80 or ME-81; possible values: 0 3 <Mode> Interrupt modes; possible values are: <Mode> Description NO_INTERRUPT (00Hex) no interrupt operation INT_IF_PATTERN (20Hex) interrupt on bit pattern match INT_EXTERN (60Hex) external interrupt Function Reference Page 38 Meilhaus Electronic

39 Manual ME-80 Rev. 2.0E Return value If the function is successfully executed, a '1' is returned. If an error occurs, a '0' is returned. The cause of the error can be determined with the function _me8xgetdrverrmess. _me80diosetmode Description Function is used for: ME-80. This functions sets the data width, direction, and trigger mode of the ports Important Note: This function must be called once before any bit/byte, read/write operations can be done. Definitions C: int _me80diosetmode (int iboardnumber, int imode, int iregmode); Delphi: Function _me80diosetmode (iboardnumber, imode, iregmode: integer): integer; Basic: Declare Function me80diosetmode Lib "me8x_32" Alias "_VBme80DIOSetMode@12" (ByVal iboardnumber As Long, ByVal imode As Long, ByVal iregmode As Long) As Long Parameters <BoardNumber>Board number for 1., 2., 3. or 4. installed board of type ME-63, ME-80 or ME-81; possible values: 0 3 <Mode> Latching the data (trigger mode); possible values: REGMODE_DIRECT (00Hex): data is latched right after the read command REGMODE_INTERNAL (01Hex): data is latched periodically on the rising edge of the internal clock REGMODE_EXTERNAL (10Hex): data is latched on the rising edge of an external trigger signal Meilhaus Electronic Page 39 Function Reference

40 Rev. 2.0E Manual ME-80 <RegMode> Return value Data width an data direction of the ports; possible values are: <RegMode> Description IN32 (00Hex) 32 bit input OUT32 (01Hex) 32 bit output IN16 (02Hex) 2 x 16 bit input OUT16 (03Hex) 2 x 16 bit output INOUT16 (04Hex) 16 bit input (port A), 16 bit output (port B) If the function is successfully executed, a '1' is returned. If an error occurs, a '0' is returned. The cause of the error can be determined with the function _me8xgetdrverrmess. _me8xdiosetpattern Description Function is used for: ME-80. This function writes a 16 bit resp. 32 bit word as the comparison pattern to the corresponding register. If the pattern matches those of the input lines, an interrupt is initiated (if enabled). Definitions C: int _me8xdiosetpattern (int iboardnumber, int ipattern); Delphi: Function _me8xdiosetpattern (iboardnumber, ipattern: integer): integer; Basic: Declare Function me8xdiosetpattern Lib "me8x_32" Alias "_VBme8xDIOSetPattern@8" (ByVal iboardnumber As Long, ByVal ipattern As Long) As Long Parameters <BoardNumber>Board number for 1., 2., 3. or 4. installed board of type ME-63, ME-80 or ME-81; possible values: 0 3 <Pattern> Comparison pattern (16 resp. 32 bit wide). This value is written independent of the port width by one function call. Input lines DIO0 15 correspond to bits 0 15 of the first compare register, input lines DIO16 31 correspond to bits 0 15 of the second compare register Function Reference Page 40 Meilhaus Electronic

41 Manual ME-80 Rev. 2.0E Return value If the function is successfully executed, a '1' is returned. If an error occurs, a '0' is returned. The cause of the error can be determined with the function _me8xgetdrverrmess. _me8xdiosettristateoff Description Function is used for: ME-80. This function activates the digital outputs of the board. Values previously written into the registers are switched through to the port. Important Note: After starting the driver, the function must be successfully completed before each output function call. Definitions C: int _me8xdiosettristateoff (int iboardnumber); Delphi: Function _me8xdiosettristateoff (iboardnumber: integer): integer; Basic: Declare Function mediosettristateoff Lib "me8x_32" Alias "_VBme8xDIOSetTristateOFF@4" (ByVal iboardnumber As Long) As Long Parameters <BoardNumber>Board number for 1., 2., 3. or 4. installed board of type ME-63, ME-80 or ME-81; possible values: 0 3 Return value If the function is successfully executed, a '1' is returned. If an error occurs, a '0' is returned. The cause of the error can be determined with the function _me8xgetdrverrmess. Meilhaus Electronic Page 41 Function Reference

42 Rev. 2.0E Manual ME-80 _me8xdiosettristateon Description Function is used for: ME-80. This function deactivates the digital outputs on the board (tristate). When the driver is loaded, the outputs are set to the state described above. Definitions C: int _me8xdiosettristateon(int iboardnumber); Delphi: Function _me8xdiosettristateon(iboardnumber: integer): integer; Basic: Declare Function me8xdiosettristateon Lib "me8x_32" Alias (ByVal iboardnumber As Long) As Long Parameters <BoardNumber>Board number for 1., 2., 3. or 4. installed board of type ME-63, ME-80 or ME-81; possible values: 0 3 Return value If the function is successfully executed, a '1' is returned. If an error occurs, a '0' is returned. The cause of the error can be determined with the function _me8xgetdrverrmess. _me8xdosetbit Description Function is used for: ME-80. This function sets a single output line to the chosen state. Important Note: In order to configure the ports the function _me80diosetmode must be called first and to activate the outputs the function _me8xdiosettristateoff must be successfully completed. Definitions C: int _me8xdosetbit (int iboardnumber, int ibitno, int ibitvalue); Function Reference Page 42 Meilhaus Electronic

43 Manual ME-80 Rev. 2.0E Delphi: Basic: Parameters function _me8xdosetbit (iboardnumber: integer; ibitno, ibitvalue: integer): integer; Declare Function me8xdosetbit Lib "me8x_32" Alias (ByVal iboardnumber As Long, ByVal ibitno As Long, ByVal ibitvalue As Long) As Long <BoardNumber>Board number for 1., 2., 3. or 4. installed board of type ME-63, ME-80 or ME-81; possible values: 0 3 <BitNo> Number of the output line whose status is to be set; possible values are: 0 15: 16 bit output port (Port A) resp. lower 16 bits of the 32 bit output port 16 31: 16 bit output port (Port B) resp. higher 16 bits of the 32 bit output port <BitValue> Possible values are: 0: output line is to be set to '0' 1: output line is to be set to '1' Return value If the function is successfully executed, a '1' is returned. If an error occurs, a '0' is returned. The cause of the error can be determined with the function _me8xgetdrverrmess. _me8xdosetword Description Function is used for: ME-80. This function writes a word to a 16 bit output port. Important Note: In order to configure the ports the function _me80diosetmode must be called first and to activate the outputs the function _me8xdiosettristateoff must be successfully completed. Definitions C: int _me8xdosetword (int iboardnumber, int iportno, int ivalue); Delphi: Function _me8xdosetword (iboardnumber, iportno, ivalue: integer): integer; Meilhaus Electronic Page 43 Function Reference

44 Rev. 2.0E Manual ME-80 Basic: Parameters Declare Function me8xdosetword Lib "me8x_32" Alias (ByVal iboardnumber As Long, ByVal iportno As Long, ByVal ivalue As Long) As Long <BoardNumber>Board number for 1., 2., 3. or 4. installed board of type ME-63, ME-80 or ME-81; possible values: 0 3 <PortNo> Port name; possible values are: <PortNo> Description PORTA (00Hex) 16 bit output port A PORTB (01Hex) 16 bit output port B <Value> Output value, possible values are: 0000Hex FFFFHex (dezimal: ) Return value If the function is successfully executed, a '1' is returned. If an error occurs, a '0' is returned. The cause of the error can be determined with the function _me8xgetdrverrmess. _me80dosetlong Description Function is used for: ME-80. This function writes a long word to a 32 bit output port. Important Note: In order to configure the ports the function _me80diosetmode must be called first and to activate the outputs the function _me8xdiosettristateoff must be successfully completed. Definitions C: int _me80dosetlong (int iboardnumber, int iportno, int ivalue); Delphi: Function _me80dosetlong (iboardnumber, iportno, ivalue: integer): integer; Basic: Declare Function me80dosetlong Lib "me8x_32" Alias "_VBmeDOSetLong@12" (ByVal iboardnumber As Long, ByVal iportno As Long, ByVal ivalue As Long) As Long Function Reference Page 44 Meilhaus Electronic

45 Manual ME-80 Rev. 2.0E Parameters <BoardNumber>Board number for 1., 2., 3. or 4. installed board of type ME-63, ME-80 or ME-81; possible values: 0 3 <PortNo> Port name; possible values are: <PortNo> Description PORTA (00Hex) 32 bit output port <Value> 32 bit output value; possible values are: 0Hex FFFFFFFFHex (decimal: ) Return value If the function is successfully executed, a '1' is returned. If an error occurs, a '0' is returned. The cause of the error can be determined with the function _me8xgetdrverrmess Interrupt Handling _me8xdisableint Description Function is used for: ME-80 The interrupt control on the board previously started by _me8xenableint is disabled. Important Note! In HP VEE this function is not supported! Definitions C: int _me8xdisableint (int iboardnumber); Delphi: Function _me8xdisableint (iboardnumber: integer):integer; Basic: not realised Parameters <BoardNumber>Board number for 1., 2., 3. or 4. installed board of type ME-63, ME-80 or ME-81; possible values: 0 3 Meilhaus Electronic Page 45 Function Reference