dlt-receive(1)

1DLT-RECEIVE(1)                                                  DLT-RECEIVE(1)
2
3
4

NAME

6       dlt-receive - Console based client for DLT Logging
7

SYNOPSIS

9       dlt-receive [-h] [-a] [-x] [-m] [-s] [-o filename] [-c limit] [-v] [-y]
10       [-b baudrate] [-e ecuid] [-f  filterfile]  [-j  filterfile]  [-p  port]
11       hostname/serial_device_name
12

DESCRIPTION

14       Receive DLT messages from DLT daemon and print or store the messages.
15
16   OPTIONS
17       -h     Display a short help text.
18
19       -a     Print DLT file; payload as ASCII.
20
21       -x     Print DLT file; payload as hex.
22
23       -m     Print DLT file; payload as hex and ASCII.
24
25       -s     Print DLT file; only headers.
26
27       -o     Output messages in new DLT file.
28
29       -c     Set limit when storing messages in file.  When limit is reached,
30              a new file is opened.  Use K,M,G as  suffix  to  specify  kilo-,
31              mega-,  giga-bytes  respectively,  e.g. 1M for one megabyte (De‐
32              fault: unlimited).
33
34       -v     Verbose mode.
35
36       -S     Send message with serial header (Default: Without serial header)
37
38       -R     Enable resync serial header
39
40       -y     Serial device mode.
41
42       -b     Serial device baudrate (Default: 115200).
43
44       -e     Set ECU ID (Default: RECV).
45
46       -f     Enable filtering of messages.  Takes a  space  separated  filter
47              file (see Space separated filter file).
48
49       -j     Enable extended filtering of messages.  Takes a json filter file
50              (Json filter file).
51
52       -p     Port for UDP and TCP communication (Default: 3490).  # EXAMPLES
53
54       Print received message headers received from a  dlt-daemon  running  on
55       localhost:: dlt-receive -s localhost
56
57       Print  received message headers received from a serila interface:: dlt-
58       receive -s -y /dev/ttySO
59
60       Store received message headers from a dlt-daemon to a log  file  called
61       log.dlt  and  filter  them  for e.g. Application ID ABCD and Context ID
62       EFGH (Write:ABCD EFGH as single line to  a  file  called  filter.txt)::
63       dlt-receive -s -o log.dlt -f filter.txt localhost
64
65       Store  incoming  messages  in  file(s)  and  restrict  file  sizes to 1
66       megabyte.  If limit is reached, log.dlt will be renamed into log.0.dlt,
67       log.1.dlt, ...  No files will be overwritten in this mode:: dlt-receive
68       -o log.dlt -c 1M localhost
69
70   Space separated filter file
71       File that defines multiple filters.  Can be used as argument for -f op‐
72       tion.   With  this  it’s  only possible to filter messages depending on
73       their Application ID and/or Context ID.  The syntax is: first AppID and
74       optional a CtxID behind it, with a space in between.  Each line defines
75       a filter and the maximum number of filters is 30.
76
77       Example:
78
79              DLTD INTM
80              DLT INT
81              TEST
82
83   Json filter file
84       Only available, when builded with cmake option WITH_EXTENDED_FILTERING.
85
86       File that defines multiple filters.  Can be used as argument for -j op‐
87       tion.   With  this  it’s  also possible to filter messages depending on
88       their Application ID, Context ID, log level and payload size.  The fol‐
89       lowing  example  shows the syntax.  Names of the filters can be custom‐
90       ized, but not more than 15 characters long.  The maximum number of fil‐
91       ters is also 30.
92
93       Example:
94
95              {
96              "filter1": {
97                  "AppId": "LOG",
98                  "ContextId": "TEST",
99                  "LogLevel": "3"
100                  },
101              "filter2": {
102                  "AppId": "app",
103                  "LogLevel": "4"
104                  },
105              "filter3": {
106                  "AppId": "app2",
107                  "ContextId": "con2",
108                  "PayloadMin": "20",
109                  "PayloadMax": "50"
110                  }
111              }
112

EXIT STATUS

114       Non zero is returned in case of failure.
115

NOTES

117       Be  aware  that  dlt-receive  will never delete any files.  Instead, it
118       creates a new file.
119

AUTHOR

121       Alexander Wenzel (alexander.aw.wenzel (at) bmw (dot) de)
122

COPYRIGHT

124       Copyright (C) 2015 BMW AG.  License  MPL-2.0:  Mozilla  Public  License
125       version 2.0 <http://mozilla.org/MPL/2.0/>.
126

BUGS

128       See Github issue: <https://github.com/GENIVI/dlt-daemon/issues>
129