You've already forked gitified_old_clb_svn
63 lines
2.1 KiB
Plaintext
63 lines
2.1 KiB
Plaintext
===========================
|
|
= CLBv2 Remote =
|
|
= Version 1.0 beta =
|
|
===========================
|
|
|
|
CLBv2 Remote is an Java API capable of communcating with a KM3NeT Digital Unit. Documentation of this API can be generated using Javadoc, and will be placed in the doc directory. Please refer to this documentation for interfacing capabilities.
|
|
|
|
CLBv2 Remote also features the following tools:
|
|
* testgui - A graphical user interface for testing various aspects of the DOM
|
|
* flasher - A tool to flash and verify images written to the CLB
|
|
|
|
TestGUI
|
|
-------
|
|
The TestGUI can be started by the testgui shell command. It loads the GUI giving accesss to most of the CLB features. testgui can be started with a special flag: --unsafe . ** THIS WILL START THE GUI IN A MODE WITH UNSAFE FEATURES WHICH COULD BRICK THE DIGITAL UNIT FOREVER! **
|
|
|
|
flasher
|
|
-------
|
|
Flasher is a simple tool to flash an image to a digital unit. Flasher has the following commandline:
|
|
|
|
flasher <ip> [update|verify] <imageno> <binary>
|
|
|
|
Where 'update' writes a new image at the given position, and verify checks whether or not the image at a specific postion is the same as the provided binary. Positions are reserved:
|
|
0 - golden image
|
|
1 - runtime image
|
|
2 - backup / test runtime imasge
|
|
3 - diagnostic image
|
|
|
|
However, to prevent accidental overwriting of the golden image, you can not simply put 0 at the imageno location. In order to overwrite the golden image you must write 'golden' instead. Please note: IN CASE OF POWER FAILURE DURING THE WRITING OF THE GOLDEN IMAGE THE DIGTAL UNIT COULD BE BRICKED.
|
|
|
|
|
|
templog
|
|
-------
|
|
Logs all CLB temperatures, each second, and relative humidity. Usage:
|
|
|
|
templog <ip>
|
|
|
|
e.g.
|
|
|
|
templog 192.168.1.10
|
|
|
|
|
|
wrlog
|
|
-------
|
|
Logs all WR parameters, each second.
|
|
Format: TX_Slave RX_Slave TX_Master RX_Master Cable_RTT
|
|
Usage:
|
|
wrlog <ip>
|
|
|
|
|
|
|
|
imgtool
|
|
-------
|
|
Lists all images on the CLB, and is able to set the default image.
|
|
|
|
Without a command it will list the images.
|
|
|
|
Usage:
|
|
imgtool <ip> [<cmd> <args>]
|
|
where <cmd> can be:
|
|
rtimg <#> - Set the runtime (active) image (1..3).
|
|
|
|
|