Skip to content

Latest commit

 

History

History
65 lines (39 loc) · 5.2 KB

Readme_Jp.md

File metadata and controls

65 lines (39 loc) · 5.2 KB
Raw

StarPRNT SDK iOS Swift

本パッケージはStarプリンタを使用するアプリケーションの開発を容易にするためのSDKです。

Apple社の指針に従い、StarIO V2.11.1以降, StarIO_Extension V1.17.1以降, StarIODeviceSetting V1.0.2以降はプライバシーマニフェストファイルを含みます。 Manifest fileについてはこちらをご参照ください。 StarIO、StarIO_ExtensionはUser defaults APIsを使用しています。StarIODeviceSettingはRequired Reason APIを使用していません。(2024年1月29日現在)

適用

対応OS・開発環境・対応プリンターについては、StarPRNT SDKの開発者向けドキュメントを参照ください。

制限事項

  1. Bluetooth Low Energyモデルは、プリンターとの接続に時間がかかることがあります。詳しくはStarPRNT SDKドキュメントのgetPort API項を参照ください。

  2. Bluetoothでご利用の場合、メモリスイッチの"ASB機能"は、デフォルト設定(無効)のままご利用ください。(バンク7/ビットC)

  3. Bluetoothプリンタにて、iOS 10.0 - 10.2.1 および iOS 11.0 - 11.2.2において、getPort、begin/endCheckedBlockでエラーが発生し、その後searchPrinter APIで発見できなくなる事があります。iOS設定画面を見ると、『接続済み』と表示されますが、「一般」-「情報」に当該デバイス情報が表示されなくなります。

    [復帰方法] 一旦プリンタ電源を切るか、iOS設定画面機能を使い、Bluetoothコネクションを切断し再接続します。

  4. 下記モデルにおいて、“writePort”を使用して大量のデータをプリンタに送信した後、データを送りきる前に”releasePort”が実行されますと、アプリからプリンタを認識できず使用不能となる現象が確認されています。

    • SM-S210i (ファームウェア 3.1以降)
    • SM-S230i (ファームウェア 1.3)
    • SM-T300i (ファームウェア 3.1以降)
    • SM-T400i (ファームウェア 3.1以降)

    また、以下のモデルにおいて同様の処理が実行されますと、Bluetooth接続が切断される事があります。

    • mPOP

    (本現象はApple社へ報告済みです)

    StarPRNT SDKの場合、Communicationクラス内のsendCommandsメソッドでデータを送りきるまでwritePortをループしていますが、指定時間内にデータを送りきれなかった場合はreleasePortするようになっており、上記の現象が発生する事があります。

    本現象を防止するため、アプリで同様の処理を行う場合は、印刷データを送りきるのに十分な長さの時間を指定するようにしてください。

    なお、プリンタが使用不能な状態になった場合は"設定"の"Bluetooth"画面にてプリンタとの接続を一旦切断し再度接続することで再び使用可能となります。Bluetooth接続が切断された場合は、Auto Connection機能が有効であれば自動的に再接続されます。Auto Connectionが無効の場合はiOSの"設定"画面から手動で再接続を行ってください。

  5. 本SDKではiOS 11 にて稀にBluetoothプリンタと通信できなくなる現象を回避するため、getPort後にスリープを行っています。 弊社の評価では、0.2秒のスリープを行うことで本現象が発生しないことを確認できましたが実際にお客様のアプリケーションで使用する際は十分に動作確認を行い、必要に応じてスリープ時間を適宜変更してください。

  6. readPort メソッドの一部の振る舞いの変更

    StarPRNT SDK 5.6.0より、EthernetインターフェイスでreadPortメソッドを実行した際に受信すべきデータがなかった場合の挙動を変更しました。

    • 変更前 : 例外をスロー
    • 変更後 : 成功を返す

    SDK V5.5.0以前をご利用の際に、変更前の例外発生をキャッチする実装をされている場合には、本修正に合わせたアプリ側の修正をお願いいたします。

  7. プリンターの電源をONした後にプリンターにmC-Soundを接続した場合、メロディスピーカーのAPIは正常に動作しません。 プリンターにmC-Soundを接続した後にプリンターの電源をONしてください。

  8. mC-Print2/3のLANインターフェイス、TSP100LAN、TSP100IIILAN/Wを使用する場合、 ネットワーク環境とホストデバイスによっては、稀にgetPortに失敗することがございます。 弊社の評価では、portSettingsの引数に;l1000を設定することで本現象が発生しなくなることを確認できましたが、 実際にお客様のアプリケーションで使用する際には十分に動作確認を行い、必要に応じて適宜変更してください。

著作権

スター精密（株）Copyright 2016 - 2024