xref: /libbtbb/README.md (revision 37c736c494b9fe5ca44e1a11131cb074a4158161)
1e25b118aSDominic Spilllibbtbb
2e25b118aSDominic Spill=======
3e25b118aSDominic Spill
4e25b118aSDominic SpillThis is the Bluetooth baseband decoding library, forked from the GR-Bluetooth
5e25b118aSDominic Spillproject.  It can be used to extract Bluetooth packet and piconet information
6e25b118aSDominic Spillfrom Ubertooth devices as well as GR-Bluetooth/USRP.
7e25b118aSDominic Spill
8e25b118aSDominic SpillThis code is incomplete, it is still under active development.  Patches and
985fe141eSDominic Spillbug reports should be submitted to the bug tracker on GitHub:
1085fe141eSDominic Spillhttps://github.com/greatscottgadgets/libbtbb/issues
11e25b118aSDominic Spill
12e25b118aSDominic SpillThis software has been developed and tested on Linux, it should work on other
13e25b118aSDominic Spillplatforms but this has yet to be tested.
14e25b118aSDominic Spill
15e25b118aSDominic Spill
16e25b118aSDominic SpillBuild Instructions
17e25b118aSDominic Spill==================
18e25b118aSDominic Spill
19e25b118aSDominic SpillLibbtbb can be built and installed as follows:
20430a2426SDominic Spill```
21e25b118aSDominic Spill$ mkdir build
22e25b118aSDominic Spill$ cd build
23e25b118aSDominic Spill$ cmake ..
24e25b118aSDominic Spill$ make
25*37c736c4Sdinosec$ sudo make install
26430a2426SDominic Spill```
27e25b118aSDominic Spill
28e25b118aSDominic SpillThis will install the library to /usr/local/lib and the headers to
29e25b118aSDominic Spill/usr/local/include, to install to different locations use:
30430a2426SDominic Spill```
31e25b118aSDominic Spill$ cmake -DINSTALL_DIR=/path/to/install -DINCLUDE_DIR=/path/to/include ..
32430a2426SDominic Spill```
33e6f5b9aaSDominic Spill
34e6f5b9aaSDominic SpillIf you have previous versions of libbtbb, libubertooth or the Ubertooth tools
35e6f5b9aaSDominic Spillinstalled, you can use the cleanup script to remove them:
36e6f5b9aaSDominic Spill```
37e6f5b9aaSDominic Spill$ sudo cmake/cleanup.sh -d
38e6f5b9aaSDominic Spill```
39e6f5b9aaSDominic Spill
40e6f5b9aaSDominic SpillTo list the installed files without removing them, use:
41e6f5b9aaSDominic Spill```
42e6f5b9aaSDominic Spill$ cmake/cleanup.sh
43e6f5b9aaSDominic Spill```
44