1lcm-spy(1)     Lightweight Communications and Marshalling (LCM)     lcm-spy(1)
2
3
4

NAME

6       lcm-spy - traffic inspection tool
7

SYNOPSIS

9       lcm-spy [options]
10
11

DESCRIPTION

13       lcm-spy  is  the  Lightweight  Communications  and  Marshalling traffic
14       inspection utility.  It  is  a  graphical  tool  for  viewing  messages
15       received  on  an  LCM  network,  and  is  analagous to tools like Ethe‐
16       real/Wireshark and tcpdump in that it is able to inspect all  LCM  mes‐
17       sages  received  and provide information and statistics on the channels
18       used.
19
20       When given appropriate LCM type definitions, lcm-spy is able  to  auto‐
21       matically  detect  and  decode messages, and can display the individual
22       fields of recognized messages.  lcm-spy is limited to  displaying  sta‐
23       tistics for unrecognized messages.
24
25       lcm-spy collects the following statistics for each channel:
26
27       - Channel name
28
29       - Number of messages received
30
31       - Message Rate (Hz)
32
33       - Bandwidth (KB/s)
34
35         On  its  own,  this information can often be used to verify that mes‐
36         sages are being transmitted on the  expected  channels,  and  at  the
37         expected data rates.
38
39

OPTIONS

41       The following options are provided by lcm-spy
42
43       -l, --lcm-url=URL
44              Use the specified LCM URL
45
46       -h, --help
47              Shows some help text and exits
48
49

AUTOMATIC MESSAGE DECODING

51       If a Java class generated by lcm-gen for an LCM type definition is con‐
52       tained within a JAR file that is on the Java classpath,  lcm-spy  auto‐
53       matically detects the class and uses Java reflection to insert the cor‐
54       responding LCM type definitions into a  type  database.   Subsequently,
55       lcm-spy is able to automatically recognize and decode messages received
56       that correspond to all such types.
57
58

SEE ALSO

60       lcm-gen(1)
61
62

64       lcm-spy is part of the Lightweight Communications and Marshalling (LCM)
65       project.   Permission  is  granted to copy, distribute and/or modify it
66       under the terms of the GNU Lesser General Public License  as  published
67       by  the Free Software Foundation; either version 2.1 of the License, or
68       (at your option) any later version.  See the file COPYING  in  the  LCM
69       distribution for more details regarding distribution.
70
71       LCM  is distributed in the hope that it will be useful, but WITHOUT ANY
72       WARRANTY; without even the implied warranty of MERCHANTABILITY or  FIT‐
73       NESS  FOR  A  PARTICULAR  PURPOSE.   See  the GNU Lesser General Public
74       License for more details.  You should have received a copy of  the  GNU
75       Lesser General Public License along with LCM; if not, write to the Free
76       Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,  MA
77       02110-1301 USA
78
79

AUTHOR

81       This manual page was written by Albert Huang.
82
83
84
85LCM                               2009-07-28                        lcm-spy(1)
Impressum