├── bladeRF ├── tools │ ├── __init__.py │ ├── waterfall.py │ ├── tx.py │ ├── rx.py │ └── repeater.py ├── devinfo.py ├── info.py ├── low_level.py ├── misc.py ├── init.py ├── errors.py ├── _cffi.py ├── __init__.py ├── gui │ └── gui.py ├── data.py ├── device.py └── ctrl.py ├── AUTHORS ├── bootstrap ├── .gitignore ├── setup.py ├── README.md ├── tests ├── test_device.py └── test_init.py └── LICENSE /bladeRF/tools/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | Copyright 2014 Michel Pelletier 2 | 3 | -------------------------------------------------------------------------------- /bladeRF/devinfo.py: -------------------------------------------------------------------------------- 1 | import bladeRF 2 | from bladeRF import _cffi 3 | from bladeRF._cffi import ffi, cdef, ptop 4 | 5 | -------------------------------------------------------------------------------- /bootstrap: -------------------------------------------------------------------------------- 1 | virtualenv .virt --distribute --system-site-packages 2 | . .virt/bin/activate 3 | python setup.py develop 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.py[cod] 2 | *~ 3 | .virt/ 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Packages 9 | *.egg 10 | *.egg-info 11 | dist 12 | build 13 | eggs 14 | parts 15 | bin 16 | var 17 | sdist 18 | develop-eggs 19 | .installed.cfg 20 | lib 21 | lib64 22 | __pycache__ 23 | 24 | # Installer logs 25 | pip-log.txt 26 | 27 | # Unit test / coverage reports 28 | .coverage 29 | .tox 30 | nosetests.xml 31 | 32 | # Translations 33 | *.mo 34 | 35 | # Mr Developer 36 | .mr.developer.cfg 37 | .project 38 | .pydevproject 39 | -------------------------------------------------------------------------------- /bladeRF/info.py: -------------------------------------------------------------------------------- 1 | import bladeRF 2 | from bladeRF import _cffi 3 | from bladeRF._cffi import ffi, cdef, ptop 4 | 5 | 6 | cdef(""" 7 | typedef enum { 8 | BLADERF_FPGA_UNKNOWN = 0, /**< Unable to determine FPGA variant */ 9 | BLADERF_FPGA_40KLE = 40, /**< 40 kLE FPGA */ 10 | BLADERF_FPGA_115KLE = 115 /**< 115 kLE FPGA */ 11 | } bladerf_fpga_size; 12 | """) 13 | 14 | 15 | @cdef('int bladerf_get_fpga_size(struct bladerf *dev, bladerf_fpga_size *size);') 16 | def get_fpga_size(dev): 17 | size = ffi.new('bladerf_fpga_size *') 18 | err = _cffi.lib.bladerf_get_fpga_size(dev, size) 19 | bladeRF.errors.check_retcode(err) 20 | return int(size[0]) 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /bladeRF/low_level.py: -------------------------------------------------------------------------------- 1 | import bladeRF 2 | from bladeRF import _cffi 3 | from bladeRF._cffi import ffi, cdef, ptop 4 | 5 | 6 | @cdef('void bladerf_set_transfer_timeout(struct bladerf *dev,' 7 | 'bladerf_module module, int timeout);') 8 | def set_transfer_timeout(dev, module, timeout): 9 | _cffi.lib.bladerf_set_transfer_timeout(dev, module, timeout) 10 | 11 | @cdef('int bladerf_get_transfer_timeout(struct bladerf *dev, bladerf_module module,' 12 | 'unsigned int *timeout);') 13 | def get_transfer_timeout(dev, module): 14 | timeout = ffi.new('unsigned int*') 15 | err = _cffi.lib.bladerf_get_transfer_timeout(dev, module, timeout) 16 | bladeRF.errors.check_retcode(err) 17 | return timeout[0] 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /bladeRF/misc.py: -------------------------------------------------------------------------------- 1 | import bladeRF 2 | from bladeRF import _cffi 3 | from bladeRF._cffi import ffi, cdef, ptop 4 | 5 | 6 | cdef(""" 7 | typedef enum { 8 | BLADERF_LOG_LEVEL_VERBOSE, /**< Verbose level logging */ 9 | BLADERF_LOG_LEVEL_DEBUG, /**< Debug level logging */ 10 | BLADERF_LOG_LEVEL_INFO, /**< Information level logging */ 11 | BLADERF_LOG_LEVEL_WARNING, /**< Warning level logging */ 12 | BLADERF_LOG_LEVEL_ERROR, /**< Error level logging */ 13 | BLADERF_LOG_LEVEL_CRITICAL, /**< Fatal error level logging */ 14 | BLADERF_LOG_LEVEL_SILENT /**< No output */ 15 | } bladerf_log_level; 16 | """) 17 | 18 | 19 | @cdef('void bladerf_log_set_verbosity(bladerf_log_level level);') 20 | def log_set_verbosity(level): 21 | _cffi.lib.bladerf_log_set_verbosity(level) 22 | 23 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | """ 3 | ========= 4 | pybladeRF 5 | ========= 6 | """ 7 | from setuptools import setup, find_packages 8 | 9 | setup( 10 | name="pybladeRF", 11 | version="0.0.1", 12 | packages=find_packages(exclude=['tests.*', 'tests', '.virt']), 13 | 14 | tests_require=['nose'], 15 | test_suite='nose.collector', 16 | 17 | author='Michel Pelletier', 18 | author_email='pelletier.michel@yahoo.com', 19 | description='pyczmq libbladeRF wrapper', 20 | long_description=__doc__, 21 | license='LGPL v3', 22 | url='https://github.com/michelp/pyczmq', 23 | install_requires=[ 24 | 'cffi', 25 | 'docopt', 26 | 'nose', 27 | ], 28 | entry_points = { 29 | 'console_scripts' : [ 30 | 'pyblade-rx = bladeRF.tools.rx:main', 31 | 'pyblade-tx = bladeRF.tools.tx:main', 32 | 'pyblade-repeater = bladeRF.tools.repeater:main', 33 | ] 34 | }, 35 | ) 36 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | pybladeRF 2 | ========= 3 | 4 | Python CFFI wrapper around libbladeRF 5 | 6 | 7 | Install 8 | ======= 9 | 10 | To start you'll need to have build and installed libbladeRF. See the 11 | nuand docs for that. You'll need a device too. 12 | 13 | On ubuntu, you'll need some packages to build pybladeRF: 14 | 15 | python-dev libffi-dev python-virtualenv 16 | 17 | Source the 'bootstrap' script to create a local virtual environment 18 | where you can use the library. 19 | 20 | If you want to run the tests, do 'python setup.py test' 21 | 22 | See the tests directory for some example usage of the python API. 23 | 24 | 25 | Tools 26 | ===== 27 | 28 | The pybladeRF package installs some command line tools. 29 | 30 | pyblade-rx: An I/Q receiver, writes to file or stdout 31 | 32 | pyblade-tx: An I/Q transmitter, reads from file or stdin 33 | 34 | pyblade-repeater: A repeater, everything that is received is retransmitted. 35 | 36 | Check out the tools package for source code, all 3 programs use the 37 | asynchronous streaming API. 38 | -------------------------------------------------------------------------------- /bladeRF/tools/waterfall.py: -------------------------------------------------------------------------------- 1 | import numpy 2 | import matplotlib.pyplot 3 | import matplotlib.animation 4 | 5 | HEIGHT = 500 6 | WIDTH = 1024 7 | 8 | fig = matplotlib.pyplot.figure() 9 | im_data = numpy.zeros((HEIGHT, WIDTH), dtype=numpy.float32) 10 | im = matplotlib.pyplot.imshow(im_data, cmap=matplotlib.pyplot.get_cmap('gray')) 11 | im.set_clim(0.0, 1.0) 12 | 13 | data = numpy.zeros(FFTPOINTS, dtype=numpy.float32) 14 | 15 | def init_image(): 16 | im.set_array(numpy.zeros((HEIGHT, WIDTH), dtype=numpy.float32)) 17 | return (im,) 18 | 19 | def update_image(i): 20 | 21 | data[:] = numpy.fromstring( 22 | sys.stdin.read(8192), 23 | dtype=numpy.complex64, 24 | ) 25 | 26 | fft = numpy.fft.rfft(data) 27 | line = numpy.sqrt(numpy.real(fft)**2+numpy.imag(fft)**2) 28 | im_data[:,:WIDTH-1] = im_data[:,1:] 29 | im_data[:,WIDTH-1] = line 30 | im.set_array(im_data) 31 | return (im,) 32 | 33 | 34 | ani = matplotlib.animation.FuncAnimation( 35 | fig, update_image, init_func=init_image, 36 | interval=0, blit=True) 37 | 38 | matplotlib.pyplot.show() 39 | -------------------------------------------------------------------------------- /tests/test_device.py: -------------------------------------------------------------------------------- 1 | import bladeRF 2 | 3 | 4 | def test_device(): 5 | device = bladeRF.Device() 6 | device.rx.config(bladeRF.FORMAT_SC16_Q11, 64, 16384, 16, 3500) 7 | device.tx.config(bladeRF.FORMAT_SC16_Q11, 64, 16384, 16, 3500) 8 | device.rx.enabled = True 9 | device.tx.enabled = True 10 | 11 | device.rx.frequency = 2**28 12 | assert device.rx.frequency == 2**28 13 | device.rx.bandwidth = 1500000 14 | assert device.rx.bandwidth == 1500000 15 | device.rx.sample_rate = 2**21 16 | assert device.rx.sample_rate == 2**21 17 | 18 | device.tx.frequency = 1234000000 19 | assert device.tx.frequency == 1234000000 20 | device.tx.bandwidth = 1500000 21 | assert device.tx.bandwidth == 1500000 22 | device.tx.sample_rate = 2**20 23 | assert device.tx.sample_rate == 2**20 24 | 25 | raw = device.rx(1024) 26 | array = bladeRF.samples_to_narray(raw, 1024) 27 | assert len(array) == 1024 28 | samples = bytearray(bladeRF.ffi.buffer(raw)) 29 | assert isinstance(samples, bytearray) 30 | assert len(samples) == 4096 31 | 32 | device.tx(1024, raw) 33 | -------------------------------------------------------------------------------- /tests/test_init.py: -------------------------------------------------------------------------------- 1 | import bladeRF 2 | 3 | 4 | def test_init(): 5 | 6 | with bladeRF.open_device() as device: 7 | bladeRF.enable_module(device, bladeRF.MODULE_RX, True) 8 | bladeRF.sync_config(device, bladeRF.MODULE_RX, bladeRF.FORMAT_SC16_Q11, 9 | 64, 16384, 16, 3500) 10 | rate = 2**20 11 | bladeRF.set_sample_rate(device, bladeRF.MODULE_RX, rate) 12 | assert bladeRF.get_sample_rate(device, bladeRF.MODULE_RX) == rate 13 | 14 | bw = 1500000 15 | bladeRF.set_bandwidth(device, bladeRF.MODULE_RX, bw) 16 | assert bladeRF.get_bandwidth(device, bladeRF.MODULE_RX) == bw 17 | 18 | freq = 2**28 19 | bladeRF.set_frequency(device, bladeRF.MODULE_RX, freq) 20 | assert bladeRF.get_frequency(device, bladeRF.MODULE_RX) == freq 21 | 22 | num_samples = 1024 23 | raw = bladeRF.ffi.new('int16_t[%s]' % (2 * num_samples)) 24 | bladeRF.rx(device, bladeRF.ffi.cast('void *', raw), num_samples, bladeRF.ffi.NULL, 0) 25 | 26 | samples = bytearray(bladeRF.ffi.buffer(raw)) 27 | assert isinstance(samples, bytearray) 28 | assert len(samples) == 4096 29 | -------------------------------------------------------------------------------- /bladeRF/init.py: -------------------------------------------------------------------------------- 1 | from contextlib import contextmanager 2 | 3 | import bladeRF 4 | from bladeRF import _cffi 5 | from bladeRF._cffi import ffi, cdef, ptop 6 | 7 | 8 | @cdef('void bladerf_free_device_list(struct bladerf_devinfo *devices);') 9 | def free_device_list(devices): 10 | _cffi.lib.bladerf_free_device_list(devices[0]) 11 | 12 | 13 | @cdef('int bladerf_get_device_list(struct bladerf_devinfo **devices);') 14 | def get_device_list(): 15 | devices = ffi.gc( 16 | ptop('struct bladerf_devinfo'), 17 | free_device_list) 18 | size = _cffi.lib.bladerf_get_device_list(devices) 19 | bladeRF.errors.check_retcode(size) 20 | return (size, devices) 21 | 22 | 23 | @cdef('int bladerf_open(struct bladerf **device, ' 24 | 'const char *device_identifier);') 25 | def open(device_identifier=''): 26 | device = ptop('struct bladerf') 27 | err = _cffi.lib.bladerf_open(device, device_identifier) 28 | bladeRF.errors.check_retcode(err) 29 | return device 30 | 31 | 32 | @cdef('void bladerf_close(struct bladerf *device);') 33 | def close(device): 34 | _cffi.lib.bladerf_close(device) 35 | 36 | 37 | @contextmanager 38 | def open_device(device_identifier=''): 39 | device = open(device_identifier) 40 | yield device[0] 41 | close(device[0]) 42 | -------------------------------------------------------------------------------- /bladeRF/errors.py: -------------------------------------------------------------------------------- 1 | from bladeRF import _cffi 2 | 3 | class BladeRFException(Exception): pass 4 | class UnexpectedError(BladeRFException): pass 5 | class RangeError(BladeRFException): pass 6 | class InvalError(BladeRFException): pass 7 | class MemError(BladeRFException): pass 8 | class BladeIOError(BladeRFException): pass # IOError conflicts with builtin 9 | class TimeoutError(BladeRFException): pass 10 | class NodevError(BladeRFException): pass 11 | class UnsupportedError(BladeRFException): pass 12 | class MisalignedError(BladeRFException): pass 13 | class ChecksumError(BladeRFException): pass 14 | 15 | errors = { 16 | _cffi.lib.BLADERF_ERR_UNEXPECTED: UnexpectedError, 17 | _cffi.lib.BLADERF_ERR_RANGE: RangeError, 18 | _cffi.lib.BLADERF_ERR_INVAL: InvalError, 19 | _cffi.lib.BLADERF_ERR_MEM: MemError, 20 | _cffi.lib.BLADERF_ERR_IO: BladeIOError, 21 | _cffi.lib.BLADERF_ERR_TIMEOUT: TimeoutError, 22 | _cffi.lib.BLADERF_ERR_NODEV: NodevError, 23 | _cffi.lib.BLADERF_ERR_UNSUPPORTED: UnsupportedError, 24 | _cffi.lib.BLADERF_ERR_MISALIGNED: MisalignedError, 25 | _cffi.lib.BLADERF_ERR_CHECKSUM: ChecksumError, 26 | } 27 | 28 | def strerror(error): 29 | return _cffi.ffi.string(_cffi.lib.bladerf_strerror(error)) 30 | 31 | 32 | def check_retcode(code, *args, **kwargs): 33 | if code < 0: 34 | if code not in errors: 35 | raise TypeError('No such retcode %s' % code) 36 | raise errors[code](strerror(code)) 37 | 38 | -------------------------------------------------------------------------------- /bladeRF/tools/tx.py: -------------------------------------------------------------------------------- 1 | """\ 2 | bladeRF Transmitter 3 | 4 | Usage: 5 | tx.py [options] 6 | tx.py (-h | --help) 7 | tx.py --version 8 | 9 | Options: 10 | -h --help Show this screen. 11 | -v --version Show version. 12 | -d --device= Device identifier [default: ] 13 | -f --file= File to read samples from [default: -]. 14 | -b --bandwidth= Bandwidth in Hertz [default: 7000000]. 15 | -s --sample-rate= Sample rate in samples per second [default: 10000000]. 16 | -n --num-buffers= Number of transfer buffers [default: 32]. 17 | -t --num-transfers= Number of transfers [default: 16]. 18 | -l --num-samples= Numper of samples per transfer buffer [default: 4096]. 19 | """ 20 | import sys 21 | import bladeRF 22 | from numpy import vdot, log10 23 | from docopt import docopt 24 | 25 | 26 | def main(): 27 | args = docopt(__doc__, version='bladeRF Transmitter 1.0') 28 | infile = sys.stdin if args['--file'] == '-' else open(args['--file'], 'rb') 29 | 30 | device = bladeRF.Device(args['--device']) 31 | device.tx.enabled = True 32 | device.tx.frequency = int(args['']) 33 | device.tx.bandwidth = int(args['--bandwidth']) 34 | device.tx.sample_rate = int(args['--sample-rate']) 35 | 36 | def tx(device, stream, meta_data, samples, num_samples, user_data): 37 | next = stream.next() 38 | if not infile.readinto(bladeRF.ffi.buffer(next, num_samples)): 39 | return 40 | return next 41 | 42 | stream = device.tx.stream( 43 | tx, 44 | int(args['--num-buffers']), 45 | bladeRF.FORMAT_SC16_Q11, 46 | int(args['--num-samples']), 47 | int(args['--num-transfers'])) 48 | 49 | stream.run() 50 | 51 | 52 | if __name__ == '__main__': 53 | main() 54 | -------------------------------------------------------------------------------- /bladeRF/_cffi.py: -------------------------------------------------------------------------------- 1 | import os 2 | import inspect 3 | from functools import wraps 4 | from cffi import FFI 5 | 6 | lib = None 7 | ffi = FFI() 8 | 9 | ffi.cdef('const char * bladerf_strerror(int error);') 10 | 11 | ffi.cdef(""" 12 | #define BLADERF_ERR_UNEXPECTED ... 13 | #define BLADERF_ERR_RANGE ... 14 | #define BLADERF_ERR_INVAL ... 15 | #define BLADERF_ERR_MEM ... 16 | #define BLADERF_ERR_IO ... 17 | #define BLADERF_ERR_TIMEOUT ... 18 | #define BLADERF_ERR_NODEV ... 19 | #define BLADERF_ERR_UNSUPPORTED ... 20 | #define BLADERF_ERR_MISALIGNED ... 21 | #define BLADERF_ERR_CHECKSUM ... 22 | """) 23 | 24 | # Code copied from michelp/pyczmq which was authored by me -mp 25 | 26 | def ptop(typ, val=ffi.NULL): 27 | ptop = ffi.new('%s*[1]' % typ) 28 | ptop[0] = val 29 | return ptop 30 | 31 | 32 | def cdef(decl, returns_string=False, nullable=False): 33 | ffi.cdef(decl) 34 | def wrap(f): 35 | @wraps(f) 36 | def inner_f(*args): 37 | val = f(*args) 38 | if nullable and val == ffi.NULL: 39 | return None 40 | elif returns_string: 41 | return ffi.string(val) 42 | return val 43 | 44 | # this insanity inserts a formatted argspec string 45 | # into the function's docstring, so that sphinx 46 | # gets the right args instead of just the wrapper args 47 | args, varargs, varkw, defaults = inspect.getargspec(f) 48 | defaults = () if defaults is None else defaults 49 | defaults = ["\"{}\"".format(a) if type(a) == str else a for a in defaults] 50 | l = ["{}={}".format(arg, defaults[(idx+1)*-1]) 51 | if len(defaults)-1 >= idx else 52 | arg for idx, arg in enumerate(reversed(list(args)))] 53 | if varargs: 54 | l.append('*' + varargs) 55 | if varkw: 56 | l.append('**' + varkw) 57 | doc = "{}({})\n\nC: ``{}``\n\n{}".format(f.__name__, ', '.join(reversed(l)), decl, f.__doc__) 58 | inner_f.__doc__ = doc 59 | return inner_f 60 | return wrap 61 | 62 | -------------------------------------------------------------------------------- /bladeRF/tools/rx.py: -------------------------------------------------------------------------------- 1 | """\ 2 | bladeRF Receiver 3 | 4 | Usage: 5 | rx.py [options] 6 | rx.py (-h | --help) 7 | rx.py --version 8 | 9 | Options: 10 | -h --help Show this screen. 11 | -v --version Show version. 12 | -d --device= Device identifier [default: ] 13 | -f --file= File to write samples to [default: -]. 14 | -b --bandwidth= Bandwidth in Hertz [default: 7000000]. 15 | -s --sample-rate= Sample rate in samples per second [default: 10000000]. 16 | -n --num-buffers= Number of transfer buffers [default: 16]. 17 | -t --num-transfers= Number of transfers [default: 16]. 18 | -l --num-samples= Numper of samples per transfer buffer [default: 8192]. 19 | -g --lna-gain= Set LNA gain [default: LNA_GAIN_MAX] 20 | -o --rx-vga1= Set vga1 [default: 21] 21 | -w --rx-vga2= Set vga2 squelch [default: 18] 22 | -q --squelch= Set squelch [default: 0] 23 | -e --decimate= Decimate factor [default: 0] 24 | """ 25 | import sys 26 | import bladeRF 27 | from docopt import docopt 28 | 29 | 30 | def get_args(): 31 | return docopt(__doc__, version='bladeRF Receiver 1.0') 32 | 33 | 34 | def get_stream(args): 35 | outfile = sys.stdout if args['--file'] == '-' else open(args['--file'], 'wb') 36 | device = bladeRF.Device(args['--device']) 37 | device.rx.enabled = True 38 | device.rx.frequency = int(args['']) 39 | device.rx.bandwidth = int(args['--bandwidth']) 40 | device.rx.sample_rate = int(args['--sample-rate']) 41 | device.lna_gain = getattr(bladeRF, args['--lna-gain']) 42 | device.rx.vga1 = int(args['--rx-vga1']) 43 | device.rx.vga2 = int(args['--rx-vga2']) 44 | squelch = float(args['--squelch']) 45 | 46 | def rx(device, stream, meta_data, samples, num_samples, user_data): 47 | if squelch: 48 | samples = bladeRF.samples_to_narray(samples, num_samples) 49 | if bladeRF.squelched(samples, squelch): 50 | return stream.current() 51 | 52 | buff = stream.current_as_buffer() 53 | outfile.write(buff) 54 | return stream.next() 55 | 56 | 57 | stream = device.rx.stream( 58 | rx, 59 | int(args['--num-buffers']), 60 | bladeRF.FORMAT_SC16_Q11, 61 | int(args['--num-samples']), 62 | int(args['--num-transfers']), 63 | ) 64 | return stream 65 | 66 | 67 | def main(): 68 | get_stream(get_args()).run() 69 | 70 | 71 | if __name__ == '__main__': 72 | main() 73 | -------------------------------------------------------------------------------- /bladeRF/tools/repeater.py: -------------------------------------------------------------------------------- 1 | """\ 2 | bladeRF Repeater 3 | 4 | Usage: 5 | repeater.py [options] 6 | repeater.py (-h | --help) 7 | repeater.py --version 8 | 9 | Options: 10 | -h --help Show this screen. 11 | -v --version Show version. 12 | -d --device= Device identifier [default: ] 13 | -b --bandwidth= Bandwidth in Hertz [default: 7000000]. 14 | -s --sample-rate= Sample rate in samples per second [default: 10000000]. 15 | -n --num-buffers= Number of transfer buffers [default: 32]. 16 | -t --num-transfers= Number of transfers [default: 1]. 17 | -l --num-samples= Numper of samples per transfer buffer [default: 8192]. 18 | -g --lna-gain= Set LNA gain [default: LNA_GAIN_MAX] 19 | -o --rx-vga1-gain= Set rx vga1 [default: 21] 20 | -w --rx-vga2-gain= Set rx vga2 squelch [default: 17] 21 | -r --tx-vga1-gain= Set tx vga1 [default: 0] 22 | -u --tx-vga2-gain= Set tx vga2 squelch [default: 0] 23 | -q --squelch= Set power squelch [default: 25] 24 | """ 25 | import sys 26 | import bladeRF 27 | import threading 28 | from numpy import vdot, log10 29 | from docopt import docopt 30 | 31 | 32 | class Repeater(object): 33 | 34 | def __init__(self, num_buffers, num_transfers, num_samples): 35 | self.zerobuf = bladeRF.ffi.new('int16_t[]', num_samples * 2) 36 | self.num_buffers = num_buffers 37 | self.num_filled = 0 38 | self.prefill_count = num_transfers + (num_buffers - num_transfers) / 2 39 | self.samples_available = threading.Condition() 40 | 41 | 42 | def main(): 43 | args = docopt(__doc__, version='bladeRF Repeater 1.0') 44 | device = bladeRF.Device(args['--device']) 45 | 46 | device.rx.enabled = True 47 | device.rx.frequency = int(args['']) 48 | device.rx.bandwidth = int(args['--bandwidth']) 49 | device.rx.sample_rate = int(args['--sample-rate']) 50 | device.rx.vga1 = int(args['--rx-vga1-gain']) 51 | device.rx.vga2 = int(args['--rx-vga2-gain']) 52 | 53 | device.lna_gain = getattr(bladeRF, args['--lna-gain']) 54 | 55 | device.tx.enabled = True 56 | device.tx.frequency = int(args['']) 57 | device.tx.bandwidth = int(args['--bandwidth']) 58 | device.tx.sample_rate = int(args['--sample-rate']) 59 | device.rx.vga1 = int(args['--tx-vga1-gain']) 60 | device.rx.vga2 = int(args['--tx-vga2-gain']) 61 | 62 | squelch = float(args['--squelch']) 63 | num_buffers = int(args['--num-buffers']) 64 | num_transfers = int(args['--num-transfers']) 65 | num_samples = int(args['--num-samples']) 66 | 67 | def rx(dev, stream, meta_data, samples, num_samples, repeater): 68 | with repeater.samples_available: 69 | if not stream.running: 70 | return 71 | samples = bladeRF.samples_to_narray(samples, num_samples) 72 | if bladeRF.squelched(samples, squelch): 73 | return stream.current() 74 | if repeater.num_filled >= 2 * repeater.num_buffers: 75 | # "RX Overrun encountered, stop advancing 76 | return stream.current() 77 | ret = stream.next() 78 | repeater.num_filled += 1 79 | repeater.samples_available.notify() 80 | return ret 81 | 82 | def tx(dev, stream, meta_data, samples, num_samples, repeater): 83 | with repeater.samples_available: 84 | if not stream.running: 85 | return 86 | if repeater.num_filled == 0: 87 | return repeater.zerobuf 88 | ret = stream.next() 89 | repeater.num_filled -= 1 90 | return ret 91 | 92 | repeater = Repeater(num_buffers, num_transfers, num_samples) 93 | 94 | rx_stream = device.rx.stream( 95 | rx, 96 | num_buffers, 97 | bladeRF.FORMAT_SC16_Q11, 98 | num_samples, 99 | num_transfers, 100 | repeater) 101 | 102 | tx_stream = device.tx.stream( 103 | tx, 104 | num_buffers, 105 | bladeRF.FORMAT_SC16_Q11, 106 | num_samples, 107 | num_transfers, 108 | repeater) 109 | 110 | tx_stream.buffers = rx_stream.buffers # wire up tx buffers to rx 111 | 112 | rx_stream.start() 113 | tx_stream.start() 114 | 115 | i = raw_input('Repeater is running, press enter to exit... ') 116 | 117 | with repeater.samples_available: 118 | rx_stream.running = tx_stream.running = False 119 | 120 | rx_stream.join() 121 | tx_stream.join() 122 | sys.exit(0) 123 | 124 | if __name__ == '__main__': 125 | main() 126 | -------------------------------------------------------------------------------- /bladeRF/__init__.py: -------------------------------------------------------------------------------- 1 | from ._cffi import ffi, ptop 2 | 3 | has_numpy = True 4 | try: 5 | import numpy as np 6 | except ImportError: 7 | has_numpy = False 8 | 9 | from .init import ( 10 | open, 11 | close, 12 | open_device, 13 | get_device_list, 14 | free_device_list, 15 | ) 16 | 17 | from .ctrl import ( 18 | enable_module, 19 | set_sample_rate, 20 | get_sampling, 21 | set_sampling, 22 | get_sample_rate, 23 | get_rational_sample_rate, 24 | set_txvga2, 25 | get_txvga2, 26 | set_txvga1, 27 | get_txvga1, 28 | set_lna_gain, 29 | get_lna_gain, 30 | set_rxvga1, 31 | get_rxvga1, 32 | set_rxvga2, 33 | get_rxvga2, 34 | set_bandwidth, 35 | get_bandwidth, 36 | set_lpf_mode, 37 | get_lpf_mode, 38 | select_band, 39 | set_frequency, 40 | get_frequency, 41 | ) 42 | 43 | from .data import ( 44 | raw_callback, 45 | init_stream, 46 | stream, 47 | deinit_stream, 48 | tx, 49 | rx, 50 | sync_config, 51 | ) 52 | 53 | from .misc import ( 54 | log_set_verbosity, 55 | ) 56 | 57 | from .info import ( 58 | get_fpga_size, 59 | ) 60 | 61 | import bladeRF._cffi 62 | 63 | # compilation happens here in verify(), 64 | # all C code must be defined at this point 65 | # and only after here may the library functions 66 | # and constants be accessed. hence the many import 67 | # name tricks used through the implementation 68 | 69 | # http://explosm.net/comics/420/ 70 | 71 | ffi.cdef(""" 72 | float* samples_to_floats(void*, int); 73 | 74 | void free(void *ptr); 75 | """) 76 | 77 | bladeRF._cffi.lib = lib = ffi.verify(""" 78 | #include 79 | #include 80 | 81 | /* this helper function is to turn the two 16 bit ints per sample into 82 | two normalized floats, so that it can be passed directly to 83 | numpy.frombuffer which can only take two 32-bit floats and turn them 84 | into a complex64 */ 85 | 86 | float* samples_to_floats(void *samples, int num_samples) { 87 | int i; 88 | int16_t* data = (int16_t*)samples; 89 | float* buffer = (float*)malloc(2 * num_samples * sizeof(float)); 90 | for (i = 0; i < num_samples; i++) { 91 | buffer[i] = (float)data[i] * (1.0f/2048.0f); 92 | } 93 | return buffer; 94 | } 95 | 96 | """, libraries=['bladeRF']) 97 | 98 | 99 | def samples_to_floats(samples, num_samples): 100 | """Call optimized C function to alocate and return pointer to 101 | buffer full of normalized I/Q floats. 102 | """ 103 | return ffi.gc(lib.samples_to_floats(samples, num_samples), lib.free) 104 | 105 | 106 | def to_float_buffer(raw_samples, num_samples): 107 | """Return an FFI buffer of I/Q floats.""" 108 | return bladeRF.ffi.buffer(samples_to_floats(raw_samples, num_samples), 2*num_samples*bladeRF.ffi.sizeof('float')) 109 | 110 | 111 | if has_numpy: 112 | def samples_to_narray(samples, num_samples): 113 | """Return a numpy array of type complex64 from the samples.""" 114 | return np.frombuffer(to_float_buffer(samples, num_samples), np.complex64) 115 | 116 | 117 | MODULE_TX = lib.BLADERF_MODULE_TX 118 | MODULE_RX = lib.BLADERF_MODULE_RX 119 | 120 | SAMPLING_UNKNOWN = lib.BLADERF_SAMPLING_UNKNOWN 121 | SAMPLING_INTERNAL = lib.BLADERF_SAMPLING_INTERNAL 122 | SAMPLING_EXTERNAL = lib.BLADERF_SAMPLING_EXTERNAL 123 | 124 | LNA_GAIN_UNKNOWN = lib.BLADERF_LNA_GAIN_UNKNOWN 125 | LNA_GAIN_BYPASS = lib.BLADERF_LNA_GAIN_BYPASS 126 | LNA_GAIN_MID = lib.BLADERF_LNA_GAIN_MID 127 | LNA_GAIN_MAX = lib.BLADERF_LNA_GAIN_MAX 128 | 129 | RXVGA1_GAIN_MIN = lib.BLADERF_RXVGA1_GAIN_MIN 130 | RXVGA1_GAIN_MAX = lib.BLADERF_RXVGA1_GAIN_MAX 131 | RXVGA2_GAIN_MIN = lib.BLADERF_RXVGA2_GAIN_MIN 132 | RXVGA2_GAIN_MAX = lib.BLADERF_RXVGA2_GAIN_MAX 133 | TXVGA1_GAIN_MIN = lib.BLADERF_TXVGA1_GAIN_MIN 134 | TXVGA1_GAIN_MAX = lib.BLADERF_TXVGA1_GAIN_MAX 135 | TXVGA2_GAIN_MIN = lib.BLADERF_TXVGA2_GAIN_MIN 136 | TXVGA2_GAIN_MAX = lib.BLADERF_TXVGA2_GAIN_MAX 137 | SAMPLERATE_MIN = lib.BLADERF_SAMPLERATE_MIN 138 | SAMPLERATE_REC_MAX = lib.BLADERF_SAMPLERATE_REC_MAX 139 | BANDWIDTH_MIN = lib.BLADERF_BANDWIDTH_MIN 140 | BANDWIDTH_MAX = lib.BLADERF_BANDWIDTH_MAX 141 | FREQUENCY_MIN = lib.BLADERF_FREQUENCY_MIN 142 | FREQUENCY_MAX = lib.BLADERF_FREQUENCY_MAX 143 | 144 | LPF_NORMAL = lib.BLADERF_LPF_NORMAL 145 | LPF_BYPASSED = lib.BLADERF_LPF_BYPASSED 146 | LPF_DISABLED = lib.BLADERF_LPF_DISABLED 147 | 148 | FORMAT_SC16_Q11 = lib.BLADERF_FORMAT_SC16_Q11 149 | 150 | LOG_LEVEL_VERBOSE = lib.BLADERF_LOG_LEVEL_VERBOSE 151 | LOG_LEVEL_DEBUG = lib.BLADERF_LOG_LEVEL_DEBUG 152 | LOG_LEVEL_INFO = lib.BLADERF_LOG_LEVEL_INFO 153 | LOG_LEVEL_WARNING = lib.BLADERF_LOG_LEVEL_WARNING 154 | LOG_LEVEL_ERROR = lib.BLADERF_LOG_LEVEL_ERROR 155 | LOG_LEVEL_CRITICAL = lib.BLADERF_LOG_LEVEL_CRITICAL 156 | LOG_LEVEL_SILENT = lib.BLADERF_LOG_LEVEL_SILENT 157 | 158 | 159 | from .errors import ( 160 | BladeRFException, 161 | UnexpectedError, 162 | RangeError, 163 | InvalError, 164 | MemError, 165 | BladeIOError, 166 | TimeoutError, 167 | NodevError, 168 | UnsupportedError, 169 | MisalignedError, 170 | ChecksumError, 171 | ) 172 | 173 | from device import ( 174 | Device, 175 | ) 176 | 177 | 178 | def power(samples): 179 | return 10*np.log10(np.abs(np.vdot(samples, samples))) 180 | 181 | 182 | def squelched(samples, level): 183 | return power(samples) < level 184 | -------------------------------------------------------------------------------- /bladeRF/gui/gui.py: -------------------------------------------------------------------------------- 1 | import pyqtgraph as pg 2 | import Queue 3 | from pyqtgraph.Qt import QtCore, QtGui 4 | from PyQt4.QtCore import QObject, pyqtSignal, Qt 5 | import scipy.ndimage as ndi 6 | import numpy as np 7 | 8 | app = QtGui.QApplication([]) 9 | import pyqtgraph.parametertree.parameterTypes as pTypes 10 | from pyqtgraph.parametertree import Parameter, ParameterTree, ParameterItem, registerParameterType 11 | 12 | from scipy import signal 13 | import bladeRF 14 | 15 | device = bladeRF.Device() 16 | device.rx.enabled = True 17 | device.rx.frequency = 440000000 18 | device.rx.bandwidth = 28000000 19 | device.rx.sample_rate = 40000000 20 | 21 | 22 | 23 | num_buffers = 16 24 | num_transfers = 16 25 | num_samples = 2**16 26 | Nf = 512 # No. of frames 27 | Ns = 1000 # Signal length 28 | 29 | params = [ 30 | {'name': 'Frequency', 31 | 'type': 'group', 32 | 'children': [ 33 | {'name': 'Mhz', 34 | 'type': 'int', 35 | 'decimals': 12, 36 | 'value': device.rx.frequency, 37 | }, 38 | ]}, 39 | 40 | {'name': 'Bandwidth', 41 | 'type': 'group', 42 | 'children': [ 43 | { 44 | 'name': 'Mhz', 45 | 'type': 'int', 46 | 'value': device.rx.bandwidth, 47 | 'step': 1, 48 | 'dec': True, 49 | }, 50 | ]}, 51 | 52 | {'name': 'Sample Rate', 'type': 'group', 'children': [ 53 | {'name': 'Mhz', 54 | 'type': 'int', 55 | 'value': device.rx.sample_rate}, 56 | ]}, 57 | 58 | {'name': 'Gain', 'type': 'group', 'children': [ 59 | {'name': 'LNA', 'type': 'list', 60 | 'values': { 61 | "mid": bladeRF.LNA_GAIN_MID, 62 | "max": bladeRF.LNA_GAIN_MAX, 63 | "bypass": bladeRF.LNA_GAIN_BYPASS 64 | }, 65 | 'value': bladeRF.LNA_GAIN_MAX}, 66 | 67 | {'name': 'VGA1', 68 | 'type': 'int', 69 | 'limits': (5, 30), 70 | 'value': device.rx.vga1}, 71 | 72 | {'name': 'VGA2', 73 | 'type': 'int', 74 | 'limits': (0, 30), 75 | 'value': device.rx.vga2}, 76 | ]}, 77 | ] 78 | 79 | ## Create tree of Parameter objects 80 | p = Parameter.create(name='params', type='group', children=params) 81 | 82 | ## If anything changes in the tree, print a message 83 | def change(param, changes): 84 | for param, change, data in changes: 85 | path = p.childPath(param) 86 | if path is not None: 87 | childName = '.'.join(path) 88 | else: 89 | childName = param.name() 90 | if childName.startswith('Frequency'): 91 | device.rx.frequency = data 92 | elif childName.startswith('Bandwidth'): 93 | device.rx.bandwidth = data 94 | elif childName.startswith('Sample Rate'): 95 | device.rx.sample_rate = data 96 | elif childName.startswith('Gain.LNA'): 97 | device.rx.lna_gain = data 98 | elif childName.startswith('Gain.VGA1'): 99 | device.rx.vga1 = data 100 | elif childName.startswith('Gain.VGA2'): 101 | device.rx.vga2 = data 102 | 103 | 104 | p.sigTreeStateChanged.connect(change) 105 | 106 | ## Create two ParameterTree widgets, both accessing the same data 107 | t = ParameterTree() 108 | t.setParameters(p, showTop=False) 109 | t.setWindowTitle('pyqtgraph example: Parameter Tree') 110 | t2 = ParameterTree() 111 | t2.setParameters(p, showTop=False) 112 | 113 | win = QtGui.QWidget() 114 | 115 | layout = QtGui.QGridLayout() 116 | win.setLayout(layout) 117 | 118 | Arx = np.zeros([Nf, Ns]) 119 | inwin = pg.ImageView(view=pg.PlotItem()) 120 | inwin.setImage(Arx, scale=[2, 2]) 121 | 122 | queue = Queue.Queue(num_buffers) 123 | 124 | def update(): 125 | global Arx 126 | Arx = np.roll(Arx, 1, axis=0) 127 | try: 128 | samples = queue.get_nowait() 129 | except Queue.Empty: 130 | return 131 | f, fft = signal.periodogram(samples, window='hamming', scaling='density', nfft=Ns) 132 | fft = 10*np.log10(fft) 133 | Arx[0] = fft 134 | inwin.setImage(Arx.T, autoRange=False, scale=[2, 2]) 135 | 136 | layout.addWidget(inwin, 1, 0, 1, 10) 137 | 138 | #cross hair 139 | vLine = pg.InfiniteLine(angle=90, movable=False) 140 | hLine = pg.InfiniteLine(angle=0, movable=False) 141 | inwin.addItem(vLine, ignoreBounds=True) 142 | inwin.addItem(hLine, ignoreBounds=True) 143 | 144 | def mouseMoved(evt): 145 | pos = evt[0] ## using signal proxy turns original arguments into a tuple 146 | if inwin.imageItem.sceneBoundingRect().contains(pos): 147 | mousePoint = inwin.imageItem.getViewBox().mapSceneToView(pos) 148 | index = int(mousePoint.x()) 149 | vLine.setPos(mousePoint.x()) 150 | hLine.setPos(mousePoint.y()) 151 | 152 | proxy = pg.SignalProxy(inwin.scene.sigMouseMoved, rateLimit=60, slot=mouseMoved) 153 | 154 | 155 | layout.addWidget(QtGui.QLabel( 156 | "BladeRF spectrum."), 0, 0, 1, 2) 157 | layout.addWidget(t, 1, 11, 1, 3) 158 | 159 | win.show() 160 | win.resize(1600,800) 161 | 162 | def rx(device, stream, meta_data, samples, num_samples, user_data): 163 | samples = bladeRF.samples_to_narray(samples, num_samples) 164 | try: 165 | queue.put_nowait(samples) 166 | except Queue.Full: 167 | pass 168 | return stream.next() 169 | 170 | stream = device.rx.stream( 171 | rx, 172 | num_buffers, 173 | bladeRF.FORMAT_SC16_Q12, 174 | num_samples, 175 | num_transfers, 176 | ) 177 | 178 | timer = QtCore.QTimer() 179 | timer.timeout.connect(update) 180 | timer.start() 181 | stream.start() 182 | 183 | ## Start Qt event loop unless running in interactive mode or using pyside. 184 | if __name__ == '__main__': 185 | import sys 186 | if (sys.flags.interactive != 1) or not hasattr(QtCore, 'PYQT_VERSION'): 187 | QtGui.QApplication.instance().exec_() 188 | stream.running = False 189 | stream.join() 190 | -------------------------------------------------------------------------------- /bladeRF/data.py: -------------------------------------------------------------------------------- 1 | import bladeRF 2 | from bladeRF import _cffi 3 | from bladeRF._cffi import ffi, cdef, ptop 4 | 5 | cdef(""" 6 | typedef enum { 7 | BLADERF_FORMAT_SC16_Q11, /**< Signed, Complex 16-bit Q11. 8 | * This is the native format of the DAC data. 9 | * 10 | * Samples are interleaved IQ value pairs, where 11 | * each value in the pair is an int16_t. For each 12 | * value, the data in the lower bits. The upper 13 | * bits are reserved. 14 | * 15 | * When using this format, note that buffers 16 | * must be at least 17 | * 2 * num_samples * sizeof(int16_t) 18 | * bytes large 19 | */ 20 | } bladerf_format; 21 | 22 | /** 23 | * For both RX and TX, the stream callback receives: 24 | * dev: Device structure 25 | * stream: The associated stream 26 | * metadata: TBD 27 | * user_data: User data provided when initializing stream 28 | * 29 | *
30 | * 31 | * For TX callbacks: 32 | * samples: Pointer fo buffer of samples that was sent 33 | * num_samples: Number of sent in last transfer and to send in next transfer 34 | * 35 | * Return value: The user specifies the address of the next buffer to send 36 | * 37 | * For RX callbacks: 38 | * samples: Buffer filled with received data 39 | * num_samples: Number of samples received and size of next buffers 40 | * 41 | * Return value: The user specifies the next buffer to fill with RX data, 42 | * which should be num_samples in size. 43 | * 44 | */ 45 | 46 | typedef void *(*bladerf_stream_cb)(struct bladerf *dev, 47 | struct bladerf_stream *stream, 48 | struct bladerf_metadata *meta, 49 | void *samples, 50 | size_t num_samples, 51 | void *user_data); 52 | 53 | 54 | struct bladerf_metadata { 55 | uint64_t timestamp; /**< Timestamp (TODO format TBD) */ 56 | uint32_t flags; /**< Metadata format flags */ 57 | uint32_t status; /**< Metadata format status */ 58 | unsigned int actual_count; /**< number of contiguous received samples */ 59 | uint8_t reserved[32]; /**< reserved */ 60 | }; 61 | 62 | """) 63 | 64 | def raw_callback(f): 65 | @ffi.callback('bladerf_stream_cb') 66 | def handler(dev, stream, meta, samples, num_samples, user_data): 67 | user_data = ffi.from_handle(user_data) 68 | v = f(dev, stream, meta, samples, num_samples, user_data) 69 | if v is None: 70 | return ffi.NULL 71 | return v 72 | return handler 73 | 74 | 75 | @cdef(""" 76 | int bladerf_init_stream(struct bladerf_stream **stream, 77 | struct bladerf *dev, 78 | bladerf_stream_cb callback, 79 | void ***buffers, 80 | size_t num_buffers, 81 | bladerf_format format, 82 | size_t num_samples, 83 | size_t num_transfers, 84 | void *user_data); 85 | """) 86 | def init_stream(dev, callback, num_buffers, format, num_samples, num_transfers, 87 | user_data): 88 | stream = ffi.new('struct bladerf_stream*[1]') 89 | buffers = ffi.new('void**[1]') 90 | err = _cffi.lib.bladerf_init_stream( 91 | stream, dev, callback, buffers, num_buffers, format, num_samples, 92 | num_transfers, user_data) 93 | bladeRF.errors.check_retcode(err) 94 | return (stream[0], buffers[0]) 95 | 96 | 97 | @cdef('int bladerf_stream(struct bladerf_stream *stream, bladerf_module module);') 98 | def stream(stream, module): 99 | err = _cffi.lib.bladerf_stream(stream, module) 100 | bladeRF.errors.check_retcode(err) 101 | 102 | 103 | @cdef('void bladerf_deinit_stream(struct bladerf_stream *stream);') 104 | def deinit_stream(stream): 105 | _cffi.lib.bladerf_deinit_stream(stream) 106 | 107 | 108 | @cdef("""int bladerf_sync_config(struct bladerf *dev, 109 | bladerf_module module, 110 | bladerf_format format, 111 | unsigned int num_buffers, 112 | unsigned int buffer_size, 113 | unsigned int num_transfers, 114 | unsigned int stream_timeout);""") 115 | def sync_config(dev, module, format, num_buffers, buffer_size, num_transfers, stream_timeout): 116 | err = _cffi.lib.bladerf_sync_config(dev, module, format, num_buffers, buffer_size, num_transfers, stream_timeout) 117 | bladeRF.errors.check_retcode(err) 118 | 119 | 120 | @cdef("""int bladerf_sync_tx(struct bladerf *dev, 121 | void *samples, unsigned int num_samples, 122 | struct bladerf_metadata *metadata, 123 | unsigned int timeout_ms);""") 124 | def tx(dev, samples, num_samples, metadata, timeout_ms): 125 | err = _cffi.lib.bladerf_sync_tx(dev, samples, num_samples, metadata, timeout_ms) 126 | bladeRF.errors.check_retcode(err) 127 | 128 | 129 | @cdef("""int bladerf_sync_rx(struct bladerf *dev, 130 | void *samples, unsigned int num_samples, 131 | struct bladerf_metadata *metadata, 132 | unsigned int timeout_ms);""") 133 | def rx(dev, samples, num_samples, metadata, timeout_ms): 134 | err = _cffi.lib.bladerf_sync_rx(dev, samples, num_samples, metadata, timeout_ms) 135 | bladeRF.errors.check_retcode(err) 136 | -------------------------------------------------------------------------------- /bladeRF/device.py: -------------------------------------------------------------------------------- 1 | from threading import Thread, RLock 2 | import weakref 3 | import bladeRF 4 | 5 | 6 | sample_size = bladeRF.ffi.sizeof('int16_t') * 2 7 | 8 | 9 | class Stream(Thread): 10 | """ 11 | A bladeRF stream of data and a thread to process streams 12 | 13 | This condition from the documents still holds: 14 | 15 | * When running a full-duplex configuration with two threads (e.g, 16 | * one thread calling bladerf_stream() for TX, and another for RX), stream 17 | * callbacks may be executed in either thread. Therefore, the caller is 18 | * responsible for ensuring that his or her callbacks are thread-safe. For the 19 | * same reason, it is highly recommended that callbacks do not block. 20 | """ 21 | 22 | def __init__(self, device, module, callback, 23 | num_buffers, format, num_samples, 24 | num_transfers, user_data=None): 25 | Thread.__init__(self) 26 | self.running = True 27 | self.current_buff = 0 28 | self.num_buffers = num_buffers 29 | self.device = device 30 | self.module = module 31 | 32 | @bladeRF.ffi.callback('bladerf_stream_cb') 33 | def raw_callback(raw_device, raw_stream, meta, raw_samples, num_samples, user_data): 34 | user_data = bladeRF.ffi.from_handle(user_data) 35 | v = callback(self.device, self, meta, raw_samples, num_samples, user_data) 36 | if v is None: 37 | return bladeRF.ffi.NULL 38 | return v 39 | 40 | self.num_samples = num_samples 41 | self.callback = callback 42 | self.raw_callback = raw_callback 43 | self.user_data_handle = bladeRF.ffi.new_handle(user_data) 44 | self.raw_stream, self.buffers = bladeRF.init_stream( 45 | self.device.raw_device, raw_callback, num_buffers, format, 46 | num_samples, num_transfers, self.user_data_handle) 47 | 48 | def next(self): 49 | if not self.running: 50 | return 51 | ret = self.current() 52 | self.current_buff += 1 53 | if self.current_buff >= self.num_buffers: 54 | self.current_buff = 0 55 | return ret 56 | 57 | def current(self): 58 | return self.buffers[self.current_buff] 59 | 60 | def current_as_buffer(self): 61 | return bladeRF.ffi.buffer(self.current(), self.num_samples*sample_size) 62 | 63 | def run(self): 64 | bladeRF.stream(self.raw_stream, self.module) 65 | 66 | 67 | class Module(object): 68 | """ A module, either rx or tx. 69 | """ 70 | 71 | def __init__(self, device, module): 72 | self.device = device 73 | self.raw_device = device.raw_device 74 | self.module = module 75 | 76 | @property 77 | def enabled(self): 78 | return bladeRF.enable_module(self.raw_device, self.module, True) 79 | 80 | @enabled.setter 81 | def enabled(self, enabled): 82 | bladeRF.enable_module(self.raw_device, self.module, enabled) 83 | 84 | @property 85 | def frequency(self): 86 | return bladeRF.get_frequency(self.raw_device, self.module) 87 | 88 | @frequency.setter 89 | def frequency(self, frequency): 90 | bladeRF.set_frequency(self.raw_device, self.module, frequency) 91 | 92 | @property 93 | def bandwidth(self): 94 | return bladeRF.get_bandwidth(self.raw_device, self.module) 95 | 96 | @bandwidth.setter 97 | def bandwidth(self, bandwidth): 98 | bladeRF.set_bandwidth(self.raw_device, self.module, bandwidth) 99 | 100 | @property 101 | def sample_rate(self): 102 | return bladeRF.get_sample_rate(self.raw_device, self.module) 103 | 104 | @sample_rate.setter 105 | def sample_rate(self, sample_rate): 106 | bladeRF.set_sample_rate(self.raw_device, self.module, sample_rate) 107 | 108 | @property 109 | def vga1(self): 110 | if self.module == bladeRF.MODULE_RX: 111 | return bladeRF.get_rxvga1(self.raw_device) 112 | else: 113 | return bladeRF.get_txvga1(self.raw_device) 114 | 115 | @vga1.setter 116 | def vga1(self, gain): 117 | if self.module == bladeRF.MODULE_RX: 118 | return bladeRF.set_rxvga1(self.raw_device, gain) 119 | else: 120 | return bladeRF.set_txvga1(self.raw_device, gain) 121 | 122 | @property 123 | def vga2(self): 124 | if self.module == bladeRF.MODULE_RX: 125 | return bladeRF.get_rxvga2(self.raw_device) 126 | else: 127 | return bladeRF.get_txvga2(self.raw_device) 128 | 129 | @vga2.setter 130 | def vga2(self, gain): 131 | if self.module == bladeRF.MODULE_RX: 132 | return bladeRF.set_rxvga2(self.raw_device, gain) 133 | else: 134 | return bladeRF.set_txvga2(self.raw_device, gain) 135 | 136 | def stream(self, callback, num_buffers, format, num_samples, 137 | num_transfers, user_data=None): 138 | return Stream(self, self.module, callback, 139 | num_buffers, format, num_samples, 140 | num_transfers, user_data=user_data) 141 | 142 | def config(self, format, num_buffers, buffer_size, num_transfers, stream_timeout=0): 143 | return bladeRF.sync_config(self.raw_device, self.module, format, num_buffers, 144 | buffer_size, num_transfers, stream_timeout) 145 | 146 | def __call__(self, num_samples, samples=None, metadata=bladeRF.ffi.NULL, timeout_ms=0): 147 | if samples is None: 148 | samples = bladeRF.ffi.new('int16_t[%s]' % (2 * num_samples)) 149 | if self.module == bladeRF.MODULE_RX: 150 | func = bladeRF.rx 151 | else: 152 | func = bladeRF.tx 153 | func(self.raw_device, bladeRF.ffi.cast('void *', samples), num_samples, metadata, timeout_ms) 154 | return samples 155 | 156 | 157 | class Device(object): 158 | 159 | def __init__(self, device_identifier=''): 160 | self._device = bladeRF.open(device_identifier) 161 | self.lock = RLock() 162 | 163 | @classmethod 164 | def from_params(cls, device_identifier='', 165 | rx_frequency=1000000000, rx_bandwidth=7000000, 166 | rx_sample_rate=10000000, tx_frequency=1000000000, 167 | tx_bandwidth=7000000, tx_sample_rate=10000000): 168 | device = cls(device_identifier) 169 | if rx_frequency: 170 | device.rx.enabled = True 171 | device.rx.frequency = rx_frequency 172 | device.rx.bandwidth = rx_bandwidth 173 | device.rx.sample_rate = rx_sample_rate 174 | if tx_frequency: 175 | device.tx.enabled = True 176 | device.tx.frequency = tx_frequency 177 | device.tx.bandwidth = tx_bandwidth 178 | device.tx.sample_rate = tx_sample_rate 179 | return device 180 | 181 | @property 182 | def raw_device(self): 183 | return self._device[0] 184 | 185 | @property 186 | def rx(self): 187 | return Module(self, bladeRF.MODULE_RX) 188 | 189 | @property 190 | def tx(self): 191 | return Module(self, bladeRF.MODULE_TX) 192 | 193 | @property 194 | def fpga_size(self): 195 | return bladeRF.get_fpga_size(self.raw_device) 196 | 197 | @property 198 | def lna_gain(self): 199 | return bladeRF.get_lna_gain(self.raw_device) 200 | 201 | @lna_gain.setter 202 | def lna_gain(self, gain): 203 | return bladeRF.set_lna_gain(self.raw_device, gain) 204 | 205 | def __del__(self): 206 | bladeRF.close(self.raw_device) 207 | 208 | -------------------------------------------------------------------------------- /bladeRF/ctrl.py: -------------------------------------------------------------------------------- 1 | import bladeRF 2 | from bladeRF import _cffi 3 | from bladeRF._cffi import ffi, cdef, ptop 4 | 5 | cdef(""" 6 | typedef enum 7 | { 8 | BLADERF_MODULE_RX, /**< Receive Module */ 9 | BLADERF_MODULE_TX /**< Transmit Module */ 10 | } bladerf_module; 11 | 12 | typedef enum { 13 | BLADERF_SAMPLING_UNKNOWN, /**< Unable to determine connection type */ 14 | BLADERF_SAMPLING_INTERNAL, /**< Sample from RX/TX connector */ 15 | BLADERF_SAMPLING_EXTERNAL /**< Sample from J60 or J61 */ 16 | } bladerf_sampling; 17 | 18 | typedef enum { 19 | BLADERF_LNA_GAIN_UNKNOWN, /**< Invalid LNA gain */ 20 | BLADERF_LNA_GAIN_BYPASS, /**< LNA bypassed - 0dB gain */ 21 | BLADERF_LNA_GAIN_MID, /**< LNA Mid Gain (MAX-6dB) */ 22 | BLADERF_LNA_GAIN_MAX /**< LNA Max Gain */ 23 | } bladerf_lna_gain; 24 | 25 | typedef enum { 26 | BLADERF_LPF_NORMAL, /**< LPF connected and enabled */ 27 | BLADERF_LPF_BYPASSED, /**< LPF bypassed */ 28 | BLADERF_LPF_DISABLED /**< LPF disabled */ 29 | } bladerf_lpf_mode; 30 | 31 | 32 | /** Minimum RXVGA1 gain, in dB */ 33 | #define BLADERF_RXVGA1_GAIN_MIN ... 34 | 35 | /** Maximum RXVGA1 gain, in dB */ 36 | #define BLADERF_RXVGA1_GAIN_MAX ... 37 | 38 | /** Minimum RXVGA2 gain, in dB */ 39 | #define BLADERF_RXVGA2_GAIN_MIN ... 40 | 41 | /** Maximum RXVGA2 gain, in dB */ 42 | #define BLADERF_RXVGA2_GAIN_MAX ... 43 | 44 | /** Minimum TXVGA1 gain, in dB */ 45 | #define BLADERF_TXVGA1_GAIN_MIN ... 46 | 47 | /** Maximum TXVGA1 gain, in dB */ 48 | #define BLADERF_TXVGA1_GAIN_MAX ... 49 | 50 | /** Minimum TXVGA2 gain, in dB */ 51 | #define BLADERF_TXVGA2_GAIN_MIN ... 52 | 53 | /** Maximum TXVGA2 gain, in dB */ 54 | #define BLADERF_TXVGA2_GAIN_MAX ... 55 | 56 | /** Minimum sample rate, in Hz */ 57 | #define BLADERF_SAMPLERATE_MIN ... 58 | 59 | /** Maximum recommended sample rate, in Hz */ 60 | #define BLADERF_SAMPLERATE_REC_MAX ... 61 | 62 | /** Minimum bandwidth, in Hz */ 63 | #define BLADERF_BANDWIDTH_MIN ... 64 | 65 | /** Maximum bandwidth, in Hz */ 66 | #define BLADERF_BANDWIDTH_MAX ... 67 | 68 | /** Minimum tunable frequency (without an XB-200 attached), in Hz */ 69 | #define BLADERF_FREQUENCY_MIN ... 70 | 71 | /** Maximum tunable frequency, in Hz */ 72 | #define BLADERF_FREQUENCY_MAX ... 73 | """) 74 | 75 | @cdef('int bladerf_enable_module(struct bladerf *dev, ' 76 | 'bladerf_module m, bool enable);') 77 | def enable_module(dev, module, enable): 78 | err = _cffi.lib.bladerf_enable_module(dev, module, enable) 79 | bladeRF.errors.check_retcode(err) 80 | 81 | 82 | @cdef('int bladerf_set_sample_rate(struct bladerf *dev, ' 83 | 'bladerf_module module, unsigned int rate, unsigned int *actual);') 84 | def set_sample_rate(dev, module, rate): 85 | actual = ffi.new('unsigned int*') 86 | err = _cffi.lib.bladerf_set_sample_rate(dev, module, int(rate), actual) 87 | bladeRF.errors.check_retcode(err) 88 | return int(actual[0]) 89 | 90 | 91 | @cdef('int bladerf_set_sampling(struct bladerf *dev, bladerf_sampling sampling);') 92 | def set_sampling(dev, sampling): 93 | err = _cffi.lib.bladerf_set_sampling(dev, sampling) 94 | bladeRF.errors.check_retcode(err) 95 | 96 | 97 | @cdef('int bladerf_get_sampling(struct bladerf *dev, bladerf_sampling *sampling);') 98 | def get_sampling(dev): 99 | sampling = ffi.new('bladerf_sampling*') 100 | err = _cffi.lib.bladerf_get_sampling(dev, sampling) 101 | bladeRF.errors.check_retcode(err) 102 | return int(sampling[0]) 103 | 104 | 105 | @cdef('int bladerf_get_sample_rate(struct bladerf *dev, bladerf_module module, unsigned int *rate);') 106 | def get_sample_rate(dev, module): 107 | rate = ffi.new('unsigned int *') 108 | err = _cffi.lib.bladerf_get_sample_rate(dev, module, rate) 109 | bladeRF.errors.check_retcode(err) 110 | return int(rate[0]) 111 | 112 | 113 | @cdef('int bladerf_get_rational_sample_rate(struct bladerf *dev,' 114 | 'bladerf_module module, struct bladerf_rational_rate *rate);') 115 | def get_rational_sample_rate(dev, module): 116 | pass 117 | 118 | 119 | @cdef('int bladerf_set_txvga2(struct bladerf *dev, int gain);') 120 | def set_txvga2(dev, gain): 121 | err = _cffi.lib.bladerf_set_txvga2(dev, gain) 122 | bladeRF.errors.check_retcode(err) 123 | 124 | 125 | @cdef('int bladerf_get_txvga2(struct bladerf *dev, int *gain);') 126 | def get_txvga2(dev): 127 | gain = ffi.new('int *') 128 | err = _cffi.lib.bladerf_get_txvga2(dev, gain) 129 | bladeRF.errors.check_retcode(err) 130 | return int(gain[0]) 131 | 132 | 133 | @cdef('int bladerf_set_txvga1(struct bladerf *dev, int gain);') 134 | def set_txvga1(dev, gain): 135 | err = _cffi.lib.bladerf_set_txvga1(dev, gain) 136 | bladeRF.errors.check_retcode(err) 137 | 138 | 139 | @cdef('int bladerf_get_txvga1(struct bladerf *dev, int *gain);') 140 | def get_txvga1(dev): 141 | gain = ffi.new('int *') 142 | err = _cffi.lib.bladerf_get_txvga1(dev, gain) 143 | bladeRF.errors.check_retcode(err) 144 | return int(gain[0]) 145 | 146 | 147 | @cdef('int bladerf_set_lna_gain(struct bladerf *dev, bladerf_lna_gain gain);') 148 | def set_lna_gain(dev, gain): 149 | err = _cffi.lib.bladerf_set_lna_gain(dev, gain) 150 | bladeRF.errors.check_retcode(err) 151 | 152 | 153 | @cdef('int bladerf_get_lna_gain(struct bladerf *dev, bladerf_lna_gain *gain);') 154 | def get_lna_gain(dev): 155 | gain = ffi.new('bladerf_lna_gain *') 156 | err = _cffi.lib.bladerf_get_lna_gain(dev, gain) 157 | bladeRF.errors.check_retcode(err) 158 | return int(gain[0]) 159 | 160 | 161 | @cdef('int bladerf_set_rxvga1(struct bladerf *dev, int gain);') 162 | def set_rxvga1(dev, gain): 163 | err = _cffi.lib.bladerf_set_rxvga1(dev, gain) 164 | bladeRF.errors.check_retcode(err) 165 | 166 | 167 | @cdef('int bladerf_get_rxvga1(struct bladerf *dev, int *gain);') 168 | def get_rxvga1(dev): 169 | gain = ffi.new('int *') 170 | err = _cffi.lib.bladerf_get_rxvga1(dev, gain) 171 | bladeRF.errors.check_retcode(err) 172 | return int(gain[0]) 173 | 174 | 175 | @cdef('int bladerf_set_rxvga2(struct bladerf *dev, int gain);') 176 | def set_rxvga2(dev, gain): 177 | err = _cffi.lib.bladerf_set_rxvga2(dev, gain) 178 | bladeRF.errors.check_retcode(err) 179 | 180 | 181 | @cdef('int bladerf_get_rxvga2(struct bladerf *dev, int *gain);') 182 | def get_rxvga2(dev): 183 | gain = ffi.new('int *') 184 | err = _cffi.lib.bladerf_get_rxvga2(dev, gain) 185 | bladeRF.errors.check_retcode(err) 186 | return int(gain[0]) 187 | 188 | 189 | @cdef('int bladerf_set_bandwidth(struct bladerf *dev, bladerf_module module, ' 190 | 'unsigned int bandwidth, unsigned int *actual);') 191 | def set_bandwidth(dev, module, bandwidth): 192 | actual = ffi.new('unsigned int *') 193 | err = _cffi.lib.bladerf_set_bandwidth(dev, module, bandwidth, actual) 194 | bladeRF.errors.check_retcode(err) 195 | return int(actual[0]) 196 | 197 | 198 | @cdef('int bladerf_get_bandwidth(struct bladerf *dev, bladerf_module module, ' 199 | 'unsigned int *bandwidth);') 200 | def get_bandwidth(dev, module): 201 | bandwidth = ffi.new('unsigned int *') 202 | err = _cffi.lib.bladerf_get_bandwidth(dev, module, bandwidth) 203 | bladeRF.errors.check_retcode(err) 204 | return int(bandwidth[0]) 205 | 206 | 207 | @cdef('int bladerf_set_lpf_mode(struct bladerf *dev, bladerf_module module, ' 208 | 'bladerf_lpf_mode mode);') 209 | def set_lpf_mode(dev, module, mode): 210 | err = _cffi.lib.bladerf_set_lpf_mode(dev, module, mode) 211 | bladeRF.errors.check_retcode(err) 212 | 213 | 214 | @cdef('int bladerf_get_lpf_mode(struct bladerf *dev, bladerf_module module,' 215 | 'bladerf_lpf_mode *mode);') 216 | def get_lpf_mode(dev, module): 217 | mode = ffi.new('bladerf_lpf_mode *') 218 | err = _cffi.lib.bladerf_get_lpf_mode(dev, module, mode) 219 | bladeRF.errors.check_retcode(err) 220 | return int(mode[0]) 221 | 222 | 223 | @cdef('int bladerf_select_band(struct bladerf *dev, bladerf_module module,' 224 | 'unsigned int frequency);') 225 | def select_band(dev, module, frequency): 226 | err = _cffi.lib.bladerf_select_band(dev, module, frequency) 227 | bladeRF.errors.check_retcode(err) 228 | 229 | 230 | @cdef('int bladerf_set_frequency(struct bladerf *dev, ' 231 | 'bladerf_module module, unsigned int frequency);') 232 | def set_frequency(dev, module, frequency): 233 | err = _cffi.lib.bladerf_set_frequency(dev, module, int(frequency)) 234 | bladeRF.errors.check_retcode(err) 235 | 236 | 237 | @cdef('int bladerf_get_frequency(struct bladerf *dev,' 238 | 'bladerf_module module, unsigned int *frequency);') 239 | def get_frequency(dev, module): 240 | frequency = ffi.new('unsigned int *') 241 | err = _cffi.lib.bladerf_get_frequency(dev, module, frequency) 242 | bladeRF.errors.check_retcode(err) 243 | return int(frequency[0]) 244 | 245 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------