-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README with initial usage instructions
- Loading branch information
Showing
1 changed file
with
33 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,40 @@ | ||
# Band Detection [](https://travis-ci.org/Shelnutt2/BandDetection) [](https://coveralls.io/github/Shelnutt2/BandDetection?branch=master) | ||
|
||
This library is designed for root qualcomm android devices. | ||
This library is designed for rooted qualcomm android devices. | ||
|
||
This library is experimental and is missing all safety checks. Use this | ||
at your own risk. | ||
|
||
## Documentation | ||
|
||
Java docs are available here: | ||
[http://shelnutt2.github.io/BandDetection/](http://shelnutt2.github.io/BandDetection/) | ||
|
||
## Usage | ||
|
||
This library requires root and uses RootTools for access. | ||
|
||
Include this in your gradle dependencies | ||
|
||
``` | ||
compile 'nu.shel.banddetection:banddetection:0.9.0' | ||
``` | ||
|
||
To get the band call the static function BandDetection.DetectBand. | ||
This will find the modem serial device, get earfcn and translate it to | ||
a band object. | ||
|
||
```java | ||
LTEBand currentBand = BandDetection.DetectBand(); | ||
``` | ||
|
||
## Advanced Usage | ||
|
||
This library also provides a way to run raw commands on the modem. | ||
|
||
```java | ||
// Create new modem object | ||
Modem mModem = new Modem(); | ||
// Run "AT" serial command and get output in ArrayList of each line. | ||
ArrayList<String> output = mModem.RunModemCommand("AT"); | ||
``` |