模塊用於方便監聽/檢索打印機的非請求消息或檢索打印機狀態/信息。 更多...
#include <PrinterMonitor.h>
公開型態 | |
typedef void(^ | EngineStatusCallback) (NSString *newEngineState) |
引擎狀態更改的回調類型。 | |
typedef void(^ | DisplayStatusCallback) (NSArray< NSString * > *panelText) |
顯示狀態更改的回調類型。 | |
typedef void(^ | AlertStatusCallback) (NSArray< NSString * > *alertText) |
警報狀態更改的回調類型。 | |
實體方法 | |
(instancetype) | - initWithTcpComm: |
使用給定的 TCP 通信對象初始化一個新實例。 | |
(instancetype) | - initWithJsonComm: |
使用給定的 JSON 通信對象初始化一個新實例。 | |
(instancetype) | - initWithCommDescriptor: |
創建由 SDK 管理的連接時調用的構造函數。 | |
(PrinterInfo *) | - getPrinterInfo |
獲取打印機信息。 | |
(NSString *) | - getEngineStatus |
查詢打印機的引擎狀態。 | |
(NSArray< NSString * > *) | - getFaultStatus |
查詢打印機的故障狀態。 | |
(void) | - SetEngineStatusListening: |
設置是否啟用引擎狀態監聽。 | |
(void) | - SetDisplayStatusListening: |
設置是否啟用顯示狀態監聽。 | |
(void) | - SetAlertStatusListening: |
設置是否啟用警報狀態監聽。 | |
屬性(properties) | |
BOOL | engineStatusListening |
啟用/禁用監聽/解析打印機發送的非請求引擎狀態。 | |
BOOL | displayStatusListening |
啟用/禁用監聽/解析打印機發送的非請求前面板顯示文本。 | |
BOOL | alertStatusListening |
啟用/禁用監聽/解析打印機發送的非請求故障狀態警報。 | |
EngineStatusCallback | engineStatusCallback |
當從打印機接收到引擎狀態時調用的函數。函數必須符合 EngineStatusNotice 的簽名。 | |
DisplayStatusCallback | displayStatusCallback |
當從打印機接收到顯示文本消息時調用的函數。函數必須符合 DisplayStatusNotice 的簽名。 | |
AlertStatusCallback | alertStatusCallback |
當從打印機接收到故障/警報消息時調用的函數。函數必須符合 AlertStatusNotice 的簽名。 | |
模塊用於方便監聽/檢索打印機的非請求消息或檢索打印機狀態/信息。
如果在打印機上啟用了非請求消息,則可以隨時發送。該模塊需要與打印機的管理端口保持恆定的連接,以便監聽打印機發送的任何消息。
- AlertStatusCallback |
警報狀態更改的回調類型。
alertText | 新的警報文本。 |
- DisplayStatusCallback |
顯示狀態更改的回調類型。
panelText | 新的面板文本。 |
- EngineStatusCallback |
引擎狀態更改的回調類型。
newEngineState | 新的引擎狀態。 |
- (NSString *) getEngineStatus |
查詢打印機的引擎狀態。
引擎狀態用於檢查打印機在發送打印作業之前是否處於可打印狀態。
返回的字符串可以是 "fault", "idle", "offline", "pause", "printing", "present"(標籤存在)中的任何一個。
實現在 PrinterMonitor 中。
- (NSArray< NSString * > *) getFaultStatus |
查詢打印機的故障狀態。
故障狀態用於檢查打印機是否處於需要注意的故障狀態,或者可能會阻止處理任何打印作業。
返回的警報字符串數組表示打印機在 alert[0] 處發送的警報編號以及 alert[1] 處的簡短描述。
例如,"2418" 表示一個 "Print Head Open" 警報。alert[0] = "2418"; alert[1] = "Print Head Open";
實現在 PrinterMonitor 中。
- (PrinterInfo *) getPrinterInfo |
- (instancetype) initWithCommDescriptor: | (NSString *) | commDescriptor |
創建由 SDK 管理的連接時調用的構造函數。
commDescriptor 是用於連接打印機的通信描述符。
TCP 描述符格式:"ip" 或 "ip:port"
例如 "127.0.0.1" 或 "127.0.0.1:3007"
如果未提供端口,則使用默認值。
commDescriptor | 通信描述符。 |
- (instancetype) initWithJsonComm: | (JsonComm *) | mgmtComm |
- (instancetype) initWithTcpComm: | (TcpComm *) | connection |
- (void) SetAlertStatusListening: | (BOOL) | value |
設置是否啟用警報狀態監聽。
value | YES 表示啟用監聽,NO 表示禁用。 |
- (void) SetDisplayStatusListening: | (BOOL) | value |
設置是否啟用顯示狀態監聽。
value | YES 表示啟用監聽,NO 表示禁用。 |
- (void) SetEngineStatusListening: | (BOOL) | value |
設置是否啟用引擎狀態監聽。
value | YES 表示啟用監聽,NO 表示禁用。 |
|
readwritenonatomiccopy |
當從打印機接收到故障/警報消息時調用的函數。函數必須符合 AlertStatusNotice 的簽名。
|
readwritenonatomicassign |
啟用/禁用監聽/解析打印機發送的非請求故障狀態警報。
請注意,必須啟用此功能才能接收來自打印機的任何通知(AlertStatusCallback)。
|
readwritenonatomiccopy |
當從打印機接收到顯示文本消息時調用的函數。函數必須符合 DisplayStatusNotice 的簽名。
|
readwritenonatomicassign |
啟用/禁用監聽/解析打印機發送的非請求前面板顯示文本。
請注意,必須啟用此功能才能接收來自打印機的任何通知(DisplayStatusCallback)。
|
readwritenonatomiccopy |
當從打印機接收到引擎狀態時調用的函數。函數必須符合 EngineStatusNotice 的簽名。
|
readwritenonatomicassign |
啟用/禁用監聽/解析打印機發送的非請求引擎狀態。
請注意,必須啟用此功能才能接收來自打印機的任何通知(EngineStatusCallback)。