DPF-0401 Windows driver software for USB expansion I/O products

Transcription

1 Interface USB Driver (I/O-CD) DPF-0401 Windows driver software for USB expansion I/O products Help for Windows

2 Contents Chapter 1 Introduction Overview Corresponding Software Driver for Each I/O Function... 3 Chapter 2 Product Specifications Functional Specifications Product Composition Class Library... 5 Chapter 3 Programming Guide Installation Control Method... 6 Chapter 4 Reference List of DLL Function IfUsbDevicePowerCtl Return Values Chapter 5 Sample Programs UsbPwrCtl Chapter 6 Terms of Use Limited Warranty Copyrights and Intellectual Property Rights Warning Regarding Medical and Clinical Use of Our Products Prohibition of Reproduction Limitation of Liability Trademark

3 Chapter 1 Introduction 1.1 Overview The DPF-0401 controls our USB expansion I/O products by applications running on Windows. Application software links a provided dynamic link library (DLL) and controls the product through the application programming interface (API). This document provides information only to control the power supply of our USB expansion I/O products. For functions and usage, refer to each software driver s Help. Find the corresponding software driver in the 1.2 Corresponding Software Driver for Each I/O Function. 1.2 Corresponding Software Driver for Each I/O Function Part Number I/O Function Software Driver IUC-x2934 Digital input/output GPF-2000 TIO-C2934x Analog-to-digital input GPF-3100 Digital-to-analog output GPF-3300 IUC-x2937 Digital input/output GPF-2000 TIO-C2937x IUC-x2980 TIO-C2980x IUC-x4668 TIO-C4668x IUC-x3615 Analog-to-digital input GPF-3100 TIO-C3615 Digital-to-analog output GPF-3300 Counter GPF-6204 IUC-x4676 TIO-C4676x Digital input/output HDLC GPF-2000 GPF

4 Chapter 2 Product Specifications 2.1 Functional Specifications Number of Device Power Supply Control to USB Device Up to one device The DPF-0401 controls power on/off to the USB device For functional specifications of each I/O function, refer to each software driver s Help. Find the corresponding software driver in the 1.2 Corresponding Software Driver for Each I/O Function. 2.2 Product Composition Item File Name Description Management file DPF0401.VER Management information file for Interface Corporation use Latest information README.HTM Latest information Sample programs - - Visual C++ UsbPwrCtl Sample program for power supply control to USB device Visual C#.NET *1 IFCUSB Class library for Visual C#.NET UsbPwrCtl Sample program for power supply control to USB device Visual Basic.NET *1 IFCUSB Class library for Visual C#.NET UsbPwrCtl Sample program for power supply control to USB device Library IFCml.Lib Import library Header file ifusbpwr.h Header file for Visual C++ Help HELP.PDF Help (PDF file) Note: *1 Sample programs for Visual C#.NET and Visual Basic.NET are built with Visual C#.NET 2003 and Visual Basic.NET 2003, respectively. 4

5 2.3 Class Library This product includes the source files of the class library. Creating the class library from the source files makes it easier to define DLL functions. (To customize DLL function call, refer to the class library sources.) 1. Creating a Class Library Prepare class library first to call DLL functions on.net. Visual C#.NET 2. Open the following project file. <installation destination>\interface\dpf0401\samples\cs_net\ifcusb\ifcusb.csproj After building the project file, IFCUSB.dll is created in the bin folder. Visual Basic.NET 2. Open the following project file. <installation destination>\interface\dpf0401\samples\vb_net\ifcusb\ifcusb.vbproj After building the project file, IFCUSB.dll is created in the bin folder. 2. Adding Class Library Reference Visual C#.NET and Visual Basic.NET 2. Select Project > Add Reference. 3. Click the Browse button. 4. Specify the class library DLL to refer. <installation destination>\interface\dpf0401\samples\cs_net\ifcusb\bin\release\ifcusb.dll <installation destination>\interface\dpf0401\samples\vb_net\ifcusb\bin\relaase\ifcusb.dll 5. The DLL file will be displayed in Selected Components. 6. Click OK. 7. Add the namespace of InterfaceCorpDllWrap as below at the header of your source file to call the DLL functions. Visual C#.NET using InterfaceCorpDllWrap; Visual Basic.NET Imports InterfaceCorpDllWrap 5

