Star_mBridge Framework Ver 2.0.2

概要

Star_mBridge.xcframework は、スター精密が提供するmC-Bridgeを制御するframeworkです。

用語の定義
対象環境
ライブラリを追加する
1. CocoaPodsを使用する場合
2. 手動でリンクする場合
ターゲット装置用にmC-Bridgeの設定を変更する
1. 自動釣銭機を接続する場合
API
ログについて
1. ログファイルの保存条件と場所
2. ログのフォーマット

用語の定義

本ドキュメントで使われる用語について定義します。

単語	定義内容
ホスト	iOS端末
ターゲット装置	ホストからmC-Bridgeを経由して制御する装置

対象環境

OS:

iOS 10.0 - 17.4.1

XCode:

Xcode 15.3

ライブラリを追加する

ライブラリはCocoaPodsとxcframeworkに対応しています。アプリケーション構成に合わせてライブラリを追加してください。(このSDKをテストする場合、そのまま利用できます)

CocoaPodsを使用する場合

以下のコードをPodfileに挿入します。

pod 'Star_mBridge', '2.0.2'

以下のコマンドを実行します。

pod install

手動でリンクする場合

Build Phases タブの "Link Binary With Libraries" に Star_mBridge.xcframework を追加します。

ターゲット装置用にmC-Bridgeの設定を変更する

自動釣銭機を接続する場合

mC-Bridgeのシリアル設定を自動釣銭機に合わせてください。設定方法はmC-Bridgeのオンラインマニュアルを確認してください。

	通信速度	フロー制御	データビット数	パリティビット
mC-Bridge 工場出荷時設定	9600bps	ハードウェア	7	偶数
グローリー製自動釣銭機対応機機 : RAD-300/RT-300, RAD-N300/RT-N300	9600bps	ハードウェア	7	偶数
富士電機製自動釣銭機対応機機 : ECS-777 [mC-Bridge (F/W Ver. 1.3以降)]	9600bps	なし	8	偶数

API

SMBDiscoveryDevice

このclassは、mC-Bridgeを検索し、制御用のインスタンスを生成します。

プロパティ	SDKバージョン
delegate: SMBBridgeManagerDelegate? メソッドの実行結果を処理するDelegateオブジェクト	1.0.0+

Public メソッド	SDKバージョン
discover(_ type: SMBBridgeType) -> Bool mC-Bridgeの検索を開始します。検索されたmC-Bridgeに対し、typeで指定された種類の制御インスタンスを生成し、SMBBridgeManagerDelegateにて通知します。	1.0.0+

SMBBridgeManagerDelegate

このprotocolは、SMBDiscoveryDeviceの結果を受信するために使用されます。

Public メソッド	SDKバージョン
bridgeManager(_ deviceManager: SMBBridgeManager, didFind machine: SMBCashHandlingMachine) 検索されたmC-BridgeへのSMBBridge型の制御インスタンスを通知します。	1.0.0+
bridgeManager(_ deviceManager: SMBBridgeManager, didFind bridge: SMBBridge) 検索されたmC-BridgeへのSMBCashHandlingMachine型の制御インスタンスを通知します。	1.0.0+
bridgeManagerDidFinishDiscovery(_ deviceManager: SMBBridgeManager) mC-Bridge検索の完了を通知します。	1.0.0+

SMBBridgeType

このNS_ENUMは、SMBDiscoveryDeviceで検索した際に、受け取る制御インスタンスの種類を指定するために使用します。

内容	SDKバージョン
Bridge SMBBridgeインスタンスを表す	1.0.0+
CashHandlingMachine_Glory CashHandlingMachineインスタンスを表します。(グローリー)	2.0.0+
CashHandlingMachine_FujiElectric CashHandlingMachineインスタンスを表します。(富士電機)	2.0.0+

SMBBridge

このclassは、mC-Bridgeを制御するための基底クラスです。基本的な通信APIが定義されています。

プロパティ	SDKバージョン
isConnected: Bool mC-Bridgeとの通信の接続状態を示します。	1.0.0+
settings: SMBSettingData mC-Bridgeとの接続設定を示します。設定の詳細はSMBSettingDataクラスを参照してください。	1.0.0+

