Loading...
SignalHawk™
Application Programming
Interface
Operations Manual
This is a preliminary manual. Specifications, limits, and text are subject to change without notice. The information within this manual was as complete as possible at the time of printing. Bird Electronic Corporation is not liable for errors.
©Copyright 2010 by Bird Electronic Corporation Instruction Book Part Number 920-SH-API Rev. P1 SignalHawk is a trademark of Bird Electronic Corporation
Safety Precautions
The following are general safety precautions that are not necessarily related to any specific part or procedure, and do not necessarily appear elsewhere in this publication. These precautions must be thoroughly understood and apply to all phases of operation and maintenance.
WARNING
Keep Away From Live Circuits
Operating Personnel must at all times observe general safety precautions. Do not replace components or make adjustments to the inside of the test equipment with the high voltage supply turned on. To avoid casualties, always remove power.
WARNING
Shock Hazard
Do not attempt to remove the RF transmission line while RF power is present.
WARNING
Do Not Service Or Adjust Alone
Under no circumstances should any person reach into an enclosure for the purpose of service or adjustment of equipment except in the presence of someone who is capable of rendering aid.
WARNING
Safety Earth Ground
An interruptible earth safety ground must be supplied from the main power source to test instruments. Grounding one conductor of a two conductor power cable is not sufficient protection. Serious injury or death can occur if this grounding is not properly supplied.
WARNING
Resuscitation
Personnel working with or near high voltages should be familiar with modern methods of resuscitation.
WARNING
Remove Power
Observe general safety precautions. Do not open the instrument with the power on.
i
Safety Symbols
WARNING
Warning notes call attention to a procedure, which if not correctly performed, could result in personal injury.
CAUTION
Caution notes call attention to a procedure, which if not correctly performed, could result in damage to the instrument.
Note: Calls attention to supplemental information.
ii
Safety Statements
USAGE
ANY USE OF THIS INSTRUMENT IN A MANNER NOT SPECIFIED BY THE MANUFACTURER MAY IMPAIR THE INSTRUMENT’S SAFETY PROTECTION.
USO
EL USO DE ESTE INSTRUMENTO DE MANERA NO ESPECIFICADA POR EL FABRICANTE, PUEDE ANULAR LA PROTECCIÓN DE SEGURIDAD DEL INSTRUMENTO.
BENUTZUNG
WIRD DAS GERÄT AUF ANDERE WEISE VERWENDET ALS VOM HERSTELLER BESCHRIEBEN, KANN DIE GERÄTESICHERHEIT BEEINTRÄCHTIGT WERDEN.
UTILISATION
TOUTE UTILISATION DE CET INSTRUMENT QUI N’EST PAS EXPLICITEMENT PRÉVUE PAR LE FABRICANT PEUT ENDOMMAGER LE DISPOSITIF DE PROTECTION DE L’INSTRUMENT.
IMPIEGO
QUALORA QUESTO STRUMENTO VENISSE UTILIZZATO IN MODO DIVERSO DA COME SPECIFICATO DAL PRODUTTORE LA PROZIONE DI SICUREZZA POTREBBE VENIRNE COMPROMESSA.
iii
SERVICE
SERVICING INSTRUCTIONS ARE FOR USE BY SERVICE - TRAINED PERSONNEL ONLY. TO AVOID DANGEROUS ELECTRIC SHOCK, DO NOT PERFORM ANY SERVICING UNLESS QUALIFIED TO DO SO.
SERVICIO
LAS INSTRUCCIONES DE SERVICIO SON PARA USO EXCLUSIVO DEL PERSONAL DE SERVICIO CAPACITADO. PARA EVITAR EL PELIGRO DE DESCARGAS ELÉCTRICAS, NO REALICE NINGÚN SERVICIO A MENOS QUE ESTÉ CAPACITADO PARA HACERIO.
WARTUNG
ANWEISUNGEN FÜR DIE WARTUNG DES GERÄTES GELTEN NUR FÜR GESCHULTES FACHPERSONAL.
ZUR VERMEIDUNG GEFÄHRLICHE, ELEKTRISCHE SCHOCKS, SIND WARTUNGSARBEITEN AUSSCHLIEßLICH VON QUALIFIZIERTEM SERVICEPERSONAL DURCHZUFÜHREN.
ENTRENTIEN
L’EMPLOI DES INSTRUCTIONS D’ENTRETIEN DOIT ÊTRE RÉSERVÉ AU PERSONNEL FORMÉ AUX OPÉRATIONS D’ENTRETIEN. POUR PRÉVENIR UN CHOC ÉLECTRIQUE DANGEREUX, NE PAS EFFECTUER D’ENTRETIEN SI L’ON N’A PAS ÉTÉ QUALIFIÉ POUR CE FAIRE.
ASSISTENZA TECNICA
LE ISTRUZIONI RELATIVE ALL’ASSISTENZA SONO PREVISTE ESCLUSIVAMENTE PER IL PERSONALE OPPORTUNAMENTE ADDESTRATO. PER EVITARE PERICOLOSE SCOSSE ELETTRICHE NON EFFETTUARRE ALCUNA RIPARAZIONE A MENO CHE QUALIFICATI A FARLA.
iv
About This Manual
This manual covers the operating and maintenance instructions for the following models:
SH-36S-PC
Changes to this Manual
We have made every effort to ensure this manual is accurate. If you discover any errors, or if you have suggestions for improving this manual, please send your comments to our Solon, Ohio factory. This manual may be periodically updated. When inquiring about updates to this manual refer to the part number and revision on the title page.
Literature Contents
Chapter Layout
Introduction — Describes the features of the SignalHawk Application Programming Interface (API).
Reference — Describes and gives an overview of the programming protocols and language.
v
vi
Table of Contents
Safety Precautions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
Safety Symbols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ii
Safety Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
About This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .v
Changes to this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Literature Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Chapter Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Chapter 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 1 |
Chapter 2 Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 3 |
General Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
3 |
shConnection_t Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 3 |
shConnection_t Structure Members . . . . . . . . . . . . . . . . . . . |
. 3 |
shDevices_t Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 3 |
shDevices_t Structure Members . . . . . . . . . . . . . . . . . . . . . . |
. 3 |
shDllProperties_t Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 3 |
shDllProperties_t Structure Members . . . . . . . . . . . . . . . . . |
. 3 |
shErrorData Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 3 |
shErrorData Structure Members . . . . . . . . . . . . . . . . . . . . . |
. 4 |
General Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
4 |
shInitialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 4 |
Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 4 |
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 4 |
shFinalize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 4 |
Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 4 |
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 4 |
shConnectDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 5 |
Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 5 |
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 5 |
Remarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 5 |
shGetDeviceList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 5 |
Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 5 |
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 6 |
Remarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 6 |
shConnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 6 |
Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 6 |
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 6 |
Remarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . |
. 7 |
|
vii |
shDisconnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 shGetLastError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 shGetDllProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Spectrum Analyzer Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 shSaParameters_t Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 shSaConfigParameters Structure . . . . . . . . . . . . . . . . . . . . . . 10 shSaTriggerParameters Structure . . . . . . . . . . . . . . . . . . . . . 10 shSaOccupiedBWType Enumeration . . . . . . . . . . . . . . . . . . . 10 shSaOccupiedBandwidthConfig Structure . . . . . . . . . . . . . . . 11 shSaChannelConfig Structure . . . . . . . . . . . . . . . . . . . . . . . . . 11 shSaAdjacentChannelConfig Structure . . . . . . . . . . . . . . . . . 11 shSaDemodSignalConfig Structure . . . . . . . . . . . . . . . . . . . . . 11 shSaZeroSpanConfig Structure . . . . . . . . . . . . . . . . . . . . . . . . 11 shSaCountersConfig Structure . . . . . . . . . . . . . . . . . . . . . . . . 12 shSaData_t Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Measurement types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 SweepCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 shSaOccupiedBandwidthData Structure . . . . . . . . . . . . . . . . 14 shSaChannelData Structure . . . . . . . . . . . . . . . . . . . . . . . . . . 14 shSaAdjacentChannelData Structure . . . . . . . . . . . . . . . . . . . 15 shSaCountersData Structure . . . . . . . . . . . . . . . . . . . . . . . . . . 15 shSaDemodData_t Structure . . . . . . . . . . . . . . . . . . . . . . . . . . 15 shSaMeasureId Enumeration . . . . . . . . . . . . . . . . . . . . . . . . . 16 shSaPreampAttenSettings Enumeration . . . . . . . . . . . . . . . . 16 shSaBwSettings Enumeration . . . . . . . . . . . . . . . . . . . . . . . . . 16 shSaDetectorModes enumeration . . . . . . . . . . . . . . . . . . . . . . 17 shSaTriggerEvents Enumeration . . . . . . . . . . . . . . . . . . . . . . 17 shSaTriggerModes Enumeration . . . . . . . . . . . . . . . . . . . . . . . 17 Spectrum Analyzer Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 shSaParametersInit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Remarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 shSaGetData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Remarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
viii
shSaGetDemodData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Remarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 shSaStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Remarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 shSaStop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Remarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Communication Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Measurement Parameter Errors . . . . . . . . . . . . . . . . . . . . . . . 23 Control Parameter Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Other Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Installation and Packaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
ix
x
Loading...