Teltone TLE-TEST User manual

Type
User manual
Telephone Line Emulator
TLE-TEST
User’s Manual
40-400-00025, Rev. D
40-400-00025, Rev. D
Note
This manual covers Model TLE-A-01 software module TLE-TEST (Automated Test).
Copyright Notice
Copyright © 1997 - 2003 Teltone Corporation
All Rights Reserved
Trademarks
Teltone is a registered trademark of Teltone Corporation.
Windows is a registered trademark of Microsoft Corporation.
Other company and product names may be trademarks or
registered trademarks of their respective owners.
Teltone Corporation
Bothell, Washington 98021 USA
Customer Service: 425-951-3388
Technical Support: 425-951-3390
Fax: 425-487-2288
Website: www.teltone.com
40-400-00025, Rev. D 1
Contents
Overview ..........................................................................................................................................3
New Features ...................................................................................................................4
Getting Started ........................................................................................................................................5
What’s on the API disk .....................................................................................................5
Serial Port.........................................................................................................................5
API Overview ..........................................................................................................................................6
Definitions.........................................................................................................................6
Command String Format..................................................................................................6
Messages .........................................................................................................................7
User Scripts......................................................................................................................8
Dial receivers....................................................................................................................9
Reset Button.....................................................................................................................9
API Commands .....................................................................................................................................10
TC_CONNECT...............................................................................................................10
TC_CONNECTAUDIOPORT .........................................................................................10
TC_DCSIGNAL ..............................................................................................................11
TC_DIALDETECT ..........................................................................................................11
TC_DISPLAY .................................................................................................................12
TC_PLAYMESSAGE .....................................................................................................13
TC_REQLEVEL..............................................................................................................13
TC_REQLINESTATE .....................................................................................................14
TC_REQVERSION .......................................................................................................14
TC_RING........................................................................................................................15
TC_SELECTCONFIG ....................................................................................................15
TC_SENDADSI ..............................................................................................................16
TC_SENDCALLERID.....................................................................................................16
TC_SENDCALLWAITING ..............................................................................................17
TC_SENDDTMF.............................................................................................................17
TC_SENDTONE.............................................................................................................18
TC_SENDVMW..............................................................................................................19
TC_SETAUDIOATTENUATION.....................................................................................20
TC_SETCALLERID_EVERYRING.................................................................................20
TC_SETCALLERID_MODE ...........................................................................................21
TC_SETCALLERID_NAME ...........................................................................................21
TC_SETCALLERID_SEQUENCE .................................................................................22
TC_SETCALLERID_TIME .............................................................................................23
TC_SETDTMFCADENCE..............................................................................................23
TC_SETDTMFTONES ...................................................................................................24
TC_SETECHO ...............................................................................................................24
TC_SETFLASHDETECTTIME.......................................................................................25
TC_SETFORCEDDISCONNECT ..................................................................................25
TC_SETHOOKTIMING ..................................................................................................25
TC_SETIMPEDANCE ....................................................................................................26
TC_SETLOOPCURRENT..............................................................................................26
TC_SETMETERCADENCE ...........................................................................................27
TC_SETMETERTONES ................................................................................................27
TC_SETOPENSWITCH .................................................................................................28
TC_SETRING.................................................................................................................28
TC_SETRXATTENUATION ...........................................................................................28
2 40-400-00025, Rev. D
Contents
TC_SETSATELLITEDELAY...........................................................................................29
TC_SETSWEEP ............................................................................................................29
TC_SETTIME_BUSY .....................................................................................................30
TC_SETTIME_CALLWAIT.............................................................................................30
TC_SETTIME_CAS .......................................................................................................31
TC_SETTIME_DIALTONE.............................................................................................31
TC_SETTIME_DIALTONEDELAY .................................................................................32
TC_SETTIME_NUMBERUNOB.....................................................................................32
TC_SETTIME_REORDER.............................................................................................33
TC_SETTIME_RING ......................................................................................................33
TC_SETTIME_SIT .........................................................................................................34
TC_SETTONE................................................................................................................34
TC_SETTONE_FSK ......................................................................................................35
TC_SETTONE_NUMBERUNOB ...................................................................................36
TC_SETTONE_SIT ........................................................................................................37
TC_SETTYPEWHITENOISE .........................................................................................37
TC_SETUNITNUMBER .................................................................................................38
TC_SETVMWAITTYPE..................................................................................................38
TC_SETWHITENOISE...................................................................................................39
Functions ........................................................................................................................................40
Function Summary .........................................................................................................40
Function TfLoopCurrent .................................................................................................41
Function TfMessage.......................................................................................................41
Function TfMeterConfig..................................................................................................41
Function TfRingConfig ...................................................................................................42
Function TfSigLevel .......................................................................................................42
Function TfLoopImpedance ...........................................................................................42
Script Details ........................................................................................................................................43
TS_DELAY .....................................................................................................................43
TS_ENDDEF ..................................................................................................................43
TS_EXECUTE................................................................................................................43
TS_RESTARTCONDITION............................................................................................44
TS_SCRIPTMODE.........................................................................................................44
TS_SCRIPTRUN............................................................................................................44
TS_STARTDEF..............................................................................................................45
TS_WAITDIAL................................................................................................................46
TS_WAITFLASH ............................................................................................................46
TS_WAITOFFHOOK......................................................................................................46
TS_WAITONHOOK........................................................................................................47
Script Examples ....................................................................................................................................48
Example of a Single Script For All Lines.......................................................................48
Example of a Dual Script:...............................................................................................50
Example of a Quad Script: .............................................................................................51
Default Configuration ............................................................................................................................53
Reference Tables..................................................................................................................................57
API Command Summary ...............................................................................................57
Script Function Summary...............................................................................................58
TLE Command Parameter Summary.............................................................................59
TLE Messages (TM_).....................................................................................................61
Line Messages ..............................................................................................................61
Multiple Message Format Call Setup Parameter Types ................................................62
Set Caller ID Mode Command Parameter Definitions (TC_SETCALLERID_MODE) ...63
Overview
40-400-00025, Rev. D 3
Overview
The Automated Test module allows the user to control the Telephone Line Emulator
(TLE) to perform specific tests that may be required in a development or production
environment. Users have access to all features in the TLE-BASE, TLE-ADV and the
TLE-INTL software. For example, the user may wish to test the ring detect threshold
for a particular CPE device. Commands could be sent to the TLE to perform the
following operations:
Set ring frequency and amplitude for line 1.
Start ringing on line1.
Verify that ringing has been detected. (External to the TLE.)
Stop ringing on line 1 if device goes off-hook or times out.
Change ring frequency and/or amplitude for line 1.
Repeat ring test.
Alternately, the user may wish to configure the TLE to perform a particular test
without a PC being connected. In this scenario, after the user has developed and
downloaded a script, the PC may be disconnected and the unit will perform whatever
action specified by that script. For example a production test user could verify that a
CPE device meets minimum ring detect requirements by programming a script to
perform the following :
Set ring frequency and amplitude for minimum detect threshold at line .
When off-hook is seen on line 2, start ringing on line 1.
When off-hook is seen on line 1, stop ringing.
When on-hook is seen on line 2, restart script.
The Automated Test features of the TLE allow the user to control the operation of the
TLE through the serial interface. To facilitate writing programs to control the TLE, an
Application Programming Interface (API) is provided which consists of definitions of
all commands and parameters which the TLE recognizes (in both Visual Basic and C
formats).
When the TLE is configured with the Automated Test software, it will not operate as a
stand alone TLE. All operation will be under control of the PC or user downloaded
scripts. The TLE will still accept programming commands from the standard TLE PC
software to allow for the user to pre-configure the stored TLE settings. The user
generated script(s) will have commands that select which stored configurations are
used by the TLE during the operation of the script. It is recommended that during
initialization of any script to select a configuration using TC_SELECTCONFIG to
load a configuration for each line.
NoteNote
NoteNote
Note: ANY changes made by the API are temporarily stored in a copy of the default
configuration loaded at power up or during TC_SELECTCONFIG. Changes made
during the running of an external or internal script are overwritten whenever
TC_SELECTCONFIG is used or when the TLE is reset.
Overview
440-400-00025, Rev. D
NeNe
NeNe
New Fw F
w Fw F
w Featureseatures
eatureseatures
eatures
These new features were added to the TLE with the release of the TLE-TEST soft-
ware.
CompleComple
CompleComple
Complex Impedancesx Impedances
x Impedancesx Impedances
x Impedances
Added to the TLE Loop PLoop P
Loop PLoop P
Loop Parar
arar
arameters ameters
ameters ameters
ameters are the complex impedances for Australia,
Germany, and the United Kingdom. These parameters are loaded into the program-
mable SLIC used in the TLE. The details include:
Australia 220 + (820 || 120nF)
Germany (See Note) 220 + (820 || 310nF)
United Kingdom 370 + (620 || 310nF)
Under the TLE ScreensScreens
ScreensScreens
Screens menu, there is a new sub menu called AA
AA
Automated utomated
utomated utomated
utomated TT
TT
Testest
estest
est.
Upon selecting this option, a window appears with the following options.
DTMF GenerationDTMF Generation
DTMF GenerationDTMF Generation
DTMF Generation
The DTMF Generation feature allows for the setting of the frequency, signal level,
and On/Off timing for the Row and Column tones generated by a DTMF keypad.
These tone pairs include 1-9,0,#,*,A,B,C, and D. The TLE-Test module allows for the
user to send a DTMF string to a Line by using command TC_SENDDTMF,dtmfstring,
linenum
SwSw
SwSw
Sweep eep
eep eep
eep
TT
TT
Toneone
oneone
one
The Sweep Tone feature is an additional Test Tone similar to the ones seen in PhonePhone
PhonePhone
Phone
NumbersNumbers
NumbersNumbers
Numbers screen and allows for the setting of the Start Frequency, Range, Level, and
Time. The TLE-TEST software allows for the user to send a Sweep Tone to a Line
using command TC_SENDTONE,tonename,linenum[,fromline]
Note:Note:
Note:Note:
Note: This complex impedance is also used in Switzerland
International Caller ID CommandsInternational Caller ID Commands
International Caller ID CommandsInternational Caller ID Commands
International Caller ID Commands
The purchase of the International (TLE-INTL) software and International Caller ID
(TLE-ICID) software will enable the TLE to execute International Caller ID commands
with the TLE in test mode.
Getting Started
40-400-00025, Rev. D 5
Getting Started
What’What’
What’What’
What’s on the API disks on the API disk
s on the API disks on the API disk
s on the API disk
The API consists of source code to assist in creation of programs to talk to the TLE.
This code includes definitions of all of the TLE commands, parameters and mes-
sages, plus the source code to the functions outlined in this manual.
The API disk contains the following (uppercase are directories, lowercase are files):
TLEAPI
C_API
auto.h Definitions of all TLE commands, parameters, and
messages
auto.cpp Source code for supported functions (see FUNC -
TION DETAILS section of this manual) in C format.
VB_API
auto.bas Definitions of all TLE commands, parameters, and
messages, plus source code for supported functions
in Visual Basic format.
SAMPLE
readme.txt Text file with details about the sample code and
operation of the sample program. Read this file for
information about the full contents of this directory.
DATA
tfloopc.000 Data file used by TfLoopCurrent function.
tfloopi.00 Data file used by TfLoopImpedance function.
tfloopi.01 Data file used by TfLoopImpedance function.
tfloopi.02 Data file used by TfLoopImpedance function.
tfloopi.03 Data file used by TfLoopImpedance function.
tfloopi.04 Data file used by TfLoopImpedance function.
tfmeter.000 Data file used by TfMeterConfig function.
tfring.000 Data file used by TfRingConfig function.
The C files were created using Microsoft Visual C++. The VB files and sample
program were created with Microsoft Visual Basic 3.0.
The data files are binary files used by the designated functions, and must be distrib-
uted with any programs written to talk to the TLE. The function routines provided
expect to find these files in the execution directory of the application.
SerSer
SerSer
Serial Pial P
ial Pial P
ial Poror
oror
ortt
tt
t
The serial port on the TLE is configured as follows:
Baud Rate 9600
Data bits 8
Parity None
Stop Bits 1
Flow Control Hardware (RTS/CTS)
The TLE does not echo characters back to the user.
API Overview
640-400-00025, Rev. D
API Overview
The TLE PC software program edits the stored configurations (non-volatile) in the
TLE and the API edits and uses a copy of the stored configuration(s) that is lost
when power is turned off. External and internal scripts should initially use
TC_SELECTCONFIG to load a copy of the appropriate stored configuration for each
line of the TLE. User scripts ARE saved in the TLE non-volatile memory.
Each line may use a separate configuration from the stored configurations for its
default values. Some parameters, however, are global and may not be changed on a
per-line basis. These global parameters will always use the configuration selected for
line 1. The global parameters are those associated with TC_SET commands which
do not include a “linenum” parameter.
DefinitionsDefinitions
DefinitionsDefinitions
Definitions
The API will contain definitions for all automated test commands and parameters.
Definitions fall into four categories:
TC_ TT
TT
TLE CC
CC
Commands Commands sent to the TLE.
TP_ TT
TT
TLE PP
PP
Parameters Parameters to be sent with commands.
TM_ TT
TT
TLE MM
MM
Messages Messages sent from the TLE.
TS_ TT
TT
TLE SS
SS
Script operations Operations to be entered into a script within
the TLE.
Command String Format.Command String Format.
Command String Format.Command String Format.
Command String Format.
All commands sent to the TLE consist of numeric values, preceeded by a colon “:”
followed by the appropriate unit number. Programs should wait for a response to a
command before sending the next command to the TLE.
Each programming and operational command string sent to the TLE will follow a
structure as follows:
:unitnumber,commandnumber,parameter_1…parameter_n<cr/lf>
Unitnumber: Unique ID given to TLE by the user.
0 All TLE’s will respond to commands with ID 0
1-255 Only those TLE’s with matching ID’s will respond
Commandnumber: Command number provided by API for each TLE command.
Parameter_1…parameter_n: Command parameters. See individual commands for
details.
The TLE will work correctly with Carriage Return or Line Feed or both as a termina-
tor. When the TLE receives a command, it will return either a Command Acknowl-
edge, Invalid or Error message. The TLE will not respond to any command string that
does not begin with a colon “:”, followed by the appropriate unit number. Programs
should wait for a response to a command before sending the next command to the
TLE.
NoteNote
NoteNote
Note: While most commands return the confirmation, error or invalid response
immediately, a few commands will delay the confirmation until completed. These are
noted in the command details section.
API Overview
40-400-00025, Rev. D 7
Example:
In Visual Basic, the user would create a command string as follows, using the defined
constants.
Command_string =
:0,&TC_SENDTONE&,&TP_BUSY&,&TP_LINE1&chr(13)
This would compile to a command string that would be sent to the TLE as shown
below.
command_string =
:0,13,16,1<ret>
MessagesMessages
MessagesMessages
Messages
The TLE sends system and line messages to the PC to inform the user of specific
events which have occurred. These events include such things as on-hook, off-hook,
flash detected, dialed digits, etc. The TLE also responds to commands with an
appropriate command response message.
All messages sent by the TLE consist of numeric values preceeded by an exclama-
tion “!” and terminated with a <cr> and <lf>. To assist in program development, the
API contains constants defined for all messages, and a function (TfMessage) for
converting System and Line messages to readable text.
The TLE will send messages to the user through the serial port. Messages are sent
as numbers, which the user can convert to text strings using the TfMessage function.
System MessagesSystem Messages
System MessagesSystem Messages
System Messages
System messages provide information about the operation of the TLE, and follow the
following format:
!unitnumber,messagetype,Y,P<cr><lf>.
Unitnumber: Unique ID given to TLE by the user.
0,1-255 If no unit number is assigned, TLE returns 0.
messagetype: 0 for system messages
Y: message number (up to 3 digits)
P: variable length parameter string (see individual messages for details)
Line messagesLine messages
Line messagesLine messages
Line messages
Line messages provide information about events that pertain to individual lines, and
follow this format:
!unitnumber,messagetype,Y,P<cr><lf>.
Unitnumber: Unique ID given to TLE by the user.
0,1-25: If no unit number is assigned, TLE returns 0.
messagetype: the line number 1 - 4
Y: message number (up to 3 digits)
P: variable length parameter string (see individual messages for details)
API Overview
840-400-00025, Rev. D
Command responsesCommand responses
Command responsesCommand responses
Command responses
The command response messages give the user feedback about the last command
that was executed by the TLE. These messages use the following format:
!unitnumber,messagetype,X,Y<cr><lf>
Unitnumber: Unique ID given to TLE by the user.
0,1-255 If no unit number is assigned, TLE returns 0.
messagetype:
7 Invalid state. The line the command was directed at was in a
state that was invalid for the function (ie: trying to send
ringing to an off-hook line, no dial receiver available,etc.) or
the command can not be run at this time (script commands
while scripts not running, etc).
8 Command accepted
9 Error
X: 0 if under PC control:
Script number (1-4) if running from a script
Y: Command number (up to 3 digits)
Note:Note:
Note:Note:
Note: The Tfmessage function does not interpret command response messages.
User ScrUser Scr
User ScrUser Scr
User Scriptsipts
iptsipts
ipts
The TLE supports downloadable scripts for custom standalone operation. Three
scripting modes are available; a single script mode, which allows only one script that
can access all four lines, a dual script mode which allows two scripts that each
accesses two lines, and a quad script mode where there is a separate script for each
line. These scripts are saved in the TLE non-volatile memory. If TS_SCRIPTRUN has
been enabled, the scripts will automatically start when power is applied to the TLE.
When a running script reaches its end, it will automatically restart.
Before entering any scripts into the TLE, a TS_SCRIPTMODE command must be
sent to select single, dual, or quad script mode. To enter the actual scripts, a
TS_STARTDEF is sent first, followed by the desired script functions, and ending with
a TS_ENDDEF. All commands between the TS_STARTDEF and TS_ENDDEF must
be script functions. To include any of the other TLE commands as part of a script, it is
included as a parameter to the TS_EXECUTE script function.
Once all of the scripts are entered into the TLE, the TS_SCRIPTRUN is used to start
and stop the scripts. While scripts are running, the TS_SCRIPTRUN is the ONLY
command which is recognized by the TLE (to allow the user to stop the script). If the
user has started the scripts and then removed power from the TLE, the scripts will
automatically restart when power is re-applied.
See Script Examples section for more information.
ImporImpor
ImporImpor
Important:tant:
tant:tant:
tant:
The TLE must be in Automated Test mode before entering commands or
scripts. A "System Offhook" message is given if not in the correct mode.
API Overview
40-400-00025, Rev. D 9
Dial receiversDial receivers
Dial receiversDial receivers
Dial receivers
The TLE can only detect DTMF digits on two lines at any time. The DTMF receivers
will be assigned on a first-come first-served basis. The DTMF receiver will remain
assigned until released by the user except under the following conditions:
If Caller ID with Call Waiting is sent, a DTMF receiver is automatically assigned to the
line, and is then released when completed.
If an ADSI script is sent, a DTMF receiver is automatically assigned to the line, and is
then released when completed. If no receiver is available, the TLE will respond with
an INVALID command response.
See the TC_DIALDETECT command for the format of the assign command.
Reset ButtonReset Button
Reset ButtonReset Button
Reset Button
The front panel reset button will set all configurations to factory defaults, and will
clear the unit ID and all scripts.
API Commands
10 40-400-00025, Rev. D
API Commands
TC_CONNECTTC_CONNECT
TC_CONNECTTC_CONNECT
TC_CONNECT
FormatFormat
FormatFormat
Format TC_CONNECT,linenum,tolinenum
DescriptionDescription
DescriptionDescription
Description Connects the audio path between line linenum and line tolinenum. If line linenum is already
connected to another line, linenum will be added to that connection.
PP
PP
Parar
arar
arameterameter
ameterameter
ameter Linenum: line to connect
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
Tolinenum: line to connect to
TP_OFF
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
ExampleExample
ExampleExample
Example This example connects line 1 to line 2:
TC_CONNECT,TP_LINE1,TP_LINE2
This adds line 3 to the connection:
TC_CONNECT,TP_LINE3,TP_LINE2
This disconnects line 2, leaving the connection between lines 1 and 3:
TC_CONNECT,TP_LINE2,TP_OFF
NoteNote
NoteNote
Note Establishing a connection from an off-hook line to multiple on-hook lines may result in exces-
sive feedback (noise) being heard at the off-hook line. The PC control program should
monitor the line hook states and disconnect lines which have gone on-hook. Alternately, if
the line-to-line attenuation is increased, this condition will not occur.
TC_CONNECTTC_CONNECT
TC_CONNECTTC_CONNECT
TC_CONNECTAA
AA
AUDIOPORUDIOPOR
UDIOPORUDIOPOR
UDIOPORTT
TT
T
FormatFormat
FormatFormat
Format TC_CONNECTAUDIOPORT,linenum
DescriptionDescription
DescriptionDescription
Description Connects a line to the audio output port.
PP
PP
Parar
arar
arameterameter
ameterameter
ameter Linenum: line number
TP_OFF
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
ExampleExample
ExampleExample
Example This example connects line 1 to the audio port:
TC_SETAUDIOPORT,TP_LINE1
This disconnects line 1 and connects line 2 to the audio port:
TC_SETAUDIOPORT,TP_LINE2
This disconnects line from audio port:
TC_SETAUDIOPORT,TP_OFF
API Commands
40-400-00025, Rev. D 11
TC_DCSIGNALTC_DCSIGNAL
TC_DCSIGNALTC_DCSIGNAL
TC_DCSIGNAL
FF
FF
Foror
oror
ormatmat
matmat
mat TC_SIGNAL,signaltype,linenum
DescrDescr
DescrDescr
Descriptioniption
iptioniption
iption Sets the DC loop state. The forced disconnect is momentary depending upon the pro-
grammed timings for forced disconnect. All others are permanent states. The forced discon-
nect command will only be accepted if the line is in the off-hook state.
PP
PP
Parar
arar
arameterameter
ameterameter
ameter Signaltype: DC loop state
TP_FORCEDDISCONNECT
TP_OPEN
TP_REVERSE
TP_NORMAL
Linenum: line number
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
ExampleExample
ExampleExample
Example This example sets reversed polarity on line 2:
TC_DCSIGNAL,TP_REVERSE,TP_LINE2
NoteNote
NoteNote
Note The confirmation for this command is sent immediately for all signal types except
TP_FORCEDDISCONNECT. For TP_FORCEDDISCONNECT the confirmation is sent at the
completion of the forced disconnect pulse.
See AlsoSee Also
See AlsoSee Also
See Also TC_SETFORCEDDISCONNECT
TC_DIALDETECTTC_DIALDETECT
TC_DIALDETECTTC_DIALDETECT
TC_DIALDETECT
FormatFormat
FormatFormat
Format TC_DIALDETECT,linenum,enable
DescriptionDescription
DescriptionDescription
Description Assigns DTMF and rotary dial receivers to specified line. Note: only two dial receivers are
available within the TLE. If a dial receiver is not available, this command will return an IN-
VALID response.
PP
PP
Parar
arar
arameterameter
ameterameter
ameter Linenum: line number
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
Enable:
TP_DISABLE
TP_ENABLE
ExampleExample
ExampleExample
Example This example enables a DTMF detector on line 1:
TC_DIALDETECT,TP_LINE1,TP_ENABLE
NoteNote
NoteNote
Note Both DTMF and Rotary dialed digits cannot be detected during the same call. As soon as
one type is detected, the other is blocked from detection. The receiver remains in this mode
until a new call is originated.
API Commands
12 40-400-00025, Rev. D
TC_DISPLATC_DISPLA
TC_DISPLATC_DISPLA
TC_DISPLAYY
YY
Y
FF
FF
Foror
oror
ormatmat
matmat
mat TC_DISPLAY,type,message
DescrDescr
DescrDescr
Descriptioniption
iptioniption
iption Displays a message on the TLE front-panel display. If type is TP_SYSTEM, the message is
displayed starting at the upper left and uses the entire display. If type is TP_LINE1-TPLINE4,
the message is displayed in the appropriate quadrant of the display for the selected line.
System messages are displayed for 1 second, then the display reverts to the individual line
messages. Line messages are displayed until replaced by new line messages.
PP
PP
Parar
arar
arameterameter
ameterameter
ameter Type: type of message
TP_SYSTEM
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
Message: message to display
If type is TP_SYSTEM, 0-40 characters, else 0-10 characters
NoteNote
NoteNote
Note The TLE Display message type is broken into 2 types, TLE status messages (Onhook,
Offhook, Ringing, etc..), and User generated messages, of which there are two types. User
generated Line Messages broken into four 10 character sets (which remain in the display
until updated), and a User generated System Message, a 40 character set that is displayed
for 1 second. The TLE remembers what message type (status vs. user) was in the Display
when a TP_SYSTEM message is displayed for 1 second, and returns that message after the
TP_SYSTEM message is complete. However, if a user generated message (e.g. TP_LINE1)
was in the TLE Display when a TP_SYSTEM message is sent, then the TLE remembers and
displays the user specified portion of the TP_SYSTEM message in the 10 character quadrant
until updated. Confused? Let’s look at the examples for clarification.
ExampleExample
ExampleExample
Example Current message in display window for all four 10 character sets is “Onhook”.
This command displays any text entered for one second:
TC_DISPLAY,TP_SYSTEM,Teltone Corporation Bothell, Washington
Teltone Corporation Bothell, Washington
and then the display returns to:
Onhook Onhook
Onhook Onhook
This command places “Hello” in the lower right quadrant left justified in the 10 character
set:
TC_DISPLAY,TP_LINE3,Hello
Now if we repeat the TP_SYSTEM message as shown above, the TLE Display will show:
Teltone Corporation Bothell, Washington
Then after 1 second:
Onhook Onhook
Onhook Ohook
After a device connected to Line 3 goes off-hook, the display is updated and displays:
Onhook Onhook
Onhook Offhook
API Commands
40-400-00025, Rev. D 13
TC_PLATC_PLA
TC_PLATC_PLA
TC_PLAYMESSAYMESSA
YMESSAYMESSA
YMESSAGEGE
GEGE
GE
FF
FF
Foror
oror
ormatmat
matmat
mat TC_PLAYMESSAGE,message,linenum
DescrDescr
DescrDescr
Descriptioniption
iptioniption
iption Plays a pre-programmed voice message. The message will stop automatically when com-
pleted. TP_OFF allows the user to stop playback before the end of the message. This
command will return an INVALID response if the line is not in the off-hook state.
PP
PP
Parar
arar
arameterameter
ameterameter
ameter Message: message number
TP_OFF
TP_MESSAGE1
TP_MESSAGE2
TP_MESSAGE3
TP_MESSAGE4
Linenum: line number
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
ExamplesExamples
ExamplesExamples
Examples This example begins playback of message 1 on line 3:
TC_PLAYMESSAGE,TP_MESSAGE1,TP_LINE3
This stops playback on line 3:
TC_PLAYMESSAGE,TP_OFF,TP_LINE3
TC_REQLEVELTC_REQLEVEL
TC_REQLEVELTC_REQLEVEL
TC_REQLEVEL
FormatFormat
FormatFormat
Format TC_REQLEVEL,linenum
DescriptionDescription
DescriptionDescription
Description Requests a signal level measurement from the specified line. The returned value must be
processed through the TfSigLevel function.
PP
PP
Parar
arar
arameterameter
ameterameter
ameter Linenum: line number
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
ReturnsReturns
ReturnsReturns
Returns TM_SIGLEVEL message, including a value from 0-4294967295 that must then be processed
through the TfSigLevel function to yield either a voltage or dB value.
ExampleExample
ExampleExample
Example This example requests a signal level measurement from line 4:
TC_REQLEVEL,TP_LINE4
See AlsoSee Also
See AlsoSee Also
See Also TM_SIGLEVEL, TfSigLevel
API Commands
14 40-400-00025, Rev. D
TC_REQLINESTTC_REQLINEST
TC_REQLINESTTC_REQLINEST
TC_REQLINESTAA
AA
ATETE
TETE
TE
FF
FF
Foror
oror
ormatmat
matmat
mat TC_REQLINESTATE,linenum
DescrDescr
DescrDescr
Descriptioniption
iptioniption
iption Requests the current on/off-hook state of the line.
PP
PP
Parar
arar
arameterameter
ameterameter
ameter Linenum: line number
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
ReturnsReturns
ReturnsReturns
Returns TM_OFFHOOK
TM_ONHK
ExampleExample
ExampleExample
Example This example requests the current state of line 1:
TC_REQLINESTATE,TP_LINE1
See AlsoSee Also
See AlsoSee Also
See Also TC_SETHOOKTIMING, TC_SETLOOPCURRENT, TC_DCSIGNAL, TM_OFFHOOK,
TM_ONHK
TC_REQVERSIONTC_REQVERSION
TC_REQVERSIONTC_REQVERSION
TC_REQVERSION
FormatFormat
FormatFormat
Format TC_REQVERSION
DescriptionDescription
DescriptionDescription
Description Requests the firmware version number string from the TLE.
ReturnsReturns
ReturnsReturns
Returns TM_VERSION
ExampleExample
ExampleExample
Example This example requests the version numbers of the boot code, microcontroller code and DSP
code:
TC_REQVERSION
See AlsoSee Also
See AlsoSee Also
See Also TM_VERSION
API Commands
40-400-00025, Rev. D 15
TC_RINGTC_RING
TC_RINGTC_RING
TC_RING
FF
FF
Foror
oror
ormatmat
matmat
mat TC_RING,ringtype,linenum,fromline
DescrDescr
DescrDescr
Descriptioniption
iptioniption
iption Sends ringing to the line with pre-programmed voltage, frequency, and cadence. This com-
mand will only be accepted if the line is in the on-hook state. Also sends Caller ID after the
first ring by default, or after every ring if enabled by TC_SETCALLERID_EVERYRING.
PP
PP
Parar
arar
arameterameter
ameterameter
ameter Ringtype: ring cadence to use
TP_OFF
TP_RING_GROUP1
TP_RING_GROUP2
TP_RING_GROUP3
Linenum: line number
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
Fromline: line whose caller ID to send
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
ExampleExample
ExampleExample
Example This example sends ringing at group 2 cadence to line 3 from line 4:
TC_RING,TP_RING_GROUP2,TP_LINE3,TP_LINE4
This stops ringing on line 3:
TC_RING,TP_OFF,TP_LINE3,TP_LINE4
See AlsoSee Also
See AlsoSee Also
See Also TC_SETTIME_RING, TC_SETRING, TC_SETTONE, TC_SENDTONE,
TC_SETCALLERID_EVERYRING
TC_SELECTCONFIGTC_SELECTCONFIG
TC_SELECTCONFIGTC_SELECTCONFIG
TC_SELECTCONFIG
FormatFormat
FormatFormat
Format TC_SELECTCONFIG,config,linenum
DescriptionDescription
DescriptionDescription
Description Selects pre-programmed configuration to use for default values.
PP
PP
Parar
arar
arameterameter
ameterameter
ameter Config: configuration
1-16
Linenum: line to set configuration for
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
ExampleExample
ExampleExample
Example Sets the configuration for line 1 to configuration 1:
TC_SELECTCONFIG,1,TP_LINE1
NoteNote
NoteNote
Note The TLE-ICID parameters set for line 1 for the configuration selected will be the same for all
the lines. For example, selecting a different configuration for line 2 will change all parameters
except for the TLE-ICID parameters; they will be identical to line 1.
API Commands
16 40-400-00025, Rev. D
TC_SENDTC_SEND
TC_SENDTC_SEND
TC_SENDADSIADSI
ADSIADSI
ADSI
FormatFormat
FormatFormat
Format TC_SENDADSI,linenum
DescriptionDescription
DescriptionDescription
Description Sends an ADSI script to the selected line. This command will only be accepted if the line is in
the off-hook state.
PP
PP
Parar
arar
arameterameter
ameterameter
ameter Linenum: line number
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
ExampleExample
ExampleExample
Example This example sends an ADSI script to line 2:
TC_SENDADSI,TP_LINE2
NoteNote
NoteNote
Note The phone must be off-hook for an ADSI script to be sent. The confirmation for this com-
mand is sent after the ADSI script has been sent to the line.
TC_SENDCALLERIDTC_SENDCALLERID
TC_SENDCALLERIDTC_SENDCALLERID
TC_SENDCALLERID
FormatFormat
FormatFormat
Format TC_SENDCALLERID,linenum,fromline
DescriptionDescription
DescriptionDescription
Description Sends a pre-programmed Caller ID sequence.
PP
PP
Parar
arar
arameterameter
ameterameter
ameter Linenum: line number
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
Fromline: line whose Caller ID is being sent
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
ExampleExample
ExampleExample
Example This example sends line 4’s Caller ID to line 3:
TC_SENDCALLERID,TP_LINE3,TP_LINE4
NoteNote
NoteNote
Note The confirmation for this command is sent after the Caller ID has been sent to the line.
See AlsoSee Also
See AlsoSee Also
See Also TC_RING, TC_SETCALLERID_EVERYRING, TC_SETCALLERID_MODE,
TC_SETCALLERID_NAME, TC_SETCALLERID_SEQUENCE, TC_SETCALLERID_TIME
API Commands
40-400-00025, Rev. D 17
TC_SENDCALLTC_SENDCALL
TC_SENDCALLTC_SENDCALL
TC_SENDCALLWW
WW
WAITINGAITING
AITINGAITING
AITING
FF
FF
Foror
oror
ormatmat
matmat
mat TC_SENDCALLWAITING,callwaittype,linenum,fromline
DescrDescr
DescrDescr
Descriptioniption
iptioniption
iption Sends Call Waiting sequence.
PP
PP
Parar
arar
arameterameter
ameterameter
ameter Callwaittype: Selects which Call Waiting cadence to send.
TP_CWNORMAL
TP_CWDISTINCTIVE
Linenum: line number
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
Fromline: line whose Caller ID is being sent
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
ExampleExample
ExampleExample
Example This example sends Distinctive Call Waiting to line 4:
TC_SENDCALLWAITING,TP_CWDISTINCTIVE,TP_LINE4
NoteNote
NoteNote
Note The confirmation for this command is sent after the Call Waiting sequence has been sent to
the line.
See AlsoSee Also
See AlsoSee Also
See Also TC_SETTONE, TC_SETTIME_CALLWAIT
TC_SENDDTMFTC_SENDDTMF
TC_SENDDTMFTC_SENDDTMF
TC_SENDDTMF
FormatFormat
FormatFormat
Format TC_SENDDTMF,dtmfstring,linenum
DescriptionDescription
DescriptionDescription
Description Sends a string of DTMF digits. This command will only be accepted if the line is in the
off-hook state.
PP
PP
Parar
arar
arametersameters
ametersameters
ameters DTMFstring: digit string to send
1-16 digits (0-9,*,#,ABCD)
Linenum: line number
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
ExampleExample
ExampleExample
Example This example sends 5551212 to line 4:
TC_SENDDTMF,5551212,TP_LINE4
NoteNote
NoteNote
Note The confirmation for this command is sent after the DTMF has been sent to the line.
See AlsoSee Also
See AlsoSee Also
See Also TC_SETDTMFCADENCE,TC_SETDTMFTONES.
API Commands
18 40-400-00025, Rev. D
TC_SENDTTC_SENDT
TC_SENDTTC_SENDT
TC_SENDTONEONE
ONEONE
ONE
FF
FF
Foror
oror
ormatmat
matmat
mat TC_SENDTONE,tonename,linenum[,fromline]
DescrDescr
DescrDescr
Descriptioniption
iptioniption
iption Sends specified tones to the line. Tones are sent with programmed cadences. Dial tone will
turn off automatically upon detection of valid DTMF or rotary dialing (if a receiver was as-
signed). A SIT sequence is sent once, all others will continue until superceded by a new
TC_SENDTONE command or until the hook state transitions from off-hook to on-hook. All
tones are sent whether the line is currently off-hook or on-hook, except those with the
_ATOFFHOOK suffix, which are sent after the defined dial tone delay when off-hook is
detected.
PP
PP
Parar
arar
arametersameters
ametersameters
ameters Tonename: tone to send
TP_OFF
TP_DIALTONE
TP_DIALTONE_NORMAL
TP_DIALTONE_RECALL
TP_DIALTONE_MESSAGEWAIT
TP_DIALTONE_CONFIRM
TP_DIALTONE_ATOFFHOOK
TP_DIALTONE_NORMAL_ATOFFHOOK
TP_DIALTONE_RECALL_ATOFFHOOK
TP_DIALTONE_MESSAGEWAIT_ATOFFHOOK
TP_DIALTONE_CONFIRM_ATOFFHOOK
TP_NUMBERUNOB
TP_RINGBACK Note: requires fromline parameter
TP_RINGBACK_GROUP1 Note: requires fromline parameter
TP_RINGBACK_GROUP2 Note: requires fromline parameter
TP_RINGBACK_GROUP3 Note: requires fromline parameter
TP_BUSY
TP_REORDER
TP_SIT
TP_SWEEP
TP_TEST
Linenum: Line number
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
Fromline: For ringback, line whose ringback cadence to use
TP_LINE1
TP_LINE2
TP_LINE3
TP_LINE4
ExampleExample
ExampleExample
Example This example sends dial tone to line 1:
TC_SENDTONE,TP_DIALTONE,TP_LINE1
This sends ringback tone to Line 1 at the cadence of the ringing set for Line 2:
TC_SENDTONE,TP_RINGBACK,TP_LINE1,TP_LINE2
This replaces ringback by SIT sequence then silence:
TC_SENDTONE,TP_SIT,TP_LINE1
  • Page 1 1
  • Page 2 2
  • Page 3 3
  • Page 4 4
  • Page 5 5
  • Page 6 6
  • Page 7 7
  • Page 8 8
  • Page 9 9
  • Page 10 10
  • Page 11 11
  • Page 12 12
  • Page 13 13
  • Page 14 14
  • Page 15 15
  • Page 16 16
  • Page 17 17
  • Page 18 18
  • Page 19 19
  • Page 20 20
  • Page 21 21
  • Page 22 22
  • Page 23 23
  • Page 24 24
  • Page 25 25
  • Page 26 26
  • Page 27 27
  • Page 28 28
  • Page 29 29
  • Page 30 30
  • Page 31 31
  • Page 32 32
  • Page 33 33
  • Page 34 34
  • Page 35 35
  • Page 36 36
  • Page 37 37
  • Page 38 38
  • Page 39 39
  • Page 40 40
  • Page 41 41
  • Page 42 42
  • Page 43 43
  • Page 44 44
  • Page 45 45
  • Page 46 46
  • Page 47 47
  • Page 48 48
  • Page 49 49
  • Page 50 50
  • Page 51 51
  • Page 52 52
  • Page 53 53
  • Page 54 54
  • Page 55 55
  • Page 56 56
  • Page 57 57
  • Page 58 58
  • Page 59 59
  • Page 60 60
  • Page 61 61
  • Page 62 62
  • Page 63 63
  • Page 64 64
  • Page 65 65

Teltone TLE-TEST User manual

Type
User manual

Ask a question and I''ll find the answer in the document

Finding information in a document is now easier with AI