JsonSDK.cpp 文件参考

#include "JsonSDK.h"
#include "JsonMng.h"
#include "RfidMonitor.h"
#include "OdvMonitor.h"
#include "PrinterMonitor.h"
#include "SettingsReadWrite.h"
#include "JsonConfig.h"

JsonSDK.cpp 的引用(Include)关系图:

函数
void	MessengerGet (void *ptrComm, COMM_TYP commTyp, int maxInputMsgCapacity, bool usingDataPort)
	建立一个频道，用于发送/接收管理讯息，并指定最大容量。
void	MessengerRelease ()
	释放讯息传输接口资源
void	MessengerSendMsg (char *strCommand, char *strContent)
	向打印机发送管理指令和数据/内容。
void	MessengerReadNextMsg (const char **strNextMsg)
	读取已经从打印机异步接收的下一则讯息。
void	MessengerSendMsgAndWaitForResponse (char *strCommand, char *strContent, int maxWaitTimeSecs, const char **strResponse)
	将管理命令和数据/内容发送到打印机，并等待 maxWaitTimeSecs 秒的回应。
int	MessengerUnreadMsgCount ()
	获取未读消息的数量。
void	RfidMonitorConnection (char *lpAddress)
	使用网络接口连接打印机以启用 RFID 监控功能。
void	OdvMonitorConnection (char *lpAddress)
	使用网络接口连接打印机以启用 ODV 监控功能。
void	PrinterMonitorConnection (char *lpAddress, INFO_TYP InfoTyp)
	使用网络接口连接打印机以启用打印机监控功能。
void	GetPrinterInfo (stPrinterInfo *pPrtInfo, INFO_TYP InfoTyp)
	获取打印机功能的相关信息。
bool	GetRfidReportListening ()
	獲取 RFID 報告監聽的標誌。
void	SetRfidReportListening (bool value)
	设置 RFID 报告监听的标志。
bool	GetOdvReportListening ()
	獲取 ODV 報告監聽的標誌。
void	SetOdvReportListening (bool value)
	设置 ODV 报告监听的标志。
void	RfidMonitorDispose ()
	释放 RFID 监控资源。
void	OdvMonitorDispose ()
	释放 ODV 监控资源。
void	PrinterMonitorDispose (INFO_TYP InfoTyp)
	释放打印机监控资源。
void	SetRfidReportCallback (void callback(const RfidReport &report))
	设置一个回调函数来获取 RFID 报告。
void	SetOdvReportCallback (void callback(const OdvReport &report))
	设置一个回调函数来获取 ODV报告。
void	SetEngineStatusListening (bool value)
	设置打印机报告监听引擎状态的标志。
void	SetDisplayStatusListening (bool value)
	设置打印机报告监听屏幕状态的标志。
void	SetAlertStatusListening (bool value)
	设置打印机报告监听警报状态的标志。
bool	GetEngineStatusListening ()
	獲取引擎狀態監聽的標誌。
bool	GetDisplayStatusListening ()
	獲取顯示狀態監聽的標誌。
bool	GetAlertStatusListening ()
	獲取警報狀態監聽的標誌。
void	SetEngineStatusCallback (void callback(const std::string &engineState))
	设置打印机报告监听警报状态的标志。
void	SetDisplayStatusCallback (void callback(const std::vector< std::string > &newDisplayText))
	设置打印机报告监听屏幕状态的标志。
void	SetAlertStatusCallback (void callback(const std::vector< std::string > &alert))
	设置打印机报告监听警报状态的标志。
char *	GetPrinterAllValues (void *ptrComm, COMM_TYP commTyp, bool usingDataPort)
	获取打印机的所有设置。
char *	GetPrinterValue (void *ptrComm, COMM_TYP commTyp, bool usingDataPort, const char *key)
	获取打印机的单一设置。
char *	GetPrinterValues (void *ptrComm, COMM_TYP commTyp, bool usingDataPort, const std::vector< std::string > &keys)
	获取打印机的多个设置。
