This action might not be possible to undo. Are you sure you want to continue?
Serial Terminal: RealTerm
Latest News ChangeLog Virtual Comports can be addressed by name eg \VCP0 (188.8.131.52+) Count of Binary Sync Matches displayed Spy Mode displays nulls (char 00) correctly (184.108.40.206+) Timestamping file captures for data logging Spaces in commnd line parameters working (220.127.116.11+) Improved installer with source and examples CallbackEvents in ActiveX interface (V18.104.22.168+) Spy Mode monitors comms of other applications. Extensive I2C support Stable Version 22.214.171.124 released Monitor New Releases Who Uses it? / What For? Hell its free, drop us a line saying what your company does with Realterm!
Realterm is a terminal program specially designed for capturing, controlling and debugging binary and other difficult data streams. It is far better for debugging comms than Hyperterminal. It has no support for dialing modems, BBS etc - that is what hyperterminal does. Contents Installing Download Display Formats Terminal Colors Sync Ports Hex Font Pin Status Capture Timestamps Trace and Log Send Chars & Files Echo to Network Monitoring RS232 Command Line ActiveX/COM Browsing Properties & Methods Callback Events Capture Events Data Triggers Examples from Excel from OpenOffice from Matlab from Perl from Scilab Lego Mindstorms Hiding Controls & Display I2C Bus, SPI, 1-Wire HexCSV2Dec Utility PIC Programmer Linux Translations Links Books Who Uses it? / What For? ChangeLog Old Version Documentation http://realterm.sourceforge.net/index.html 13/07/2013 16:22:13 Text or Binary views of data binary viewed as hex, 8 bit, 16 bit, little/big endian, signed, unsigned, special fonts colorised: rx and tx data are different colors ansi terminal or plain text or binary modes protocol analyser / "port spying" mode fixed frame sizes/line lengths sync patterns with masks and xors data inversion full remote control through active X/ Windows Scripting extensive command-line control can be used for serial I/O component of other programs via activeX. Full support for minimize,hide,iconize, tooltray special ascii+hex font to see hidden control chars capture to file, settable capture size or capture duration timestamping capture files for simple data logging view and change control lines (cts,rts, dcd etc) easy to send binary sequences serial (comports) or telnet via tcp arbitary baud rates reset / power buttons for Pic Programmer hideable to run in invisible or on tool-tray can dump files to serial port Drives I2C and SPI chips via BL233
sourceforge.html 13/07/2013 16:22:13 . Special TermHex Fonts should be installed automatically. install the font file TERM_HEX.net/index. Installing Realterm Download Monitor New File Releases Download and run the installer. USE RSS NOW! If you are using an FTDI usb adaptor you need to install the FTDI driver first To use Spy mode. If you need to. Active X should be registered automatically. or PicProg functions. Read all the Tool Tips carefully. Realterm should be installed by an Administrator user on XP and Vista. http://realterm. Amongst other things you get a list of the actual commandline parameters that version supports. Check the examples directory for programming examples. This font is also useful in editors etc. Popup Hints (tool tips) are the primary source of help and explanation when using Realterm. Make shortcuts with all the configurations you need. Double click the status bar to show them the full screen width. This is now the main news notification Monitor New File Releases to be notified of updates. If you doubleclick on the status bar at the bottom it will toggle to a longer hint string. Take the time to move the mouse over every control.FON from control panel -> fonts. Example directory will be created with more up to date examples that you will find here. The Popup hints are also displayed (and don't timeout) on the status bar. (see commandline options) eg "Port=2 baud=9600 flow=2" Subscribe to RSS News feed for development versions.Terminal Software Contact Us Read the popup hints carefully. and documentation changes. install the separate drivers required. and read the hints that pop up. They give a lot of information Right mouse context menu has some extra functions There is an "examples" directory to see how to use it in scripts and with other programs Page 2 Help & Hints: Press F1 to bring up the help screen.
Display Formatting Reaterm displays data in meaningful forms ASCII is plain text. Tray Icon & Popup Menu Right mouse click on the main window or on the Tray Icon Realterm (ie make it disappear from the taskbar) will bring up the popup menu. or on the Misc tab. 'T': clTeal. The sequence is: Kbd. or you want a bigger screen. Red when capturing.net/index. then hides all the controls.html 13/07/2013 16:22:13 . The Hiding Controls / Fullscreen If you don't want the control panel visible. 'W': clWhite. and help links. make bug reports etc. 'P': clPurple. You can doubleclick the tray icon to hide/show The Tray Icon and main icon changes to show a red dot dot is Green for normal chars. Yellow when Data Triggers or Binary Sync Matches occur.64+). 'N': clMaroon.Port. The dot rotates as data bytes are actually being received.sourceforge. to make it less confusing. 'G': clGreen. then you can Hide Controls either from the popup menu.SpyRX. This is ideal for making a shortcut that sets up Realterm for your field staff or users. 'M': clFuchsia. 'L': clLime.Background Default is 'RYLRYK' 'R': clRed.Terminal Software F1 brings up the About page with lots of links.0. http://realterm. 'K': clBlack. 'Y': clYellow. or the commandline or activeX interfaces. when it is capturing.0. Hex Font lets you see non-ascii values ANSI is terminal emulation data can be inverted (pager IC's do this) Data can be in 1 or 2 byte binary views 2 byte data can have either byte order Terminal Colors Colors can be set from the commandline (V2.SpyTX. (bright green) 'O': clOlive.SendStr. Page 3 Project Page on Help is Here back to contents is the place to find all up-to-date information. Colors are set by a sting of color chars below. 'B': clBlue. 'C': clAqua.
back to contents Frame Sync Binary data is arranged in frames. Delimited frames start a new line when they detect the sync sequence. echoing a port to a remote machine. These frames are either Fixed size N byte frames variable length. You can have as many bytes as you want in the sync word.html 13/07/2013 16:22:13 . GULP swallows a character each time it is pressed.net/index. You will notice that the terminal resizes to always have a whole number of frames across. This is ideal where Realterm is being used by another program to work in the background. Press it until the frames correctly start at the beginning of a line. by setting the AND term to $80 $80. (Note hex numbers are preceded by $) Errata: Versions <1. The middle field is AND. the tray icon square changes to yellow for a few seconds. the bottom is XOR back to contents Baud Rates & Ports http://realterm. all the time. when 0xA55A XOR 0x0000 AND 0xFFFF > 0. The XOR term allows you to invert some or all data bits. then select "Synch is: ASCII" and put the chars in the top editbox. ($00 is normal $FF is inverted). it disappears from the taskbar. eg capturing data to a file.sourceforge. Unfortunately frames will randomly begin somewhere on the line. When a sync match occurs.99. Fixed size frames are self evident. delimited by a trailing byte sequence Single byte Leading Sync where the first char of the line delimits lines. If you want it to be totally hidden the activeX interface lets you hide even the Tray Icon.31 the XOR and AND fields are mislabelled (swapped). set Bytes and check "Single" You can set the display rows from the commandline to launch it the size you want. Unlike minimising. Setting Rows and Columns To force the number of columns across the terminal window. or more accurately. If you are syncing off ASCII chars. For example you could use this to use bit 7 as a sync bit. The AND term lets you ignore some of the bits. just leave them empty to get the defaults. (of course Text is arranged as lines ending with LF or CR) A count of sync matches is shown on the Binary Sync Chars panel. The example shown will be a 40x16 window. ["SyncIs" should be set to "Number"].Terminal Software Page 4 Show / Hiding Everything The popup menu (and ActiveX and Commandline) have a Show option that will completely hide Realterm. unless "Single" is checked. If you don't need the XOR and AND fields. This is ideal if (like us) you have 16 Realterms running in the background at once. A sync sequence can be any number of bytes long Here sync is detected when 2 bytes match 0xA55A. Only the Tray Icon is left.
RS485 Enables hardware direction control by the RTS line.20. Note that some specialist serial cards and USB-Serial adaptors can handle this in hardware. or which usb hub port it is connected to. and Bluetooth Version 2. which is a give away that they are in your serial card. This will result in higher than requested baud rates. Look under "my computer->properties->hardware->ports" to find where they are. When starting normally. Unfortunately the same device will often appear at different comport numbers when it is on different USB hub ports. and this won't help you. Realterm can connect to both SERIAL ports (real uarts.0. This can cause long delays where Bluetooth is running.net/index.html 13/07/2013 16:22:13 . Most PC ports accept non-standard values that the chips divider is capable of generating. When trying to get very high baud rates. and don't require this to be set. (V2. On Win9X there don't seem to be any special names for devices. Scanning for Ports.70 Realterm will scan for ports at startup if an explicit port is not given on the commandline.57+) When started as an ActiveX automation server. Double click on the the word "Baud" to show/hide the hidden multiplier selector.sourceforge. The SCANPORTS commandline option restricts scanning.168.0. Realterm accepts anything.1:23 port can be a number or service name eg "telnet" server:port eg "server:telnet" or "server:9876" Virtual Comports and USB Devices USB serial ports appear at some port number.0. They have 64byte FIFO's.0. ie the actual baud rate = requested rate * multiplier There is a hidden control to scale Realterms baud rate. Baud Rate Multiplier and 16C95X Uarts The16C95X family of advanced uarts are able to support very high baud rates. The currently present devices and associated ports are also listed in the registry at HKLM\HARDWARE\DEVICEMAP\SERIALCOMM.70 onwards Realterm now uses the registry to find ports rather than trying to open them all. Realterm will try to open the first existent port that it finds. Some ports complain about invalid baud rates. as well as USB. regardless of the comport# that it is assigned. Note that this does not change the multiplier itself. They may also get around the limitations that windows imposes on this.0. Please report any problems especially with older versions of windows eg 98 Versions Before 2. Startup Delay. and network virtual uarts) or TCP/Telnet ports. You can use these device names directly in the port selection eg "\VCP0" or "\Serial0" For example when you plug in an I2C2PC adaptor it will normally appear as \VCP0. others just ignore them. it does not open the port until explicitly requested. some coerce to the nearest rate.0.Terminal Software Page 5 Baudrates depend on the exact hardware port. I have found other people complaining about a "significant lag" when using this flag to control http://realterm. Windows Serial Port# eg "2" Port Name from Registry if preceded by "\" eg "\VCP0" or "\Serial0" ip_address:port eg 192. This makes it easier to select the rate you want. which must be set in the hardware control panel. there is an option in the hardware configuration of the uart to enable the "baud rate multiplier". as described by Stephen Boyd below: “For all versions of Windows > NT AsyncPro handles the toggling of RTS via the RTS_CONTROL_TOGGLE flag and the Windows SetCommState function.
and via activeX) The error cause is displayed when you hover the mouse over the error light. Set means data flow is enabled. invalid hidden codes and errors.sourceforge. Note that if CTS/RTS or DTR/DSR handshaking is enabled. then you cannot control that pin from the buttons. please do. (Note that you won't see them in ANSI mode. Handshake outputs can be controlled directly (and from the command-line. If you can convert these fonts for use with Linux or another OS. The non-ascii values <32 are shown as either HEX or CONTROL chars. The Installer should install the fonts for you automatically.Terminal Software RS485 devices from non-ASyncPro programs. back to contents Hex Font Our Hex fonts are included. please do! If you would like to add a larger size to the font.net/index. The hex font contains all 8 bit values. You can also go to the windows font installer in Control Panel to install it. This seems to be a problem with Windows in general and not AsyncPro in particular. back to contents http://realterm. in serial comms. depending on the font you select. and I noticed that Windows has a significant delay between the end of transmission and the control of the RTS line. Pin states can be set manually. You need to change between Telnet and Raw modes. back to contents Pins & Status Handshake Pins and comms status can be monitored. Here is a quote from a user in a different forum: I tested the RTS_CONTROL_TOGGLE mode with RS485 devices. as the control codes will be processed) You can now get just the fonts from the downloads page. due to a conflict between the RS422 amplifiers simultaneously active on the RS485 line. However if you are connecting to a socket with raw data. you might notice that some characters (eg 0xFF) are missing or doubled up.FNT file) This is very useful for seeing control codes. (There are 3 different fonts in the .html 13/07/2013 16:22:13 . so this mode does not work properly with a RS485 equipment that replies "too fast" for Windows. It's equally useful in a programmers editor. Your best bet might be to get an actual RS485 card for your windows system that handles the RTS toggle in hardware.” Page 6 TCP/IP: Telnet and Raw modes The TCP connections default to using Telnet protocol.
0. The Log buffer is 10000 long and Trace buffer 1000 long (V2.) This provides a very easy way to (say) collect serial data. popupmenu. eg excel. "Debugging Facilities" (pg 33) back to contents http://realterm. and automation interfaces. and graph it live using Matlab. Timestamp is triggered by CR or LF. the terminal window is turned off. Select hex if you need to see non-printing chars. Unix timestamps are the number of seconds from 1/1/1970.0. and the echo port operation will cease. Well behaved applications can read and process the files whilst RealTerm is writing them. Realterm can be hidden. Diagnostic Files: Trace and Log RealTerm can also write LOG and TRACE files to help debugging difficult serial problems. Char Count and CPS (chars per sec) are displayed The Tray Icon and main icon changes to show a red dot during capture. This means less processor load. When you use DIRECT capture.html 13/07/2013 16:22:13 . You can CLEAR the queue or DUMP it to a file. when it is capturing.69).net/index. This is best for embedded type uses.Terminal Software Page 7 Capture Incoming data can be captured to file. and capture controlled from the tray icon. This is most useful for comma separated (CSV) type text data. Matlab timestamps are given to the PC's clock resolution. so it is probably not ideal for very fast and dense data streams. Chapter 2. These are a reports from a dignostic queue. Combine capture with filesend to make simple datalogging applications Capture can be fully controlled through the ActiveX interface. For more information see the Turbo Async Reference Guide . word. and use a binary/hex editor to examine the file Timestamps Timestamping is very useful for data logging. notepad. Matlab timestamps are floating point days since 0 Jan 0. Using Matlab timestamps should give you finer resolution than 1 second. It can either capture "direct" or via the terminal window. This option only works with Direct Capture. Capture As HEX Sometimes it is easier to look at binary data when it is saved as hex. this should be 10ms for NT and later and 55ms for Win98 and earlier. These are completely separate from the Capture function and provided by the Turbo Async comport component. So each received char is converted to two hex chars and saved to file. The capture can automatically stop after a certain time or number of chars. In this case the whole file including timestamps can be converted to decimal by the HEXCSV2DEC utility that is bundled with Realterm Timestamping also slows down file capture somewhat.sourceforge. The dot rotates as data bytes are actually being received. (beware: Microsoft apps often try to lock the file. If you want to capture what you are seeing in the terminal. For best speed don't do this: capture normally. UnixHex is provided for convenience when all the data being captured is in hex. or where you want to know when an occaisional string arrived. don't use Direct Capture. screen draws etc.
and buffer space.Terminal Software Page 8 Sending Char Sequences Read the popup Hints carefully. they take time. Sending ASCII with special/non-printable values When you press "SendASCII" any valid backslash sequences are converted to special values in the style of Python. or send them quickly. (V2) If half-duplex is set. Sent chars aren't echoed to the terminal. Both ascii and binary strings can be sent.net/index. Type in numeric values here. each char will be sent. When Sending ASCII. CRC and Checksum You can add a variety of CRC's and Checksums to the end of the send string. See the drop down list.html 13/07/2013 16:22:13 . They give lots of information especially in the Send tab! Often you want to send special chars strings or strings repeatedly. In the terminal window you can send most control chars by holding the control key down eg ctrl+m = CR. then sent strings will be shown on the terminal. When you hit SPACE. you can optionally end the line with CR and/or LF. While it ignores spaces. Chars can be decimal. This is useful for the I2CChip adaptor. (You cannot send 0x00 or 0x03 this way) You can send special chars NUL (0x00) and ^C (0x03) using the buttons You can enter a string of hex or decimal numbers in the Send comboboxes eg "51 0x31 $32" and press "Send Numbers". This can be appended to each string sent. then the string is sent raw. and won't be used in the final application. Modbus binary packets end with a 16bit CRC. or hex eg "13" "$1A" or "0x1A".sourceforge. Sending Files http://realterm. separated by spaces. You can also strip spaces from sent data. Just keep typing out numbers. If Literal is checked. Note that the special chars must be lower case \n \r \a \b \f \v \t LF (0x0A) CR BEL BS FF VT HT \xXX hex value \NNN decimal (NOT octal like python) \\ \ (backslash) Sending Non-printable binary chars You can do this in several ways. (Note that they must be separated by spaces) To send a series of binary numbers use the unmarked edit box. This also applies to strings/chars sent via the ActiveX interface. (but they make it much easier to read!) Loading Canned Strings From the ActiveX interface you can prepopulate the Send dropdowns with strings by using the “AddCannedString” function The SendStr commandline option loads strings into the dropdowns.
net/index. and at the end of each line. and capture the replies to "results. See capture section back to contents I2C & SPI Bus I2C. 1-Wire and other Serial buses can be read using the I2CChip products "I2C2PC" and the "BL233B" IC.txt" endlessly.14 swallowed ^Z / 0x1A). . (EOL is denoted by CR at present).46) The TIMESTAMP option can be used to prepend a timestamp to each line. realterm. (V2. you can log data and control intruments directly from the commandline. This affects file dump. and read pin states Read Status register Read a Dallas 1-Wire ID chip Write to 4 digit 7 seg LED display modules Control various special I2C chips: BL301. It cannot use printer ports. Now the data will be read to file every 1 second.0.txt This will send "commands. so it will loop for ever. Sending Repeatedly You can set the number of repeats. when combined with capture. Using the ActiveX interface you can easily send strings from excel or other apps.Terminal Software You can dump a file directly to the port. PCA9544. (versions before 1. Write to any I2C Address Read N bytes from an I2C Address Write then Read and I2C Address.sourceforge. Page 9 Padding File Dump with Delays Two delay settings are provided to add delays after each char. the PC's SMBUS interface etc. Using this you can quickly try out an I2C adaptor or 1-wire device. and Capture.0.txt capture=results.txt". without extra software. Common commands you want to send to play with the adaptor are provided by the controls. This is most useful for CSV type text data. with a 10sec pause between sends. This is all you need to do to turn (say) and RS232 multimeter into a datalogger. and delay to 1000ms. These are particularly useful from the commandline for data logging. MAX127. SPI. PCA9545. one line file that commands a multimeter to read a voltage. (used to read from I2C devices that have internal registers Read SMBus Alert register Control adaptor pin states directly (bit-bash pins). and the delay after sending the file. The main I2C tab has controls to select one of the serial buses. The I2CChip Host adaptor provides a USB/RS232 interface to 3 I2C buses. For example you can make a simple. but not sending char sequences above. Realterm cannot read I2C without these external devices.html 13/07/2013 16:22:13 .exe senddly=10000 sendrep=0 sendfile=commands. This has no "protocol" and just sends everything. Using the Echo port provides a way to make hardware devices that can be controlled over the internet. Data Logging Using Capture and SendFile from the commandline. Realterm is an easy way to use it. Set repeats to 0. http://realterm.
and use it to re-establish a dropped link.Terminal Software Page 10 Refer to the datasheet for the BL233B chip used.sourceforge. When the connection is broken. This allows a real serial port to be aliased across the network.99:9876 This makes a telnet connection to the remote machine. http://realterm.99) has a datalogger connected to COM1. you can use Windows remote DCOM to start. Note that as Realterm has a full ActiveX interface. as well as the local copy. When the connection is broken. where its commands are detailed. as well as I2C The I2C-2 tab has controls to support a number of common IC's.net/index. it simply stops attempting to echo chars. These are standard modules from I2CChip Dallas 1-Wire devices Echo Port: Redirect Ports across Network The main port can be passed through or echoed to the Echo Port. When there is a connection. the server end just waits for another connection. and other serial IC's. 7 Segment LED and LCD display modules based on MM5451.html 13/07/2013 16:22:13 .0. Now you can sit at your desk.0.168.168. This is partcularly useful when the echoport is a TCP port. (the echo port can be a real comm port too) Lets say the remote (unattended) machine (192. On the local (attended) machine run a copy of Realterm like this: realterm -port=192. It runs Realterm at startup with a command line like this: realterm -port=1 -baud=9600 -echo=server:9876 -caption=Mirror_Multimeter _To_Internet ie realterm connects to the datalogger on COM1 at 9600 bd. and control and monitor the remote serial device. Dallas 1-wire. and presents a telnet server on port 9876 (or any other suitable number). If you are using the activeX interface you can check the open property to see if the link is up. the port need to be manully restarted. or the buffers are full for some reason. At the client end. chars are echoed. The MAX127 12Bit Precision ADC and PCA9545 Bus Switch/multiplexor are available as standard modules from I2CChip The I2C Misc tab has support for non-I2C devices: SPI Chip select pins Bit Bash direct pin operations 4 Digit. Note that you can use it with SPI.stop and control the remote Realterm.
only shows you when the data arrived at Realterms handlers. Special Monitor Cable You need a special adaptor with 2 plugs for the PC's 2 serial ports.Terminal Software Page 11 The Monitor checkbox lets the terminal window display both sides of the conversation (ie both the data received through the ain port. in a different color.net/index. or decent gaps between send and receive. Only connect RXD and GND on those plugs at the PC end.html 13/07/2013 16:22:13 . The Echo port can be used to give you a second receiver. The data is put into the terminal screen. we can use one of the comports handshake output lines (DTR. but the terminal window displays the data from both directions. and the comport must be closed before spy mode can be released. (ie use DTR for signalling if you are using RTS/CTS handshaking for flow control) back to contents Monitor RX and TX data: Protocol Analyser Realterm has two ways to monitor serial communications. and the echo port) Signalling Winsock Connection state to Comport When a telnet/winsock connection is being echoed to a physical comport. The indeterminate delays in Windows mean that you can't rely on the sequence being exactly as it happened. by installing a device driver to intercept the port messages.RTS) to signal a remote system whether winsock is connected. Spy button is on the port tab. and let you see the RXD and TXD data interleaved in the same terminal window: "Spy" on Port tab uses a special driver to intercept the comport messages and display them "Monitor" on EchoPort tab uses 2 comports and a special cable to monitor the actual RS232 cable Spy Mode Spy mode allows you to monitor the communications between a program running on your PC and the com device. Obviously with slow data.sourceforge. Now you can see both sides of the conversation. Now Realterm echos as normal. Note that you cannot currently capture the spy mode. Spy mode must be activated before opening the comport. However you can copy and paste from the terminal window. You must make sure that this doesn't interfere with the operation of the handshake lines. back to contents http://realterm. The interleaving on screen. it will work better than with very fast data streams. Monitor and Echoing You can select both Echo and Monitor. Monitor Mode Monitor mode is useful to monitor communications between external devices by connecting to the RS232 cable.
exe capfile=junk. Can use CAPQUIT=filename Capture as Hex ie turns all chars to a 2 char hex value. During capture. It is also possible to send commands to a running instance of Realterm from the commandline.sourceforge..b. use underscores) Sends the file immediately.exe tab=Send realterm. Prepends a timestamp to each line. eg DISPLAY=5 set big-endian checkbox sets hardware flow control mode sets RTS pin sets DTR pin Starts with port closed (default is open) Selects the opening tabsheet by name Sets the echo port. hex.exe capture=in. StopBits 1-2 terminal frame size name of the capture file to use Length of capture in bytes (either CAPCOUNT or CAPSECS) Time of capture in SECS Capture starts immediately.Parity.Space.exe port=server:telnet realterm. Parity is None.dat visible=0 display=5 bigend=1 capcount=9876 framesize=7 realterm.txt BAUD PORT DATA FRAMESIZE CAPFILE CAPCOUNT CAPSECS 0/1/2 CAPTURE filename Capture=0 is off.txt sendrep=10 senddly=10000 sendquit=out. (not working properly yet) Sets HALF Duplex Sets window caption (can't accept spaces. (n.Parity. Instead it is set up from either the command line.0. for basic setups. or using its extensive ActiveX interface.0.exe port=\VCP0 realterm.txt capsecs=10 capture realterm.Mark. (capture started before sending starts) Hide Controls and expand terminal window to full screen Monitor Echo port RX onto terminal Sets delay (in ms) after each character when sending files and strings 7E1 # Set the baud rate.3 1/0 1/0 1/0 0-4 0/1 # Capture (as above). Capture=2 is APPEND CAPQUIT CAPHEX TIMESTAMP VISIBLE DISPLAY BIGEND FLOW RTS DTR CLOSED TAB ECHO EBAUD EDATA HALF CAPTION SENDFILE CONTROLS MONITOR CHARDLY 1/0 1/0 # n 7E1 0.exe port=127. and enables echoing Set the baud rate for echo port. These examples show the command-line params you can use. If you manually stop capture. and may not work if you need spaces in parameters and filenames Check the Help (F1) to see a list of the commandline parameters which has been automatically generated. For radiobuttons and checkboxes.exe echo=server:9876 realterm.Odd. No "/" or "-" before parameters) Errata V2..1. Sets Echoport DataBits.int etc).StopBits.txt chardly=3 linedly=50 realterm. For booleans (eg visible) use either 1 or 0. Can use CAPTURE=filename http://realterm.Terminal Software Page 12 Command Line Parameters Realterm doesn't save its settings.net/index. eg DATA=7E1 DataBits is 8-5. Non standard baudrates are fine sets the port Sets DataBits.1:21 realterm.Even.html 13/07/2013 16:22:13 . Capture=1 is ON. a number selects the state. It may be more complete than the one below. starts hidden. then Autoquit is cancelled. but program quits when capture ends.exe RTS=1 DTR=0 realterm.2.0.0. Stops at count OR secs.exe sendfile=junk. only tray-icon is visible sets the display format (ascii.exe baud=9600 port=1 flow=2 capfile=c:\temp\junk. Generally they set the corresponding widgets.StopBits.60 and below: Quoted strings are not working properly. realterm.
and quits. and set the params in its properties.0. then Autoquit is cancelled. sets Newline Mode checkbox Spy mode. contact us. 0 stops.net/index. HexCSV).Terminal Software LINEDLY ROWS SENDDLY SENDREP SENDQUIT SENDSTR SENDNUM FIRST LFNL SPY 1/0 1/0 "string" # # # # Sets delay (in ms) after each line when sending files and strings Set number of rows in terminal window. set delay (in ms) after file is sent. =0 disables.exe first LF sendstr="S42F0" QUIT EXIT CAPTURE 0/1/filename SENDFILE 0/1/filename SENDSTR "string" CR LF 0/1 0/1 Quits Realterm same as Quit Start/stop capture. and some special ones below.SendStr. SENDREP will be set to 0.If you manually stop send. This allows you to pass many of the above parameters (not all will do anything). If Send Delay is set. Can use SENDQUIT=filename Page 13 Loads "string" into the Send String comboboxes. This option can be sued to suppress scanning set the I2C Address. because it takes a while before the OS can say that a port is not there. The sequence is: Kbd. Does not send the string unless sent to a running instance using FIRST (see below) "string" as SENDSTR above Sends commands to running (FIRST) instance of Realterm or stops more than one instance running. Be sure to specify the port on the command line with port=X when using this.Background Default is 'RYLRYK' see Terminal Colors "format" Sets format string for HexCSV formatting. Should be hex string eg "0x40" SCANPORTS I2CADD HELP 1/0 SCROLLBACK # COLORS HEXCSV Enable Scrollback. set number of times file will be sent.0.Port.SpyTX. (when implemented) will set the capture formatting sting to the same. 0 sends for ever. (only when sent to a running instance) send CR after string (sets for following strings) send LF after string SENDNUM "numeric string" send numeric string as binary (only when sent to a running instance) The best idea is to create a special shortcut for each setup you want to use.exe hexcsv=uv hexcsv=st hexcsv=ab Controlling a Running Instance When you begin a line with the FIRST parameter. Port you are spying on must be closed when starting.69+ has fix for quoted string bugs) realterm. Should be first param.SpyRX. eg realterm. realterm scans for actual comports by trying to open them all. (2.SendNum. 1 starts capture. and the second instance will terminate. the parameters will be sent to the existing (first) running instance. Should follow after SENDDLY quit when sendfile ends. Can be called more than once to load more strings. can be called multiple times to push more than a single value into the drop down. until next send begins. Note that Windows Scripting/ActiveX is a better way to do complicated tasks.sourceforge. If you need other parameters added. =N Sets SCROLLBACK lines=N Terminal colors are set by a sting of color chars. Brings FIRST instance of realterm to front. back to contents http://realterm.html 13/07/2013 16:22:13 . filename starts and sets filename start/stop send file send string. Hints: Parameters that put a string into a drop down (eg SendStr. This can cause problems with Bluetooth serial devices.
Capture to File. If you don't want people to see RealTerm. Chars and 0x00 Windows has one big problem for users of binary data. 4. and write a simple . VB. property TimerPeriod: Integer dispid 1. Properties & Methods @ V2. Sending Strings. ie they end with 0x00. Use Events to notify your application that the file can be read Use Data Trigger events Use WaitForDataTrigger.OpenOffice. as this page may be out of date. eg matlab. procedure StopCapture. property WindowState: EnumWindowState dispid 18. 3. Alternatively use windows scripting. procedure Close. excel. which are in the source directory. (must be registered first run: REALTERM /REGSERVER) You can launch Realterm from another application. Or open the typelibrary (. Browsing the COM interface Many languages include a browsing tool to examine the properties and methods of the COM interface. you can't pass a string containing char 0 (0x00) through the activeX interface. Sometimes this fails. Note that the capture file interface is mature.net/index. or perhaps you don't have the right permissions under XP or Vista. Many properties and methods have help comments that you can see. If you need to send char 0 to an application use the Putchar function. property PortOpen: WordBool dispid 7.66 Open Realterm using a property editor/browser. Strings are null-terminated. Capture to File. thoroughly tested and reliable. you can completely hide it. dispid 13. One free tool to do this is ActiveX/COM Inspector from Oakland Software Browsing the interface will show you how it actually is. dispid 12. http://realterm. delphi.SCP file to launch and control it. property Port: WideString dispid 6.0.pas file. Use a property browser (eg from excel or delphi) to see what it can do. it is part of the source package in the installer. property Capture: EnumCaptureMode dispid 4. property EnableCaptureCallbacks : WordBool dispid 9. Putstring can send any 8 bit chars except 0. Use the browser tool.EXE /regserver When the type library changes (ie we extend it) you may need to unregisterm then register it.sourceforge.Terminal Software Page 14 ActiveX/COM Interface RealTerm is an out-of-process server. If you need it. procedure StartCapture. property CPS: Integer dispid 17. property FrameSize: Integer dispid 14. Poll properties like CaptureCount to know when to read the file.html 13/07/2013 16:22:13 . 2. property CaptureCountForCallback : Integer dispid 8. Run: REALTERM. Some languages might want the type library. Amazing as it seems. From Matlab From Excel Getting Data With the ActiveX interface you can get data in several ways: 1.EXE /unregserver Why not the microsoft comms ocx It has many problems. property CharCount: Integer dispid 16. property EnableTimerCallbacks : WordBool dispid 2. property baud: Integer dispid 5. property DisplayAs: Integer dispid 15. dispid 11. dispid 10.0. You could even launch it from a web page to use as telnet client! Registering the COM interface This should be done automatically when you run the installer.tlb) or the realterm_tlb. procedure StartCaptureAppend . To register the ActiveX (only needed if you want to use activex) run: REALTERM. Save yourself time and headaches. The active interface is more extensive than the command line. property CaptureFile: WideString dispid 3. The best thing about using RealTerm is that you can see exactly what is happening when you want.
function DiskFree(Drive: Integer): Double. dispid 3. property HideControls: WordBool dispid 34. AutoEnable: WordBool. property SendFileDelay : Integer dispid 47.Terminal Software property Caption: WideString dispid 19. dispid 51. function SelectTabSheet (const TabCaption: WideString): WordBool. dispid 2. IncludeStrings : WordBool). procedure OnDataTrigger(Index: Integer. procedure OnTimer. property StopBits: Integer dispid 37. property EchoPortOpen: WordBool dispid 32. const EndString: WideString. procedure DataTriggerSet (Index: Integer. procedure NewlineTerminal . property BigEndian: WordBool dispid 30. procedure PutChar(C: Byte). procedure DataTriggerSet (Index: Integer. property CaptureTimeLeft : Integer readonly dispid 26. IncludeStrings : WordBool). function DiskSize(Drive: Integer): Double. PacketSIze: Integer. property CaptureEnd: Integer dispid 21. Timeout: Integer. const EndString: WideString. property CaptureAsHex: WordBool dispid 205. Timeout: WordBool. property DataBits: Integer dispid 36. procedure DisableDataTrigger (Index: Integer). AutoEnable: WordBool. to make it easier to test your software interface. From the Events tab you can manually trigger events.0. Note that when you are capturing a lot of data. dispid 58. Reenable: WordBool). property EchoFlowControl : Integer dispid 43. procedure DisableDataTrigger (Index: Integer). property EchoBaud: Integer dispid 38. dispid 1. There are several properties and methods to control the events: property TimerPeriod: Integer property EnableTimerCallbacks : WordBool procedure EnableDataTrigger (Index: Integer). property SendFile: WideString dispid 49. property CaptureEndUnits : EnumUnits dispid 23. dispid 204. It does nothing within Realterm. By default they are disabled. property EchoParity: WideString dispid 39. dispid 201. dispid 206. procedure EnableDataTrigger (Index: Integer). property LineDelay: Integer dispid 45.net/index. property TrayIconActive : WordBool dispid 28. Timeout: Integer. PacketSIze: Integer. dispid 25. property LinefeedIsNewline : WordBool dispid 53. using the a capture file is probably a better approach than Data Triggers.dispid 203. ControlNum:Integer): WordBool. property Rows: Integer dispid 46. Testing Events and Events Tab http://realterm. ie it only provides callbacks to your application. Page 15 Callback Events (V2. property Visible: WordBool dispid 20. property MonitorOn: WordBool dispid 52. IgnoreCase: WordBool. property Parity: WideString dispid 35. Delimiter: Byte). dispid 29. function AddCannedSendString (const SendString: WideString. or the data rate is high. IgnoreCase: WordBool. property HalfDuplex: WordBool dispid 33. This exists as some languages do not have a convenient timer arrangement. const StartString: WideString. procedure OnCaptureCount. so the interface will change in future. procedure TimeStamp(Style: Integer. dispid 202.0. property SendFileRepeats : Integer dispid 48. const StartString: WideString. DataTrigger is new. Events usually have an associated property to enable them. dispid 22. dispid 54. property Send: WordBool dispid 50. and a work in progress. dispid 27. procedure ClearTerminal . function WaitforDataTrigger (Timeout: Integer): WideString. property CaptureDirect : WordBool dispid 57.dispid 203. property FlowControl: Integer dispid 42. Size: Integer. property CharDelay: Integer dispid 44. property EchoStopBits: Integer dispid 41. dispid 201. procedure PutString(const S: WideString). dispid 202. The Events tab is only visible when Realterm started as an ActiveX. procedure OnCaptureStop. property EchoPort: WideString dispid 31. so you will need to explicitly enable them before anything happens.sourceforge. dispid 24. property Version: WideString readonly dispid 59.html 13/07/2013 16:22:13 . property RTS: WordBool dispid 55.46+) Realterm can send events to an application. property DTR: WordBool dispid 56. The Timer is a utility. property EchoDataBits: Integer dispid 40. Data: OleVariant.
So it is ideal to capture ascii data lines eg from the I2C2PC adaptor. Events in Excel Unfortunately it appears that you cannot practically use callback events in Excel or OpenOffice. Capture Events OnCaptureCount and OnCaptureStop are provided to work with capture. Data triggers can be automatically re-enabled or manually re-enabled. and not recommended. These may change with different revisions. Unlike some other hex2dec utilitys it converts the binary format of the hex into decimal http://realterm. All the methods include an index. Now you can edit and tests the trigger. Before using Data Triggers you should enable them.exe" With no parameters it will display its help.net/index. At the end of the event handler you should update CaptureCountForCallback to a new value. to support multiple triggers in future. back to contents HexCSV2DEC Utility This command line utility is installed with Realterm and is normally found at: "c:\Program Files\BEL\Realterm\HexCSV2DEC. It is a blocking function. The Events tab also has a button to edit these settings. This means that your application will completely stall while it waits. You can manually display it using the "show Events Tab" button on the misc tab. In your OnDataTrigger handler you can reenable the trigger by setting Reenable. See below. WaitForDataTrigger This function is provided for convenience. without having to get the actual serial data working at the same time. OnCaptureCount is used with the properties CharCount and CaptureCountForCallback. as new functions are always being added. Timeouts Timeout numbers are in "ticks" (18ms) Testing The Events tab will show when Realterm is started as an ActiveX/COM. please make an example for others.Terminal Software Page 16 When Realterm has been started as an ActiveX/COM server. DataTriggerSet is used to configure the trigger from the COM interface. Always check your actual version using a browser. Misc Notes Don't rely on the defaults when using ActiveX (eg baud rate). function WaitforDataTrigger (Timeout: Integer): WideString.sourceforge. contact us. as you can getting the event handler going.html 13/07/2013 16:22:13 . This is poor programming practice. Alternatively it is possible to clear CharCount. The TrayIcon changes to Yellow when Data Triggers or Binary Sync Matches occur. OnCaptureEvent is fired when CharCount>=CaptureCountForCallback. If you know how to do this. It converts a file of hexadecimal data values to decimal. Data Trigger The default trigger is a LF character at the end of line. This makes testing your code very much easier. The light will flash when a trigger is matched. On this are controls to manully send the various events. WaitForDataTrigger was provided for this. Index should be set to 1. If you need other parameters added. At present there is only 1 data trigger and index is ignored. there will be an event tab. This is only a snapshot when this web page was written. Otherwise the event will not happen again. But sometimes it is the only way.
into useful decimal numbers.net/index.06 and Systools are on sourceforge.Terminal Software Page 17 numbers.06 library (now free on Sourceforge) Version 1.com Converts HEX in CSV files to Decimal CSV files Command Line may have these forms: HexCSV2DEC <InFile> <OutFile> HexCSV2DEC <InFile> HexCSV2DEC -<option> <InFile> <OutFile> Uses stdin. It is easy to recompile for specific setups.i2cchip. V2. If you are using NT/2K/XP you need to install the DLPORTIO driver using its install program. Unsigned Precede hex with the special explicit chars to override the default "s" signed big endian eg "s8000" "u" unsigned big endian eg "u8000" "t" signed little endian eg "t0080" "v" unsigned little endian eg "v0080" "f" IEEE Floating point big endian (4byte singles only) "g" IEEE Floating Point little endian "b" Binary (only big endian) "a" ASCII Chars The first parameter can be options -s.-v to set the default format eg HEXCSV2DEC -s <infile> <outfile> Convert hex as signed bigendian Alternatively it can be a series of format chars for each hex substring eg HEXCSV2DEC -sufbd <infile> <outfile> Convert hex using format string back to contents PIC Programmer Realterm can has buttons for RESET and POWER if you are using the BEL Dual PIC Programmer.11 library. You will need additional components.3 (c)2008 Broadcast Equipment Ltd http://www. Its watches the RB7 line.html 13/07/2013 16:22:13 . Async4. and non-hex data is passed through unchanged EXCEPT explicit decimal/bcd strings can be passed though by preceding with "d" eg "d1234" will be passed through as "1234" Floats (numbers with a decimal point) will pass through Default is Big Endian. back to contents Compiling Realterm The current source code for your version is in the installer and will be installed in the "source" subdirectory. This makes it easy to control a serial PIC when you are using ICP. Async Pro (windows) http://realterm. HexCSV2DEC V0.x was compiled with Delphi 3 and used the turbopower Async 2. Other components are on the Download page. stdout if <file> is omitted Only valid UPPERCASE hex substrings will be converted Quoted strings.sourceforge.-t.-u.x is compiled with Delphi 7 and Apro 4. It is especially useful to convert a file of hex captured by reading I2C data with the I2C2PC and BL233.
This action might not be possible to undo. Are you sure you want to continue?
We've moved you to where you read on your other device.
Get the full title to continue listening from where you left off, or restart the preview.