TERMI Commands

Apart form normal TCL commands TERMI also supports following commands.


SendOut

Sends “data” out to connected serial-port. While sending “data” out, character and line delays from port settings are applied. If data string contains TCL variable, string value of the variable is sent out.

TERMI > set $address 20000
TERMI > set $data 1234
TERMI > SendOut “devwrite $address $data”
TERMI >

For the above code, data send to serial port will be "devwrite 20000 1234" (without quotes)

Please note that SendOut command only sends data out, it won't read or return any thing back.

This command is very efficient if user only wants to send data out without bothering about incoming data.

Note that both outgoing and incoming data will get displayed on serial-pan.

Syntax : SendOut “string”
Return : None
Example :
TERMI
>
SendOut “devwrite $d”


SendOutR

This commands is same as “SendOut” except that it returns incoming data after command execution.

After sending sending “data” out to the connected serial-port, SendOutR waits for TermiReadDelay. While waiting for TermiReadDelay received data is collected in ReadBuffer. Collected data is returned as command-return after TermiReadDelay expires.

Character and line delays settings are applied while sending data out.

TermiReadDelay and ReadBuffer size can be changed by using SetTermiReadDelay and SetReadBufferSize commands.

Syntax : SendOut “string”
Return : Incoming Data
Example :
TERMI > set $address 20000
TERMI > SendOutR “devread $address”
1234
TERMI >

Note that both outgoing and incoming data will get displayed on serial-pan.


SetTermiReadDelay

Sets TermiReadDelay in milli seconds. SendOutR commands accumulates incoming data for TermiReadDelay duration in ReadBuffer.

Syntax : SetTermiReadDelay time-in-mili-seond
Return : None
Example :
TERMI > SetTermiReadDelay 50


GetTermiReadDelay

Returns current TermiReadDelay.

Syntax : GetTermiReadDelay
Return : Time in milli seconds
Example :
TERMI > GetTermiReadDelay
50
TERMI >


ResetTermiReadDelay

Resets TermiReadDelay to original 200ms.

Syntax : ResetTermiReadDelay
Return : None
Example :
TERMI > ResetTermiReadDelay
TERMI >


SetReadBufferSize

Sets read buffer size, this buffer is used for receiving data in SendOutR command. Buffer size is set as number of characters.

Syntax : SetReadBufferSize size-in-no-of-characters
Return : None
Example :
TERMI > SetReadBufferSize 1500
TERMI >


GetReadBufferSize

Returns current read-buffer size.

Syntax : GetReadBufferSize
Return : size in number of characters
Example :
TERMI > GetReadBufferSize
1500
TERMI >


ResetReadBufferSize

Sets read buffer size to original 1000 characters.

Syntax : ResetReadBufferSize
Return : None
Example :
TERMI > ResetReadBufferSize
TERMI >


pwd

Returns present working directory path. pwd can be changed using cd command.

Syntax : pwd
Return : present working directory path
Example :
TERMI > pwd
C:\Program Files\TERMI
TERMI >


dir

Prints files and directory present in pwd.

Syntax : dir
Return : files/directory present in pwd
Example :
TERMI > dir
mclcfpg.dll
serial_port.exe
TCL85.DLL
TERMI.exe
TERMI.ini
TERMI >


clear

Clears TERMI pan.

Syntax : clear
Return : None
Example :
TERMI > clear


cmdhist

Termi stores history of previous commands typed by user, this command prints list of previously typed commands. Previously typed command can be accessed directly by up/down arrow keys.

Syntax : cmdhist
Return : None
Example :
TERMI > cmdhist
dir
pwd
GetTermiReadDelay


GetLicensePath

Prints current license path.

Syntax : GetLicensePath
Return : License path
Example :
TERMI > GetLicensePath
C:\TERMI_LIC\TERMI
TERMI >


GetTermiVersion

Prints TERMI version.

Syntax : GetTermiVersion
Return : version no
Example :
TERMI > GetTermiVersion
1.0
TERMI >


help

Prints one liner help for each TERMI command.

Syntax : help
Return : command list and one liner description
Example :
TERMI > help

    pwd			(prints	present working directory) 
    dir			(prints	files/dir present in pwd)
    SendOut		(Sends	string out to serial port) 
    SendOutR		(Sends string out to serial
                        port and reads data back) 
    clear		(clears	TERMI window)
    cmdhist		(Previous commands history)
    SetTermiReadDelay	(sets read delay in ms) 
    GetTermiReadDelay	(gets read delay) 
    ResetTermiReadDelay	(resets	to original delay value) 
    SetReadBufferSize	(sets read buffer size) 
    GetReadBufferSize	(gets read buffer size) 
    ResetReadBufferSize	(resets	to original buffer size)
    GetTermiVersion	(prints	Termi Version)
    GetLicensePath	(prints license file path) 
    help		(help command)
    exit		(Exit TREMI Application)

    TERMI >

exit

exits TERMI

Syntax : exit
Return : None
Example :
TERMI > exit