py-hackrf-ctypes/README.md

49 lines
1.4 KiB
Markdown
Raw Normal View History

2014-12-24 23:04:37 -05:00
pyhackrf-ctypes
==============
pyhackrf-ctypes is a Python wrapper for libhackrf.<br>
I create this project because i want a simple Python interface to my hackrf board.
At First I use pyusb to directly get the data from HackRF, then I found pyusb can only move data at a rate of 5MiB/S, too slow for HackRF.<br>
So finally i choose ctypes .
# Dependencies
* libusb
* Python 2.7.x/3.3+
* libhackrf
* NumPy
sudo apt-get install python-dev,libusb-1.0-0
[libhackrf](https://github.com/mossmann/hackrf/tree/master/host)
## Examples
```python
import pylibhackrf ,ctypes
hackrf = pylibhackrf.HackRf()
if hackrf.is_open == False:
hackrf.setup()
hackrf.set_freq(hackrf_settings.centre_frequency)
hackrf.set_sample_rate(hackrf_settings.sample_rate)
hackrf.set_amp_enable(False)
hackrf.set_lna_gain(hackrf_settings.if_gain)
hackrf.set_vga_gain(hackrf_settings.bb_gain)
hackrf.set_baseband_filter_bandwidth(hackrf_settings.bb_bandwidth)
def callback_fun(hackrf_transfer):
array_type = (ctypes.c_ubyte*length)
values = ctypes.cast(hackrf_transfer.contents.buffer, ctypes.POINTER(array_type)).contents
#iq data here
iq = hackrf.packed_bytes_to_iq(values)
return 0
hackrf.start_rx_mode(callback_fun)
```
# Todo
There are a few remaining functions in libhackrf haven't been wrapped.
# License
All of the code contained here is licensed by the GNU General Public License v3.