Public メソッド	SDKバージョン
version() -> String ライブラリのバージョンを取得します。	1.0.0+
initWithSettings(settings: SMBSettingData) -> SMBridge? settingsの設定を持つSMBBridgeインスタンスを生成します。	1.0.0+
openPort() -> Int mC-Bridgeと通信の接続を行います。SMBSettingData.openTimeoutで指定された時間を越えるとタイムアウトします。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。 openPortからclosePortまでmC-Bridgeとの接続状態が維持されますが、他のアプリケーションへの遷移やスリープ状態への遷移が想定される場合、接続状態に関する実装上の配慮が必要となります。	1.0.0+
closePort() -> Int mC-Bridgeと通信の切断を行います。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。	1.0.0+
write(_ data: Data) -> Int ターゲット装置にdataを送信します。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。	1.0.0+
readDataWithErrorCode(_ errorCode: UnsafeMutablePointer) -> Data ターゲット装置からmC-Bridgeが受信したデータを取得します。実行結果をerrorCodeで取得できます。データの受信にSMBSettingData.timeoutで指定された時間を越えるとタイムアウトします。実行結果の種類はSMBCode.hにて定義されています。	1.0.0+
readData(withSize size: Int, errorCode: UnsafeMutablePointer) -> Data ターゲット装置からmC-Bridgeが受信したデータについて、sizeで指定した分取得します。受信したデータの総量がsizeよりも少ない場合は、受信したデータの総量分のみ取得できます。データの受信時間がSMBSettingData.timeoutで指定された時間を越えるとエラーコードを返します。実行結果をerrorCodeで取得できます。実行結果の種類はSMBCode.hにて定義されています。	1.0.0+
readData(untilSize size: Int, errorCode: UnsafeMutablePointer) -> Data ターゲット装置からmC-Bridgeが受信したデータについて、sizeで指定した分までの取得を試みます。受信したデータの総量がsizeよりも少ない場合は、指定した量のデータを受信するまで待ちます。データの受信時間がSMBSettingData.timeoutで指定された時間を越えるとエラーコードを返します。実行結果をerrorCodeで取得できます。実行結果の種類はSMBCode.hにて定義されています。	1.0.0+
getStatusWithErrorCode(_ errorCode: UnsafeMutablePointer) -> SMBBridgeStatus? mC-Brigeのステータスを取得します。取得ステータスの詳細はSMBBridgeStatusを参照ください。実行結果をerrorCodeで取得できます。実行結果の種類はSMBCode.hにて定義されています。	1.0.0+

SMBSettingData

このclassは、mC-Bridgeとの通信設定を格納しているdata classです。