bool	SetPrinterValue (void *ptrComm, COMM_TYP commTyp, bool usingDataPort, const char *key, const char *value)
	设置打印机的单一设置。
bool	SetPrinterValues (void *ptrComm, COMM_TYP commTyp, bool usingDataPort, std::map< std::string, std::string > *keysToSet)
	设置打印机的多个设置。
char *	GetPrinterProperties (void *ptrComm, COMM_TYP commTyp, bool usingDataPort, const char *key)
	获取打印机的单一属性。
char *	GetPrinterPropertiesEx (void *ptrComm, COMM_TYP commTyp, bool usingDataPort, const char *keys[], size_t count)
	获取打印机的多个属性。
char *	GetPrinterAllProperties (void *ptrComm, COMM_TYP commTyp, bool usingDataPort)
	获取打印机的所有属性。
void	FreeString (char *str)
	释放字符串资源。
char *	GetPrinterConfig (void *ptrComm, COMM_TYP commTyp, bool usingDataPort, int CfgNumber)
	获取打印机的单一组态设定。
bool	SetPrinterConfig (void *ptrComm, COMM_TYP commTyp, bool usingDataPort, char *pConfig)
	设置打印机的单一组态设定。
char *	GetPrinterAllConfig (void *ptrComm, COMM_TYP commTyp, bool usingDataPort)
	获取打印机的所有组态设定。

变量
static JsonMessenger	gJsonMessenger
static RfidMonitor	gRfidMonitor
static RfidReport	gRfidReport
static OdvMonitor	gOdvMonitor
static PrinterMonitor	gPrinterMonitor_Rfid
static PrinterMonitor	gPrinterMonitor_Odv
static PrinterMonitor	gPrinterMonitor
static std::string	AllMsg

函数说明

FreeString()

void FreeString

(

char *

str

)

释放字符串资源。

参数

[in]

str

: 字符串资源

返回

无

程序代码

FreeString(AllProperties);

GetAlertStatusListening()

bool GetAlertStatusListening

(

)

獲取警報狀態監聽的標誌。

返回

bool

GetDisplayStatusListening()

bool GetDisplayStatusListening

(

)

獲取顯示狀態監聽的標誌。

返回

bool

GetEngineStatusListening()

bool GetEngineStatusListening

(

)

獲取引擎狀態監聽的標誌。

返回

bool

GetOdvReportListening()

bool GetOdvReportListening

(

)

獲取 ODV 報告監聽的標誌。

返回

bool

GetPrinterAllConfig()

char * GetPrinterAllConfig	(	void *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort )

获取打印机的所有组态设定。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false

返回

char*

程序代码

char* pAllConfig = pGetPrinterAllConfig(commPtr, commTyp, false);

GetPrinterAllProperties()

char * GetPrinterAllProperties	(	void *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort )

获取打印机的所有属性。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false

返回

char*

程序代码

char* AllProperties = GetPrinterAllProperties(commPtr, commTyp, false);

GetPrinterAllValues()

char * GetPrinterAllValues	(	void *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort )

获取打印机的所有设置。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false

返回

char*

程序代码

char* values = GetPrinterAllValues(commPtr, commTyp, false);

GetPrinterConfig()

char * GetPrinterConfig	(	void *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort,
		int	CfgNumber )

获取打印机的单一组态设定。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false
[in]	CfgNumber	: 组态设定索引值, 范围是 0~8

返回

char*

程序代码

char* pConfig = pGetPrinterConfig(commPtr, commTyp, false, 2);

GetPrinterInfo()

void GetPrinterInfo	(	stPrinterInfo *	pPrtInfo,
		INFO_TYP	InfoTyp )

获取打印机功能的相关信息。

参数

[out]	pPrtInfo	: 用来存储打印机信息的结构体
[in]	InfoTyp	: 设置 RFID 或 ODV 信息的类型

返回

无

程序代码

PrinterInfo PrtInfo;
GetPrinterInfo(&PrtInfo, INFO_TYP::PRINTER_TYP);

GetPrinterProperties()

