AsReader 導入の手引 - AsReader Developer

AsReader 導入の手引
株式会社アスタリスク
2015/05/13 版
AsReader 導入の手引
1. 準備.....................................................................................................................................1
1-1. CocoaPods のインストール .......................................................................................1
1-2. プロジェクトの作成...................................................................................................1
2. ASRManager の導入...........................................................................................................2
2-1. Podfile の作成............................................................................................................2
2-2. ASRManger のインストール ....................................................................................3
3. ASRManager の準備...........................................................................................................5
3-1. 拡張子の変更..............................................................................................................5
3-2. Info.plist ....................................................................................................................7
4. ASRManager の使い方 .......................................................................................................8
4-1. Delegate の指定.........................................................................................................8
4-2. ASRManagerDelegate の実装 ................................................................................10
AsReader 導入の手引
1. 準備
1-1. CocoaPods のインストール
インストールされていない場合は、CocoaPods のインストールを行います。Mac の「ア
プリケーション」→「ユーティリティ」を開き、「ターミナル.app」を起動します。すでに
インストールされている方は、飛ばしていただいても構いません。
ターミナルを開いたら、(1)のコマンドを打ちます。エンターキーを押すとパスワードを
求められるので、Mac に設定しているパスワードを入力して、インストールを開始します。
… (1)
sudo gem install cocoapods
インストールが完了したら、(2)のコマンドを打ってセットアップを行います。
… (2)
pod setup
ターミナルに Setup completed の文字が表示されていたら、CocoaPods のインストール
は完了です。
1-2. プロジェクトの作成
Xcode から AsReader を組み込みたいプロジェクトを開きます。
例では、図 1 のように新規でプロジェクト（ AsReaderTestProject ）を作成します。
図 1 新規プロジェクトの作成
1
AsReader 導入の手引
2. ASRManager の導入
2-1. Podfile の作成
CocoaPods でライブラリをインストールするために必要な Podfile というファイルを作
成します。テキストエディタを使用して、図 2 のファイルを作成します。拡張子はありま
せん。
図 2 Podfile
作成した Podfile をプロジェクトフォルダに保存します。
図 3 のように、プロジェクト名.xcodeproj と同じ場所に保存してください。
図 3 Podfile の保存場所
2
AsReader 導入の手引
2-2. ASRManger のインストール
Podfile を保存したら、Mac の「アプリケーション」→「ユーティリティ」を開き、
「ターミナル.app」を起動します。ターミナルを起動したら、cd コマンドを使用し、図 4
のように Podfile を保存したプロジェクトフォルダまで移動します。
フォルダまで移動が完了したら、(3)のコマンドを打ち、エンターキーを押します。
… (3)
pod install
図 4 ターミナル
エンターキーを押すと、ASRManager のインストールが始まります。
図 5 のように、Generating Pods project、Integrating client project と表示されていれ
ば、インストールは完了です。
図 5 ターミナル（インストール完了）
また、ASRManager が更新された場合は、(4)のコマンドを実行するだけで、最新の
ASRManager をインストールすることができます。
… (4)
pod update
3
AsReader 導入の手引
ターミナルを閉じて、図 6 のように、Podfile を保存したフォルダに、
「Pods」フォルダ、
「プロジェクト名.xcworkspace」、「Podfile.lock」の 3 種類のファイルが作成されたことを
確認します。
ここからは、プロジェクト名.xcworkspace を使用してプログラムを実装していきます。
図 6 作成されたファイル
4
AsReader 導入の手引
3. ASRManager の準備
3-1. 拡張子の変更
プロジェクト名.xcworkspace を開いて、図 7 のように、新しくファイルが追加されてい
ることを確認します。
図 7 追加された Pods ファイル
5
AsReader 導入の手引
また、ASRManager を使用するために、任意のソースファイルの拡張子を図 8 のように
「ソースファイル名.m」から「ソースファイル名.mm」に変更します。
(a) 変更前
(b) 変更後
図 8 拡張子の変更
6
AsReader 導入の手引
3-2. Info.plist
Info.plist ファイルを開き、図 9 のように Supported external accessory protocols を追加
します。Information Property List にクリックすると、文字の横に＋のボタンが表示され
ますので、そこから Supported external accessory protocols を選択して、追加します。
図 9 Info.plist への追加
Supported external accessory protocols の左にある三角形のボタンを押すと、アイテム
一覧が表示されます。また Supported external accessory protocols の右にある＋ボタンを
押すと、アイテム名を追加することができます。図 10 のように、新しく追加した項目に
「jp.co.asx.asreader.barcode」を記載します。
図 10 識別子の追加
7
AsReader 導入の手引
4. ASRManager の使い方
4-1. Delegate の指定
図 11 のように、AsReader の処理を呼び出したいクラスで、ASRManager クラスをイン
ポートし、ASRManagerDelegate を継承します。
図 11 インポートと継承
8
AsReader 導入の手引
図 12 のように、-(void) viewWillApper:(BOOL)animaited メソッドで、Delegate の指定
を行います。また、画面が遷移する場合は、-(void) viewWillDisapper:(BOOL)animaited
メソッドで、Delegate の破棄を行います。
Delegate の破棄は、[ASRManager sharedInstance].delegate = nil; で行います。
図 12 Delegate の設定
9
AsReader 導入の手引
4-2. ASRManagerDelegate の実装
最後に図 13 のように、Delegate メソッドを実装します。
図 13 Delegate メソッドの実装
10
AsReader 導入の手引
各 Delegate メソッドは、表 1 の状態になった場合に呼び出されます。
必要に応じて、処理を実装してください。
表 1 ASRManagerDelegate
Delegate メソッド
説明
AsReader との接続状態が更新されたら実行されます。
isPlugged が TRUE なら接続状態、
ASRManagerPlugged
FALSE なら切断状態です。
ASRManagerOnBarcodeScanned
バーコード読み取り時に実行されます。
value に読み取ったバーコードの値が入っています。
バッテリー状態を受け取ったら実行されます。
ASRManagerBattery
5 秒に 1 回のペースでバッテリー状態を受け取り、
battery に AsReader のバッテリー残量の値が入って
います。
また、ASRManager は、表 2 のメソッドも提供しています。
表 2 ASRManager メソッド
メソッド
説明
open
AsReader との接続を開始し、電源を ON にします。
close
AsReader の電源を OFF にし、接続を切断します。
setBarcodeEncoding
読み取ったバーコードの値をエンコードする種類を
設定します。
デフォルトは、NSShiftJISStringEncoding です。
startReadBarcodeOnce
レーザー照射を開始します。
stopReadBarcode
レーザー照射を停止します。
Xcode で実行できれば、AsReader の導入は完了です。
※本説明では、Xcode （Version 6.3.1）を使用しています。
11

Download Report