Download
Share
Print this page
  1. Manuals
  2. Brands
  3. Spectracom Manuals
  4. Inverter
  5. TSAT-PCI
  6. Programmer's manual

Spectracom TSAT-PCI Programmer's Manual

Synchronizable timecode generator with universal pci bus interface, windows driver application
Hide thumbs

Advertisement

Quick Links

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

Advertisement

loading
Need help?

Need help?

Do you have a question about the TSAT-PCI and is the answer not in the manual?

Questions and answers

Related Manuals for Spectracom TSAT-PCI

Summary of Contents for Spectracom TSAT-PCI

  • Page 1 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...
  • Page 2 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.
  • Page 3 Spectracom’s judgment the defective condition in a Spectracom Spectracom be liable for any direct, indirect, special or product is for a cause listed above for which Spectracom is not consequential damages whether the claims are grounded in responsible, Spectracom will make the repairs or replacement of contract, tort (including negligence), or strict liability.

  • Page 5: Table Of Contents

    Spectracom Corporation TPRO-PCI-U/TSAT-PCI-U — Windows Driver Table of Contents ....................OVERVIEW ................INSTALLING THE DRIVER Running the TPRO/TSAT Control Utility ..................2-2 Clock Daemon Utilities........................2-2 Example Executables and Source Code ..................2-4 INTERFACE TO THE WINDOWS API ..............Header File ............................ 3-1 TPRO API —...

  • Page 7: Overview

    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...

  • Page 9: Installing The Driver

    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.

  • Page 10: Running The Tpro/Tsat Control Utility

    A small icon — — will show up in the system tray. Double click on that icon to display a window. A shortcut can also be found in the “Start/Spectracom Corp/PCI” Windows Start menu. Synchronizable Timecode Generator Application Programmer’s Guide...
  • Page 11 Daemon.exe”, but it will run as a Windows service. It will run automatically at boot-up and does not need to be added to the user’s Startup folder. The program can be found in the folder C:\Program Files\KSI\control and a shortcut can be found in the “Start/Spectracom Corp/PCI” Windows Start menu.

  • Page 12: Example Executables And Source Code

    TPRO-PCI-U/TSAT-PCI-U — Windows Driver Spectracom Corporation 2.3 Example Executables and Source Code The driver package includes folders with example programs to interface to the board. The source code and make files for the example programs are included. All of the example programs were compiled using Visual Studio 2005.

  • Page 13: Interface To The Windows Api

    ** Purpose: Contains structures and definions used to interface with the TPRO-PCI or TSAT-PCI API. Applications that access the API should include this header. ** Copyright(C) 2007 Spectracom Corporation. All Rights Reserved ****************************************************************** ** Modifications: 08/08/2007 Multi-user enablement ******************************************************************/ #ifndef _defined_TPRO_...
  • Page 14 TPRO-PCI-U/TSAT-PCI-U — Windows Driver Spectracom Corporation ** Length of firmware rev string #define TPRO_FIRMWARE_LENGTH ( 4 ) ** Length of driver version string "XX.YY" ** (not including termination) #define TPRO_DRV_VERSION_LENGTH ( 5 ) Match constants #define MATCH_TIME_START // start time...
  • Page 15 Spectracom Corporation TPRO-PCI-U/TSAT-PCI-U — Windows Driver unsigned char month; /*-- month ---------------*/ unsigned char day; /*-- day -----------------*/ } /*----------------------------------------------------------------------*/ TPRO_DateObj; /*========================================================================== TPRO LONGITUDE/LATTITUDE OBJECT ==========================================================================*/ typedef struct TPRO_LongLat { /*----------------------------------------------------------------------*/ unsigned short degrees; /*-- degrees -------------*/ float minutes; /*-- minutes -------------*/ } /*----------------------------------------------------------------------*/ TPRO_LongObj, TPRO_LatObj;...
  • Page 16 TPRO-PCI-U/TSAT-PCI-U — Windows Driver Spectracom Corporation unsigned short year; /*-- year for CPCI board -*/ unsigned short sync; /*--sync flags (0x91xx boards -*/ } /*----------------------------------------------------------------------*/ TPRO_TimeObj; /*========================================================================== TPRO WAIT OBJECT ==========================================================================*/ typedef struct TPRO_WaitObj { /*----------------------------------------------------------------------*/ unsigned int ticks; /*-- # ticks to wait -----*/ double seconds;...
  • Page 17 Spectracom Corporation TPRO-PCI-U/TSAT-PCI-U — Windows Driver unsigned char TPRO_flushFIFO (TPRO_BoardObj *hnd); DLL_EXPORT unsigned char TPRO_getAltitude (TPRO_BoardObj *hnd, TPRO_AltObj *Altp); DLL_EXPORT unsigned char TPRO_getDate (TPRO_BoardObj *hnd, TPRO_DateObj *Datep); DLL_EXPORT unsigned char TPRO_getDriver (TPRO_BoardObj *hnd, char *driver); DLL_EXPORT unsigned char TPRO_getFirmware (TPRO_BoardObj *hnd, char *firmware);...
  • Page 18 TPRO-PCI-U/TSAT-PCI-U — Windows Driver Spectracom Corporation DLL_EXPORT unsigned char TPRO_poke (TPRO_BoardObj *hnd, TPRO_MemObj *Mem); #ifdef __cplusplus #endif #pragma pack() #endif // _defined_TPRO_ Synchronizable Timecode Generator Application Programmer’s Guide...

  • Page 19: Tpro Api - Routine Descriptions

    Spectracom Corporation TPRO-PCI-U/TSAT-PCI-U — Windows Driver 3.2 TPRO API — Routine Descriptions The TPRO-PCI driver permits overlapping use of the TPRO-waitXXX routines and other device access routines. NOTE: Simultaneous access to the device requires multiple open device handles. (If an application requires access to the device driver from two different threads, each thread must have its own device handle.)
  • Page 20 TPRO-PCI-U/TSAT-PCI-U — Windows Driver Spectracom Corporation 3.2.1.1.4 TPRO_getDate unsigned char TPRO_getDate (TPRO_BoardObj *hnd, TPRO_DateObj *Datep); This routine retrieves the current date from the TPRO/TSAT board. The date is in Gregorian Format. Arguments: Pointer to TPRO_BoardObj Pointer to TPRO_DateObj Returns: TPRO_INVALID_BOARD_TYPE_ERR – invalid board type for function...
  • Page 21 Spectracom Corporation TPRO-PCI-U/TSAT-PCI-U — Windows Driver 3.2.1.1.7 TPRO_getSatInfo unsigned char TPRO_getSatInfo(TPRO_BoardObj *hnd, TPRO_SatObj *Satp); This routine retrieves the number of satellites tracked from the TSAT device. Arguments: Pointer to the TPRO_BoardObj Pointer to the TPRO_SatObj Returns: TPRO_INVALID_BOARD_TYPE_ERR – invalid board type for function...
  • Page 22 TPRO-PCI-U/TSAT-PCI-U — Windows Driver Spectracom Corporation 3.2.1.1.11 TPRO_setHeartbeat unsigned char TPRO_setHeartbeat(TPRO_BoardObj *hnd, TPRO_HeartObj *Heartp); This routine controls the hearbeat output. The heartbeat output may be a square wave or pulse at various frequencies. Arguments: Pointer to the TPRO_BoardObj Pointer to the TPRO_HeartObj Returns: TPRO_FREQ_ERR –...
  • Page 23 Spectracom Corporation TPRO-PCI-U/TSAT-PCI-U — Windows Driver 3.2.1.1.14 TPRO_setTime unsigned char TPRO_setTime(TPRO_BoardObj *hnd, TPRO_TimeObj *Timep); This routine sets the time on the on-board clock of the TPRO/TSAT device. If the board is synchronized to a GPS antenna this value will not be accepted.
  • Page 24 TPRO-PCI-U/TSAT-PCI-U — Windows Driver Spectracom Corporation 3.2.1.1.17 TPRO_synchControl unsigned char TPRO_synchControl(TPRO_BoardObj *hnd, unsigned char *enbp); This routine commands the TPRO/TSAT device to synchronize to input or freewheel. This distinction is made using the enable argument. If the enable argument is (0) the clock will freewheel, otherwise it will synchronize to input.
  • Page 25 Spectracom Corporation TPRO-PCI-U/TSAT-PCI-U — Windows Driver 3.2.1.1.20 TPRO_waitHeartbeat unsigned char TPRO_waitHeartbeat(TPRO_BoardObj *hnd, unsigned int *ticks); This routine will reports the condition of the heartbeat output. The routine will block for a given number of ticks (in milliseconds) until a heartbeat occurs or the timeout period has been reached.
  • Page 26 TPRO-PCI-U/TSAT-PCI-U — Windows Driver Spectracom Corporation 3-14 Synchronizable Timecode Generator Application Programmer’s Guide...
  • Page 27 Spectracom Corporation TPRO-PCI-U/TSAT-PCI-U — Windows Driver Document Revision History Description Date 2325 First draft of Spectracom documentation for this product. Minor corrections. 2332 2552 Added 32/64-bit Lib/DLL comments. Added Windows 7 support December 2010 comment. Other minor corrections. Synchronizable Timecode Generator Application Programmer’s Guide...
  • Page 28 Spectracom Corporation 95 Methodist Hill Drive Rochester, NY 14623 www.spectracomcorp.com Phone: US +1.585.321.5800 Fax: US +1.585.321.5219...

This manual is also suitable for:

Tsat-pci-uTpro-pciTpro-pci-u