SimmSerial demo code package compilation
and use instructions
SimmSerial is a Simm72 module to be used in a two socket TINI board. Tini
is plugged into one slot of Step, or another two socket TINI board and simmserial
is plugged into the other. Simmserial provides two external serial ports for
use when TINI serial ports are being used for other purposes. For more general
information on TINI, visit the TINI home page at http://www.maxim-ic.com/TINIplatform.cfm.
For many helpful tutorials, check out the Systronix TINI help page at http://www.systronix.com/tutor/top.htm.
SimmSerial Javadocs are here Detailed explainations of what
each class in this package does are contained here.
This document contains instructions for:
Serial Echo Event Instructions
To build SerialEchoEvent:
- first open the JBuilder Project.
- Go to project->properties->required Libraries and make sure you have included
a library that points to the TINI 1.02e .jar files. These files are normally
located under C:\tini1.02e\bin\tini.jar and C:\tini1.02e\bin\tiniclasses.jar.
C:\tini1.02e represents the folder you installed your tini tools to.
- Build the project in JBuilder
- Next, open a command prompt in the SerialEchoEvent directory and run
"buildep SerialEchoEvent"
- Type "deploy {My.Tini.Address} SerialEchoEvent" to FTP the final project
to TINI.
- After this, type "telnet {My.Tini.Address}" to telnet into your tini.
- Log into your tini and type "java SerialEchoEvent.tini &" into the command
prompt. The & runs the program in background mode and allows you to enter
additional commands while the program is running.
- Next, plug a serial dongle into either of your two SimmSerial serial ports.
- Open a hyperterminal program set at 115200 baud, 1 stop bit, no parity
and type some text into the terminal. The text should be echoed back and
printed to the Telnet window.
This program just echos text back to whatever serial port it was entered
in to.
To stop the program, type ps in your telnet window. This will show all running
processes.
Type kill {processnumber} where processnumber is the number listed in the
ps list corresponding to the SerialEchoEvent program.
Type ps again to verify that the SerialEchoEvent process has stopped running.
Serial Echo Blocking Read
Instructions
To build SerialEchoBR:
- first open the JBuilder Project.
- Go to project->properties->required Libraries and make sure you have included
a library that points to the TINI 1.02e .jar files. These files are normally
located under C:\tini1.02e\bin\tini.jar and C:\tini1.02e\bin\tiniclasses.jar.
C:\tini1.02e represents the folder you installed your tini tools to.
- Build the project in JBuilder
- Next, open a command prompt in the SerialEchoBR directory and run "buildep
SerialEchoBlockRead"
- Type "deploy {My.Tini.Address} SerialEchoBlockRead" to FTP the final project
to TINI.
- After this, type "telnet {My.Tini.Address}" to telnet into your tini.
- Log into your tini and type "java SerialEchoBlockRead.tini &" into the
command prompt. The & runs the program in background mode and allows you
to enter additional commands while the program is running.
- The output of the program will be a list of command line options used
to select a serial port.
- SerialEchoBlockRead is designed to use any TINI serial port, internal
or external. It supports both Simmserial and SBX2,
another External UART product from Systronix.
- Type in "java SerialEchoBlockRead.tini SimmSerialA &" or
"java SerialEchoBlockRead.tini SimmSerialB &" to run the serial
echo program.
- Next, plug a serial dongle into the SimmSerial serial port you selected.
Each port is clearly labeled next to the dongle connector.
- Open a hyperterminal program set at 115200 baud, 1 stop bit, no parity
and type some text into the terminal. The text should be echoed back.
- Feel free to kill this process and run SerialEchoBlockRead on any TINI
serial port.
- Instructions are found by running "java SerialEchoBlockRead.tini"
with no parameters as mentioned above.
This program just echos text back to whatever serial port it was entered
in to.
To stop the program, type ps in your telnet window. This will show all running
processes.
Type kill {processnumber} where processnumber is the number listed in the
ps list corresponding to the SerialEchoBR program.
Type ps again to verify that the SerialEchoBR process has stopped running.
Loopback and Handshaking
Instructions
Loopback and Handshaking is fundamentally different from either of the Echo
programs because it is a loopback test and it has been written in a package.
Packages complicate builds in tini because they make command lines longer.
Fortunately, the process of building this program has been simplified by creating
separate buildep.bat files for both the blocking read version of the loopback
program and the event driven loopback program.
To build and run blocking read:
-
- Go to project->properties->required Libraries and make sure you have included
a library that points to the TINI 1.02e .jar files. These files are normally
located under C:\tini1.02e\bin\tini.jar and C:\tini1.02e\bin\tiniclasses.jar.
C:\tini1.02e represents the folder you installed your tini tools to.
-
Build the JBuilder project to create the needed .class files.
-
Open a command prompt in the LoopBack_and_Handshaking directory.
-
Next, type "buildepBlockingRead" in the command prompt to
run the buildepBlockingRead.bat batch file.
-
Next, type "{deploy My.Tini.Address} MultithreadBlockingRead"
to ftp the completed build to TINI.
-
Take a DTE and DCE systronix dongle and connect them together.
DTE dongles are the male connections and DCE are the female connections.
-
Plug a dongle into each of serialA and serialB of SimmSerial.
-
Finally, log into your Tini using Telnet and type "java
MultithreadBlockingRead.tini &" into the Tini Slush terminal.
-
You should see the green Uart activity leds start to flash
at the top of the SimmSerial module. The test only prints out error messages
when there are serial transmission problems and runs for some time, so feel
free to unplug the dongles at some point to see a report of how much serial
data has been transfered between the two serial ports. The report will print
out in the Telnet terminal.
-
To see the serial handshaking test in action, probe the
handshaking lines on the back of a dongle with an occilloscope probe.
-
You should see two lines rapidly switching between -3to-8
volts and +3to+8 volts. These are RS-232 compatable voltage levels.
-
Four pins should switch voltage at a much slower rate. These
are the handshaking pins between the serial ports. If any of these pins
short out, or stop switching, the serial program will stop and print out
a data report.
-
Three pins will have constant voltage levels. These pins
are signal ground, Ring Indicator and Received line signal detect.
Ring Indicator and Received line signal detect are inputs on both DCE and
DTE type serial connections and are not driven.
To build and run HandshakingEvents:
- first open the JBuilder
Project.
- Go to project->properties->required Libraries and make sure you have included
a library that points to the TINI 1.02e .jar files. These files are normally
located under C:\tini1.02e\bin\tini.jar and C:\tini1.02e\bin\tiniclasses.jar.
C:\tini1.02e represents the folder you installed your tini tools to.
- Then build the JBuilder project to create the needed .class files.
- Open a command prompt in the LoopBack_and_Handshaking directory.
- Next, type "buildepHandshakingEvents" in the command prompt to run the buildepHandshakingEvents.bat
batch file.
- Next, type "deploy My.Tini.Address HandshakingEvents" to ftp the completed
build to TINI.
- Take a DTE and DCE systronix dongle and connect them together. DTE dongles
are the male connections and DCE are the female connections.
- Plug a dongle into each of serialA and serialB of SimmSerial.
- Finally, log into your Tini using Telnet and type "java HandShakingEvents.tini
&" into the Tini Slush terminal.
- You should see the green Uart activity leds start to flash at the top of
the SimmSerial module. The test only prints out error messages when there
are serial transmission problems and runs for some time, so feel free to unplug
the dongles at some point to see a report of how much serial data has been
transfered in the Telnet terminal.
- To see the serial handshaking test in action, probe the handshaking lines
on the back of a dongle with an occilloscope probe.
- You should see two lines rapidly switching between -3to-8 volts and +3to+8
volts. These are RS-232 compatable voltage levels.
- Four pins should switch voltage at a much slower rate. These are the handshaking
pins between the serial ports. If any of these pins short out, or stop switching,
the serial program will stop and print out a data report.
- Three pins will have constant voltage levels. These pins are signal ground,
Ring Indicator and Received line signal detect.
Ring Indicator and Received line signal detect are inputs on both DCE and
DTE type serial connections and are not driven.
Irda Demo Program Instructions
Basically all the IrDA code was written by Jac Kersing and posted to SourceForge.
http://sourceforge.net/project/showfiles.php?group_id=9614
Very few modifications were needed to work with SimmSerial.
To run the demo IrDA program, you will need a Palm Pilot capable of running
this Palm program:
TiniTemp program, using Irda to read a one wire device
on Tini
This program is less than completely reliable, but it does demonstrate that
it is possible to use tini to connect to Palm devices using IrDA.
When you press the "get Temp" button on the Palm, several lines of text will
be printed out to the telnet terminal, indicating that Tini is reading the
incoming Irda frames. Also, TINI does successfully discover the palm as an
IrDA device when it runs scans and prints out information sent by the palm.
To build this program:
- Open Irda/IRDA_General.jpr
- Go to project->properties->required Libraries and make sure you have included
a library that points to the TINI 1.02e .jar files. These files are normally
located under C:\tini1.02e\bin\tini.jar and C:\tini1.02e\bin\tiniclasses.jar.
C:\tini1.02e represents the folder you installed your tini tools to.
- Build the general Irda project to create all the neccesary library .class
files.
- Next, open a command prompt in the Irda/tini directory.
- Type "buildep" at the command prompt to build the TiniTemp.tini file to
be used in Tini.
- Type "deploy My.Tini.Address TiniTemp" to ftp TiniTemp.tini to your tini.
- Plug in an Irda Dongle to the Irda port on SimmSerial and point it toward
your palm.
- Open Tini-Temp on your palm.
- Finally, log into your tini and type "java TiniTemp.tini SimmSerial &" in
the slush command promt and wait for messages from the Palm OS program.
- When you press the "Get Temp" button on the Palm program, you
should see several lines of text print out to the Telnet window.
More IrDA updates will likely be developed in coming months to make it easier
and more convienient to use IrDA in your applications. Look for information
both at www.systronix.com and http://sourceforge.net/project/showfiles.php?group_id=9614
Javadoc batch file details:
The javadoc batch file is located in docs.bat run this
batch file to rebuild all the javadocs for this project located in the doc
directory. This batch file contains some interesting options including
- -Sourcepath option
The sourcepath option includes this section of code: "-sourcepath Loopback_and_Handshaking\src;SerialEchoBR\src;SerialEchoEvent\src;Irda\src;Irda\tini\src;Irda\tini\demo\TiniTemp"
The sourcepath option works much like the classpath option, it is a semicolon
separated list of places for javadoc to look for source code. You must use
this option to specify where your packages are located. This is how I run
javadoc on several packages at once.
- -private option
Runs javadoc on all private members of a class and private classes. It is
useful for explaining implementation details of classes.
- -d option
Specifies the output directory of javadoc. In this case, "doc"
- single class file javadocs
Javadoc is run on the following single class files not put into packages:
SerialEchoEvent\src\SerialEchoEvent.java, SerialEchoBR\src\SerialEchoBlockRead.java,
Irda\tini\demo\TiniTemp\TiniTemp.java, and Irda\tini\demo\TiniTemp\GetTemp.java.
You can also run javadoc on individual class files in packages, but you will
get an empty package-list file and will have difficulty linking future code
to your new javadocs later.
- package at a time javadocs
The following packages are examined simultaneously: nl.tbdev.IR and com.systronix.TINI_Serial
This is how the three frame package list version of javadocs are generated.
You can also use the -link option later to link future javadoc builds to this
javadoc version. Read the attached package-list
file to see a list of packages that can be linked to.
We hope you enjoy working with SimmSerial and find it useful in supporting
your UART needs for TINI.
Thank You, Leonard Andrews