HumidiProbe User Manual - Interworld Electronics
Contents
1. oe PL Limited HumidiProbe User Guide 2005 Pico Technology Limited All rights reserved HumidiProbe044 1 3 l HumidiProbe User Manual Contents Re at d e e WEE 2 1 About HumidiProbe 4 0e eenen ennen nennen enn nnneneneennenennnnnenennennn 2 2 Intended USC mnnmmmmerssnererrinearersdaarearddnansnnddnarvsnddnenrsndenanvenddvanwenddannes 2 3 This document rme sereen serene de edee e AE ege SES eh cs Ae Eee E deed seeders 2 Z Legal MOUGES E 3 1 CE notice sgusseuesuegsees negssgeeg ENEE EVERESENENESESNEN SEENEN ERENNERT 3 2 FCC notice ssessgegeggegeegeg E eESeEREREENEEE SES EE EErEE ARENES REEERE EE EE ENEE EE EEN ER 3 3 Licence conditions EEN EE EEN 3 A Warranty nnnnn nnen eennennnnneneeneernnnnnnnnnnrenvennnnannnnnnsnennennnnannnnnentennennnnannmnnnen 4 ERT EIT CN 4 6 Trademarks stervende Senden See D eg inkt dede eege eg de ee 4 3 Using HUMIGIPIODG ssssecederenrnnnenenenne ege ENEE ERR nesne POSO ranan Aanias 5 1 Specifications nnn nnen nnnaansnnenrennenennannnnnenrennensnnannnnnsnenvennnnaannnnnenennenen 5 2 Connecting HumidiProbe quick guide enen 6 3 Connecting HumidiProbe detailed guide nnee eenen 7 4 Driver SOMW Ale sees geess eege EES 10 T Introduetion a tezeee iseen a a ar paa aRar naana 10 2 HumidiProbeOpenUnit een 11 3 HumidiProbeOpenUnitAsync nnee eeeneeneeeeenennnnenenenenennnennnn 11 4 HumidiProbeOpenUnitProgress2. sssrnrrrrrrrrrrrnnnnnnnrerrnnnnnnnnnnene 11 5 HumidiProbeGetSingleValue ee NENNEN 12 6 HumidiProbeGetUnitl nfo EEN 13 7 HumidiProbeGetUnitl nfo error codes 0 00 en eene 14 8 HumidiProbeCloseUnit EEN 14 5 Writing your own programs nanenenenenennenenenennenenenennenenenennenensnenneneneneen 15 DS AE CEF ET 15 2 Delphi nnnnnnnannnnnnnrenennnenansnnnnsennennnnannnannnsennnnnnnannnnnnnreenennnnannnanensnvennnnnnn 15 SE dol EPE 15 WE EE 16 5 Visual Basic 24 zsvsvssererevsennenensensreen dense ennen eren diners s asin nie subswerd susan sik su beusedn 16 6 Agilent VEE nnnn ennen nenneneensenenvensennenennennenvennennenensenneneennnenvensen 16 Tt TE SE 17 HumidiProbe044 1 3 2005 Pico Technology Limited All rights reserved Introduction 2 1 Introduction 1 1 About HumidiProbe aa 2288 RSR ROSE 1 2 Intended use HumidiProbe is a complete self contained temperature and humidity measuring device It is calibrated to give highly accurate readings which it takes every two seconds from a dual purpose humidity and temperature sensor Its USB connector is compatible with standard PCs and laptops The PicoLog data logging program will collect data supplied by the HumidiProbe or you can use the HumidiProbe driver software to custom build your own programs that take advantage of its features PicoLog and the driver support up to four HumidiProbe units HumidiProbe is suitable
3. The HumidiProbe Channels dialog box appears HumidiProbe Channels x Temp unused Edit Humidity unused Disable Help 8 Double click on Temp unused The Edit HumidiProbe Channel dialog box appears Edit HumidiProbe Channel x Name Temperature Cancel Help Options 9 Click OK PicoLog activates the Temperature parameter 10 Double click on Humidity unused The Edit HumidiProbe Channel dialog box appears 2005 Pico Technology Limited All rights reserved HumidiProbe044 1 3 9 HumidiProbe User Manual 11 Click OK PicoLog activates the Humidity parameter 12 Atthe HumidiProbe Channels dialog box click OK The recorder view should now display the temperature and humidity IPL Recorder TTE File Settings View Help Bl ele wl el e Awaiting data filename Use File New data DB Temperature Humidity HumidiProbe044 1 3 2005 Pico Technology Limited All rights reserved Driver software 10 4 4 1 Driver software Introduction HumidiProbe is supplied with driver routines that allow you to write your own programs The drivers are for use with the following operating systems Microsoft Windows 98SE Microsoft Windows ME Microsoft Windows 2000 Microsoft Windows XP Once you have installed the software you will find a Drivers directory containing the drivers anda selection of examples of how to use them The dire
4. 5 Installation 6 7 Intended use 2 Interface 5 LabVIEW 16 Liability 3 Licence conditions 3 M Microsoft Windows 10 Mission critical applications 3 O Overview 2 P PicoLog 2 6 7 Protection 5 Repairs 4 Resolution 5 Response times 5 S Specifications 5 T Temperature range 5 Trademarks 4 U Usage 3 USB 5 HumidiProbe044 1 3 2005 Pico Technology Limited All rights reserved Index 18 V Visual Basic 16 W Warranty 4 Windows Microsoft 10 2005 Pico Technology Limited All rights reserved HumidiProbe044 1 3 Interworld Electronics amp Computers Inc P O Box 1280 145 Tyee drive Suite 3120 Point Roberts WA 98281 Tel 1 877 902 2979 Fax 1 877 FAX IECI Web www interworldna com HumidiProbe044 1 3 17 11 05
5. To use the example copy these files to your LabVIEW directory HProbe vi HumidiProbe dll The example program displays the temperature in degrees Celsius and the relative humidity in percent 5 5 Visual Basic The Drivers subdirectory contains the following files HPROBE VBP HPROBE BAS HPROBE FRM 5 6 Agilent VEE Two example programs are supplied in the drivers directory one for VEE 6 and the other for VEE 7 They show how to collect readings continuously from the HumidiProbe and log the data to disk VEE 6 The example program HProbe6 vee is in the Drivers directory It was tested using Agilent VEE version 6 under Windows VEE 7 The example program HProbe7 vee is in the Drivers directory It was tested using Agilent VEE version 7 under Windows 2005 Pico Technology Limited All rights reserved HumidiProbe044 1 3 17 HumidiProbe User Manual Index A Access 3 Accuracy 5 Agilent VEE 16 C C C 15 CE notice 3 Connecting HumidiProbe 7 Connecting HumidiProbe quick guide 6 Connector 5 Conversion time 5 12 Copyright 3 D Delphi 15 Dimensions 5 DLL 10 Driver 10 E Enclosure 5 Error codes 14 Excel 15 F FCC notice 3 Filtering 12 Fitness for purpose 3 H Help files 2 HumidiProbeCloseUnit 14 HumidiProbeGetSingleValue 12 HumidiProbeGetUnitInfo 13 14 HumidiProbeOpenUnit 11 HumidiProbeOpenUnitAsync 11 HumidiProbeOpenUnitProgress 11 Humidity range
6. by Pico Technology Limited or its authorised distributors Trademarks Borland Delphi and Turbo Pascal are trade marks or registered trade marks of Borland International Inc Windows Excel and Visual Basic are registered trademarks or trademarks of Microsoft Corporation in the USA and other countries National Instruments and LabVIEW are trademarks of National Instruments Corporation registered in the United States and other countries Agilent VEE is a registered trade mark of Agilent Technologies Pico Technology Limited PicoLog and HumidiProbe are trademarks of Pico Technology Limited registered in the United Kingdom and other countries 2005 Pico Technology Limited All rights reserved HumidiProbe044 1 3 HumidiProbe User Manual 3 3 1 Using HumidiProbe Specifications Humidity Range 0 to 100 relative humidity non condensing Accuracy 2 Resolution 0 03 Response time 4 seconds Temperature Range Oto 70 C Accuracy 0 5 C Resolution 0 01 C Response time 5 to 30 seconds Conversion time 2 seconds humidity and temperature Interface USB 1 1 compatible with USB 2 0 Connector Integrated USB cable and connector Enclosure Dimensions 22 mm length 170 mm approx 4 5 m including cable Material Grey ABS Protection NOT waterproof HumidiProbe044 1 3 2005 Pico Technology Limited All r
7. for measuring temperature and relative humidity in benign environments particularly indoors You must not expose the unit to temperatures outside the maximum range see Specifications The driver software which runs under Microsoft Windows 98SE ME 2000 XP or later contains everything necessary to convert the sensor readings into temperature and relative humidity 1 3 This document This document describes the physical and electrical properties of HumidiProbe and explains how to use the software drivers For more information about using HumidiProbe with PicoLog please consult the following files PLWO44 hlp Windows help file PLW044 pdf printable PDF file 2005 Pico Technology Limited All rights reserved HumidiProbe044 1 3 HumidiProbe User Manual 2 2 1 2 2 2 3 Legal notices CE notice The HumidiProbe meets the intent of EMC directive 89 336 EEC and meets the EN61326 1 1997 Class A Emissions and Immunity standard The HumidiProbe also meets the intent of the Low Voltage Directive and meets the BS EN 61010 1 2001 IEC 61010 1 2001 safety requirements for electrical equipment control and laboratory use standard FCC notice This equipment has been tested and found to comply with the limits for a Class A digital device pursuant to Part 15 of the FCC Rules These limits are designed to provide reasonable protection against harmful interference when the equipment is operate
8. 3 11 HumidiProbe User Manual 4 2 HumidiProbeOpenUnit short HumidiProbeOpenUnit void This routine opens a HumidiProbe unit The driver can support up to four units If you wish to use more than one HumidiProbe call the routine once for each unit Arguments None Returns ch If the unit fails to open 0 If no unit is found gt 0 Handle to the device opened 4 3 HumidiProbeOpenUnitAsync short HumidiProbeOpenUnitAsyne void This routine opens a HumidiProbe unit without blocking the calling function Arguments None Returns 0 If there is a previous open operation in progress 1 If the call has successfully initiated an open operation 4 4 HumidiProbeOpenUnitProgress short HumidiProbeOpenUnitProgress short handle short progress This routine checks the progress of an asynchronous open operation initiated by HumidiProbeOpenUnitAsync Arguments handle A pointer to a short where the unit handle is to be written progress A pointer to a short where the percentage progress is to be written Returns TRUE If the driver successfully opens the HumidiProbe handle 1 if the unit fails to open 0 if no unit is found gt 0 handle of device valid only if function returns TRUE progress 100 implies that open operation is complete HumidiProbe044 1 3 2005 Pico Technology Limited All rights reser
9. ctory also contains a copy of this manual as a PDF file The 32 bit Windows driver is supplied as a DLL HumidiProbe d11 installed in the Drivers subdirectory This can be used with C Delphi LabVIEW Agilent VEE and Visual Basic programs It can also be used with programs like Microsoft Excel where the macro language is a form of Visual Basic More than one application can access the Windows DLL at the same time as long as the applications do not change the settings for channels that they are not using The following table specifies the function of each of the routines that the driver exports Routine Function HumidiProbeOpenUnit Open a HumidiProbe unit HumidiProbeOpenUnitAsync Open a HumidiProbe unit without blocking the calling thread HumidiProbeOpenUnitProgress Check the progress of an asynchronous open operation HumidiProbeGetUnitInfo Obtain unit information in a character string HumidiProbeGetSingleValue Get the most recent temperature and relative humidity readings HumidiProbeCloseUnit Shut down a HumidiProbe unit All routines are C functions using the standard call naming convention __stdcal1i and are exported with both decorated and undecorated names The normal calling sequence for these routines is as follows Open driver While you want to measure temperatures Get temperature and humidity End while Close driver 2005 Pico Technology Limited All rights reserved HumidiProbe044 1
10. d in a commercial environment This equipment generates uses and can radiate radio frequency energy and if not installed and used in accordance with the instruction manual may cause harmful interference to radio communications Operation of this equipment in a residential area is likely to cause harmful interference in which case the user will be required to correct the interference at his or her own expense For safety and maintenance information see the safety warning Licence conditions The material contained in this release is licensed not sold Pico Technology Limited grants a licence to the person who installs this software subject to the conditions listed below Access The licensee agrees to allow access to this software only to persons who have been informed of these conditions and agree to abide by them Usage The software in this release is for use only with Pico products or with data collected using Pico products Copyright Pico Technology Limited claims the copyright of and retains the rights to all material software documents etc contained in this release You may copy and distribute the entire release in its original state but must not copy individual items within the release other than for backup purposes Liability Pico Technology and its agents shall not be liable for any loss damage or injury howsoever caused related to the use of Pico Technology equipment or software unless excluded by statute Fitness f
11. ico Technology Limited All rights reserved HumidiProbe044 1 3 13 HumidiProbe User Manual 4 6 HumidiProbeGetUnitinfo short HumidiProbeGetUnitInfo short handle ehar String short stringLength short info A This routine obtains information from the driver about the specified HumidiProbe unit Arguments handle The handle of the device for which information is required If an invalid handle is passed the error code from the last unit that failed to open is returned when info HUMIDIPROBE_ERROR 7 string A pointer to the character string buffer in the calling function where the unit information string selected with info will be stored If a null pointer is passed no information will be written stringLength The length of the character string buffer If the string is not long enough to accept all of the information only the first stringLength characters are returned info An enumerated type specifying what information is required from the driver Returns 0 If one or more parameters is out of range or a null pointer is passed for string HE length of the string written to the character string buffer S tring Allowed values for info argument info Description Example HUMIDIPROBE_DRIVER_VERSION 0 The version of 1 0 0 1 HumidiProbe dll A valid handle is optional when calling the functio
12. idiProbeApi h HumidiProbe d11 All 32 bit applications C C programs can access all versions of the driver If HumidiProbeApi h is included in a C program the PREF1 macro expands to extern Cc this disables name decoration as Microsoft calls it and enables C routines to make calls to the driver routines using C headers Delphi The Win sub directory contains HPROBE DPR a simple program which opens the drivers and reads temperature and humidity You will need the following files to build a complete program HProbeFM dfm HProbeFM pas hprobe inc hprobe inc contains procedure prototypes for the driver routines You can include this file in your application This example has been tested with Delphi version 3 Excel The easiest way to transfer data to Excel is to use PicoLog If however you need to do something that is not possible using PicoLog you can write an Excel macro which calls the driver to read in a set of data values The Excel macro language is similar to Visual Basic HProbe xls an example file reads in 20 values of the channel 1 temperature one per second and assigns them to cells A1 A20 HumidiProbe044 1 3 2005 Pico Technology Limited All rights reserved Writing your own programs 16 5 4 LabVIEW The HProbe vi example in the Drivers subdirectory shows how to access the driver functions using LabVIEW It was tested using version 6 1 of LabVIEW for Windows
13. ights reserved Using HumidiProbe 6 3 2 Connecting HumidiProbe quick guide Important note Always install the PicoLog software BEFORE connecting your HumidiProbe to the computer for the first time Once the software is installed connect the HumidiProbe to the USB port on your computer using the integrated cable and connector To set up the unit with PicoLog do the following naan NO 8 9 10 11 Open PicoLog Recorder Select New settings from the File menu In the Recording dialog box click OK In the Sampling Rate dialog box click OK In the Converter details dialog box select HumidiProbe from the drop down box and click OK In the HumidiProbe Channels dialog box double click on Temp unused In the Edit HumidiProbe Channel dialog box click OK and PicoLog will activate the Temperature parameter In the HumidiProbe Channels dialog box double click on Humidity unused In the Edit HumidiProbe Channel dialog box click OK and PicoLog will activate the Humidity parameter In the HumidiProbe Channels dialog box click OK PicoLog Recorder should now display the temperature and humidity For a more detailed description of the procedure see Connecting HumidiProbe detailed quide 2005 Pico Technology Limited All rights reserved HumidiProbe044 1 3 7 HumidiProbe User Manual 3 3 Connecting HumidiProbe detailed quide Important note Always install
14. n with info 0 HUMIDIPROBE USB VERSION 1 The type of USB port to which the 1 1 HumidiProbe is connected HUMIDIPROBE HARDWARE VERSION 2 The hardware version of the 2 HumidiProbe attached HUMIDIPROBE_ VARIANT _ INFO 3 The type of HumidiProbe 1 attached HUMIDIPROBE BATCH AND SERIAL 4 The batch and serial number of GFY72 3 the unit HUMIDIPROBE CAL DATE 5 The calibration date of the unit 14Mar05 HUMIDIPROBE KERNEL DRIVER VERSION 6 The kernel driver version Ee HUMIDIPROBE_ERROR 7 An error code see 4 list of error codes below HumidiProbe044 1 3 2005 Pico Technology Limited All rights reserved Driver software 14 4 7 HumidiProbeGetUnitInfo error codes HumidiProbeGetUnitInfo will return one of the following error codes when called with info HUMIDIPROBE_ERROR 7 Error Symbol Description code 0 HUMIDIPROBE_OK The HumidiProbe is functioning correctly 1 HUMIDIPROBE_KERNEL_DRIVER The kernel driver picopp sys does not support this product 2 HUMIDIPROBE_NOT_FOUND No HumidiProbe could be found 3 HUMIDIPROBE_CONFIG_FAIL Unable to download firmware 4 HUMIDIPROBE_INVALID_PARAMETERS Temperature and Humidity parameters are both null 5 HUMIDIPROBE_CONVERSION_FAILED The unit
15. or purpose Because no two applications are the same Pico Technology cannot guarantee that its equipment or software is suitable for a given application It is your responsibility therefore to ensure that the product is suitable for your application Mission critical applications This software is intended for use on a computer that may be running other software products For this reason one of the conditions of the licence is that it excludes usage in mission critical applications for example life support systems HumidiProbe044 1 3 2005 Pico Technology Limited All rights reserved Legal notices 4 2 4 2 5 2 6 Warranty Pico Technology warrants upon delivery and for a period of 24 months unless otherwise stated from the date of delivery that the Goods will be free from defects in material and workmanship Pico Technology shall not be liable for a breach of the warranty if the defect has been caused by fair wear and tear wilful damage negligence abnormal working conditions or failure to follow Pico Technology s spoken or written advice on the storage installation commissioning use or maintenance of the Goods or if no advice has been given good trade practice or if the Customer alters or repairs such Goods without the written consent of Pico Technology Repairs The unit contains no user serviceable parts Repair or calibration of the unit requires specialised test equipment and must be performed
16. the PicoLog software BEFORE connecting your HumidiProbe to the computer for the first time Once the software is installed connect the HumidiProbe to the USB port on your computer using the integrated cable and connector To set up the unit with PicoLog do the following 1 Open PicoLog Recorder The application opens at the recorder view Tj PLw Recorder LE File Settings View Help SE wel r Settings not defined yet Use File New settings 2 Select New settings from the File menu PicoLog displays the Recording dialog box recording xi Recording method Real time continuous DI Action at end of run Stop Restart delay fi Minutes J Use multiple converters Cancel Help 3 Click OK The Sampling Rate dialog box appears Sampling Rate x Sampling interval H Seconds DI Maximum number of samples soo Sen Readi enden Si As many as possible DI Help HumidiProbe044 1 3 2005 Pico Technology Limited All rights reserved Using HumidiProbe 8 4 Click OK PicoLog displays the Converter details dialog box Converter details x Converter type Humidiprobe kd Port z Cancel USB Devices Hel p Device Serial Status Refresh USB enumeration progress 5 From the Converter type drop down list select Humidiprobe 6 After a few seconds the program will detect the HumidiProbe and list it under USB Devices 7 Click OK
17. tried to get a new temperature and humidity reading and failed 6 HUMIDIPROBE_FW_FAIL The firmware could not be loaded 7 HUMIDIPROBE_ERROR_OS_NOT_SUPPORTED The driver does not support this operating system 4 8 HumidiProbeCloseUnit void HumidiProbeCloseUnit short handle This routine shuts down the specified HumidiProbe unit You do not need to call this routine before exiting the application as the driver will automatically shut down the unit However you can call it if you need to shut down the unit without exiting the application Arguments handle The handle returned by HumidiProbeOpenUnit of the HumidiProbe to be closed Returns I If a valid handle is passed 0 If not 2005 Pico Technology Limited All rights reserved HumidiProbe044 1 3 15 HumidiProbe User Manual 5 5 1 5 2 5 3 Writing your own programs C C CG The C program HumidiProbeCon c provided as an example with the driver is a generic Windows application meaning it does not use Borland AppExpert or Microsoft AppWizard To compile the program create a new project for an application containing the following files HProbe c HProbe rc and either HumidiProbebc 1ib Borland 32 bit applications or HumidiProbe 1lib Microsoft Visual C 32 bit applications The following files must be in the same directory Hum
18. ved Driver software 12 4 5 HumidiProbeGetSingleValue short HumidiProbeGetSingleValue Short float Shore float short handle temp filterTemp humidity filterHumidity This routine retrieves the temperature and relative humidity from the specified HumidiProbe unit New readings are available every two seconds If you call the routine more frequently than this it will return old readings Arguments handle the handle returned by HumidiProbeOpenUnit temp a pointer to the temperature from the driver in degrees Celsius If temp is a null pointer it is ignored filterTemp if O temp is unfiltered if non zero temp is the median of a number of readings humidity a pointer to the relative humidity from the driver in percent If humidity is a null pointer it is ignored filterHumidity if 0 humidity is unfiltered if non zero humidity is the median of a number of readings Returns one of the codes shown below indicating the status of the temperature and humidity readings Status codes Code Symbol Description 0 HUMIDIPROBE_CR_NONE No new readings were taken 1 HUMIDIPROBE_CR_OLD_READING The temperature and humidity returned are old readings because the previous readings were less than 2 seconds old 2 HUMIDIPROBE_CR_NEW_READING The temperature and humidity are new readings 2005 P
Download Pdf Manuals
Related Search