char * GetPrinterProperties	(	void *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort,
		const char *	key )

获取打印机的单一属性。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false
[in]	key	打印机设置的一个键值

返回

char*

程序代码

std::string key = "Speed.Print-mmps";
char* Properties = GetPrinterProperties(commPtr, commTyp, false, key.c_str());

GetPrinterPropertiesEx()

char * GetPrinterPropertiesEx	(	void *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort,
		const char *	keys[],
		size_t	count )

获取打印机的多个属性。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false
[in]	keyProps	打印机设置的多个键值
[in]	keyCount	键值数量

返回

char*

程序代码

const char* keyProps[] = { "Speed", "Label.Sensor" };
size_t keyCount = sizeof(keyProps) / sizeof(keyProps[0]);
char* PropertiesEx = GetPrinterPropertiesEx(commPtr, commTyp, false, keyProps, keyCount);

GetPrinterValue()

char * GetPrinterValue	(	void *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort,
		const char *	key )

获取打印机的单一设置。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false
[in]	key	打印机设置的一个键值

返回

char*

程序代码

const std::string& key = "Ethernet.MAC";
char* value = GetPrinterValue(commPtr, commTyp, false, key.c_str());

GetPrinterValues()

char * GetPrinterValues	(	void *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort,
		const std::vector< std::string > &	keys )

获取打印机的多个设置。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false
[in]	keys	打印机设置的多个键值

返回

char*

程序代码

std::vector<std::string> keys = { "Ethernet.IP", "Ethernet.MAC", "Ethernet.Speed" };
char* values = GetPrinterValue(commPtr, commTyp, false, keys);

GetRfidReportListening()

bool GetRfidReportListening

(

)

獲取 RFID 報告監聽的標誌。

返回

bool

MessengerGet()

void MessengerGet	(	void *	ptrComm,
		COMM_TYP	commTyp,
		int	maxInputMsgCapacity,
		bool	usingDataPort )

建立一个频道，用于发送/接收管理讯息，并指定最大容量。

参数

[out]	ptrComm	: 界面指针
[in]	commTyp	: 接口种类 enum COMM_TYP { USB_COMM = 0, TCP_COMM, BT_COMM, };
[in]	maxInputMsgCapacity	: 最大讯息输入容量, 默认 MAX_INPUT_MSG_CAPACITY(20)
[in]	usingDataPort	: 使用数据端口传输, 默认是 false

返回

无

程序代码

std::string content;
COMM_TYP commTyp = COMM_TYP::TCP_COMM;
void* commPtr = NULL;
MessengerGet(commPtr, commTyp, MAX_INPUT_MSG_CAPACITY, false);

MessengerReadNextMsg()

void MessengerReadNextMsg

(

const char **

strNextMsg

)

读取已经从打印机异步接收的下一则讯息。

参数

[out]

strNextMsg

: 用来存储下一个返回消息的缓冲区

返回

无

程序代码

const char* strNextMsg = new char[MAX_BUFSIZE];
MessengerReadNextMsg(&strNextMsg);
if (!_bAsyncListening)
       break;
if (strNextMsg != NULL)
{
  std::string str(strNextMsg);
  currentText += str;
  std::cout << std::endl;
  std::cout << std::endl;
  std::cout << "Response:";
  std::cout << currentText << std::endl;
}
delete[] strNextMsg;

MessengerRelease()

void MessengerRelease

(

)

释放讯息传输接口资源

返回

无

程序代码

MessengerRelease();

MessengerSendMsg()

void MessengerSendMsg	(	char *	strCommand,
		char *	strContent )

向打印机发送管理指令和数据/内容。

参数

[in]	strCommand	: 管理指令字符串
[in]	strContent	: 管理数据/内容字符串

返回

无

程序代码

char* pCmdStr = (char*)"Cfg.Item";
std::string content;
content += "{\r\n";
content += "\"Speed\" : null,\r\n";
content += "\"ODV.Symbol\" : null,\r\n";
content += "\"Label.Sensor\":null\r\n";
content += "}\r\n";
const char* pContentStr = content.c_str();
MessengerSendMsg(pCmdStr, (char*)pContentStr);

