Client Action
A "clientAction" option in the response packet is used by the server to ask the client to perform an action other than printing, or to return information that is not typically included inside the normal client POST Request packet. If the server issues a "clientAction" request, then the client will send a POST Request in reply as soon as it has handled this action, instead of at the usual poll interval.
For performance, multiple client actions can be passed as an array, allowing several requests to be made simultaneously. Clients can also respond with an array, and in some cases may generate several responses. For example a firmware update may issue an action at the start, and the end of the update process.
Normal printing operation is entirely possible without requiring any client action features.
| Version (HI01X/02X) | Version (mC-Print2/3) | Client Action Request | Parameter | Client Request result |
|---|---|---|---|---|
| 1.0 | 1.2 | ClientType | Responds with a fixed string indicating the client type. Pre-defined types are: "Star Intelligent Interface HI01X" (IFBD-HI01X) "Star mC-Print2" (mC-Print2) "Star mC-Print3" (mC-Print3) |
|
| 1.0 | 1.2 | ClientVersion | Responds with the CloudPRNT version implemented by the client. Currently this will always be "1.0.x". Where 1.0 represents the CloudPRNT specification version, and "x" the implementation revision. |
|
| 1.0 | 1.2 | Encodings | Returns a semi-colon separated list of supported print job content encodings supported by this client. The encoding name follows the common http mime/content type string format. |
|
| 1.0 | 1.2 | SetID | New ID string | Set the ID that the client will use within the "UniqueID" field of POST/GET requests |
| 1.0 | 1.2 | GetPollInterval | Report the clients polling interval in seconds. This may be used by the server to determine a safe timeout for determining a loss of client connection. |
|
| 1.4 | 1.2 | PageInfo | Request printer page information, which will be returned as a JSON formatted object, containing the string fields: { "paperWidth": " "printWidth": " "horizontalResolution": " "verticalResolution": " } These are returned as a string to avoid rounding errors. |
Note, Client Actions are technically optional, and may not all be supported by all clients. However, all above client actions are fully supported by the Star HI01X and HI02X printer interface cards, mC-Print2 and mC-Print3.