Client Action
重要
プリンターが CloudPRNT Version MQTT Full MQTT / Pass URL で動作している場合、POSTレスポンスではなく、MQTTメッセージ order-client-action を使ってClient Actionを要求します。
Client Action Request |
HI01X/02X Version (*1) |
mC-Print2/3 Version (*2) |
TSP100IV Version (*2) |
TSP100IV SK Version (*2) |
mC-Label3 Version (*2) |
|---|---|---|---|---|---|
ClientType |
1.0 |
1.2 |
1.0 |
2.0 |
1.0 |
ClientVersion |
1.0 |
1.2 |
1.0 |
2.0 |
1.0 |
Encodings |
1.0 |
1.2 |
1.0 |
2.0 |
1.0 |
SetID |
1.0 |
1.2 |
1.0 |
2.0 |
1.0 |
GetPollInterval |
1.0 |
1.2 |
1.0 |
2.0 |
1.0 |
PageInfo |
1.4 |
1.2 |
1.0 |
2.0 |
1.0 |
SetPostUrl |
1.8 |
3.5 |
1.0 |
2.0 |
1.0 |
PaperPresentStatusMonitor |
1.9 (*3) |
n/a |
n/a |
2.0 |
1.0 |
PaperPresentStatusControl |
1.9 (*3) |
n/a |
n/a |
2.0 |
1.0 |
HoldPrintControl |
1.9 (*3) |
n/a |
n/a |
2.0 |
1.0 |
GetConfig |
n/a |
n/a |
n/a |
n/a |
1.0 |
RequestGetServerInfo |
n/a |
5,1 |
n/a |
n/a |
n/a |
注釈
clientAction 要求は全てのクライアントで全ての項目をサポートされる保証はないため、オプションとなります。クライアントがサポートしていない項目は"n/a"が記載されます。
Client Action Request |
Parameter |
Client Request result |
|---|---|---|
ClientType |
クライアントタイプを示す文字列の応答を取得します。
例:
“Star Intelligent Interface HE01x/HE02x“ - (IFBD-HI01X/HI02X)
“Star mC-Print2” - (mC-Print2)
“Star mC-Print3” - (mC-Print3)
“Star TSP100IV” - (TSP100IV)
“Star TSP100IV SK” - (TSP100IV SK)
“Star mC-Label3” - (mC-Label3)
|
|
ClientVersion |
クライアントに実装されているCloudPRNTのバージョンの応答を取得します。
例:
IFBD-HI01X/02X: X.X.X
mC-Print2/3: X.X
TSP100IV: X.X
TSP100IV SK: X.X
mC-Label3: X.X
Currently this will always be "1.0.x" for IFBD-HI01X/02X.
Where 1.0 represents the CloudPRNT specification version, and "x" the implementation revision(It is also possible to be "1.8.x", "2.x.x" etc...).
|
|
Encodings |
クライアントにてサポートされている印刷ジョブのエンコーディングリストについてセミコロンを仕切りにした応答を取得します。
エンコード名は標準 MIME/Content type の文字列フォーマットに準じます。
|
|
SetID |
新規ID文字列 |
クライアントにて、POST/GETリクエストの"uniqueID"フィールドで使われる任意のID(※)を設定します。
*文字列の長さは31文字までとなります。また、本IDはプリンターの不揮発性メモリへ書き込まれます。不揮発性メモリの寿命を考慮し、印刷ジョブ毎にIDを設定するような使い方は避けてください。
|
GetPollInterval |
クライアントのポーリングインターバル秒の応答を取得します。
この値はサーバーによってクライアント接続のタイムアウトを決定することに利用することができます。
|
|
PageInfo |
クライアントのプリンターページ情報の応答を取得します。
応答には文字列フィールドが含まれるJSONフォーマットされたオブジェクトが返ります:
{
"paperWidth": "",
"printWidth": "",
"horizontalResolution": "",
"verticalResolution": ""
}
これらは丸め誤差を避けるため文字列で返答されます。
|
|
SetPostUrl |
URL文字列 |
ポーリングを実行するためのhttp POST要求の代替URLを設定します。
一度指定するとcloudPRNTデバイスはWebコンフィグUIで指定されたサーバーURLの代わりに、このパラメーターにより指定された代替URLに対してPOST要求ポーリングを実行するようになります。
また、指定された代替URLは保存され、cloudPRNTデバイスからの全てのhttp要求に利用されます。
もし代替URLでの通信中にて通信タイムアウトやHTTPステータスコードのエラーが発生した場合、cloudPRNTデバイスはWebコンフィグUIで指定されたURLに戻り、プリンタ内の代替URLの情報は削除されます。
|
PaperPresentStatusMonitor |
"enable" / "disable" |
排紙口の用紙の有無チェックを自動的に行うかどうかのフラグを設定します。
また、クライアントは現在の設定値をclientActionの実行結果(
result の値)として "enable" または "disable" を返します。"enable" : 用紙保持ステータスが有効な場合において、プリンターの排紙口に用紙がある場合、用紙が無くなるまでクライアントはGETリクエストを発行しません（印刷ジョブを取得しません）。"disable" : クライアントは用紙の有無チェックをしません。デフォルト値:
"enable" |
PaperPresentStatusControl |
"default" / "valid" / "invalid" |
ジョブ印刷時に、排出口の用紙有無のステータス通知をクライアントに送信するかしないかの設定をするためのフラグを指定します。
クライアントは現在の設定値をclientActionの実行結果(
result の値)として "default" または "valid" , "invalid" を返します。"default" : 次の印刷ジョブを送信した後、クライアントの現在設定値に従って用紙保持制御ステータスが通知されます(または通知されません)。"valid" : 次の印刷ジョブを送信した後、プリンターASBステータスの7番目の値にて用紙保持制御ステータスが通知されます。"invalid ": 次の印刷ジョブを送信した後、用紙保持制御ステータスは通知されません。デフォルト値:
"default" |
HoldPrintControl |
"default" / "valid" / "invalid" |
ジョブ印刷時に、デバイスによる用紙保持制御の有効無効を設定をするためのフラグを指定します。
クライアントは現在の設定値をclientActionの実行結果(
result の値)として "default" または "valid", "invalid" を返します。"default" : 次の印刷ジョブを送信した後、クライアントの現在設定値に従って用紙保持制御が有効になります(または無効になります)。"valid" : 次の印刷ジョブを送信した後、デバイスによる用紙保持制御を有効にします。"invalid" : 次の印刷ジョブを送信した後、デバイスによる用紙保持制御を無効にします。デフォルト値:
"invalid"なお、用紙保持状態の監視をする場合この設定はinvalidに設定し、PaperPresentStatusMonitor及びPaperPresentStatusControlを利用することを推奨します。
|
GetConfig |
"" / "{\"password\":\"xxxxxx\"}" |
クライアントに設定されている詳細設定情報を取得します。
応答される形式はStar Configuration Format仕様書の
title / version / configurations キー仕様に準じます:{
"title": "star_configuration",
"version": "X.X.X", (X is numeric)
"configurations": [
{
...
}
]
}
"" : title / version / configurations(password_protected_settings項目を除く)キーを含むJSONオブジェクトが取得されます。"{\"password\":\"xxxxxx\"}" : title / version / configurationsキーを含むJSONオブジェクトが取得されます。xxxxxxはプリンターのWeb Configuration UIで利用するパスワード値を入力します。
例: "options":"{\"password\":\"public\"}"
|
RequestGetServerInfo |
プリンターに サーバー設定情報取得リクエスト (GET) を実行させます。
|