# メソッド ## shared シングルトンAsReaderAskオブジェクトを作成します。 ```swift class func shared() -> AsReaderAsk! ``` ### 戻り値 ```{list-table} :align: left :class: list-table * - 型 - 説明 * - AsReaderAsk - AsReaderAskのシングルトンオブジェクトを返す ``` ### サンプルコード ```swift let ask = AsReaderAsk.shared() ``` --- ## sendPower AsReader の電源・ビープ音・バイブレーションのステータスを設定するメソッドです。 本メソッドが成功すると、設定結果は [onReceivedPowerState](AsReaderAsk_delegate.md#onreceivedpowerstate) デリゲートを通じてコールバックされます。 ### 使用条件 AsReader が接続され、[onReceivedConnectedState](AsReaderAsk_delegate.md#onreceivedconnectedstate) デリゲートがコールバックされて `isConnected` が `true` の場合に、本メソッドを使用できます。 ```swift func sendPower( on isOn: Bool, setBeep isBeep: Bool, setVib isVib: Bool, setLed isLED: Bool ) -> Bool ``` ### パラメータ ```{list-table} :align: left :class: list-table * - 項目名 - 型 - 説明 * - isOn - Bool - AsReader の電源スイッチ true：オン false：オフ * - isBeep - Bool - データを受け取る際のビープ音スイッチ true：オン false：オフ * - isVib - Bool - データを受け取る際のバイブレーションスイッチ true：オン false：オフ * - isLED - Bool - LED スイッチ（現バージョンでは未使用） ``` ### 戻り値 ```{list-table} :align: left :class: list-table * - 型 - 説明 * - Bool - メソッドの実行結果 true：成功 false：失敗 ``` ### サンプルコード ```swift let status: Bool = ask.sendPower(on: true, setBeep: true, setVib: true, setLed: true) if status { // メソッドの呼び出し：成功 } else { // メソッドの呼び出す：失敗 } ``` --- ## sendSettingBeep AsReader の電源が ON の状態で、ビープ音とバイブレーションのステータスを設定するメソッドです。 メソッドの実行が成功すると、設定結果は [onReceivedReaderSettingBeep](AsReaderAsk_delegate.md#onreceivedreadersettingbeep) デリゲートを通じてコールバックされます。 ### 使用条件 AsReader の電源が ON になったあと、[onReceivedPowerState](AsReaderAsk_delegate.md#onreceivedpowerstate) デリゲートがコールバックされ、 そのコールバックパラメータ `isOn` が `true` の場合に、このメソッドを呼び出すことができます。 ```swift func sendSettingBeep( _ isBeep: Bool, setVib isVib: Bool, setLed isLED: Bool ) -> Bool ``` ### パラメータ ```{list-table} :align: left :class: list-table * - 項目名 - 型 - 説明 * - isBeep - Bool - データを受け取る際のビープスイッチ true：オン false：オフ * - isVib - Bool - データを受け取る際のバイブレーションスイッチ true：オン false：オフ * - isLED - Bool - 未使用（現バージョンでは未使用） ``` ### 戻り値 ```{list-table} :align: left :class: list-table * - 型 - 説明 * - Bool - メソッドの実行結果を返す true：成功 false：失敗 ``` ### サンプルコード ```swift let status: Bool = ask.sendSettingBeep( true, setVib: true, setLed: true ) if status { // メソッドの呼び出し：成功 } else { // メソッドの呼び出し：失敗 } ``` --- ## setAsReaderAskLogOn AsReaderAsk のログ機能をオンまたはオフに設定します。 ⚠️ デフォルトはオフです。 ログファイルはアプリのサンドボックス内、`/Documents/AsReader.log` に保存されます。 このファイルは iTunes 経由で取得できます。 AsReader のログファイルの取得方法については、[ログファイルを取得](Log.md)」をご参照ください。 ```swift func setAsReaderAskLogOn(_ on: Bool) ``` ### パラメータ ```{list-table} :align: left :class: list-table * - 項目名 - 型 - 説明 * - on - Bool - true：Log機能をオンにする false：Log機能をオフにする ``` ### サンプルコード ```swift ask.setAsReaderAskLogOn(true) ``` --- ## removeAllAsReaderAskLog AsReaderAskのLogをクリアします。 ```swift func removeAllAsReaderAskLog() ``` ### サンプルコード ```swift ask.removeAllAsReaderAskLog() ``` --- ## setTriggerModeDefault トリガーキーが押されたときに、デフォルトの動作を自動で実行するか、 それともイベントとしてアプリ側に通知し、アプリ側で制御するかを設定します。 ASR-06X の場合、デフォルトの動作は設定されていないため、初期状態では何も処理されません。 トリガーの押下イベントをアプリ側で取得するには、`isDefault` を `false` に設定する必要があります。 `isDefault` が `false` の場合、トリガーを押してから離すと、 [`onReceivedTriggerState`](AsReaderAsk_delegate.md#onreceivedtriggerstate) デリゲートでトリガーの状態がコールバックされます。 ### 使用条件 AsReader への接続が成功し、[`onReceivedConnectedState`](AsReaderAsk_delegate.md#onreceivedconnectedstate) デリゲートがコールバックされ、 そのパラメータ `isConnected` が `true` の場合に、このメソッドを呼び出すことができます。 ```swift func setTriggerModeDefault(_ isDefault: Bool) ``` ### パラメータ ```{list-table} :align: left :class: list-table * - 項目名 - 型 - 説明 * - isDefault - Bool - true：トリガーキーでスキャンを自動実行する false：トリガーキー押下をイベントとして通知し、アプリで制御する ``` ### サンプルコード ```swift ask.setTriggerModeDefault(false) ``` --- ## makeBeep 現在接続されている AsReader のビープ音を鳴らします。 ### 使用条件 AsReader への接続が成功し、 [`onReceivedConnectedState`](AsReaderAsk_delegate.md#onreceivedconnectedstate)デリゲートがコールバックされ、 そのパラメータ `isConnected` が `true` の場合に、このメソッドを呼び出すことができます。 ⚠️ この機能は **ASR-061D** のみに対応しています。 ```swift func makeBeep() -> Bool ``` ### 戻り値 ```{list-table} :align: left :class: list-table * - 型 - 説明 * - Bool - メソッドの実行結果 true：成功 false：失敗 ``` ### サンプルコード ```swift let status: Bool = ask.makeBeep() if status { // メソッド呼び出し：成功 } else { // メソッド呼び出し：失敗 } ``` --- ## makeVibration 現在接続されているAsReaderを振動させます。 ### 使用条件 AsReader への接続が成功し、 [`onReceivedConnectedState`](AsReaderAsk_delegate.md#onreceivedconnectedstate)デリゲートがコールバックされ、 そのパラメータ `isConnected` が `true` の場合に、このメソッドを呼び出すことができます。 ⚠️ この機能は **ASR-061D** のみに対応しています。 ```swift func makeVibration() -> Bool ``` ### 戻り値 ```{list-table} :align: left :class: list-table * - 型 - 説明 * - Bool - メソッドの実行結果 true：成功 false：失敗 ``` ### サンプルコード ```swift let status: Bool = ask.makeVibration() if status { // メソッド呼び出し：成功 } else { // メソッド呼び出し：失敗 } ``` --- ## makeBeepVibration 現在接続されているAsReaderのビープ音を鳴らし、同時に振動させます。 ### 使用条件 AsReader への接続が成功し、 [`onReceivedConnectedState`](AsReaderAsk_delegate.md#onreceivedconnectedstate)デリゲートがコールバックされ、 そのパラメータ `isConnected` が `true` の場合に、このメソッドを呼び出すことができます。 ⚠️ この機能は **ASR-061D** のみに対応しています。 ```swift func makeBeepVibration() -> Bool ``` ### 戻り値 ```{list-table} :align: left :class: list-table * - 型 - 説明 * - Bool - メソッドの実行結果 true：成功 false：失敗 ``` ### サンプルコード ```swift let status: Bool = ask.makeBeepVibration() if status { // メソッド呼び出し：成功 } else { // メソッド呼び出し：失敗 } ``` --- ## connectBluetooth Bluetooth で **ASR-M060DB** に接続します。 このメソッドを実行すると、Bluetooth 接続ステータスが [`onReceivedBLEConnectedState`](AsReaderAsk_delegate.md#onreceivedbleconnectedstate) デリゲートを通じてコールバックされます。 ⚠️ この機能は **ASR-M060DB** のみに対応しています。 ```swift func connectBluetooth(bluetoothModule: BluetoothModule!) ``` ### パラメータ ```{list-table} :align: left :class: list-table * - 項目名 - 型 - 説明 * - bluetoothModule - BluetoothModule - Bluetooth で接続可能な AsReader （[BluetoothModule](BluetoothModule.md) を参照） ``` ### サンプルコード ```swift ask.connectBluetooth(bluetoothModule) ``` --- ## disConnectBluetooth Bluetooth で **ASR-M060DB** との接続を切断します。 このメソッドを実行すると、Bluetooth 接続ステータスが [`onReceivedBLEConnectedState`](AsReaderAsk_delegate.md#onreceivedbleconnectedstate) デリゲートを通じてコールバックされます。 ⚠️ この機能は **ASR-M060DB** のみに対応しています。 ```swift func disConnectBluetooth() ``` ### サンプルコード ```swift ask.disConnectBluetooth() ```