blob: d6ddfcbfe83f67329b547c4714d7324d5e74794a [file] [log] [blame]
piotr6c692872014-02-08 14:16:26 +01001<?xml version="1.0"?>
2<block>
Piotr Krysik24db0752016-07-15 13:09:07 +02003 <name>Bursts Printer</name>
piotr6c692872014-02-08 14:16:26 +01004 <key>gsm_bursts_printer</key>
ptrkrysik3be74a72014-12-13 10:11:00 +01005 <import>import grgsm</import>
Jacob Gilbert607a09e2014-12-13 10:41:20 -08006 <import>import pmt</import>
Roman Khassraf7faabf32015-07-24 14:14:16 +02007 <make>grgsm.bursts_printer(pmt.intern($prepend_string), $prepend_fnr,
8 $prepend_frame_count, $print_payload_only, $ignore_dummy_bursts)</make>
Jacob Gilbert607a09e2014-12-13 10:41:20 -08009
10 <param>
11 <name>Prepend String</name>
12 <key>prepend_string</key>
13 <value></value>
14 <type>string</type>
15 <hide>part</hide>
16 </param>
Roman Khassraf717b57b2015-04-12 18:09:45 +020017 <param>
18 <name>Prepend Frame Number</name>
19 <key>prepend_fnr</key>
20 <value>False</value>
21 <type>bool</type>
22 <option>
23 <name>False</name>
24 <key>False</key>
25 </option>
26 <option>
27 <name>True</name>
28 <key>True</key>
29 </option>
30 </param>
Roman Khassraf63444962015-07-13 13:42:57 +020031 <param>
32 <name>Prepend Frame Count</name>
33 <key>prepend_frame_count</key>
34 <value>False</value>
35 <type>bool</type>
36 <option>
37 <name>False</name>
38 <key>False</key>
39 </option>
40 <option>
41 <name>True</name>
42 <key>True</key>
43 </option>
44 </param>
45 <param>
46 <name>Print payload only</name>
47 <key>print_payload_only</key>
48 <value>False</value>
49 <type>bool</type>
50 <option>
51 <name>False</name>
52 <key>False</key>
53 </option>
54 <option>
55 <name>True</name>
56 <key>True</key>
57 </option>
58 </param>
Roman Khassraf7faabf32015-07-24 14:14:16 +020059 <param>
60 <name>Ignore dummy bursts</name>
61 <key>ignore_dummy_bursts</key>
62 <value>False</value>
63 <type>bool</type>
64 <option>
65 <name>False</name>
66 <key>False</key>
67 </option>
68 <option>
69 <name>True</name>
70 <key>True</key>
71 </option>
72 </param>
Jacob Gilbert607a09e2014-12-13 10:41:20 -080073
piotr6c692872014-02-08 14:16:26 +010074 <sink>
75 <name>bursts</name>
76 <type>message</type>
77 </sink>
Roman Khassraff1111eb2015-07-13 13:58:25 +020078
79 <doc>
80This block prints bursts to output. By default the whole burst including tail bits, stealing bits and training sequence is printed.
81
82If "Prepend Frame Number" is enabled, then the framenumber is prepended to each burst.
83
84If "Prepend Frame Count" is enabled, then the frame count for A5 is prependend to each burst.
85
86If "Print payload only" is enabled, then only the two data blocks of a burst are printed, tail bits, stealing bits and training sequence are omitted.
87
Roman Khassraf7faabf32015-07-24 14:14:16 +020088If "Ignore dummy bursts" is enabled, then the burst printer will not print dummy bursts (see GSM 05.02)
89
90Enabling first three options (or all four options) results in an output that is similar to the output of airprobe, i.e. the format is "frame_nr frame_count: databits"
Roman Khassraff1111eb2015-07-13 13:58:25 +020091 </doc>
piotr6c692872014-02-08 14:16:26 +010092</block>