Spectracom TSAT-PCI, TSAT-PCI-U, TPRO-PCI, TPRO-PCI-U Programmer's Manual

TPRO/TSAT-PCI

SYNCHRONIZABLE TIMECODE

GENERATOR with

UNIVERSAL PCI BUS INTERFACE

Windows Driver Application Programmer’s Guide

95 Methodist Hill Drive

Rochester, NY 14623

Phone: US +1.585.321.5800

Fax: US +1.585.321.5219

www.spectracomcorp.com

Part Number 1186-5002-0050

Manual Revision C

December 2010

Copyright © 2009 Spectracom Corporation. The contents of this publication may not be reproduced
in any form without the written permission of Spectracom Corporation. Printed in USA.

Specifications subject to change or improvement without notice.

Spectracom, NetClock, Ageless, TimeGuard, TimeBurst, TimeTap, LineTap, MultiTap, VersaTap, and
Legally Traceable Time are Spectracom registered trademarks. All other products are identified by
trademarks of their respective companies or organizations. All rights reserved.

LIMITED WARRANTY

SPECTRACOM LIMITED WARRANTY

Spectracom warrants each new product manufactured and sold by
it to be free from defects in software, material, workmanship, and
construction, except for batteries, fuses, or other material normally
consumed in operation that may be contained therein AND AS
NOTED BELOW, for five years after shipment to the original
purchaser (which period is referred to as the “warranty period”).
This warranty shall not apply if the product is used contrary to the
instructions in its manual or is otherwise subjected to misuse,
abnormal operations, accident, lightning or transient surge, repairs
or modifications not performed by Spectracom.

The GPS receiver is warranted for one year from date of shipment
and subject to the exceptions listed above. The power adaptor, if
supplied, is warranted for one year from date of shipment and
subject to the exceptions listed above.

THE ANALOG CLOCKS ARE WARRANTED FOR ONE YEAR
FROM DATE OF SHIPMENT AND SUBJECT TO THE EXCEPTIONS
LISTED ABOVE.

THE TIMECODE READER/GENERATORS ARE WARRANTED FOR
ONE YEAR FROM DATE OF SHIPMENT AND SUBJECT TO THE
EXCEPTIONS LISTED ABOVE.

The Rubidium oscillator, if supplied, is warranted for two years from
date of shipment and subject to the exceptions listed above.

All other items and pieces of equipment not specified above,
including the antenna unit, antenna surge suppressor and antenna
pre-amplifier are warranted for 5 years, subject to the exceptions
listed above.

WARRANTY CLAIMS

Spectracom’s obligation under this warranty is limited to in-factory
service and repair, at Spectracom’s option, of the product or the
component thereof, which is found to be defective. If in
Spectracom’s judgment the defective condition in a Spectracom
product is for a cause listed above for which Spectracom is not
responsible, Spectracom will make the repairs or replacement of
components and charge its then current price, which buyer agrees
to pay.

Spectracom shall not have any warranty obligations if the
procedure for warranty claims is not followed. Users must notify
Spectracom of the claim with full information as to the claimed
defect. Spectracom products shall not be returned unless a return
authorization number is issued by Spectracom.

Spectracom products must be returned with the description of the
claimed defect and identification of the individual to be contacted
if additional information is needed. Spectracom products must be
returned properly packed with transportation charges prepaid.

Shipping expense: Expenses incurred for shipping Spectracom
products to and from Spectracom (including international customs
fees) shall be paid for by the customer, with the following
exception. For customers located within the United States, any
product repaired by Spectracom under a “warranty repair” will be
shipped back to the customer at Spectracom’s expense unless
special/faster delivery is requested by customer.

Spectracom highly recommends that prior to returning equipment for
service work, our technical support department be contacted to
provide trouble shooting assistance while the equipment is still
installed. If equipment is returned without first contacting the support
department and “no problems are found” during the repair work,
an evaluation fee may be charged.

