Popularity
4.2
Growing
Activity
0.0
Stable
325
12
95

Description

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.

Code Quality Rank: L4
Programming language: Java
Tags: QRCode     Reader     Vision     Component    

QREader alternatives and similar packages

Based on the "QRCode" category

Do you think we are missing an alternative of QREader or a related project?

Add another 'QRCode' Package

README

[Image](img/github_banner.png)

Specs

API

Android Arsenal AndroidDev Digest

Show some :heart:

GitHub stars GitHub forks GitHub watchers GitHub followers Twitter Follow

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.

Integration

QREader is available in the Jcenter, so getting it as simple as adding it as a dependency

  • For gradle version < 4.0

    compile 'com.github.nisrulz:qreader:{latest version}'
    
  • For gradle 4.0+

    implementation 'com.github.nisrulz:qreader:{latest version}'
    

where {latest version} corresponds to published version in Download

Usage Docs

Steps

  1. Add a SurfaceView to your layout
  <SurfaceView
    android:id="@+id/camera_view"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:layout_above="@+id/info"
    />
  1. Setup SurfaceView and QREader in onCreate()
  // 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()
    @Override
    protected void onResume() {
      super.onResume();

      // Init and Start with SurfaceView
      // -------------------------------
      qrEader.initAndStart(mySurfaceView);
    }
  1. Cleanup in onPause()
    @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
    boolean isCameraRunning = qrEader.isCameraRunning()
    
  • To stop QREader

      qrEader.stop();
    
  • To start QREader

      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 first, before filing an issue.
  6. Have fun!

Created & Maintained By

Nishant Srivastava (@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
  • Bitcoin Address: 13PjuJcfVW2Ad81fawqwLtku4bZLv1AxCL