Code Monkey home page Code Monkey logo

qreader's Introduction

#QREader Maven Central Android Arsenal

Twitter

Android library using google's mobile vision api to read QR Code

#Integration

  • QREader is available in the MavenCentral, so getting it as simple as adding it as a dependency
compile 'com.github.nisrulz:qreader:1.0.3'

#Usage

  • First add a SurfaceView to your layout and give it an id
<SurfaceView
        android:id="@+id/camera_view"
        android:layout_width="320dp"
        android:layout_height="320dp"/>
  • Then in your Activity code reference the SurfaceView
SurfaceView surfaceView = (SurfaceView) findViewById(R.id.camera_view);
  • Next setup the config with QRDataListener as the last argument in any of the setConfig() calls

    • The default config uses autofocus, back camera and preview size set at 800x800 and is referenced as below
    QREader.getInstance().setUpConfig(new QRDataListener() {
            @Override
            public void onDetected(final String data) {
                Log.d("QREader", "Value : " + data);
                
                // Post data on UI Thread
                textView_qrcode_info.post(new Runnable() {
                    @Override
                    public void run() {
                        textView_qrcode_info.setText(data);
                    }
                });
            }
        });
    • There are other config methods to give you more granular configurations
    // Disable/Enable autofocus
    // Choose between Front facing or Back facing camera | Possible arguments : CameraSource.CAMERA_FACING_BACK /  CameraSource.CAMERA_FACING_FRONT
     public void setUpConfig(boolean autofocus_enabled, int facing, QRDataListener qrDataListener) {
    // Change all the config values
     public void setUpConfig(boolean autofocus_enabled, int width, int height, int facing, QRDataListener qrDataListener) {
  • Call QREader.getInstance().init() with required arguments in your Activity code, to start reading QR code.

QREader.getInstance().init(this, surfaceView);

where

argument type
this Context
surfaceView SurfaceView
  • To start QR code detection
QREader.getInstance().start();
  • To stop QR code detection
QREader.getInstance().stop();
  • To releaseAndCleanup by QREader
QREader.getInstance().releaseAndCleanup();

NOTE :

  1. The library uses android.permission.CAMERA permission implicitly. For Android platforms Marshmallow and above you need to make sure the permission is requested during
    runtime and granted for QREader to function.
  1. The onDetected(final String data) function call returns the data string on a different thread, so in order for you to show the result on the main thread you need to use a handler.
Checkout the sample app for implementation

P.S : You can use this nice QR Code generator to test.

License

Copyright 2016 Nishant Srivastava

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

qreader's People

Contributors

nisrulz avatar warosaurus avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.