HHLib Programming Library for HydraHarp 400 
Version 3.0.0.4
PicoQuant GmbH - April 2022


Introduction

The HydraHarp 400 is a TCSPC and time tagging system with USB interface. 
The system requires a 686 class PC with USB 2.0/3.0 host controller,
4 GB of memory and at least a 1.5 GHz dual core CPU. The HydraHarp 
software is supported under Windows 8.1 and 10. Windows 7 should still 
work but is no longer actively tested or supported.
The programming library is a DLL with demos for various programming 
languages. Please refer to the manual (PDF) for instructions.


What's new in version 3.0.0.4

- Solves an issue where the library could not be loaded in LabVIEW 
  and some other programming environments due to an unfortunate 
  restriction of the load address. 
- Provides some more advanced demos in C, C#, Python and Delphi, 
  most importantly some new demos for instant processing of TTTR data
- Now officially supporting Windows 11.


What was new in version 3.0.0.3

Version 3.0.0.3 is a bugfix release addressing the following issues: 
- Fixes a bug where warnings were wrong or missing upon change of 
  measurement modes.  
- Provides updated device drivers v2.16 with better recovery from USB 
  errors, secure boot is now supported. 
- Supports Windows 10 and 8.1 (Windows 7 probably still works but is 
  no longer tested and supported). 
- Includes updated demos.
Please read the notes for version 2.0 below if you are upgrading 
from a library version prior to 2.0! 


What was new in version 3.0.0.2

Version 3.0.0.2 was a bugfix release addressing the following issues:
- Fixes a firmware bug in continuous mode where the hardware controlled 
  start of a measurement did not work properly in repetition.
- Fixes a bug where the library routine HH_SetOffset was not working 
  properly in T3 mode. 
- Fixes a bug where the library routine HH_GetWarnings was giving false
  warnings at the first call after initialization.
- Fixes several documentation errors and omissions.
- Provides a new device driver PQUSB v.2.13 fixing compatibility issues
  with some HP workstations (note: secure boot is not supported)
- Includes new and improved demos.
Please read the notes for version 2.0 below if you are upgrading 
from a library version prior to 2.0! 


What was new in version 3.0.0.1

Version 3.0.0.1 fixes an incompatibility with USB 3.0 ports of Intel Z97 
chipsets. It also provides an updated device driver to meet new Windows 
driver signing requirements (XP and Vista are no longer supported).
The demos remain unchanged from version 3.0.0.0. 
Please read the notes for version 2.0 below if you are upgrading 
from a library version prior to 2.0! 


What was new in version 3.0

Version 3.0 is an improvement release that supersedes versions 2.x. 
Please upgrade if you installed version 2.x. If you are still using 
version 1.x, please read the following notes carefully.


What was new in version 2.0 versus 1.2

- Supports HydraHarp devices with USB 3.0 interface 
- Supports time bin widths of up to 33.5 µs and histogram time spans 
  up to 2.2 seconds. 
- Supports compressed TTTR overflow records for file size reduction at 
  low count rates. 
- Fixes some minor bugs. 
- NOTE 1: Version 2.0 requires a firmware update of the HydraHarp device. 
  The HydraHarp software can perform this update when it is first started.
- NOTE 2: This version has a new TTTR data format. 

IMPORTANT! The firmware update requirement has consequences that you 
must observe:

1. Once the update is performed you will no longer be able to use any 
   HydraHarp software prior to version 2.0.
2. Custom software you may have written for file import will require 
   minor adaptions for version 2.0.
3. You will no longer be able to use custom software based on HHLib.dll 
   prior to version 2.0.
4. Custom DLL-based software you may have written will require minor 
   adaptions for version 2.0.
5. In case of a power failure or computer crash during the update the 
   device may become inoperational.
6. Reverting to old firmware or repairing a disrupted update requires 
   a return to factory and may incur costs.


Installation 

Before installation, make sure to backup any work you kept in previous
installation directories and uninstall any older versions of HHLib.
The HHLib package can be distributed on CD, via download or via email.
The setup distribution file is setup.exe.
If you received the package via download or email, it may be packed in a 
zip-file. Unzip that file and place the distribution setup file in a 
temporary disk folder. Start the installation by running setup.exe before
connecting the HydraHarp device.

The setup program will install the programming library including manual, 
and programming demos. Note that the demos create output files and must 
have write access in the folder where you run them. This may not be the 
case in the default installation folder. If need be, please adjust the 
acces permissions or copy the demos to a suitable folder.

Before uninstalling the HHLib package, please backup your measurement data 
and custom programs.
From the start menu select:  PicoQuant - HydraHarp-HHLib vx.x  >  uninstall.
Alternatively you can use the Control Panel Wizard 'Add/Remove Programs'
(in some Windows versions this Wizard is called 'Software')


Disclaimer

PicoQuant GmbH disclaims all warranties with regard to this software 
and associated documentation including all implied warranties of 
merchantability and fitness. In no case shall PicoQuant GmbH be 
liable for any direct, indirect or consequential damages or any material 
or immaterial damages whatsoever resulting from loss of data, time 
or profits arising from use or performance of this software.


License and Copyright Notice

With the HydraHarp hardware product you have purchased a license to use 
the HydraHarp software. You have not purchased other rights to the software. 
The software is protected by copyright and intellectual property laws. 
You may not distribute the software to third parties or reverse engineer, 
decompile or disassemble the software or part thereof. You may use and 
modify demo code to create your own software. Original or modified demo 
code may be re-distributed, provided that the original disclaimer and 
copyright notes are not removed from it. Copyright of the manual and 
on-line documentation belongs to PicoQuant GmbH. No parts of it may be 
reproduced, translated or transferred to third parties without written 
permission of PicoQuant GmbH. 


Trademark Disclaimer

HydraHarp, PicoHarp, TimeHarp and NanoHarp are registered trademarks 
of PicoQuant GmbH. Other products and corporate names appearing in the 
product manuals or in the online documentation may or may not be registered 
trademarks or copyrights of their respective owners. They are used only 
for identification or explanation and to the owner’s benefit, without 
intent to infringe.


Contact and Support

PicoQuant GmbH
Rudower Chaussee 29
12489 Berlin, Germany
Phone +49 30 1208820-0
Fax   +49 30 1208820-90
email info@picoquant.com