1FFBBLOG(1) Fawkes Manual FFBBLOG(1)
2
6 ffbblog - Fawkes blackboard log file tool
7
9 ffbblog [-r host[:port]] <command> file [params]
10
12 This tool operates on log files recorded using the bblogger plugin. It
13 reads the binary log file and prints human readable output to the
14 console. It can also enable or disable a currently ongoing logging
15 process.
16 The tool can watch log files as they are written (in a way similar to
18 the unix tool tail(1)). It can also print an entry at a specific index,
19 or the meta information about a log file. In replay mode it will print
20 the information to the console in the same timing that it was recorded.
21 Log files can be repaired, for example if the logging process ended
22 prematurely (e.g. because of a segfault in a plugin you are debugging).
23 It will update the meta information in the file as required for other
24 tool operations. It can enable or disable logging in a currently
25 running bblogger. Finally, the log files can be converted to other
26 formats compatible with other tools.
27 For replaying a log file to the blackboard use the fflogreplay plugin.
29
31 watch
32 Watch the given file as it is written. This is useful if the
33 bblogger plugin is currently running and writing updates to the
34 given file.
35 info
37 Show meta information about the given log file.
38 print index [index...]
40 Print one or more specified indexes. The indexes are given on the
41 command line following the file names and must be in the available
42 range that can be queried with the info command.
43 replay
45 Replay the given log file with a timing similar to the one it had
46 during recording.
47 repair
49 Repair the given log file. It will check for certain
50 unconsistencies in the log file which occur if the logging process
51 is ended prematurely, and then repairs them.
52 enable
54 Enable logging in a currently running bblogger. The -r parameter
55 can be optionally supplied to connect to a remote Fawkes instance.
56 disable
58 Disable logging in a currently running bblogger. The -r parameter
59 can be optionally supplied to connect to a remote Fawkes instance.
60 convert infile outfile format
62 Convert the log file to a different format (see formats below for
63 the available formats). After the input infile, two more parameters
64 are expected. First the output file outfile must be given followed
65 by the desired output format.
66
68 -h
69 Show usage instructions.
70 -r host[:port]]
72 The host and port of the Fawkes instance to connect to.
73
75 The following output formats are available for converting bblogger log
76 files.
77 Comma-separated Values (CSV)
79 Lines starting with # are considered comments. The very first line
80 contains a comment with the field names, followed by type and length in
81 braces. Fields are separated as data rows.
82 One row of data is written per line. It contains fields separated by
84 semicolons (;). Warning, strings that may contain semicolons are
85 currently not escaped.
86
88 ffbblog info file.bblog
89 Show meta information of file.bblog.
90 ffbblog replay file.bblog
92 Replay file.bblog in real-time.
93 ffbblog convert in.bblog out.csv csv
95 convert the file in.bblog to CSV format and write the converted
96 data to out.csv.
97
99 fawkes(8)
100
102 Written by Tim Niemueller <niemueller@kbsg.rwth-aachen.de>
103
105 Documentation by Tim Niemueller <niemueller@kbsg.rwth-aachen.de>
106
108 Part of the Fawkes Robot Software Framework. Project website is at
109 http://www.fawkesrobotics.org
110Fawkes 1.3.0 10/09/2020 FFBBLOG(1)