StarIOは、Starプリンタを使用するアプリケーションの開発を容易にするためのライブラリです。
Starプリンタと通信するために、StarIOには利用しやすいAPIが用意されています。
このAPIはJava、.NETを含む多くの開発環境に対応しており、ご使用のStarプリンタのモデル、
インターフェイスに関係なく、同じ機能を使用することができます。
StarIOは、Star Line Mode エミュレーション、またはStarPRNT エミュレーションでの使用に対応しています。
サーマルプリンタ |
| ||
---|---|---|---|
ハイブリッドプリンタ |
| ||
ドットプリンタ |
| ||
モバイルプリンタ |
| ||
DK-AirCash (キャッシュドロワ コントローラ) |
|
モバイルプリンタにおいて、以下のファームウェアバージョンでは、StarPRNTエミュレーションを搭載していないため、StarIO for Windowsは利用できません。
機種名 | F/Wバージョン | ||
---|---|---|---|
SM-S210i |
| ||
SM-S220i |
| ||
SM-T300i |
| ||
SM-T400i |
|
Windows 7(32/64bit)
Windows 8 (Desktop UI 32bit/64bit) *WindowsRT を除く
Windows 8.1 (Desktop UI 32bit/64bit) *WindowsRT 8.1 を除く
Windows 10 (32/64bit) *Windows 10 Mobile Edition、IoT Editionを除く
■ プリンタ本体 ディップスイッチ1(DIPSW1) の設定
シリアル (COM) | パラレル (LPT) | USB | イーサネット (LAN) | Bluetooth | 備考 | ||
---|---|---|---|---|---|---|---|
ベンダークラス | プリンタクラス | ||||||
TSP650II | 8=OFF | 8=OFF 5=OFF | 5=OFF:USBベンダークラスに設定 8=OFF:NSB有効に設定 | ||||
FVP10 | 8=OFF | 8=OFF 5=OFF | 5=OFF:USBベンダークラスに設定 8=OFF:NSB有効に設定 | ||||
TSP800II | 8=OFF | 8=OFF 5=OFF | 5=OFF:USBベンダークラスに設定 8=OFF:NSB有効に設定 | ||||
TSP650 | 8=OFF | 8=OFF 5=OFF | --- | 5=OFF:USBベンダークラスに設定 8=OFF:NSB有効に設定 | |||
TSP700II | 8=OFF | 8=OFF 5=OFF | 5=OFF:USBベンダークラスに設定 8=OFF:NSB有効に設定 | ||||
TUP500 | 5=OFF | --- | 5=OFF:USBベンダークラスに設定 | ||||
TUP900 | 5=OFF | 6=OFF (Mode 1) | --- | 5=OFF:USBベンダークラスに設定 6=OFF:USBモードをMode1に設定(F/WバージョンがVer4.4以前の場合) (Mode1:USB Printer Class New Type) | |||
HSP7000 | 8=OFF | 5=OFF | --- | 5=OFF:USBプリンタクラスに設定 8=OFF:NSB有効に設定 | |||
SP700 | 5=OFF | 5=OFF:USBベンダークラスに設定 | |||||
SP500 | 5=OFF | --- | 5=OFF:USBベンダークラスに設定 | ||||
SAC10 | --- | --- | --- | --- |
■ プリンタ本体 メモリスイッチ (MSW) の設定
シリアル (COM) | パラレル (LPT) | USB | イーサネット (LAN) | Bluetooth | 備考 | ||
---|---|---|---|---|---|---|---|
ベンダークラス | プリンタクラス | ||||||
TSP650II | |||||||
FVP10 | |||||||
TSP800II | |||||||
TSP650 | --- | ||||||
TSP700II | |||||||
TUP500 | MSW7-8=1 | MSW7-8=1 | --- | MSW7-8=1:NSB有効に設定 | |||
TUP900 | MSW7-8=1 | --- | MSW7-8=1:NSB有効に設定(F/WバージョンがVer4.4以前の場合) | ||||
mPOP | --- | --- | --- | --- | |||
HSP7000 | --- | ||||||
SP700 | MSW4-7=1 | MSW4-7=1 | MSW4-7=1:NSB有効に設定 | ||||
SP500 | MSW4-7=1 | MSW4-7=1 | --- | MSW4-7=1:NSB有効に設定 | |||
SM-L200 | --- | --- | --- | --- | |||
SM-S210i | --- | --- | --- | --- | |||
SM-S220i | --- | --- | --- | --- | |||
SM-S230i | --- | --- | --- | --- | |||
SM-T300i | --- | --- | --- | --- | |||
SM-T400i | --- | --- | --- | --- | |||
SAC10 | --- | --- | --- | --- |
■ インターフェイスカード ディップスイッチ(DIPSW)の設定
以下の設定は、シリアルインターフェイスで”ResetDevice関数”を使用する場合のみ設定してください。
I/F | DIPSW設定 | 備 考 |
---|---|---|
シリアルI/F | DIPSW1-7=ON | DSR(#6)によるプリンタリセット有効 |
アプリケーションの開発に必要なファイルは"/redistributables"フォルダに格納されています。
また、開発言語、開発環境により、使用するファイルは異なります。
使用するファイルと格納先は、以下の表をご参照ください。
Visual C++ |
| ||||||
---|---|---|---|---|---|---|---|
Visual C# Visual Basic .NET |
| ||||||
Java |
| ||||||
Visual Basic 6.0 |
|
Visual C++ |
| ||||||
---|---|---|---|---|---|---|---|
Visual C# Visual Basic .NET |
| ||||||
Java |
|
サンプルファイルはVisual Studio 2005にて作成されています。
プロジェクトに”StarIOPort.h”ヘッダファイルをインクルードし、”StarIOPort.lib”ライブラリファイルをリンクします。
アプリケーション実行時には、アプリケーションファイルと同一フォルダに”StarIOPort.dll”を置いてください。
”StarIOPort.h”ヘッダファイルの各関数宣言部に説明が記載されています。
サンプルファイルはVisual Studio 2005にて作成されています。
プロジェクトの参照設定に”StarIO.dll”を追加してアプリケーションをビルドします。
アプリケーション実行時には、アプリケーションファイルと同一フォルダに”StarIO.dll”と”StarIOPort.dll”を置いてください。
各APIの説明は”StarIO.xml”の内部に含まれます。このXMLファイルを”StarIO.dll"と同じフォルダに置くことで、
Visual Studioのオブジェクトブラウザ機能やインテリセンスで説明を見ることができるようになります。
サンプルファイルはJavaランタイム Ver. 1.5に準拠しています。
コンパイル(javac)時と実行(java)時のクラスパス定義に”StarIO.jar”を指定します。
またアプリケーション実行時には、アプリケーションファイルと同一フォルダに”StarIO.jar”、”StarIOJ.dll”、”StarIOPort.dll”を置いてください。
コンパイルおよび、アプリケーション実行コマンドの実行例が、”StarIO_Sample.java”のヘッダ部分に記載されています。
また、各コマンドに関する詳細な説明はこちら(英語版)をご参照ください。
モジュールに”StarIOPort.bas”を追加してコンパイルします。
アプリケーション実行時には、アプリケーションファイルと同一フォルダに”StarIOPort.dll”を置いてください。
”StarIOPort.bas”ファイルの各関数宣言部に説明が記載されています。
StarIOを使用する上で、よく使用する機能についてご説明します。
ここでご説明する以外のAPIコマンド機能については、開発環境に記載した各開発環境ごとの内容をご参照ください。
StarIOを使用するには、始めにポートのオープンを行ないます。
Visual C++
OpenPort 関数を使用します。
ポートオープンエラーの場合には、”0” を返して失敗を知らせます。
Visual C# / Visual Basic .NET
Portクラスの GetPort 静的メソッドを呼び出します。
成功した場合には、ポートのハンドル(またはオブジェクト)が返ります。
ポートオープンエラーの場合には、PortException 例外がスローされます。
Java
StarIOPort クラスの getPort 静的メソッドを呼び出します。
ポートオープンエラーの場合には、StarIOPortException 例外がスローされます。
ポートオープンエラーとなる場合には、以下のケースが考えられます。
Visual C++
GetLastError 関数が ”ERROR_ALREADY_EXISTS” を返します。
Visual C# / Visual Basic .NET / Java
IsPortInUseFailure プロパティが ”True” を返します。
StarIO APIの記述方法は各環境ごとに異なります。
Visual C++ / Visual C#
ポートハンドルを最初のパラメータに指定します。
Visual Basic .NET / Java
Portオブジェクトのメソッドを呼び出します。
ポートの使用が終了したら、ポートのクローズを行ないます。
Visual C++
ClosePort 関数を使用します。
Visual C# / Visual Basic .NET
Portクラスの ReleasePort 静的メソッドを呼び出します。
Java
StarIOPort クラスの StarIOPort.releasePort 静的メソッドを呼び出します。
システム内でのポート競合の発生を避けるために、ポートの使用が終了したらすぐにポートをクローズすることを推奨します。
.NET / Java を使用する場合は、try-catch-finally文のfinallyブロックを使用してクローズ処理を行なうと便利です。
OpenPort 関数は”ポート名”、”ポート設定”、”タイムアウト”の3つのパラメータを取ります。
インターフェイス別の”ポート名”、”ポート設定”指定方法を以下に説明します。
”COM1”・ ”COM2” のように、指定するプリンタのシリアルポート名を指定します。
”ボーレート”、”パリティ”、”データビット”、”ストップビット”、”フロー制御”のフィールドからなります。
各フィールドはカンマ(,)で区切り、”<ボーレート>,<パリティ>,<データビット>,<ストップビット>,<
フロー制御>”のように記述します。
(例:"9600,n,8,1,n")
ボーレート: ”115100”、”57600”、”38400”、”19200”、”9600”、”4800”から、プリンタの設定内容に合わせて選択します。
パリティ:
”n”、”e”、”o”から、プリンタの設定内容に合わせて選択します。
データビット: ”7”、”8”から、プリンタの設定内容に合わせて選択します。
ストップビット: ”1”、”2”から、プリンタの設定内容に合わせて選択します。
フロー制御:
”n”、”h”、”c”から、プリンタの設定内容に合わせて選択します。
”LPT1”・ ”LPT2” のように、指定するプリンタのパラレルポート名を指定します。
空の文字列””を指定します。
USBベンダークラスでは、以下の3通りの指定方法があります。
使用するプリンタが1台のみでプリンタがUSBシリアルナンバーを持たない(工場出荷時)場合には1.の設定方法が適しています。
1.特にポートを指定しない方法
2.USBシリアルナンバーを指定する方法
3.COMポート名を指定する方法
空の文字列””を指定します。
”usbprn:” に続けて、指定するプリンタのWindowsプリンタキュー名を入力します。
プリンタキュー名は、添付のサンプルプログラムでは1バイト文字を使用して作成されていますが、2バイト文字の使用も可能です。
たとえば、Windowsプリンタキュー名”Star TSP800II (TSP847II)”を指定する場合、以下のように入力します。
空の文字列””を指定します。
”TCP:” に続けて、指定するプリンタのIPアドレスを入力します。
たとえば、IPアドレス”192.168.1.102”のプリンタを指定する場合、以下のように入力します。
空の文字列””を指定します。
”BT:” に続けて、指定するCOMポートを入力します。
たとえば、Bluetoothポート”COM3”を指定する場合、以下のように入力します。
空の文字列””を指定します。
以下の内容は、このリリースにおける制限事項についての説明です。
ご一読いただき、内容を把握された上でご使用ください。
機種名 | F/W対応バージョン |
---|---|
TSP650II | 1.0以降 |
FVP10 | 1.0以降 |
TSP800II | 1.0以降 |
TSP650 | 2.0以降 |
TSP700II | 2.0以降 |
TUP500 | 1.0以降 |
TUP900 | 1.2以降 |
mPOP | 1.0以降 |
HSP7000 | 1.0以降 |
SP700 | 2.0以降 |
SP500 | 4.0以降 |
SM-L200 | 1.0以降 |
SM-S210i | × |
SM-S220i | × |
SM-S230i | 1.0以降 |
SM-T300i | × |
SM-T400i | × |
SAC10 | × |
機種名 | Bluetoothインターフェイス | F/W対応バージョン |
---|---|---|
TSP650II | ○ | 1.0以降 |
FVP10 | ○ | 2.0以降 |
TSP800II | ○ | 2.0以降 |
TSP650 | × | - |
TSP700II | ○ | 5.0以降 |
TUP500 | × | - |
TUP900 | × | - |
mPOP | ○ | 1.0以降 |
HSP7000 | × | - |
SP700 | ○(SP742のみ) | 4.0以降 |
SP500 | × | - |
SM-L200 | ○ | 1.0以降 |
SM-S210i | ○ | 3.0以降 |
SM-S220i | ○ | 3.0以降 |
SM-S230i | ○ | 1.0以降 |
SM-T300i | ○ | 3.0以降 |
SM-T400i | ○ | 3.0以降 |
SAC10 | ○ | 1.0以降 |
Ver. No. | 改訂年月 | 内容 |
---|---|---|
Version 1.2.0.0 | Mar. 2009 | 単体リリース初版 |
Version 1.2.1.0 | Mar. 2010 | FVP10, TSP800II対応 |
Version 1.2.2.0 | Jul. 2010 | SP500対応、誤記訂正(プリンタ設定値) パラレルインターフェイス・USBインターフェイス(ベンダークラスモード)の制限解除 |
Version 1.2.3.0 | Dec. 2010 | ”GetParsedStatusEx関数”のバグ修正 |
Version 1.3.1.0 | Apr. 2012 | プリンタキューでオフラインが発生するバグの修正 ”OpenPort関数”が失敗した時に、”ERROR_ACCESS_DENIED”が発生するバグの修正 |
Version 1.3.2.0 | Jul. 2012 | TUP500, TUP900対応 |
Version 1.3.3.0 | Dec. 2012 | TSP650II対応 Bluetoothインターフェイス対応(TSP650IIのみ) |
Version 1.3.3.0 | Mar. 2014 | SAC10対応 |
Version 2.0.0.0 | Apr. 2014 | Bluetoothインターフェース対応 : TSP700II, TSP800II, SP700(SP742) |
Version 2.1.0.0 | Jan. 2015 | Bluetoothインターフェース対応 : FVP10 |
Version 2.2.0.0 | Sep. 2015 | mPOP, SM-L200, SM-S210i, SM-S220i, SM-S230i, SM-T300i, SM-T400i対応 |