6 Chapter 3 Programming Guide 3.1 Installation Refer to README.HTM for installation. 3.2 Control Method Refer to each driver s Help for control method of each I/O function. For corresponding software driver, see 1.2 Corresponding Software Driver for Each I/O. 6

7 Chapter 4 Reference 4.3 List of DLL Function No. Function Description Initialization 1 IfUsbDevicePowerCtl Controls the power supply of a USB device. 7

8 4.3.1 IfUsbDevicePowerCtl Description The IfUsbDevicePowerCtl function controls the power supply status of a USB device. Syntax Visual C++ int IfUsbDevicePowerCtl( int UsbNum, // USB number int PwrCtl // Power supply status ); Visual C#.NET [DllImport("ifusbpwr.dll")] int IfUsbDevicePowerCtl( int UsbNum, // USB number int PwrCtl // Power supply status ); Visual Basic.NET Declare Function CmlOpen Lib "ifusbpwr.dll"(_ ByVal UsbNum As Integer _ USB number ByVal PwrCtl As Integer _ Power supply status )As Integer Parameters UsbNum The parameter means the USB number. Specify 1. PwrCtl The parameter specifies the status of power supply. Return Values The IfUsbDevicePowerCtl function returns IFUSBPWR_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns another code. Please refer to the 4.4 Return Values. Comments As this function can control the status of power supply to the USB device, it is used when the USB device hangs while being controlled or when the status of USB device needs to be reset. However, when the power supply to the USB device stops, all I/O functions included in the USB device are disabled. Except when the USB device hangs, close all I/O functions in a normal way before using this function. 8

9 Example Controlling the status of power supply to the USB device Visual C++ using namespace System; using namespace System::Threading; int _tmain() { int ret; Console::WriteLine(L"USB Power OFF\n"); // USB Power OFF ret = IfUsbDevicePowerCtl(1, IFUSBPWR_POWER_OFF); if(ret){ Console::WriteLine("IfUsbDevicePowerCtl Error ret[{0}]", ret.tostring("x")); } Thread::Sleep(1000); Console::WriteLine(L"USB Power ON\n"); // USB Power ON ret = IfUsbDevicePowerCtl(1, IFUSBPWR_POWER_ON); if(ret){ Console::WriteLine("IfUsbDevicePowerCtl Error ret[{0}]", ret.tostring("x")); } } return 0; 9

10 Visual C#.NET using System; using InterfaceCorpDllWrap; using System.Threading; static void Main(string[] args) { int ret; Console.WriteLine("USB Power OFF"); // USB Power OFF ret = IFCUSB.IfUsbDevicePowerCtl(1, IFCUSB.IFUSBPWR_POWER_OFF); if(ret!= IFCUSB.IFUSBPWR_ERROR_SUCCESS){ Console.WriteLine("IfUsbDevicePowerCtl Error ret[{0:x}]", ret); } Thread.Sleep(1000); Console.WriteLine("USB Power ON"); } // USB Power ON ret = IFCUSB.IfUsbDevicePowerCtl(1, IFCUSB.IFUSBPWR_POWER_ON); if(ret!= IFCUSB.IFUSBPWR_ERROR_SUCCESS) { Console.WriteLine("IfUsbDevicePowerCtl Error ret[{0:x}]", ret); } return; Visual Basic.NET Imports System Imports System.Threading Imports InterfaceCorpDllWrap Sub Main() Dim ret As Integer Console.WriteLine("USB Power OFF") ' USB Power OFF ret = IFCUSB.IfUsbDevicePowerCtl(1, IFCUSB.IFUSBPWR_POWER_OFF) If ret <> IFCUSB.IFUSBPWR_ERROR_SUCCESS Then Console.WriteLine("IfUsbDevicePowerCtl Error ret[{0:x}]", ret) End If Thread.Sleep(1000) Console.WriteLine("USB Power ON") ' USB Power ON ret = IFCUSB.IfUsbDevicePowerCtl(1, IFCUSB.IFUSBPWR_POWER_ON) If ret <> IFCUSB.IFUSBPWR_ERROR_SUCCESS Then Console.WriteLine("IfUsbDevicePowerCtl Error ret[{0:x}]", ret) End If End Sub 10

11 4.4 Return Values Error Code Value Description IFUSBPWR_ERROR_SUCCESS 0 Successful completion IFUSBPWR_ERROR_FAILED_OPEN_IFCMGR 1h Driver open failed. IFUSBPWR_ERROR_FAILED_USBPWR_CTL 2h The power supply was not normally controlled. IFUSBPWR_ERROR_NOT_SUPPORT 3h Not supported 11

12 Chapter 5 Sample Programs 5.1 UsbPwrCtl Description This sample program controls the power supply to the USB device. Execution Procedure This product does not include executable files of the sample programs. Compile source codes to create executable file. Visual C++ 2. Select File > Open Workspace. 3. Open the makefile, *.dsp. 4. Build the project file. 5. Run the executable file, *.exe. Visual C++.NET 2. Select File > Open > Project. 3. Open the makefile, *.vcproj. 4. Build the project file. 5. Run the executable file, *.exe. Visual Basic 1. Start Visual Basic. 2. Open the project file, *.vbp. 3. Build the project file. 4. Run the executable file, *exe. Visual C#.NET 2. Select File > Open > Project. 3. Open the project file, *.csproj. *1 4. Build the project file. 5. Run the executable file, *.exe. Visual Basic.NET 2. Select File > Open > Project. 3. Open the project file, *.vbproj. *1 4. Build the project file. 5. Run the executable file, *.exe. Note: *1 The class library will be automatically built at the same time. 12

13 Chapter 6 Terms of Use 6.1 Limited Warranty Interface Corporation does not warrant uninterrupted or error-free operations of the source program. The entire risks as to the quality of or arising out of use or performance of the source program, if any, remains with you. Interface believes that information contained in the document is accurate. The document is carefully reviewed for technical accuracy. Interface reserves the right to make changes to subsequent editions of this document without prior notice to holders of this edition. Interface is not liable for any damages arising out of or related to this document or the information contained in it. Charts and tables contained in this document are only for illustration purposes and may vary depending upon a user's specific application. All official specifications are in metric. English unit is supplied for convenience. 6.2 Copyrights and Intellectual Property Rights Interface Corporation owns all titles and intellectual property rights in and to the products. The products include the product software, audio/visual content such as images, texts, or pictures. 6.3 Warning Regarding Medical and Clinical Use of Our Products Our products are not designed for components intended to ensure a level of reliability suitable for use under conditions that might cause serious injury or death. Our products are not designed with components and testing instrument intended to ensure a level of reliability suitable for use in treatment and diagnosis of human. Applications of our products involving medical or clinical treatment can create a potential for accidental injury caused by product failure, or by errors on the part of the user or application engineer. 6.4 Prohibition of Reproduction No part of this document may be reproduced or changed in any form without the prior consent of Interface Corporation. 6.5 Limitation of Liability Interface Corporation will not be liable for any special, incidental, indirect or consequential damages whatsoever even if Interface Corporation or any reseller could foresee the possibility of damages. Users shall assume any subsequent risks whatsoever resulting from such as using and installing this product. Interface Corporation shall not be liable for any incidental or consequential damages, including damages or other costs resulting from defects which might be contained in the product, product supply delay or product failure. Customer's right to recover damages caused by fault or negligence on the part of Interface Corporation shall be limited exclusively to product replacement. This product is designed under Japanese domestic specifications. Interface Corporation is not responsible for the use of this product outside Japan. We do not offer any maintenance service or technical support abroad. Interface Corporation is not liable for any damage arising from the included document or information. 6.6 Trademark Products and company names are trademarks, registered trademarks, or servicemarks of their respective owners. 13