Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nisrulz/qreader
:white_square_button: [Android Library] Read QR codes using google's mobile vision api, but without the hassle
https://github.com/nisrulz/qreader
android android-library qrcode reader
Last synced: 7 days ago
JSON representation
:white_square_button: [Android Library] Read QR codes using google's mobile vision api, but without the hassle
- Host: GitHub
- URL: https://github.com/nisrulz/qreader
- Owner: nisrulz
- License: apache-2.0
- Created: 2016-03-10T18:36:51.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-10-29T00:42:24.000Z (over 3 years ago)
- Last Synced: 2025-01-18T21:43:40.854Z (14 days ago)
- Topics: android, android-library, qrcode, reader
- Language: Java
- Homepage: http://nisrulz.github.io/qreader
- Size: 727 KB
- Stars: 372
- Watchers: 13
- Forks: 108
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
### Specs
[](https://android-arsenal.com/api?level=14)
### Badges/Featured In
[](https://android-arsenal.com/details/1/3478) [](https://www.androiddevdigest.com/digest-121/)
### Show some :heart:
[](https://github.com/nisrulz/qreader) [](https://github.com/nisrulz/qreader/fork) [](https://github.com/nisrulz/qreader) [](https://github.com/nisrulz/qreader)
[](https://twitter.com/nisrulz)
Android library which makes use of Google's Mobile Vision API to enable reading QR Code.
The library is built for simplicity and ease of use. It not only eliminates most boilerplate code for dealing with setting up QR Code reading , but also provides an easy and simple API to retrieve information from QR Code quickly.
> Requires Google Play Services
# Changelog
Starting with `1.0.4`, Changes exist in the [releases tab](https://github.com/nisrulz/qreader/releases).
#Integration
QREader is available in the Jcenter, so getting it as simple as adding it as a dependency
- For gradle version < 4.0
```gradle
compile 'com.github.nisrulz:qreader:{latest version}'
```
- For gradle 4.0+
```gradle
implementation 'com.github.nisrulz:qreader:{latest version}'
```
where `{latest version}` corresponds to published version in [  ](https://bintray.com/nisrulz/maven/com.github.nisrulz%3Aqreader/_latestVersion)
# Usage Docs
### Steps
1. Add a `SurfaceView` to your layout
```xml
```
1. Setup `SurfaceView` and `QREader` in `onCreate()`
```java
// QREader
private SurfaceView mySurfaceView;
private QREader qrEader;
..
@Override
protected void onCreate(final Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
..
..
// Setup SurfaceView
// -----------------
mySurfaceView = (SurfaceView) findViewById(R.id.camera_view);
// Init QREader
// ------------
qrEader = new QREader.Builder(this, mySurfaceView, new QRDataListener() {
@Override
public void onDetected(final String data) {
Log.d("QREader", "Value : " + data);
text.post(new Runnable() {
@Override
public void run() {
text.setText(data);
}
});
}
}).facing(QREader.BACK_CAM)
.enableAutofocus(true)
.height(mySurfaceView.getHeight())
.width(mySurfaceView.getWidth())
.build();
}
```
1. Initialize and Start in `onResume()`
```java
@Override
protected void onResume() {
super.onResume();
// Init and Start with SurfaceView
// -------------------------------
qrEader.initAndStart(mySurfaceView);
}
```
1. Cleanup in `onPause()`
```java
@Override
protected void onPause() {
super.onPause();
// Cleanup in onPause()
// --------------------
qrEader.releaseAndCleanup();
}
```
1. Some provided utility functions which you can use
+ To check if the camera is running
```java
boolean isCameraRunning = qrEader.isCameraRunning()
```
+ To stop `QREader`
```java
qrEader.stop();
```
+ To start `QREader`
```java
qrEader.start();
```
> ##### Check the included sample app for a working example.
# Pull Requests
I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:
1. Match coding style (braces, spacing, etc.) This is best achieved using CMD+Option+L (Reformat code) on Mac (not sure for Windows) with Android Studio defaults.
2. If its a feature, bugfix, or anything please only change code to what you specify.
3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
4. Pull requests _must_ be made against `develop` branch. Any other branch (unless specified by the maintainers) will get rejected.
5. Check for existing [issues](https://github.com/nisrulz/qreader/issues) first, before filing an issue.
6. Have fun!
### Created & Maintained By
[Nishant Srivastava](https://github.com/nisrulz/nisrulz.github.io) ([@nisrulz](https://www.twitter.com/nisrulz))
> If you found this library helpful or you learned something from the source code and want to thank me, consider buying me a cup of :coffee:
> + [PayPal](https://www.paypal.me/nisrulz/5)
> + Bitcoin Address: 13PjuJcfVW2Ad81fawqwLtku4bZLv1AxCL