Kiwi 1.0 User Guide

July 1, 2003
 

Installation
Interface
The Trace File
Using the Keyboard
Using the Mouse
Trace Example
Author

Installation

Kiwi is fully written in Tcl/Tk and so, in order to run Kiwi, you need the Tcl/Tk interpreter installed on your system. Tcl/TK is available as a standard binary package for most of the Linux distributions. You have binary installation packages for Windows and MacOS as well. In any case, if you don't have a binary package for your system, you can always build it from its sources. Tcl/TK is available for virtually any Unix system and it is very easy to compile and install. Please, refer to the Tcl Developer Xchange homepage for details.

Unix Systems

First, you must find the full pathname of the Tcl/TK interpreter which is installed in your system. The name of this interpreter is "wish" or "wishN.M" being N.M the version of Tcl/TK that you have. You can execute "which wish" for getting the full pathname of "wish". Next, edit the first line in the file called "kiwi" and correct the full pathname of "wish" if necessary. That's all. You can run now Kiwi just by executing the file named "kiwi".

Windows Systems

You should rename the file "kiwi" to "kiwi.tcl". You can run now Kiwi by double-clicking the icon of the file "kiwi.tcl".

MacOS Systems

No tested yet. Sorry.
 

Interface

Main Buttons

• Open a trace file, Save as a new trace file
• Take an snapshot of the current view as an EPS file
• Play the trace file
• Stop playing or drawing.

Main Drawing Options

• Adjust Zoom X.
• Adjust Zoom Y
• Select the Palette
• Redraw (apply drawing options)

Viewer

Tools

• Show/Hide the Events List pane
• Show/Hide the Drawing Options pane

Move

• Go to the beginning of the trace 
• Fast backward
• Normal backward
• Slow backward
• Current time point
• Go to an specific time point
• Delete duration and go-to lines
• Slow forward
• Normal forward
• Fast forward
• Go to the end of the trace

Information

• Time-stamp of the first event in the trace file.
• Time-stamp of the last event in the trace file.
• Miniature.
• Time length of the current view.
• Time length of the current grid.

The Trace File

A Kiwi trace file is a text file in which lines represent timed events. Each line is formed by five fields, being the space character used as the field separator. These fields are:

Time   Event Type   Arg1   Arg2   Arg3

The "Time" and "Event Type" fields are mandatory. The "Arg1", "Arg2" and "Arg3" fields are used depending on the "Event Type" value, as follows:
 
 

The requirements imposed on the field values are:

• "Time" is a real number between 0.0 and 9999.999999999. It represents a time point expressed in seconds. Lines in a Kiwi trace file must be sorted in ascending order on this field.
• "Event Type" must be one of the values listed in the table above. You can either use  the number listed in the first column or its corresponding name listed in the second column.
• "Line" is an integer number between 0 and 99.
• "Text" is a string of characters. If the string contains space characters they must be enclosed between " " or { }.
• "Color" is an hexadecimal number which represents a RGB color using the format #rrggbb or a symbolic color name valid for Tcl/TK (see the "n colors" man page for details)

You can set drawing options in the trace file. These drawing options are optional and they must be placed at the beginning of the trace file, before any timed event. Each option line is formed by four fields, being the space character used as the field separator. These fields are:

Drawing Option   Arg1   Arg2   Arg3

The "Drawing Option" field is mandatory. The "Arg1", "Arg2" and "Arg3" fields are used depending on the "Drawing Option" value, as follows:
 

Using the Keyboard

Using the Mouse

Trace Example

File demo.ktr

DECIMAL_DIGITS 0
DURATION 50
LINE_NAME 0 A
LINE_NAME 1 B
LINE_NAME 2 C
PALETTE Rainbow
ZOOM_X    4
ZOOM_Y  16
COLOR EXEC-E 0 orchid4

0    READY-B 0
0    READY-B 1
0    READY-B 2
0    START 0
0    START 1
0    START 2
0    EXEC-B 0
 

2    READY-E 0
2    STOP 0
2    EXEC-E 0
2    EXEC-B 1

5    READY-E 1
5    STOP 1
5    EXEC-E 1
5    EXEC-B 2

7    ARROWUP 2 e2 orange

8    ARROWDOWN 1 e1

9    LOCK 2 s0
9    EXEC-E 2
9    EXEC-B 2

10   DEADLINE 1

11   DEADLINE 0
11   READY-B 0
11   START 0
11   EXEC-E 2 gray70
11   EXEC-B 0

13   READY-E 0
13   STOP 0
13   EXEC-E 0
13   READY-B 1
13   START 1
13   EXEC-B 1

14   VLINE M1

15   BLOCK 1 s0
15   READY-E 1
15   EXEC-E 1
15   EXEC-B 2

17   TEXTOVER   3 "KIWI TRACE" blue3
17   TEXTUNDER 3 "EXAMPLE" blue3

20   UNLOCK 2 s0
20   LOCK 1 s0
20   READY-B 1
20   EXEC-E 2 gray70
20   EXEC-B 1

21   UNLOCK 1 s0
21   READY-E 1
21   STOP 1
21   EXEC-E 1 gray70
21   EXEC-B 2

22   DEADLINE 0
22   READY-B 0
22   START 0
22   EXEC-E 2
22   EXEC-B 0

23   DEADLINE 1

24   READY-E 0
24   STOP 0
24   EXEC-E 0
24   EXEC-B 2

26   READY-B 1
26   START 1
26   EXEC-E 2
26   EXEC-B 1

27   ARROWUP 2 "" orange

29   READY-E 1
29   STOP 1
29   EXEC-E 1
29   EXEC-B 2

32   READY-E 2
32   STOP 2
32   EXEC-E 2

33   DEADLINE 0
33   EXEC-B 0
33   READY-B 0
33   START 0

35   READY-E 0
35   STOP 0
35   EXEC-E 0

Author

Kiwi was written by Agustín Espinosa Minguet ( aespinos@dsic.upv.es )

Please send me an e-mail for any comments about Kiwi.