MessengerSendMsgAndWaitForResponse()

void MessengerSendMsgAndWaitForResponse	(	char *	strCommand,
		char *	strContent,
		int	maxWaitTimeSecs,
		const char **	strResponse )

将管理命令和数据/内容发送到打印机，并等待 maxWaitTimeSecs 秒的回应。

参数

[in]	strCommand	: 一个管理命令字符串
[in]	strContent	: 一个管理数据/内容字符串
[in]	maxWaitTimeSecs	: 最大等待时间
[out]	strResponse	: 用来存储 JSON 字符串回应的缓冲区

返回

无

程序代码

#define MAX_WAIT_TIME_SECS 5
char* pCmdStr = (char*)"Cfg.Item";
std::string content;
content += "{\r\n";
content += "\"Speed\" : null,\r\n";
content += "\"ODV.Symbol\" : null,\r\n";
content += "\"Label.Sensor\":null\r\n";
content += "}\r\n";
const char* pContentStr = content.c_str();
const char* strResponse = NULL;
MessengerSendMsgAndWaitForResponse(pCmdStr, (char*)pContentStr, MAX_WAIT_TIME_SECS, &strResponse);

MessengerUnreadMsgCount()

int MessengerUnreadMsgCount

(

)

获取未读消息的数量。

返回

int

程序代码

int iUnreadMsgCount = MessengerUnreadMsgCount();

OdvMonitorConnection()

void OdvMonitorConnection

(

char *

lpAddress

)

使用网络接口连接打印机以启用 ODV 监控功能。

参数

[in]

lpAddress

: IP 地址

返回

无

程序代码

std::string ptrIpOdv = "10.0.10.171";
pOdvMonitorConnection((char*)ptrIpOdv.c_str());

OdvMonitorDispose()

void OdvMonitorDispose

(

)

释放 ODV 监控资源。

返回

无

PrinterMonitorConnection()

void PrinterMonitorConnection	(	char *	lpAddress,
		INFO_TYP	InfoTyp )

使用网络接口连接打印机以启用打印机监控功能。

参数

[in]

lpAddress

: IP 地址

返回

无

程序代码

std::string ptrIpRfid = "10.0.10.178";
RfidMonitorConnection((char*)ptrIpRfid.c_str());
PrinterMonitorConnection((char*)ptrIpRfid.c_str(), INFO_TYP::RFID_TYP);

PrinterMonitorDispose()

void PrinterMonitorDispose

(

INFO_TYP

InfoTyp

)

释放打印机监控资源。

返回

无

RfidMonitorConnection()

void RfidMonitorConnection

(

char *

lpAddress

)

使用网络接口连接打印机以启用 RFID 监控功能。

参数

[in]

lpAddress

: IP 地址

返回

无

程序代码

std::string ptrIpRfid = "10.0.10.178";
RfidMonitorConnection((char*)ptrIpRfid.c_str());

RfidMonitorDispose()

void RfidMonitorDispose

(

)

释放 RFID 监控资源。

返回

无

SetAlertStatusCallback()

void SetAlertStatusCallback

(

void

callbackconst std::vector< std::string > &alert

)

设置打印机报告监听警报状态的标志。

参数

[in]

callback

:回调函数

返回

无

程序代码

SetAlertStatusCallback(PtrAlertNoticeListener);

SetAlertStatusListening()

void SetAlertStatusListening

(

bool

value

)

设置打印机报告监听警报状态的标志。

参数

[in]

value

: 用来设置打印机报告监听的标志

返回

无

程序代码

SetAlertStatusListening(true);

SetDisplayStatusCallback()

void SetDisplayStatusCallback

(

void

callbackconst std::vector< std::string > &newDisplayText

)

设置打印机报告监听屏幕状态的标志。

参数

[in]

callback

:回调函数

返回

无

程序代码

SetEngineStatusCallback(PtrEngineStatusNoticeListener);

