UniPRT SDK v1.0.0.0
 
载入中...
搜索中...
未找到
PrinterMonitor类 参考

模块用于方便监听/检索印表机的非请求讯息或检索印表机状态/资讯。 更多...

#include <PrinterMonitor.h>

类 PrinterMonitor 继承关系图:

Public 类型

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:
 设置是否启用警报状态监听。
 

属性

BOOL engineStatusListening
 启用/禁用监听/解析印表机发送的非请求引擎状态。
 
BOOL displayStatusListening
 启用/禁用监听/解析印表机发送的非请求前面板显示文本。
 
BOOL alertStatusListening
 启用/禁用监听/解析印表机发送的非请求故障状态警报。
 
EngineStatusCallback engineStatusCallback
 当从印表机接收到引擎状态时调用的函数。函数必须符合 EngineStatusNotice 的签名。
 
DisplayStatusCallback displayStatusCallback
 当从印表机接收到显示文本讯息时调用的函数。函数必须符合 DisplayStatusNotice 的签名。
 
AlertStatusCallback alertStatusCallback
 当从印表机接收到故障/警报讯息时调用的函数。函数必须符合 AlertStatusNotice 的签名。
 

详细描述

模块用于方便监听/检索印表机的非请求讯息或检索印表机状态/资讯。

如果在印表机上启用了非请求讯息,则可以随时发送。该模块需要与印表机的管理端口保持恒定的连接,以便监听印表机发送的任何讯息。

成员类型定义说明

◆ AlertStatusCallback

- AlertStatusCallback

警报状态更改的回调类型。

参数
alertText新的警报文本。

◆ DisplayStatusCallback

- DisplayStatusCallback

显示状态更改的回调类型。

参数
panelText新的面板文本。

◆ EngineStatusCallback

- EngineStatusCallback

引擎状态更改的回调类型。

参数
newEngineState新的引擎状态。

函数文档

◆ getEngineStatus

- (NSString *) getEngineStatus

查询印表机的引擎状态。

引擎状态用于检查印表机在发送打印作业之前是否处于可打印状态。

返回的字符串可以是 "fault", "idle", "offline", "pause", "printing", "present"(标签存在)中的任何一个。

实现在 PrinterMonitor 中。

返回
表示引擎状态的字符串。

◆ getFaultStatus

- (NSArray< NSString * > *) getFaultStatus

查询印表机的故障状态。

故障状态用于检查印表机是否处于需要注意的故障状态,或者可能会阻止处理任何打印作业。

返回的警报字符串数组表示印表机在 alert[0] 处发送的警报编号以及 alert[1] 处的简短描述。

例如,"2418" 表示一个 "Print Head Open" 警报。alert[0] = "2418"; alert[1] = "Print Head Open";

实现在 PrinterMonitor 中。

返回
表示故障状态的字符串数组。

◆ getPrinterInfo

- (PrinterInfo *) getPrinterInfo

获取印表机资讯。

适用于需要检查型号、固件版本、安装选项和其他硬件特定详细资讯的情况。

实现在 PrinterMonitor 中。

返回
包含印表机资讯的 PrinterInfo 对象。

◆ initWithCommDescriptor:

- (instancetype) initWithCommDescriptor: (NSString *) commDescriptor

创建由 SDK 管理的连接时调用的构造函数。

commDescriptor 是用于连接印表机的通信描述符。

TCP 描述符格式:"ip" 或 "ip:port"

例如 "127.0.0.1" 或 "127.0.0.1:3007"

如果未提供端口,则使用默认值。

参数
commDescriptor通信描述符。
返回
一个初始化的 PrinterMonitor 实例,如果无法创建对象,则返回 nil。

◆ initWithJsonComm:

- (instancetype) initWithJsonComm: (JsonComm *) mgmtComm

使用给定的 JSON 通信对象初始化一个新实例。

参数
mgmtCommJSON 通信对象。
返回
一个初始化的 PrinterMonitor 实例,如果无法创建对象,则返回 nil。

◆ initWithTcpComm:

- (instancetype) initWithTcpComm: (TcpComm *) connection

使用给定的 TCP 通信对象初始化一个新实例。

参数
connectionTCP 通信对象。
返回
一个初始化的 PrinterMonitor 实例,如果无法创建对象,则返回 nil。

◆ SetAlertStatusListening:

- (void) SetAlertStatusListening: (BOOL) value

设置是否启用警报状态监听。

参数
valueYES 表示启用监听,NO 表示禁用。

◆ SetDisplayStatusListening:

- (void) SetDisplayStatusListening: (BOOL) value

设置是否启用显示状态监听。

参数
valueYES 表示启用监听,NO 表示禁用。

◆ SetEngineStatusListening:

- (void) SetEngineStatusListening: (BOOL) value

设置是否启用引擎状态监听。

参数
valueYES 表示启用监听,NO 表示禁用。

属性说明

◆ alertStatusCallback

- (AlertStatusCallback) alertStatusCallback
readwritenonatomiccopy

当从印表机接收到故障/警报讯息时调用的函数。函数必须符合 AlertStatusNotice 的签名。

◆ alertStatusListening

- (BOOL) alertStatusListening
readwritenonatomicassign

启用/禁用监听/解析印表机发送的非请求故障状态警报。

请注意,必须启用此功能才能接收来自印表机的任何通知(AlertStatusCallback)。

◆ displayStatusCallback

- (DisplayStatusCallback) displayStatusCallback
readwritenonatomiccopy

当从印表机接收到显示文本讯息时调用的函数。函数必须符合 DisplayStatusNotice 的签名。

◆ displayStatusListening

- (BOOL) displayStatusListening
readwritenonatomicassign

启用/禁用监听/解析印表机发送的非请求前面板显示文本。

请注意,必须启用此功能才能接收来自印表机的任何通知(DisplayStatusCallback)。

◆ engineStatusCallback

- (EngineStatusCallback) engineStatusCallback
readwritenonatomiccopy

当从印表机接收到引擎状态时调用的函数。函数必须符合 EngineStatusNotice 的签名。

◆ engineStatusListening

- (BOOL) engineStatusListening
readwritenonatomicassign

启用/禁用监听/解析印表机发送的非请求引擎状态。

请注意,必须启用此功能才能接收来自印表机的任何通知(EngineStatusCallback)。


该类的文档由以下文件生成: