GSI AudioStar Pro Service Manual
GSI AudioStar Pro Service Manual
GSI AudioStar Pro Service Manual
Copyright © 2012-2019 Grason-Stadler. All rights reserved. No part of this publication may be
reproduced or transmitted in any form or by any means without the prior written permission of Grason-
Stadler. The information in this publication is proprietary to Grason-Stadler.
Contents
Introduction ................................................................................................................................................. 1
Intended Use .............................................................................................................................................. 1
Installation ................................................................................................................................................. 1
Compatibility and Restrictions .................................................................................................................. 2
Windows Start menu ................................................................................................................................. 2
USB Ports .................................................................................................................................................. 3
Instrument Service User Interface ............................................................................................................. 3
Context Menu ....................................................................................................................................... 3
About..................................................................................................................................................... 4
Settings.................................................................................................................................................. 5
Log Files ................................................................................................................................................. 6
Data Port Serial Settings (GSI 61 and TympStar) .................................................................................. 7
Close ...................................................................................................................................................... 7
Data Port Interface ..................................................................................................................................... 8
GSI AudioStar Pro v1, Pello ...................................................................................................................... 8
Data Transfer .............................................................................................................................................. 8
Record and Field Formatting ..................................................................................................................... 8
Input Operation ......................................................................................................................................... 9
Input Record Type 5 - Pushbutton Code Record....................................................................................... 9
Output Record Type 4 - Error Record ..................................................................................................... 10
Output Record Type - Test Battery Data Record .................................................................................... 11
Output Record Type 7 – Instrument Type ............................................................................................... 16
GSI TympStar Pro .................................................................................................................................... 17
Data Port - Data Transfer ........................................................................................................................ 17
Output Record Formats ........................................................................................................................... 17
Summary Data Records ........................................................................................................................... 17
Tymp Diagnostic .................................................................................................................................. 17
Tymp Screening ................................................................................................................................... 20
Reflex Threshold ................................................................................................................................. 23
Eustachian Tube Function - Intact ...................................................................................................... 27
Eustachian Tube Function - Perforated .............................................................................................. 29
Reflex Decay ........................................................................................................................................ 31
XY Graphic Data Record ........................................................................................................................ 34
Record Format .................................................................................................................................... 34
X Value Description ............................................................................................................................. 35
Y Value Description ............................................................................................................................. 35
Embedded Control Code ..................................................................................................................... 36
End of Summary and XY Data Record ................................................................................................... 36
Error Record ............................................................................................................................................ 36
Keyboard Entry Record ........................................................................................................................... 37
Patient Name ...................................................................................................................................... 37
Patient ID ............................................................................................................................................ 37
Tester Name ........................................................................................................................................ 38
Facility Name....................................................................................................................................... 38
Transmit Test Data Request Command ................................................................................................... 39
ACK/NAK Records................................................................................................................................. 39
Record Received OK Acknowledgement – ACK................................................................................... 39
Record Received Incorrectly Acknowledgement – NAK ..................................................................... 39
Instrument Services Public Interface ...................................................................................................... 40
XML Schema .......................................................................................................................................... 40
WCF Interface ......................................................................................................................................... 40
Calls to the host ....................................................................................................................................... 40
Callbacks ................................................................................................................................................. 43
WCF Bindings ........................................................................................................................................... 44
Defining WCF bindings with the app.config settings ............................................................................. 44
Creating the connection to the Instrument Service.................................................................................. 44
Defining WCF bindings programmatically ............................................................................................. 45
Patient List................................................................................................................................................. 46
Patient List XML Schema ....................................................................................................................... 46
Patient List CSV ...................................................................................................................................... 48
Introduction
It is possible to extract the data from the GSI AudioStar Pro, GSI Pello and GSI
TympStar Pro for direct integration of audiologic results into third party software
programs (Electronic Medical Records (EMR) and Electronic Healthcare Records
(EHR)). It is also possible to import a list of patients into the AudioStar Pro, Pello
and TympStar Pro. GSI provides data integration with a computer using the GSI
Instrument Service software.
GSI Instrument Service also provides a virtual serial interface (audiometry Data
Port) to emulate a GSI 61 for backward compatibility functionality for the
AudioStar Pro (V1) and Pello audiometers. Similarly, GSI Instrument Service
provides a separate virtual serial interface (tympanometry Data Port) to emulate a
GSI TympStar for backward compatibility functionality for the TympStar Pro
tympanometer.
These virtual serial port interfaces allow PC programs that can read data from the
GSI 61 or TympStar to also read similar data from the AudioStar Pro (V1), Pello
and TympStar Pro. Data Port is not available for AudioStar Pro V2.
This manual describes the functionality and data that is available from the GSI
Instrument Service.
Intended Use
GSI Instrument Service provides electronic data transfer of audiometric data
created by the GSI AudioStar Pro, Pello, and TympStar Pro devices. Independent
software programming engineers may interface to the Instrument Services
software provided by GSI directly from their proprietary software to manage
patient data. The direct transfer of data gives the physician immediate access to the
audiometric data in the electronic record.
Installation
Minimum System Requirements
• CPU: 1.6 GHz
• RAM: 1 GB
• Hard Disk: 3 GB
• USB Port: 1 for each connected GSI instrument
• CD-ROM Drive
Supported Operating systems
• Microsoft Windows™ 7 Professional
• Microsoft Windows™ 10 Pro
Software requirements
• Microsoft .NET Framework version 4.6.2
Installation instructions
1. Insert the CD or USB drive into the computer.
2. Browse the contents of the CD /USB to the “GSI Instrument Service”
folder.
3. Double-click on the setup.exe.
4. Follow the on-screen instructions to properly install the selected software.
NOTE: You will need administrative rights to install the GSI Instrument
Service software. If you install GSI Suite V2.3 or above, it will also install the
GSI Instrument Service.
The GSI Instrument Service must be closed when using the AudioStar Pro, Pello
or TympStar Pro calibration application. It can be restarted from the Windows Start
menu.
The GSI Instrument Service V2.6 and above is not compatible with an AudioStar
Pro running V1.0 or V1.1, or GSI Suite V2.3 or earlier. Versions are displayed in
the GSI Instrument Service About dialog.
These settings may be changed from the computer’s control panel. Typical location
is found under advanced settings of the power options.
If you place your mouse pointer over the top of the icon, you will get the following
tooltip indicating the connected devices.
Context Menu
The context menu is displayed when you right click on the Instrument Services
Icon. There are six options that may be selected from the context menu.
About
The about dialog shows the current version and copyright information.
Settings
The connection status to an AudioStar Pro or Pello and/or TympStar Pro is
displayed along with the version of the connected instrument.
Automatically update devices date and time: When this check box is checked, the
program will update the date and time of the connected AudioStar Pro, Pello or
TympStar Pro instrument to the match the date and time of the PC. This date and
time update occur once per hour. To update the time on an instrument immediately
the Config App for the instrument may be used.
Emulated Data Ports: The selected serial port used for the GSI 61 or TympStar, if
the data port is enabled, is displayed.
Press OK to close.
Log Files
The Log Files dialog provides options for sending and saving files that may be
useful in troubleshooting any problems encountered with the software.
Data Port Serial Settings (GSI 61 and TympStar)
1. Enable Data Port: The Data Port is used with programs that require
backward compatibility with the GSI 61 or TympStar data stream. Check
the box to enable this backward compatibility. GSI Suite does not require
this backward compatibility and there is no need to enable the Data Port
when using GSI Suite.
2. Automatic: GSI Instrument Service will automatically search for a serial
communication port that is not already being utilized by another
application. The user must configure the PC application to the same serial
port as the data port for seamless communication with the GSI Instrument
Service/AudioStar Pro/Pello/TympStar Pro.
NOTE: When the GSI Instrument Service starts, it will first try to use the serial
port that is previously used. If this is not available, it will automatically search
for the next open serial port. It will assign itself to the next unassigned serial
port. The user must ensure the serial ports are the same.
3. Manual: The GSI Instrument Service will use the configured serial
communication port even if it is already being utilized by another
application. In this case, it would be the user’s responsibility to
troubleshoot serial port conflicts.
Close
The Close option shuts down the Instrument Service program and returns to the
PC OS. GSI Suite will automatically restart Instrument Service if not already
running.
Data Port Interface
The Data Port interface allows the AudioStar Pro V1, Pello and TympStar Pro data
transfer function to be backwards compatible with the GSI 61 and TympStar data
stream. The AudioStar Pro V2 does not support the Data Port interface. This
interface is for GSI 61 or TympStar users who are currently transferring data to a
3rd Party PC application such as an EMR system and wish to maintain that transfer
function with the AudioStar Pro V1, Pello and TympStar Pro. The GSI Instrument
Service will alter the GSI AudioStar Pro V1, Pello and TympStar Pro data stream,
to mimic that of the GSI 61 and TympStar respectively.
The default settings are 9600 baud rate, no parity, 8 data bits, 1 stop bit, and
hardware flow control.
When the GSI Instrument Service is initiated, the Data Port Interface will always
try to use the serial ports it used before. If it cannot reuse the serial port it used
before, it will choose another available serial port if it is configured to automatic
serial port selection.
NOTE: In Windows Device Manager, the Data Port will be displayed as the
“GSI data port (COM X), where “X” is the currently assigned serial port.
The record prefix consists of a “:” character and denotes the start of a record. Input
records do not contain a checksum. The record terminator consists of a “CR,” “LF”
sequence. Each record consists of fixed length data fields with any unused or Zero
data fields filled with a “0.” All records consist of a sequence of printable ASCII
characters from the set of “0” to “9,” “A” to “G,” “-,” “:,” “.,” “_,” “CR” and “LF.”
All multiple character ASCII fields will be right justified with unused character
positions filled with “_” characters. Positive numeric values will not contain a “+”
sign; this will be implied. Negative values contain a “-” sign in any character
position to the left of the most significant digit of the number. Unless specified,
the decimal point for non-integer numbers will not be included in the character
sequence.
Checksums
Checksums will be calculated to maintain compatibility with the GSI 61 as the
mod 256 sum of all preceding characters on the record, including the “:” prefix,
and stored as two HEX ASCII characters.
Input Operation
Validation
When a complete input record is received, the record is validated and processed.
If the record is invalid, an error record is transmitted back to the remote device.
All input records are validated in the following manner:
• Must begin with a “:,” and end with a carriage return, line feed sequence.
• Must contain all valid ASCII characters.
• Must contain a valid record type.
• Must contain a valid function code.
• Must contain a valid function subcode when required.
Acknowledgment
The GSI AudioStar Pro will acknowledge the correct reception and processing of
all input records by transmitting back the requested information.
Function Codes
The following are function codes that describe the commands sent and the response
you can expect to see when transferring data from the AudioStar Pro to a computer
using the Data Port Software.
• System errors.
• Input record which has an incorrect format or is invalid for the current
operating mode.
• Push button operation commands which are invalid.
Speech Test
Character Number of Data Field Name Field Description
Offset Characters Type
Speech Test - -20 to 120 dB x 2
424 4 slnt Test Ear NR = 260 to 540
Threshold NT = 32768 (0 x 8000)
Speech Test - -20 to 120 dB x 2
428 4 slnt Masking NR = 260 to 540
Threshold NT = 32768 (0 x 8000)
“_0” = None
“_1” = White Noise
Speech Test -
432 2 uChar “_2” = Speech Noise
Masking Type
“_3” = Ext. A
“_4” = Ext. B
Speech Test -
_0 to 100
434 2 uChar Number
Decimal
Presented
Speech Test - _0 to 10
436 2 uChar
Number Correct Decimal0
SISI Test
Alternate (ABLB)
Record Terminator
Y Value Description
NOTE: The Y axis values for Tymp Diagnostic and ETF — Intact TM are
transmitted as unbaselined values. If baseline is selected the baselined
values may be obtained by subtracting the Y axis values from the Ear canal
Volume.
Embedded Control Code
Penup Code
Value = 7FFFH
Purpose = Embedded in the X and Y graphical data to indicate the end of the graph
of a stimulus presentation during a Reflex type test. The code indicates to the
plotting routines not to plot (draw) between the previous plotted point and the next
point to produce the blank space between stimulus graphs on the LCD screen.
Error Record
Patient ID
Facility Name
ACK/NAK Records
Record Received OK Acknowledgement – ACK
The following information describes the programmatic interface and XML data
that is exported. It is intended to be used by experienced computer programmers
familiar with Windows Communications Foundation (WCF) to write the interface
between the AudioStar Pro, Pello, TympStar Pro and a PC software application.
Changes from previous version; the old interface is supported for backward
compatibility only:
XML Schema
The XML schema for the audiometric data from the AudioStar Pro V1 (and Pello),
AudioStar Pro V2 and TympStar Pro are provided in separate documents included
with this manual. The files are AudioStarPro.xsd, AudioStarPro2.xsd and
TympStarPro.xsd.
WCF Interface
The Public Interface is implemented using Windows Communication Foundation.
There are two interfaces to implement IInstrumentPublicInterfaceService and
IInstrumentPublicInterfaceCallbacks. Namespace GrasonStadler.Public Interface.
Only the documented interfaces are supported.
namespace GrasonStadler.PublicInterface
{
public enum GsiInstruments
{
AudioStarPro,
TympStarPro
};
[ServiceContract(SessionMode = SessionMode.Allowed)]
public interface IInstrumentPublicInterfaceService
{
/// <summary>
/// Get the Firmware Version of the instrument
/// </summary>
/// <returns>Version</returns>
[OperationContract]
Version GetinstrumentVersion(GsiInstruments instrument);
/// <summary>
/// Get the Serial Number of the instrument
/// </summary>
/// <returns>String containing the serial number</returns>
[OperationContract]
string GetSerialNumber(GsiInstruments instrument);
/// <summary>
/// Returns a list of the instruments that are connected to the PC
/// </summary>
/// <returns></returns>
[OperationContract]
List<GsiInstruments> GetConnectedInstruments();
/// <summary>
/// Gets the current session data from the instrument
/// This callis not recomeneded because building the returned XML
/// can cause a timeout on the WCF channel
/// </summary>
/// <returns>Data in XML formatted string</returns>
[OperationContract]
string GetData(GsiInstruments instrument);
/// <summary>
/// Returns true if a instrument is connected to the computer
/// </summary>
/// <returns></returns>
[OperationContract]
bool IsConnected(GsiInstruments instrument);
/// <summary>
/// The Client creates a GUID and Registers the GUID along with the
instrument type to connect.
/// This GUID is the ID the host uses for messages to the client..
/// </summary>
/// <param name="clientId"></param>
/// <param name="instrument"></param>
/// 0 = no errors
/// 1 = unable to connect to instrument
/// 2 = instrument busy
/// 3 = not supported
[OperationContract]
int Register(Guid clientId, GsiInstruments instrument);
/// <summary>
/// Removed the client from listening for messages from the instrument
/// </summary>
/// <param name="clientId"></param>
/// <param name="instrument"></param>
[OperationContract(IsOneWay = true)]
void UnregisterInstrument(Guid clientId, GsiInstruments instrument);
/// <summary>
/// Unregister the client
/// </summary>
[OperationContract(IsOneWay = true)]
void Unregister(Guid clientID);
/// <summary>
/// Request the current session from the instrument.
/// </summary>
/// <param name="clientId"></param>
/// <param name="instrument"></param>
/// 0 = no errors
/// 1 = unable to connect to instrument
/// 2 = instrument busy
/// 3 = not supported
[OperationContract]
int RequestData(Guid clientId, GsiInstruments instrument);
/// <summary>
/// Requst that the current session on the instrument to be discared.
/// </summary>
/// <param name="instrument"></param>
/// <returns>
/// 0 = no errors
/// 1 = unable to connect to instrument
/// 2 = instrument busy
/// 3 = not supported
/// </returns>
[OperationContract]
int ClearSession(GsiInstruments instrument);
/// <summary>
/// Always returns true. Can be used to verify the Instrument Service is
running
/// </summary>
/// <returns></returns>
[OperationContract]
bool ServerReady();
}
}
Callbacks
1. OnDeviceConnected - Callback: Broadcast to all registered clients when an
AudioStar Pro connects to the computer.
namespace GrasonStadler.PublicInterface
{
[ServiceContract(SessionMode = SessionMode.Allowed)]
public interface IInstrumentPublicInterfaceCallbacks
{
/// <summary>
/// New session data
/// </summary>
/// <param name="xmlData"></param>
/// <param name="instrument"></param>
[OperationContract]
void OnNewData(string xmlData, GsiInstruments instrument);
/// <summary>
/// Called when a device is connected to the computer
/// </summary>
/// <param name="serialNumber"></param>
/// <param name="instrument"></param>
[OperationContract]
void OnDeviceConnected(string serialNumber, GsiInstruments
instrument);
/// <summary>
/// Called when a device is disconnected from the computer
/// </summary>
[OperationContract]
void OnDeviceDisconnected(GsiInstruments instrument);
/// <summary>
/// If the Instrument Service is closed, this is called on
each of the Registered Clients
/// </summary>
[OperationContract]
void OnServerShuttingDown();
}
}
WCF Bindings
Below are examples of configuring the client and connecting to the host.
<?xml version="1.0"?>
<configuration>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/>
</startup>
<system.serviceModel>
<bindings>
<netNamedPipeBinding>
<binding name="BindingSettings"
maxBufferPoolSize="524288000"
maxReceivedMessageSize="655360000"
maxBufferSize="655360000" >
<readerQuotas maxStringContentLength="655360000"
maxArrayLength="2000001"
maxBytesPerRead="2000001"
maxNameTableCharCount="2000001" />
</binding>
</netNamedPipeBinding>
</bindings>
</system.serviceModel>
</configuration>
The following is an example for the client to connect and register to Instrument
Services
clientId = Guid.NewGuid();
clientHost.AddServiceEndpoint((typeof(IInstrumentPublicInterfaceCallbacks)), binding,
"net.pipe://localhost/GsiInstrumentService/Client_" + clientId);
clientHost.Open();
clientId = Guid.NewGuid();
clientHost.AddServiceEndpoint((typeof(IInstrumentPublicInterfaceCallbacks)), binding,
"net.pipe://localhost/GsiInstrumentService/Client_" + clientId);
clientHost.Open();
<xs:element name="Patient">
<xs:complexType>
<xs:sequence>
<xs:element ref="Guid"/>
<xs:element ref="FirstName"/>
<xs:element ref="MiddleName"/>
<xs:element ref="LastName"/>
<xs:element ref="Id"/>
<xs:element ref="Gender"/>
<xs:element ref="DateOfBirth"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="FirstName">
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:element>
<xs:element name="MiddleName">
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:element>
<xs:element name="LastName">
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:element>
<xs:element name="Id">
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:element>
<xs:element name="Guid">
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:element>
<xs:element name="Gender">
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:element>
<xs:element name="DateOfBirth">
<xs:simpleType>
<xs:restriction base="xs:date"/>
</xs:simpleType>
</xs:element>
</xs:schema>
Patient List CSV
The CSV format of the Patient List file is based on the patient export from NOAH.