SetDisplayStatusListening()

void SetDisplayStatusListening

(

bool

value

)

设置打印机报告监听屏幕状态的标志。

参数

[in]

value

: 用来设置打印机报告监听的标志

返回

无

程序代码

SetDisplayStatusListening(true);

SetEngineStatusCallback()

void SetEngineStatusCallback

(

void

callbackconst std::string &engineState

)

设置打印机报告监听警报状态的标志。

参数

[in]

callback

:回调函数

返回

无

程序代码

SetEngineStatusCallback(PtrEngineStatusNoticeListener);

SetEngineStatusListening()

void SetEngineStatusListening

(

bool

value

)

设置打印机报告监听引擎状态的标志。

参数

[in]

value

: 用来设置打印机报告监听的标志

返回

无

程序代码

SetEngineStatusListening(true);

SetOdvReportCallback()

void SetOdvReportCallback

(

void

callbackconst OdvReport &report

)

设置一个回调函数来获取 ODV报告。

参数

[in]

callback

:回调函数

返回

无

程序代码

SetOdvReportCallback(OdvReportCallback);

SetOdvReportListening()

void SetOdvReportListening

(

bool

value

)

设置 ODV 报告监听的标志。

参数

[in]

value

: 用来设置 ODV 报告监听的标志

返回

无

程序代码

SetRfidReportListening(true);

SetPrinterConfig()

bool SetPrinterConfig	(	void *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort,
		char *	pConfig )

设置打印机的单一组态设定。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false
[in]	pConfig	: 组态设定

返回

bool

程序代码

char* pConfig = pGetPrinterConfig(commPtr, commTyp, false, 2);
bool result = pSetPrinterConfig(commPtr, commTyp, false, pConfig);

SetPrinterValue()

bool SetPrinterValue	(	void *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort,
		const char *	key,
		const char *	value )

设置打印机的单一设置。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false
[in]	key	打印机设置的一个键值
[in]	value	一個打印机设置值

返回

bool

程序代码

const std::string _key = "Ethernet.Speed";
const std::string _value = "eAutomatic";
bool result = SetPrinterValue(commPtr, commTyp, false, _key.c_str(), _value.c_str());

SetPrinterValues()

bool SetPrinterValues	(	void *	ptrComm,
		COMM_TYP	commTyp,
		bool	usingDataPort,
		std::map< std::string, std::string > *	keysToSet )

设置打印机的多个设置。

参数

[in]	commPtr	: 界面指针
[in]	commTyp	: 接口种类
[in]	usingDataPort	: 使用数据端口传输, 默认是 false
[in]	keysToSet	打印机设置的多个键值

返回

bool

程序代码

std::map<std::string, std::string> keyValues = {
     {"Ethernet.Speed", "eAutomatic"},
      {"Image.Width-in", "3.5"}
   };
bool result = SetPrinterValues(commPtr, commTyp, false, &keyValues);

SetRfidReportCallback()

void SetRfidReportCallback

(

void

callbackconst RfidReport &report

)

设置一个回调函数来获取 RFID 报告。

参数

[in]

callback

:回调函数

返回

无

程序代码

SetRfidReportCallback(RfidReportCallback);

SetRfidReportListening()

void SetRfidReportListening

(

bool

value

)

设置 RFID 报告监听的标志。

参数

[in]

value

: 用来设置 RFID 报告监听的标志

返回

无

程序代码

SetRfidReportListening(true);

变量说明

AllMsg

std::string AllMsg

static

gJsonMessenger

JsonMessenger gJsonMessenger

static

gOdvMonitor

OdvMonitor gOdvMonitor

static

gPrinterMonitor

PrinterMonitor gPrinterMonitor

static

gPrinterMonitor_Odv

PrinterMonitor gPrinterMonitor_Odv

static

gPrinterMonitor_Rfid

PrinterMonitor gPrinterMonitor_Rfid

static

gRfidMonitor

RfidMonitor gRfidMonitor

static

gRfidReport

RfidReport gRfidReport

static