Allen-Bradley API Software for 1746 I/O PCI User Interface Manual (Cat. No. 1747-PCIDOS, -PCINT) Important User Because of the variety of uses for the products described in this Information publication, those responsible for the application and use of this control equipment must satisfy themselves that all necessary steps have been taken to assure that each application and use meets all performance and safety requirements, including any applicable laws, regulations, codes and standards. The illustrations, charts, sample programs and layout examples shown in this guide are intended solely for example. Since there are many variables and requirements associated with any particular installation, Allen-Bradley does not assume responsibility or liability (to include intellectual property liability) for actual use based upon the examples shown in this publication. Allen-Bradley publication SGI-1.1, Safety Guidelines For The Application, Installation and Maintenance of Solid State Control (available from your local Allen-Bradley office) describes some important differences between solid-state equipment and electromechanical devices which should be taken into consideration when applying products such as those described in this publication. Reproduction of the contents of this copyrighted publication, in whole or in part, without written permission of Allen-Bradley Company, Inc. is prohibited. Throughout this manual we use notes to make you aware of safety considerations: ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or ! death, property damage or economic loss. Attention helps you to: • identify a hazard • avoid the hazard • recognize the consequences Important: Identifies information that is critical for successful application and understanding of the product. AMIBIOS is a trademark of American Megatrends, Inc. SystemSoft and CardSoft are trademarks of SystemSoft Corporation. Microsoft and MS-DOS are trademarks of Microsoft. Preface Using This Manual Who Should Use Use this manual if you are responsible for developing control applications using the this Manual 1746 I/O PCI Interface API (application programming interface) software in an MS-DOS or Windows NT environment. This manual documents the 1746 I/O PCI Interface API software for DOS and the API software for Windows NT. The APIs use most of the same calls. Differences are noted as appropriate. Terminology Throughout the language of this document, we refer to the 1746 I/O PCI Interface card (1747-PCIS) as the scanner and the 1747-PCIL chassis interface module as the adapter. There are two versions of the PCI Bus Interface Card. 1747-PCIS has a 256k memory capacity and the 1747-PCIS2 has a 1M capacity. Reference The following books might be useful as you develop your 1746 I/O PCI Interface Material1746 I/O applications: PCI Interface This document: By: Has this ISBN number: PC System Architecture Series MindShare, Inc. ISBN: 0-201-40993-3 PCI System Architecture Addison-Wesley Publishing Company PCI Hardware and Software Architecture and Design Edward Solari and George Willse ISBN: 0-929392-28-0 Support Due to the PC-based architecture of the 1746 I/O PCI Interface, the telephone support provided with the purchase price of the 1746 I/O PCI Interface consists primarily of determining if the system software and hardware is operating within documented specifications. The tools for this support are: • diagnostic utility disk that ships with the 1746 I/O PCI Interface • 1746 I/O PCI Interface system diagnostic LEDs The diagnostic utility disk uses the DOS API as its programming interface, which provides examples of how to use the API. The diagnostic utility disk is a good tool to help diagnose your API application software. See appendix B for more information. When you purchase a 1746 I/O PCI Interface system, you also receive firmware upgrades during the 12-month warranty period. You can purchase extended support in blocks of 5 hours by ordering support contracts (1747-OCTS). Publication 1747-6.5.3 June 1998 Preface–2 Using This Manual Publication 1747-6.5.3 June 1998 Table of Contents Overview Chapter 1 Introduction . 1-1 Relationship to the Open Controller . 1-1 The 1746 I/O PCI Interface API . 1-2 API Software for DOS . 1-2 API Software for Windows NT. .1-2 Understanding the 1746 I/O PCI Interface Architecture . 1-3 Scanner Modes. 1-4 Checking LED Indicators . 1-5 STATUS . 1-5 Installing the DOS API . 1-5 Installing the Windows NT API . 1-6 Installation Details. 1-7 Uninstalling the Windows NT API . 1-7 Using the API Chapter 2 Introduction . 2-1 Getting Started . 2-1 Programming Conventions . 2-1 DOS Considerations . 2-2 Windows NT Considerations. 2-3 Tools to Use . 2-4 Sample DOS MAKE file for Borland compilers . 2-5 Sample DOS MAKE file for Microsoft compilers . 2-6 Sample Windows NT MAKE file for Microsoft compilers. .2-7 Sample Windows NT MAKE file for Borland compilers. 2-9 Developing Applications Chapter 3 Introduction . 3-1 How the API Functions Are Organized . .3-1 Programming Sequence . 3-2 Access the scanner. .3-2 Initialize the scanner . 3-3 Configure the scanner. 3-3 Control scanner operation. 3-4 Scan I/O . 3-5 Programming Example for DOS . 3-6 Programming Example for Windows NT. 3-12 Handling Interrupt Messages . 3-18 Handling Errors. 3-18 Determining Partition Sizes for Shared Memory. 3-18 Using the API Structures Chapter 4 Introduction . 4-1 API Structures. 4-1 Publication 1747-6.5.3 June 1998 ii Configuring I/O Chapter 5 Modules Introduction. 5-1 Configuring I/O . 5-1 Using M0-M1 Files and G Files . 5-3 M0-M1 files . 5-3 G files . 5-3 Supported I/O Modules . 5-4 Library of Routines Chapter 6 Introduction. 6-1 OC_CalculateCRC . 6-2 OC_ClearFault . 6-3 OC_CloseScanner . 6-4 OC_ConfigureDII . 6-5 OC_CreateIO Configuration . 6-7 OC_DemandInputScan . 6-9 OC_DemandOutputScan . 6-10 OC_DownloadIO Configuration . 6-11 OC_EnableEOSNotify . 6-13 OC_EnableForces . 6-15 OC_EnableSlot. 6-17 OC_ErrorMsg . 6-18 OC_ExtendedErrorMsg . 6-19 OC_GetBatteryStatus. 6-21 OC_GetDeviceInfo . 6-22 OC_GetExtendedError . 6-23 OC_GetInputImage UpdateCounter . 6-25 OC_GetIOConfiguration . 6-27 OC_GetLastFaultCause . 6-29 OC_GetMeasuredScan Time . 6-30 OC_GetScannerInitInfo . 6-31 OC_GetScannerStatus. 6-33 OC_GetScanner WatchdogCount . 6-35 OC_GetStatusFile . 6-36 OC_GetSwitchPosition. 6-40 OC_GetTemperature . ..