mirror of
https://github.com/rad1o/hackrf_android.git
synced 2026-03-06 02:04:13 +01:00
Added Readme and clarified License Texts
This commit is contained in:
Dennis Mantz
63
Readme.md
Normal file
63
Readme.md
Normal file
@@ -0,0 +1,63 @@
|
||||
HackRF Library for Android
|
||||
==========================
|
||||
|
||||
This repository is a ported version of Michael Ossmann's libhackrf
|
||||
([https://github.com/mossmann/hackrf/tree/master/host/libhackrf]
|
||||
(https://github.com/mossmann/hackrf/tree/master/host/libhackrf))
|
||||
library to work with Android 3.1+.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
(photo by Dennis Mantz)
|
||||
|
||||
See [http://tech.mantz-it.com](http://tech.mantz-it.com) and @dennismantz for updates.
|
||||
|
||||
|
||||
Implemented Features
|
||||
--------------------
|
||||
* Open HackRF (including the USB permission request)
|
||||
* Reading Board ID from HackRF
|
||||
* Reading Version from HackRF
|
||||
* Reading Part ID and Serial Number from HackRF
|
||||
* Setting Sample Rate of HackRF
|
||||
* Setting Frequency of HackRF
|
||||
* Setting Baseband Filter Width of HackRF
|
||||
* Compute Baseband Filter Width for given Sample Rate
|
||||
* Setting VGA Gain (Rx/Tx) of HackRF
|
||||
* Setting LNA Gain of HackRF
|
||||
* Setting Amplifier of HackRF
|
||||
* Setting Antenna Port Power of HackRF
|
||||
* Setting Transceiver Mode of HackRF
|
||||
* Receiving from the HackRF using a BlockingQueue
|
||||
* Get Transmission statistics
|
||||
* Example App that shows how to use the library
|
||||
|
||||
|
||||
Known Issues
|
||||
------------
|
||||
* USB connection is too slow for Sample Rates >15 Msps (testet on Nexus 7)
|
||||
* Tx not implemented yet
|
||||
* FileWriter in example app is too slow. Only works for ~ 2 Msps.
|
||||
* Not much testing so far...
|
||||
|
||||
|
||||
Installation / Usage
|
||||
--------------------
|
||||
If you want to use the library in your own app, just copy the bin/hackrf_android.jar
|
||||
file into your project and include it as a library. See the example project to
|
||||
learn how to use the library.
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2 of the License, or (at your option) any later version.
|
||||
[http://www.gnu.org/licenses/gpl.html](http://www.gnu.org/licenses/gpl.html) GPL version 2 or higher
|
||||
|
||||
principal author: Dennis Mantz <dennis.mantzgooglemail.com>
|
||||
|
||||
principal author of libhackrf: Michael Ossmann <mikeossmann.com>
|
||||
@@ -31,17 +31,35 @@ import android.widget.Toast;
|
||||
*
|
||||
* @author Dennis Mantz
|
||||
*
|
||||
* Copyright (C) 2014 Dennis Mantz
|
||||
* based on code of libhackrf [https://github.com/mossmann/hackrf/tree/master/host/libhackrf]:
|
||||
* Copyright (c) 2012, Jared Boone <jared@sharebrained.com>
|
||||
* Copyright (c) 2013, Benjamin Vernoux <titanmkd@gmail.com>
|
||||
* Copyright (c) 2013, Michael Ossmann <mike@ossmann.com>
|
||||
* All rights reserved.
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
* - Redistributions of source code must retain the above copyright notice, this list
|
||||
* of conditions and the following disclaimer.
|
||||
* - Redistributions in binary form must reproduce the above copyright notice, this
|
||||
* list of conditions and the following disclaimer in the documentation and/or other
|
||||
* materials provided with the distribution.
|
||||
* - Neither the name of Great Scott Gadgets nor the names of its contributors may be
|
||||
* used to endorse or promote products derived from this software without specific
|
||||
* prior written permission.
|
||||
* License: http://www.gnu.org/licenses/gpl.html GPL version 2 or higher
|
||||
*
|
||||
* This library is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU Lesser General Public
|
||||
* modify it under the terms of the GNU General Public
|
||||
* License as published by the Free Software Foundation; either
|
||||
* version 2.1 of the License, or (at your option) any later version.
|
||||
* version 2 of the License, or (at your option) any later version.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* Lesser General Public License for more details.
|
||||
* General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public
|
||||
* You should have received a copy of the GNU General Public
|
||||
* License along with this library; if not, write to the Free Software
|
||||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
*/
|
||||
|
||||
@@ -11,17 +11,20 @@ package com.mantz_it.hackrf_android;
|
||||
*
|
||||
* @author Dennis Mantz
|
||||
*
|
||||
* Copyright (C) 2014 Dennis Mantz
|
||||
* License: http://www.gnu.org/licenses/gpl.html GPL version 2 or higher
|
||||
*
|
||||
* This library is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU Lesser General Public
|
||||
* modify it under the terms of the GNU General Public
|
||||
* License as published by the Free Software Foundation; either
|
||||
* version 2.1 of the License, or (at your option) any later version.
|
||||
* version 2 of the License, or (at your option) any later version.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* Lesser General Public License for more details.
|
||||
* General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public
|
||||
* You should have received a copy of the GNU General Public
|
||||
* License along with this library; if not, write to the Free Software
|
||||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
*/
|
||||
|
||||
@@ -9,17 +9,20 @@ package com.mantz_it.hackrf_android;
|
||||
*
|
||||
* @author Dennis Mantz
|
||||
*
|
||||
* Copyright (C) 2014 Dennis Mantz
|
||||
* License: http://www.gnu.org/licenses/gpl.html GPL version 2 or higher
|
||||
*
|
||||
* This library is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU Lesser General Public
|
||||
* modify it under the terms of the GNU General Public
|
||||
* License as published by the Free Software Foundation; either
|
||||
* version 2.1 of the License, or (at your option) any later version.
|
||||
* version 2 of the License, or (at your option) any later version.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* Lesser General Public License for more details.
|
||||
* General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public
|
||||
* You should have received a copy of the GNU General Public
|
||||
* License along with this library; if not, write to the Free Software
|
||||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user