EXCEPT FOR THE LIMITED WARRANTY STATED ABOVE,
SPECTRACOM DISCLAIMS ALL WARRANTIES OF ANY KIND
WITH REGARD TO SPECTRACOM PRODUCTS OR OTHER
MATERIALS PROVIDED BY SPECTRACOM, INCLUDING
WITHOUT LIMITATION ANY IMPLIED WARRANTY OR
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Spectracom shall have no liability or responsibility to the original
customer or any other party with respect to any liability, loss, or
damage caused directly or indirectly by any Spectracom product,
material, or software sold or provided by Spectracom, replacement
parts or units, or services provided, including but not limited to any
interruption of service, excess charges resulting from malfunctions of
hardware or software, loss of business or anticipatory profits
resulting from the use or operation of the Spectracom product or
software, whatsoever or howsoever caused. In no event shall
Spectracom be liable for any direct, indirect, special or
consequential damages whether the claims are grounded in
contract, tort (including negligence), or strict liability.

EXTENDED WARRANTY COVERAGE

Extended warranties can be purchased for additional periods
beyond the standard five-year warranty. Contact Spectracom no
later than the last year of the standard five-year warranty for
extended coverage.

SPECTRACOM 95 Methodist Hill Drive Rochester, NY 14623

+1.585.321.5800 FAX: [phone] www.spectracomcorp.com [e-mail]

Spectracom Corporation TPRO-PCI-U/TSAT-PCI-U — Windows Driver

iii

Table of Contents

1 OVERVIEW
2 INSTALLING THE DRIVER

2.1 Running the TPRO/TSAT Control Utility ........................................................................................ 2-2

2.2 Clock Daemon Utilities................................................................................................................... 2-2

2.3 Example Executables and Source Code ....................................................................................... 2-4

3 INTERFACE TO THE WINDOWS API

3.1 Header File .................................................................................................................................... 3-1

3.2 TPRO API — Routine Descriptions ............................................................................................... 3-7

..................................................................................................

...............................................................................

................................................................

1-1
2-1

3-1

Synchronizable Timecode Generator Application Programmer’s Guide

Spectracom Corporation TPRO-PCI-U/TSAT-PCI-U — Windows Driver

1-1

1 Overview

1.1

General

The TPRO/TSAT PCI Windows Driver provides an interface between the PCI board and
applications developed for 32-bit or 64-bit Windows™ operating systems. In addition to the
interface library, a Control Utility program, Time Daemon Utility and example programs with
source code are provided. The TPRO/TSAT PCI Windows Driver has been tested for
compatibility with the following versions of Windows:

• Windows 2000

• Windows XP

• Windows Server 2003

• Windows Vista

• Windows Server 2008 & R2

• Windows 7

The 32-bit library file and DLL (tpro.lib & tpro.dll) can be found in the “KSI\Dev”
directory under “Program Files”. Similarly, the 64-bit versions of the same files are located
in the “KSI\Dev64” directory under “Program Files (x86)“ on 64-bit operating systems.

1.2

Features

The TPRO/TSAT PCI Windows Driver includes the following:

• Interface API library that accesses all of the PCI board features

• Example programs with source code, utilizing the API library

• A Control Utility that can be used to retrieve data from the card and/or modify card

settings

• A Time Daemon tray Utility and Time Daemon service that query the TPRO/TSAT-PCI
card and sets the computer’s system clock at a user-defined interval

Synchronizable Timecode Generator Application Programmer’s Guide

Spectracom Corporation TPRO-PCI-U/TSAT-PCI-U — Windows Driver

2-1

2 Installing the Driver

NOTE: If your system is equipped with the TPRO-TSAT PCI software driver, it must be

uninstalled before installing the new, updated driver. To uninstall the driver:

1. Go to “Control Panel”, “Add/Remove Programs”

2. Remove “TPRO-TSAT PCI”

To install the driver, perform the following steps:

1. Install the TPRO/TSAT-PCI card in a vacant slot on the computer to be used.

2. Switch on the PC power. Once the PC is running, Windows may prompt you to install the
newly found hardware. Disregard and cancel this dialog box.

3. Insert the CD with the TPRO/TSAT-PCI driver into the CD-ROM drive and follow the
automated installation procedure. If Auto-Run is disabled, manually install the driver by
running “setup.exe” from the Windows driver folder located on the CD.

4. Once the driver installation has completed, the computer must be rebooted for the changes
to take effect.

The following folders are created in the Program Files folder under “KSI” when the driver is
installed:

• control – contains the Clock Daemon utilities, daemon.ini, and Control utility

• dev – contains “tpro.h” and “tpro.dll” files needed for application software

development

• documentation – contains PCI user manual and application programmer’s guide

• drivers – contains all Windows driver files

• examples – contains example executables and source code for each TPRO API

Synchronizable Timecode Generator Application Programmer’s Guide