Software for the CONV-TTL-BLO board
===================================

This folder contains various software that can communicate to the CONV-TTL-BLO
for diagnostics purposes, or to issue MultiBoot to a board. It contains the
following sub-folders:

catbstream/ -- a Python script for concatenating two bitstreams for writing a
               golden and application bitstream to the Flash at once
diag/       -- Python scripts for diagnostics
ei2c/       -- common "library" files for the other programs used to test the
               CONV-TTL-BLO
multiboot/  -- MultiBoot-related files
pulsetest/  -- Python script for running pulse tests
regtest/    -- Python script for running communication tests

All of the scripts in this folder connect via Telnet to communicate to a board
inside a crate. The ei2c/ folder contains scripts that are used by all other
test scripts to control the connection. Of particular interest is the
ei2c/ei2cdefine.py script, where there are declarations of variables used by
all test scripts to control connecting to the board to be probed (see also
Getting Started below).

For more information on the scripts in each folder, refer to the README.txt
file in the respective folder.

Getting started
===============

Normally, you would use these test scripts to connect to boards in multiple
crates. In this case, you will type in the crate's hostname or IP, user name
and password from the keyboard, which is the default state of the scripts
when you clone the repository.

Alternatively, should you want to work on a board in a single crate, perform
these steps:

1. Set the ENABLED variable to True in ei2c/ei2cdefine.py; this will enable the
use of the next three variables when connecting to a crate. The scripts will
now stop asking for a hostname, username and password every time you use them.
2. Set the HNAME variable to the hostname or IP to the appropriate value
according to the crate you connect to
3. Set the USER variable to the username to which you wish to connect on the
crate ("user" or "admin")
4. Set the PWD variable to the password for the previously-selected username
5. Should you want to debug the communication, the DUMP variable will enable
the generation of a file containing the dump of the communication (Telnet
command and its reply). The dump file will be a file called "dump.txt" in the
same directory as the script being run.