プロパティ	SDKバージョン
portName: String! 接続先のポート名を表します。LAN接続の場合、次のうちいずれかの指定が出来ます。 TCP:IPアドレス IPアドレスを用いて接続先を指定できます。(SDKバージョン 1.0.0+） TCP:MACアドレス MACアドレスを用いて接続先を指定できます。(SDKバージョン 1.1.0+）本指定ではUDPを用いた通信も行うため稀ではありますが、接続できない場合があります。その場合、再度接続を試みてください。	1.0.0+
openTimeout: UInt32 mC-Bridgeとの通信の確立時に用いるタイムアウト値（ミリ秒）を表します。	1.0.0+
timeout: UInt32 mC-Bridgeとの通信時に用いるタイムアウト値（ミリ秒）を表します。	1.0.0+
targetDeviceTimeout: UInt32 ターゲット装置との通信時に、ターゲット装置がBusy状態の時に用いるタイムアウト値（ミリ秒）を表します。１秒以下は切り捨てられます。0秒が指定された場合はタイムアウト時間が無限大となります。	1.0.0+
macAddress: String! SMBDiscoveryDeviceで検索された場合に、mC-BridgeのMACアドレスを示します。	1.0.0+

SMBBridgeStatus

このclassは、mC-Bridgeとのステータス情報を格納しているdata classです。

プロパティ	SDKバージョン
isComConnect: Bool mC-Bridgeにシリアルケーブルが接続されている場合はtrueとなります。falseの場合は接続されていません。	1.0.0+
isLanConnect: Bool mC-BridgeにLANケーブルが接続されている場合はtrueとなります。falseの場合は接続されていません。	1.0.0+
isExistsReceivedData: Bool mC-Bridgeにターゲット装置から受信したデータが存在し、上位ホストに未送信の場合はtrueとなります。falseの場合、未送信データは存在しません。	1.0.0+
isExistsSendData: Bool mC-Bridgeにターゲット装置への未送信データが存在するはtrueとなります。falseの場合、未送信データは存在しません。	1.0.0+

SMBCashHandlingMachineFactory

SMBCashHandlingMachineを生成するclassです。

メソッド	SDKバージョン
createSMBCashHandlingMachine(_ type: SMBCashHandlingMachineType, settings: SMBSettingData) -> SMBCashHandlingMachine SMBCashHandlingMachineを生成します。	2.0.0+

SMBCashHandlingMachineType

このNS_ENUMは、SMBCashHandlingMachineFactoryで生成するインスタンスの種類を指定するために使用します。

内容	SDKバージョン
glory グローリー製自動釣銭機を表します。	2.0.0+
fujiElectric 富士電機製自動釣銭機を表します。	2.0.0+

SMBCashHandlingMachine

このclassは、ターゲット装置として自動釣銭機が接続されている場合の制御インスタンスです。また、SMBBridgeクラスの派生クラスです。自動釣銭機本体の設定によって、APIの実行結果を取得できるタイミングが異なります。使用形態にあった自動釣銭機本体の設定をご確認の上ご利用ください。

プロパティ	SDKバージョン	グローリー	富士電機
delegate: SMBCountingDelegate? 計数開始から終了までの間、自動釣銭機で計数された情報を処理するDelegateオブジェクトです。	1.0.0+	◯	◯
countingAmount: Int 自動釣銭機で計数された合計金額を表します。 beginCountingDepositメソッドかbeginCountingReplenishmentChangeの実行後から、endCountingメソッドの実行の間まで自動更新されます。	1.0.0+	◯	◯
countingCashCount: SMBCashCount 自動釣銭機で計数された金種の枚数を表します。 beginDepositメソッドの実行後から、endDepositメソッドの実行の間まで自動更新されます。金種の定義はSMBCashCountを参照してください。	1.0.0+	◯	◯
balanceAmount: Int 自動釣銭機内とカセット内に格納されている金種の合計金額を表します。 readCashCountメソッドの処理成功時に更新されます。	1.0.0+	◯	◯
balanceCashCount: SMBCashCount 自動釣銭機内に格納されている金種の枚数を表します。 readCashCountメソッドの処理成功時に更新されます。金種の定義はSMBCashCountを参照してください。	1.0.0+	◯	◯
balanceCassetteCashCount: SMBCashCount 自動釣銭機のカセット内に格納されている金種の枚数を表します。 readCashCountメソッドの処理成功時に更新されます。金種の定義はSMBCashCountを参照してください。	1.0.0+	◯	◯
balanceDenominationStatus: SMBCashHandlingMachineDenominationStatus 自動釣銭機内に格納されている金種の状態を表します。 readCashCountメソッドの処理成功時に更新されます。金種の状態の定義はSMBCashHandlingMachineDenominationStatusを参照してください。	1.1.0+	◯	◯
replenishmentChangeAmount: Int 自動釣銭機の補充した累計枚数から算出される金額を表します。 readReplenishmentChangeWithResetメソッドの処理成功時に更新されます。	1.0.0+	◯	×
replenishmentChangeCount: SMBCashCount 自動釣銭機の補充した累計枚数を表します。 readReplenishmentChangeWithResetメソッドの処理成功時に更新されます。金種の定義はSMBCashCountを参照してください。	1.0.0+	◯	×
isInAction: Bool 自動釣銭機の動作状況を表します。 trueの場合、自動釣銭機が動作している、もしくはエラーが発生しています。（例：計数動作中） falseの場合、自動釣銭機は動作していません。	1.0.0+	◯	◯
state: SMBCashHandlingMachineCountingState 自動釣銭機の計数状態を表します。状態の種類はSMBCashHandlingMachineCountingStateにて定義されています。	1.0.0+	◯	◯
countingDetailStatus: SMBCashHandlingMachineCountingDetailStatus 自動釣銭機の計数処理における紙幣部および硬貨部の詳細状態を表します。状態はSMBCountingDelegateによる計数結果が通知されるタイミングとupdateCountingDetailStatusメソッドが実行されたタイミングで更新されます。状態の種類はSMBCashHandlingMachineCountingDetailStatusにて定義されています。	2.0.0+	◯	◯

メソッド	SDKバージョン	グローリー	富士電機	備考
change(_ mode: SMBCashHandlingMachineCountingMode) -> Int 釣銭機の運用モードを変更します。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。運用モードの定義はSMBCashHandlingMachineCountingModeを参照してください。	1.0.0+	◯	◯
beginCountingDeposit() -> Int 預かり金の計数を開始します。本メソッド実行後から、SMBCountingDelegateにて計数結果が通知されます。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。	1.0.0+	◯ *	◯ *	* 預かり金手入力モード(`kSMBDepositManualInputMode`)では非対応
beginCountingReplenishmentChange() -> Int 補充の計数を開始します。本メソッド実行後から、SMBCountingDelegateにて計数結果が通知されます。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。	1.0.0+	◯	◯ *F	*F 預かり金手入力モード(`kSMBDepositManualInputMode`)では非対応
pauseCounting() -> Int 計数を停止します。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。	1.0.0+	◯	×
resumeCounting() -> Int 計数を再開します。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。	1.0.0+	◯	×
endCounting() -> Int 計数を終了します。本メソッド実行後、SMBCountingDelegateによる計数結果の通知が停止します。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。	1.0.0+	◯	◯ *F	*F 預かり金手入力モード(`kSMBDepositManualInputMode`)では非対応
endCountingWithRepay() -> Int 計数を終了します。預かり金の現物を返却します。本メソッド実行後、SMBCountingDelegateによる計数結果の通知が停止します。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。	2.0.0+	×	◯ *F	*F 預かり金手入力モード(`kSMBDepositManualInputMode`)では非対応
dispenseChange(_ value: Int32) -> Int valueで指定された金額の釣り銭を払い出します。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。	1.0.0+	◯	◯
dispenseCashFromOtherThanSales(with count: SMBCashCount) -> Int 指定枚数取引外出金を実施します。countで指定された金種の枚数を払い出します。APIの最大指定枚数は金種毎に99枚までとなります。本メソッドで払い出した金額は売上取引として扱われません。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。	1.1.0+	◯	×
collectCash(with count: SMBCashCount) -> Int 指定枚数回収を実施します。countで指定された金種の枚数を回収します。APIの最大指定枚数は金種毎に999枚までとなります。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。	1.1.0+	◯	◯
collectExcessCash() -> Int 残置回収を実施します。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。	1.1.0+	◯	◯	枚数残置のみ対応
readCashCount() -> Int 釣銭機内の金種枚数を取得します。実行後にBalanceCashCountプロパティとBalanceDenominationStatusプロパティが更新されます。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。	1.0.0+	◯	◯
readReplenishmentChange(withReset isReset: Bool) -> Int 今までの累計補充枚数を取得します。実行後にReplenishmentChangeCountとReplenishmentChangeAmountプロパティが更新されます。 isResetフラグをtrueとした時、補充枚数更新後に累計枚数がクリアされます。isResetフラグをfalseとした時はクリアされません。戻り値の種類はSMBCode.hにて定義されています。	1.0.0+	◯	×
getState() -> Int 自動釣銭機の状態を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。	1.0.0+	◯	◯
updateCountingDetailStatus() -> Int 自動釣銭機内の紙幣部および硬貨部の詳細状態を取得します。実行後にCountingDetailStatusプロパティが更新されます。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。	2.0.0+	◯	◯
reset() -> Int 自動釣銭機のメカイニシャルを実行します。メカイニシャルは釣銭機がエラーの場合のみ実行されます。戻り値の種類はSMBCode.hにて定義されています。	1.0.0+	◯	◯
recountingTotalAmount() -> Int 自動釣銭機内の硬貨・紙幣を再計算します。実行結果を戻り値として返します。戻り値の種類はSMBCode.hにて定義されています。	2.0.0+	×	◯

SMBCountingDelegate

このprotocolは、SMBCashHandlingMachineの計数の結果を受信するために使用されます。

Public メソッド	SDKバージョン	グローリー	富士電機
cashHandlingMachine(_ machine: SMBCashHandlingMachine, didUpdateCounting count: SMBCashCount, errorCode: Int) 計数された金種枚数を通知します。errorCodeにて実行結果を取得することができます。実行結果の定義はSMBCode.hにて定義されています。	1.0.0+	◯	◯

SMBCashCount

この構造体は、各金種の枚数を表現するために使用されます。

メンバー	SDKバージョン
coin1: Int32 1円硬貨の枚数を表します。	1.0.0+
coin5: Int32 5円硬貨の枚数を表します。	1.0.0+
coin10: Int32 10円硬貨の枚数を表します。	1.0.0+
coin50: Int32 50円硬貨の枚数を表します。	1.0.0+
coin100: Int32 100円硬貨の枚数を表します。	1.0.0+
coin500: Int32 500円硬貨の枚数を表します。	1.0.0+
bill1000: Int32 1,000円札の枚数を表します。	1.0.0+
bill2000: Int32 2,000円札の枚数を表します。	1.0.0+
bill5000: Int32 5,000円札の枚数を表します。	1.0.0+
bill10000: Int32 10,000円札の枚数を表します。	1.0.0+

SMBCashHandlingMachineDenominationStatus

この構造体は、各金種の状態（ニアエンプティやニアフル状態等）を表現するために使用されます。

メンバー	SDKバージョン
coin1: SMBCashHandlingMachineDenominationState 1円硬貨の状態を表します。	1.1.0+
coin5: SMBCashHandlingMachineDenominationState 5円硬貨の状態を表します。	1.1.0+
coin10: SMBCashHandlingMachineDenominationState 10円硬貨の状態を表します。	1.1.0+
coin50: SMBCashHandlingMachineDenominationState 50円硬貨の状態を表します。	1.1.0+
coin100: SMBCashHandlingMachineDenominationState 100円硬貨の状態を表します。	1.1.0+
coin500: SMBCashHandlingMachineDenominationState 500円硬貨の状態を表します。	1.1.0+
bill1000: SMBCashHandlingMachineDenominationState 1,000円札の状態を表します。	1.1.0+
bill2000: SMBCashHandlingMachineDenominationState 2,000円札の状態を表します。	1.1.0+
bill5000: SMBCashHandlingMachineDenominationState 5,000円札の状態を表します。	1.1.0+
bill10000: SMBCashHandlingMachineDenominationState 10,000円札の状態を表します。	1.1.0+

SMBCashHandlingMachineDenominationState

このNS_ENUMは、金種の状態を示すために使用されます。

定義	SDKバージョン
denominationUnknown 状態不明を表します。	1.1.0+
denominationEmpty 金種がエンプティの状態を表します。	1.1.0+
denominationNearEmpty 金種がニアエンプティの状態を表します。	1.1.0+
denominationNormal 金種が通常の状態を表します。	1.1.0+
denominationNearFull 金種がニアフルの状態を表します。	1.1.0+
denominationFull 金種がフルの状態を表します。	1.1.0+
denominationStorageUnitNone 金種の格納庫がないことを表します。	1.1.0+

SMBCashHandlingMachineCountingState

このNS_ENUMは、計数状態を示すために使用されます。

定義	SDKバージョン	グローリー	富士電機
normalState 通常状態を表します。	1.0.0+	◯	◯
countingState 計数中状態を表します。	1.0.0+	◯	◯
receivedPauseCommandState 計数中かつ、計数停止コマンドを受信した状態を表します。	1.0.0+	◯	×
pauseCountingState 計数停止状態を表します。	1.0.0+	◯	×
unknownState 状態不明を表します。	1.0.0+	◯	◯

SMBCashHandlingMachineCountingDetailStatus

この構造体は、計数処理おける紙幣部および硬貨部の詳細状態を表現するために使用されます。

メンバー	SDKバージョン
bill: SMBCashHandlingMachineCountingDetailState 紙幣部の詳細状態を表します。	2.0.0+
coin: SMBCashHandlingMachineCountingDetailState 硬貨部の詳細状態を表します。	2.0.0+

SMBCashHandlingMachineCountingDetailState

このNS_ENUMは、計数処理における紙幣部および硬貨部の詳細状態を示すために使用されます。

定義	SDKバージョン	グローリー	富士電機	備考
other その他の状態を表します。	2.0.0+	◯	◯
countingStandBy 計数待機中状態を表します。	2.0.0+	◯	◯
countingInProgress 計数動作中状態を表します。	2.0.0+	◯	◯
error エラー中状態を表します。	2.0.0+	◯	◯
rejecting Reject抜き取り待ち状態を表します。	2.0.0+	◯	◯
storageFull 収納部フル状態を表します。	2.0.0+	◯	◯
enclosureOpened セット外れ状態を表します。	2.0.0+	◯	◯
resetting リセット中状態を表します。	2.0.0+	◯	×
collecting 回収中状態を表します。	2.0.0+	◯	×
waitingRemoveCashAtCollection 回収中抜き取り待ち状態を表します。	2.0.0+	◯	◯ *F	*F `updateCountingDetailStatus` 実行時にのみ反映されます。
unknown 状態不明を表します。	2.0.0+	◯	◯

SMBCashHandlingMachineCountingMode

このNS_ENUMは、運用モードを変更するために使用されます。

定義	SDKバージョン
depositCountingMode 預かり金計数モードに設定します。	1.0.0+
depositManualInputMode 預かり金手入力モードに設定します。	1.0.0+

SMBCode.h

状態を表す定数が定義されているヘッダーファイルです。

定義	値	グローリー	富士電機
SMB_SUCCESS 処理が成功しました。	0	◯	◯
SMB_TIMEOUT タイムアウトエラーです。	-1	◯	◯
SMB_ALREADY_OPENED 既に通信確立済みです。	-2	◯	◯
SMB_NOT_OPEN 通信が未確立です。	-3	◯	◯
SMB_WRONG_PARAMETER パラメータが誤っています。	-4	◯	◯
SMB_OPEN_PORT_ERROR 通信確立に失敗しました。	-5	◯	◯
SMB_WRITE_PORT_ERROR データの送信に失敗しました。	-6	◯	◯
SMB_READ_PORT_ERROR データの受信に失敗しました。	-7	◯	◯
SMB_CLOSE_PORT_ERROR 通信切断に失敗しました。	-8	◯	◯
SMB_NOT_DISCOVERED_ERROR 指定されたMACアドレスのmC-Bridgeがネットワーク上で検出できませんでした。	-9	◯	◯
SMB_WRITE_CHECK_COM_BUSY_TIMEOUT ターゲット装置への送信がビジーでタイムアウトしました。（送信データが欠けた可能性があります）	-20	◯	◯
SMB_WRITE_CHECK_COM_NOT_CONNECTED シリアル通信ケーブルが接続されていません。（送信データは破棄されました。）	-21	◯	◯
SMB_WRITE_CHECK_COM_UNKNOWN_ERROR ターゲット装置への送信が未定義のエラーで失敗しました。	-24	◯	◯
SMB_WRITE_CHECK_COM_NO_RESPONSE ターゲット装置への送信結果が返ってきませんでした。	-25	◯	◯
SMB_FW_NOT_SUPPORTED_ERROR mC-Bridgeからの応答が未定義のエラーで失敗しました。	-26	◯	◯
SMB_READ_CHECK_TIMEOUT mC-Bridgeから応答が返ってきませんでした。	-40	◯	◯
SMB_UNKNOWN_ERROR 未定義のエラーで失敗しました。	-99	◯	◯
SMB_CASH_HANDLING_RESPONSE_FORMAT_ERROR 自動釣銭機の応答がフォーマットエラーで失敗しました。	-1000	◯	◯
SMB_CASH_HANDLING_RESPONSE_ILLEGAL_EXIT 自動釣銭機の処理が異常終了しました。	-1001	◯	◯
SMB_CASH_HANDLING_RESPONSE_NEAR_EMPTY 自動釣銭機の処理は正常終了しましたが、ニアエンプティもしくはエンプティを検知しました。	-1002	◯	◯
SMB_CASH_HANDLING_RESPONSE_ILLEGAL_DATA 自動釣銭機がパリティーエラーやBCCエラー等の通信エラーを検知しました。	-1003	◯	◯
SMB_CASH_HANDLING_RESPONSE_UNIT_OPEN 自動釣銭機のユニットが外れています。	-1004	◯	◯
SMB_CASH_HANDLING_RESPONSE_EXECUTING 自動釣銭機の動作中に処理不可能なコマンドが送信されました。	-1005	◯	◯
SMB_CASH_HANDLING_RESPONSE_DESPENDING 自動釣銭機の放出動作中です。放出動作中に処理不可能なコマンドを受信しました。	-1006	◯	×
SMB_CASH_HANDLING_RESPONSE_COUNTING 自動釣銭機は計数中です。計数中に処理不可能なコマンドを受信しました。	-1007	◯	◯
SMB_CASH_HANDLING_RESPONSE_PAUSE_COUNTING 自動釣銭機は計数停止中です。計数停止中に処理不可能なコマンドを受信しました。	-1008	◯	×
SMB_CASH_HANDLING_RESPONSE_INOPERABLE 自動釣銭機が処理中に動作不能なコマンドが送信されました。	-1009	◯	◯
SMB_CASH_HANDLING_RESPONSE_WAIT_TAKE_OUT 自動釣銭機が抜き取り待ち中に処理不可能なコマンドが送信されました。	-1010	◯	◯
SMB_CASH_HANDLING_MACHINE_RESPONSE_CASH_SHORTAGE_ON_DISPENSE 自動釣銭機の出金枚数不足で失敗しました。	-1011	×	◯
SMB_CASH_HANDLING_MACHINE_RESPONSE_PENDING_CASH_ON_RECOUNT 精査時排出紙幣保留中に処理不可能なコマンドを受信しました。	-1012	×	◯
SMB_CASH_HANDLING_RESPONSE_TIMEOUT 自動釣銭機の応答がありませんでした。	-1099	◯	◯
SMB_CASH_HANDLING_READ_COUNTING_ERROR 自動釣銭機の計数情報の取得に失敗しました。	-1101	◯	◯
SMB_CASH_HANDLING_MACHINE_NOT_SUPPORTED_ERROR 自動釣銭機が対応していないコマンドを受信しました。	-1200	◯	◯
SMB_CASH_HANDLING_MACHINE_UNKNOWN_ERROR 自動釣銭機の制御が未定義のエラーで失敗しました。	-1999	◯	◯

Topへ戻る

ログについて

Star_mBridge.xcframeworkでは、通信記録を保存するログ機能を有しています。ログはAPIを使って通信するごとに自動的に記録されます。ログは一定サイズを上限として複数のファイルへ分割して保存されます。ログの保存上限に達した場合は、古いログファイルから順に削除されます。ログ情報を保存しておきたい場合は、任意の手段を使ってファイルをコピーするなどの対応を行ってください。

ログファイルについて

条件	内容
最大サイズ	50MB
最大保存数	60ファイル
保存場所	AppData/Documents/Star_mBridge/Star_mBridgeLog_yyyymmdd_hhmmss.log

ログのフォーマット

CSV形式にて、次のような構文で保存されます。

日付,Framework名,Action,メソッド名,情報（通信データや通信結果）

Topへ戻る

IOS は、米国およびその他の国におけるCisco社の商標または登録商標であり、ライセンスに基づき使用されています。