バーコード読み取り機能を使う

アプリはBarcodeReaderSDKを組み込むことでバーコード読取り機能を利用することができます。

BarcodeReaderSDKの取り込み方法はSDK仕様書を参照ください。

ダウンロードページ

1．BarcodeReader：カメラとバーコードデコードライブラリを使用した、バーコード読み取り機能

パナソニックが提供するバーコードデコーダー、カメラ制御（リアカメラのみ）、エイマーフラッシュ制御を使用してバーコードを読み取る機能BarcodeReaderが提供する機能は次のとおりです。

• バーコード読取り
  対応するバーコード種別はQR Code／CODE128／GS-128／Codabar（NW7）／CODE39／EAN-8／EAN-13／UPC-A／UPC-Eです。デコード結果として文字列（UTF-8）もしくは、バイナリ列がアプリ側で取得できます。
• プレビュー表示機能
  スキャン中、リアカメラが取得しているプレビュー画像を表示できます。

2．AimerController：エイマーの単独制御機能

バーコードデコーダーやカメラ制御を3rdアプリベンダで用意し、エイマーの点灯、消灯制御のみをする機能

InstalledInformation Java API メソッド

BarcodeReader.Builder API一覧

実際のコードは下記のとおりです。

BarcodeReaderのインスタンスを生成します。この時、BarcodeReaderに対する設定ができます。対象バーコード種別は必ず指定が必要です。

設定値はBarcodeReaderAPI一覧を参照ください。

コードは横スクロールさせて確認することができます。

    BarcodeReader barcodeReader = BarcodeReader.Builder()
        // 対象バーコード種別の設定　例）QRコードとEAN-8を有効にする場合
        .setBarcodeFormats(
                BarcodeReader.FORMAT_QR_CODE,
                BarcodeReader.FORMAT_EAN_JAN_8
        )
        .Builde();

BarcodeReaderを利用可能にするため、LifecyleOwnerに対して1回実行してください。

パラメータにはContextとLifecycleOwnerの指定が必要です。ActivityのonCreateで行う場合以下の例のようになります。

コードは横スクロールさせて確認することができます。

    barcodeReader.bindToLifecycle(
        this, // ActivityをContextとして渡す
        this  // LifecycleOwnerとして渡す
    )

BarcodeReader.scan()を実行することにより、バーコードスキャンを開始します。

スキャンは非同期で行われるため、scan()メソッドはすぐにリターンし、CompletableFuture<Barcode>が返ります。

参考：CompletableFuture | Android Developers

別ウィンドウでAndroid Developersのウェブサイトにリンクします。

コードは横スクロールさせて確認することができます。

    CompletableFuture<Barcode> scanning = barcodeReader.scan();

Completeable<Barcode>のwhenComplete()などを使い、バーコードが読み取れた際の動作を記述します。

whenCompleteのパラメータ（コールバック）であるactionは、下記のいずれかの状態になったときに実行されます。

1．バーコードが読み取れた場合

この場合、第一パラメータであるresultにnullでないBarcodeクラスのインスタンスが入っており、バーコードの種類、読取り結果（文字列／バイナリ）を取得可能。第二パラーメータexはnullとなっている。

• バーコード種別：getFormat（型：String）
• 結果（文字列）：getData（型：String）
• 結果（バイナリ）：getRawData（型：byte[]）

2．スキャン開始（scan()の実行）からバーコードが読めないまま10秒が経過した

この場合、第一パラメータであるresultにnullでないBarcodeクラスのインスタンスが入っており、バーコードの種類、読取り結果（文字列／バイナリ）を取得可能。第二パラーメータexはnullとなっている。第一パラメータのresultはnullとなっており、第二パラメータのexはCancellationExceptionのインスタンスとなっています。

3．エラーが発生した

第一パラメータのresultはnullとなっており、第二パラメータのexは、CancellationException以外のExceptionインスタンスとなっています。

発生する可能性のあるエラーについては、BarcodeReader.scan()のjavadocを参照してください。

コードは横スクロールさせて確認することができます。

    scanning.whenComplete((result, ex) ->{
        // 結果はコールバックとして受け取る
        // ex != nullの場合、キャンセルまたはエラー
        if (ex != null){
            if(ex instanceof CancellationException){
                // タイムアウトによるキャンセルの場合
                // resultText.postValue("Cancelled")
                Log.d(TAG, "scan cancelled");
            }else{
                resulttext.postValue("Error:"+ ex.getMessage());
                ex.printStackTrace();
            }
        } else {
            // バーコード読取りに成功した場合、resultにバーコードの情報が入る
            resultText.postValue(
                String.format(
                    "[%s] %s",
                    result.getFromat(),
                    result.getData()
                )
            );
        }
    })

AimerController API メソッド

実際のコードは下記のとおりです。

BarcodeReaderのインスタンスを生成します。

コードは横スクロールさせて確認することができます。

    AimerController aimerController = AimerController.Builder.builde();

AimerControllerを利用可能にするため、LifecyleOwnerに対して1回実行してください。

パラメータにはContextとLifecycleOwnerの指定が必要です。ActivityのonCreateで行う場合以下の例のようになります。

コードは横スクロールさせて確認することができます。

    aimerController.bindToLifecycle(
        this, // ActivityをContextとして渡す
        this  // LifecycleOwnerとして渡す
    );

AimerController.setAimer(AIMER_ON)を実行することによりエイマーが点滅します。同様にAimerController.setAimer(AIMER_OFF)により消灯します。

setAimer()の戻り値はCompletableFuture<VOID>です。

スキャンは非同期で行われるため、scan()メソッドはすぐにリターンし、CompletableFuture<Barcode>が返ります。

参考：CompletableFuture | Android Developers 

別ウィンドウでAndroid Developersのウェブサイトにリンクします。

CompletableFuture<VOID>のwhenComplete()などを使い、エラー処理を記述できます。

whenCompleteのパラメータ（コールバック）であるactionは、下記のいずれかの状態になったときに実行されます。

1．エイマーの制御に成功
ex = nullでactionが実行される。

2．エイマーの制御に失敗（非対応機種の場合など。通常は発生しない）
ex != nullでactionが実行される。exにはエラー内容が含まれる。

コードは横スクロールさせて確認することができます。

    buttonOn.setOnClickListener(view -> {
        aimerController.setAimer(AimerController.AIMER_ON)
            .whenComplete((result, ex) -> {
                if (ex != null){
                    // エラー処理
                }
            });
    });