Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 1 | #!/usr/bin/env python |
| 2 | # -*- coding: utf-8 -*- |
| 3 | # @file |
| 4 | # @author Roman Khassraf <rkhassraf@gmail.com> |
| 5 | # @section LICENSE |
| 6 | # |
| 7 | # Gr-gsm is free software; you can redistribute it and/or modify |
| 8 | # it under the terms of the GNU General Public License as published by |
| 9 | # the Free Software Foundation; either version 3, or (at your option) |
| 10 | # any later version. |
| 11 | # |
| 12 | # Gr-gsm is distributed in the hope that it will be useful, |
| 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | # GNU General Public License for more details. |
| 16 | # |
| 17 | # You should have received a copy of the GNU General Public License |
| 18 | # along with gr-gsm; see the file COPYING. If not, write to |
| 19 | # the Free Software Foundation, Inc., 51 Franklin Street, |
| 20 | # Boston, MA 02110-1301, USA. |
| 21 | # |
| 22 | # |
| 23 | |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 24 | from gnuradio import blocks |
| 25 | from gnuradio import eng_notation |
| 26 | from gnuradio import gr |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 27 | from gnuradio.eng_option import eng_option |
| 28 | from gnuradio.filter import firdes |
| 29 | from math import pi |
| 30 | from optparse import OptionParser |
| 31 | |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 32 | import grgsm |
| 33 | import osmosdr |
| 34 | import pmt |
Roman Khassraf | 7eda480 | 2015-08-24 20:00:48 +0200 | [diff] [blame] | 35 | import signal |
| 36 | import sys |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 37 | |
| 38 | |
Piotr Krysik | 3e192c4 | 2016-02-13 07:31:51 +0100 | [diff] [blame] | 39 | class grgsm_capture(gr.top_block): |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 40 | |
Piotr Krysik | 7185b66 | 2016-02-14 20:24:54 +0100 | [diff] [blame] | 41 | def __init__(self, fc, gain, samp_rate, ppm, arfcn, cfile=None, burst_file=None, band=None, verbose=False, rec_length=None, args=""): |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 42 | |
Piotr Krysik | 3e192c4 | 2016-02-13 07:31:51 +0100 | [diff] [blame] | 43 | gr.top_block.__init__(self, "Gr-gsm Capture") |
Roman Khassraf | 7eda480 | 2015-08-24 20:00:48 +0200 | [diff] [blame] | 44 | |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 45 | ################################################## |
| 46 | # Parameters |
| 47 | ################################################## |
| 48 | self.fc = fc |
| 49 | self.gain = gain |
| 50 | self.samp_rate = samp_rate |
| 51 | self.ppm = ppm |
| 52 | self.arfcn = arfcn |
| 53 | self.cfile = cfile |
| 54 | self.burst_file = burst_file |
Roman Khassraf | 5a80400 | 2015-08-24 20:11:10 +0200 | [diff] [blame] | 55 | self.band = band |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 56 | self.verbose = verbose |
| 57 | self.shiftoff = shiftoff = 400e3 |
Piotr Krysik | 351d217 | 2015-09-20 13:53:06 +0200 | [diff] [blame] | 58 | self.rec_length = rec_length |
Roman Khassraf | 7eda480 | 2015-08-24 20:00:48 +0200 | [diff] [blame] | 59 | |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 60 | ################################################## |
| 61 | # Processing Blocks |
| 62 | ################################################## |
| 63 | |
Piotr Krysik | 0ff0d09 | 2016-03-18 11:39:09 +0100 | [diff] [blame] | 64 | self.rtlsdr_source = osmosdr.source( args="numchan=" + str(1) + " " + args ) |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 65 | self.rtlsdr_source.set_sample_rate(samp_rate) |
Roman Khassraf | 7eda480 | 2015-08-24 20:00:48 +0200 | [diff] [blame] | 66 | self.rtlsdr_source.set_center_freq(fc - shiftoff, 0) |
| 67 | self.rtlsdr_source.set_freq_corr(ppm, 0) |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 68 | self.rtlsdr_source.set_dc_offset_mode(2, 0) |
| 69 | self.rtlsdr_source.set_iq_balance_mode(2, 0) |
| 70 | self.rtlsdr_source.set_gain_mode(True, 0) |
Roman Khassraf | 7eda480 | 2015-08-24 20:00:48 +0200 | [diff] [blame] | 71 | self.rtlsdr_source.set_gain(gain, 0) |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 72 | self.rtlsdr_source.set_if_gain(20, 0) |
| 73 | self.rtlsdr_source.set_bb_gain(20, 0) |
| 74 | self.rtlsdr_source.set_antenna("", 0) |
| 75 | self.rtlsdr_source.set_bandwidth(250e3+abs(shiftoff), 0) |
| 76 | self.blocks_rotator = blocks.rotator_cc(-2*pi*shiftoff/samp_rate) |
Piotr Krysik | 351d217 | 2015-09-20 13:53:06 +0200 | [diff] [blame] | 77 | |
| 78 | if self.rec_length is not None: |
| 79 | self.blocks_head_0 = blocks.head(gr.sizeof_gr_complex, int(samp_rate*rec_length)) |
| 80 | |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 81 | if self.verbose or self.burst_file: |
| 82 | self.gsm_receiver = grgsm.receiver(4, ([self.arfcn]), ([])) |
| 83 | self.gsm_input = grgsm.gsm_input( |
| 84 | ppm=0, |
| 85 | osr=4, |
| 86 | fc=fc, |
| 87 | samp_rate_in=samp_rate, |
| 88 | ) |
| 89 | self.gsm_clock_offset_control = grgsm.clock_offset_control(fc-shiftoff) |
| 90 | |
| 91 | if self.burst_file: |
| 92 | self.gsm_burst_file_sink = grgsm.burst_file_sink(self.burst_file) |
| 93 | |
| 94 | if self.cfile: |
| 95 | self.blocks_file_sink = blocks.file_sink(gr.sizeof_gr_complex*1, self.cfile, False) |
| 96 | self.blocks_file_sink.set_unbuffered(False) |
| 97 | |
| 98 | if self.verbose: |
| 99 | self.gsm_bursts_printer_0 = grgsm.bursts_printer(pmt.intern(""), |
| 100 | False, False, False, False) |
| 101 | |
| 102 | ################################################## |
| 103 | # Connections |
| 104 | ################################################## |
| 105 | |
Piotr Krysik | 351d217 | 2015-09-20 13:53:06 +0200 | [diff] [blame] | 106 | if self.rec_length is not None: #if recording length is defined connect head block after the source |
| 107 | self.connect((self.rtlsdr_source, 0), (self.blocks_head_0, 0)) |
| 108 | self.connect((self.blocks_head_0, 0), (self.blocks_rotator, 0)) |
| 109 | else: |
| 110 | self.connect((self.rtlsdr_source, 0), (self.blocks_rotator, 0)) |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 111 | |
| 112 | if self.cfile: |
| 113 | self.connect((self.blocks_rotator, 0), (self.blocks_file_sink, 0)) |
| 114 | |
| 115 | if self.verbose or self.burst_file: |
| 116 | self.connect((self.gsm_input, 0), (self.gsm_receiver, 0)) |
| 117 | self.connect((self.blocks_rotator, 0), (self.gsm_input, 0)) |
| 118 | self.msg_connect(self.gsm_clock_offset_control, "ppm", self.gsm_input, "ppm_in") |
| 119 | self.msg_connect(self.gsm_receiver, "measurements", self.gsm_clock_offset_control, "measurements") |
| 120 | |
| 121 | if self.burst_file: |
| 122 | self.msg_connect(self.gsm_receiver, "C0", self.gsm_burst_file_sink, "in") |
| 123 | if self.verbose: |
| 124 | self.msg_connect(self.gsm_receiver, "C0", self.gsm_bursts_printer_0, "bursts") |
| 125 | |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 126 | def get_fc(self): |
| 127 | return self.fc |
| 128 | |
| 129 | def set_fc(self, fc): |
| 130 | self.fc = fc |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 131 | if self.verbose or self.burst_file: |
| 132 | self.gsm_input.set_fc(self.fc) |
Roman Khassraf | 5a80400 | 2015-08-24 20:11:10 +0200 | [diff] [blame] | 133 | |
| 134 | def get_arfcn(self): |
| 135 | return self.arfcn |
| 136 | |
| 137 | def set_arfcn(self, arfcn): |
| 138 | self.arfcn = arfcn |
| 139 | if self.verbose or self.burst_file: |
| 140 | self.gsm_receiver.set_cell_allocation([self.arfcn]) |
| 141 | if options.band: |
| 142 | new_freq = grgsm.arfcn.arfcn2downlink(self.arfcn, self.band) |
| 143 | else: |
| 144 | for band in grgsm.arfcn.get_bands(): |
| 145 | if grgsm.arfcn.is_valid_arfcn(arfcn, band): |
| 146 | new_freq = grgsm.arfcn.arfcn2downlink(arfcn, band) |
| 147 | break |
| 148 | self.set_fc(new_freq) |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 149 | |
| 150 | def get_gain(self): |
| 151 | return self.gain |
| 152 | |
| 153 | def set_gain(self, gain): |
| 154 | self.gain = gain |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 155 | |
| 156 | def get_samp_rate(self): |
| 157 | return self.samp_rate |
| 158 | |
| 159 | def set_samp_rate(self, samp_rate): |
| 160 | self.samp_rate = samp_rate |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 161 | self.rtlsdr_source.set_sample_rate(self.samp_rate) |
| 162 | if self.verbose or self.burst_file: |
| 163 | self.gsm_input.set_samp_rate_in(self.samp_rate) |
| 164 | |
| 165 | def get_ppm(self): |
| 166 | return self.ppm |
| 167 | |
| 168 | def set_ppm(self, ppm): |
| 169 | self.ppm = ppm |
| 170 | self.set_ppm_slider(self.ppm) |
| 171 | |
Piotr Krysik | 351d217 | 2015-09-20 13:53:06 +0200 | [diff] [blame] | 172 | def get_rec_length(self): |
| 173 | return self.rec_length |
| 174 | |
| 175 | def set_rec_length(self, rec_length): |
| 176 | self.rec_length = rec_length |
| 177 | self.blocks_head_0.set_length(int(self.samp_rate*self.rec_length)) |
| 178 | |
| 179 | |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 180 | if __name__ == '__main__': |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 181 | |
| 182 | parser = OptionParser(option_class=eng_option, usage="%prog [options]", |
| 183 | description="RTL-SDR capturing app of gr-gsm.") |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 184 | |
| 185 | parser.add_option("-f", "--fc", dest="fc", type="eng_float", |
| 186 | help="Set frequency [default=%default]") |
| 187 | |
| 188 | parser.add_option("-a", "--arfcn", dest="arfcn", type="intx", |
| 189 | help="Set ARFCN instead of frequency. In some cases you may have to provide the GSM band also") |
| 190 | |
| 191 | parser.add_option("-g", "--gain", dest="gain", type="eng_float", |
| 192 | default=eng_notation.num_to_str(30), |
| 193 | help="Set gain [default=%default]") |
| 194 | |
| 195 | parser.add_option("-s", "--samp-rate", dest="samp_rate", type="eng_float", |
Piotr Krysik | 13d9e7a | 2016-04-24 15:23:15 +0200 | [diff] [blame] | 196 | default=eng_notation.num_to_str(2000000), |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 197 | help="Set samp_rate [default=%default]") |
| 198 | |
| 199 | parser.add_option("-p", "--ppm", dest="ppm", type="intx", default=0, |
| 200 | help="Set ppm [default=%default]") |
| 201 | |
| 202 | parser.add_option("-b", "--burst-file", dest="burst_file", |
| 203 | help="File where the captured bursts are saved") |
| 204 | |
| 205 | parser.add_option("-c", "--cfile", dest="cfile", |
| 206 | help="File where the captured data are saved") |
| 207 | |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 208 | bands_list = ", ".join(grgsm.arfcn.get_bands()) |
| 209 | parser.add_option("--band", dest="band", |
| 210 | help="Specify the GSM band for the frequency.\nAvailable bands are: " + bands_list + ".\nIf no band is specified, it will be determined automatically, defaulting to 0." ) |
Roman Khassraf | 7eda480 | 2015-08-24 20:00:48 +0200 | [diff] [blame] | 211 | |
Piotr Krysik | 7185b66 | 2016-02-14 20:24:54 +0100 | [diff] [blame] | 212 | parser.add_option("", "--args", dest="args", type="string", default="", |
| 213 | help="Set device arguments [default=%default]") |
| 214 | |
Roman Khassraf | 7eda480 | 2015-08-24 20:00:48 +0200 | [diff] [blame] | 215 | parser.add_option("-v", "--verbose", action="store_true", |
| 216 | help="If set, the captured bursts are printed to stdout") |
Piotr Krysik | 351d217 | 2015-09-20 13:53:06 +0200 | [diff] [blame] | 217 | |
| 218 | parser.add_option("-T", "--rec-length", dest="rec_length", type="eng_float", |
| 219 | help="Set length of recording in seconds [default=%default]") |
| 220 | |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 221 | (options, args) = parser.parse_args() |
| 222 | |
| 223 | if options.cfile is None and options.burst_file is None: |
| 224 | parser.error("Please provide a cfile or a burst file (or both) to save the captured data\n") |
| 225 | |
| 226 | if (options.fc is None and options.arfcn is None) or (options.fc is not None and options.arfcn is not None): |
| 227 | parser.error("You have to provide either a frequency or an ARFCN (but not both).\n") |
| 228 | |
| 229 | arfcn = 0 |
| 230 | fc = 939.4e6 |
| 231 | if options.arfcn: |
| 232 | if options.band: |
| 233 | if options.band not in grgsm.arfcn.get_bands(): |
| 234 | parser.error("Invalid GSM band\n") |
| 235 | elif not grgsm.arfcn.is_valid_arfcn(options.arfcn, options.band): |
| 236 | parser.error("ARFCN is not valid in the specified band\n") |
| 237 | else: |
| 238 | arfcn = options.arfcn |
| 239 | fc = grgsm.arfcn.arfcn2downlink(arfcn, options.band) |
| 240 | else: |
| 241 | arfcn = options.arfcn |
| 242 | for band in grgsm.arfcn.get_bands(): |
| 243 | if grgsm.arfcn.is_valid_arfcn(arfcn, band): |
| 244 | fc = grgsm.arfcn.arfcn2downlink(arfcn, band) |
| 245 | break |
| 246 | elif options.fc: |
| 247 | fc = options.fc |
| 248 | if options.band: |
| 249 | if options.band not in grgsm.arfcn.get_bands(): |
| 250 | parser.error("Invalid GSM band\n") |
| 251 | elif not grgsm.arfcn.is_valid_downlink(options.fc, options.band): |
| 252 | parser.error("Frequency is not valid in the specified band\n") |
| 253 | else: |
| 254 | arfcn = grgsm.arfcn.downlink2arfcn(options.fc, options.band) |
| 255 | else: |
| 256 | for band in grgsm.arfcn.get_bands(): |
| 257 | if grgsm.arfcn.is_valid_downlink(options.fc, band): |
| 258 | arfcn = grgsm.arfcn.downlink2arfcn(options.fc, band) |
| 259 | break |
| 260 | |
Piotr Krysik | 3e192c4 | 2016-02-13 07:31:51 +0100 | [diff] [blame] | 261 | tb = grgsm_capture(fc=fc, gain=options.gain, samp_rate=options.samp_rate, |
Roman Khassraf | 7eda480 | 2015-08-24 20:00:48 +0200 | [diff] [blame] | 262 | ppm=options.ppm, arfcn=arfcn, cfile=options.cfile, |
Piotr Krysik | 351d217 | 2015-09-20 13:53:06 +0200 | [diff] [blame] | 263 | burst_file=options.burst_file, band=options.band, verbose=options.verbose, |
Piotr Krysik | 0ff0d09 | 2016-03-18 11:39:09 +0100 | [diff] [blame] | 264 | rec_length=options.rec_length, args=options.args) |
Roman Khassraf | 7eda480 | 2015-08-24 20:00:48 +0200 | [diff] [blame] | 265 | |
| 266 | def signal_handler(signal, frame): |
| 267 | tb.stop() |
| 268 | tb.wait() |
| 269 | sys.exit(0) |
| 270 | |
| 271 | signal.signal(signal.SIGINT, signal_handler) |
Roman Khassraf | 529e215 | 2015-08-22 19:52:41 +0200 | [diff] [blame] | 272 | |
| 273 | tb.start() |
Roman Khassraf | 7eda480 | 2015-08-24 20:00:48 +0200 | [diff] [blame] | 274 | tb.wait() |