CommSDK.cpp 檔案參考文件

#include "pch.h"
#include "framework.h"
#include "CommSDK.h"
#include "UsbComm.h"
#include "TcpComm.h"
#include "BtComm.h"
#include "ComComm.h"

CommSDK.cpp的包含相依圖:

列舉型態
enum	COMM_IDX { USB_COMM = 0 , TCP_COMM , BT_COMM , COM_COMM }

函式
DLLEXINT	BytesAvailable ()
	取得可讀取資料數量 (bytes)
DLLEXBOOL	Connected ()
	印表機是否處於連接狀態
DLLEXVOID	Read (byte *buffer, int size)
	從印表機讀取資料
DLLEXVOID	Write (byte *dataOut, int iDataSize)
	寫入資料至印表機
DLLEXPBYTE	WriteAndWaitForResponse (byte *dataOut, int iDataSize, int responseStartTimeOut, int responseEndTimeOut, char *completetionToken)
	將位元資料寫入輸出流並返回接收到的資料，返回的資料是任何接收到的資料，或者如果收到完成標誌則返回至該標誌的資料，在返回之前等待回應超時。
DLLEXVOID	Close ()
	從印表機斷開連線
DLLEXVOID	Open ()
	透過介面開啟印表機
DLLEXVOID	SendPrintFile (char *ipAddress, char *fileName)
	透過 NET 介面寫入檔案至印表機
DLLEXVOID	SendPrintString (char *ipAddress, char *data, int iDataSize)
	透過 NET 介面寫入字串至印表機
DLLEXINT	GetAvailableDevices (Tuple_c **devices, int *count)
	傳回有效設備的v_id和p_id，格式為Tuple_c {short v_id;short p_id;}。 「v_id」指供應商ID，「p_id」指供應商ID
DLLEXVOID	UsbConnect (Tuple_c device)
	透過 USB 連接所選擇的印表機
DLLEXVOID	TcpConnect (char *ipAddress, int port)
	透過 NET 連接所選擇的印表機
DLLEXVOID	BtConnect (u_int64 macAddress)
	透過藍芽介面連接所選擇的印表機
DLLEXVOID	ComConnect (std::string ComPort, int BaudRate)
	透過通信埠介面連接所選擇的印表機
DLLEXVOID	GetComm (CObject *&ptrComm)
	取得印表機目前使用的連接介面

變數
CCommSDKApp	theApp
UsbComm	gUsbComm
UsbConnection	gUsbConnection
TcpComm	gTcpComm
TcpConnection	gTcpConnection
BtComm	gBtComm
BtConnection	gBtConnection
ComComm	gComComm
ComConnection	gComConnection
int	giComm = USB_COMM

列舉型態說明文件

COMM_IDX

enum COMM_IDX

列舉值
USB_COMM
TCP_COMM
BT_COMM
COM_COMM

函式說明文件

BtConnect()

DLLEXVOID BtConnect

(

u_int64

macAddress

)

透過藍芽介面連接所選擇的印表機

參數

[in]

macAddress

: 藍芽裝置的 MAC 位址

傳回值

無

程式碼

BtConnect(0x3481F4433DA8);

BytesAvailable()

DLLEXINT BytesAvailable

(

)

取得可讀取資料數量 (bytes)

傳回值

大於 0 : 可讀取的資料數量
等於 0 : 無資料

程式碼

int iBytes = BytesAvailable();
pBuf = new byte[iBytes];
Read(pBuf, iBytes);

Close()

DLLEXVOID Close

(

)

從印表機斷開連線

傳回值

無

程式碼

Close();

ComConnect()

DLLEXVOID ComConnect	(	std::string	ComPort,
		int	BaudRate )

透過通信埠介面連接所選擇的印表機

參數

[in]	ComPort	: 通信埠名稱
[in]	BaudRate	: 鮑率, 設定範圍 (9600 bps ~ 115200 bps)

傳回值

無

程式碼

ComConnect("COM5", 9600);

Connected()

DLLEXBOOL Connected

(

)

印表機是否處於連接狀態

傳回值

真 (連接) or 假 (沒連接)

程式碼

if (true == Connected())

GetAvailableDevices()

DLLEXINT GetAvailableDevices	(	Tuple_c **	devices,
		int *	count )

傳回有效設備的v_id和p_id，格式為Tuple_c {short v_id;short p_id;}。 「v_id」指供應商ID，「p_id」指供應商ID

參數

[out]	devices	: Tuple_c 用於儲存 USB 裝置的 v_id 和 p_id
[out]	count	: 用於儲存 USB 裝置數量

傳回值

int

程式碼

Tuple_c* devices = nullptr;
int count = 0;
GetAvailableDevices(&devices, &count);

GetComm()

DLLEXVOID GetComm

(

CObject *&

ptrComm

)

取得印表機目前使用的連接介面

參數

[in]

ptrComm

: 介面指標

傳回值

無

程式碼

CObject* commPtr = NULL;
GetComm(commPtr);

Open()

DLLEXVOID Open

(

)

透過介面開啟印表機

傳回值

無

程式碼

Open();

Read()

DLLEXVOID Read	(	byte *	buffer,
		int	size )

從印表機讀取資料

參數

[in]	buffer	: 儲存資料的緩衝區
[in]	size	: 緩衝區大小

傳回值

無

程式碼

int iBytes = BytesAvailable();
pBuf = new byte[iBytes];
Read(pBuf, iBytes);

SendPrintFile()

DLLEXVOID SendPrintFile	(	char *	ipAddress,
		char *	fileName )

透過 NET 介面寫入檔案至印表機

參數

[in]	ipAddress	: 印表機的IP位址
[in]	fileName	: 檔案路徑

傳回值

無

程式碼

SendPrintFile((char*)"10.0.10.172", (char*)"rfid.pgl");

SendPrintString()

DLLEXVOID SendPrintString	(	char *	ipAddress,
		char *	data,
		int	iDataSize )

透過 NET 介面寫入字串至印表機

參數

[in]	ipAddress	: 印表機的IP位址
[in]	data	: 待寫入的資料
[in]	iDataSize	: 寫入的資料量

傳回值

無

程式碼

SendPrintString((char*)"10.0.10.172", (char*)"FEED 100", strlen("FEED 100"));

TcpConnect()

DLLEXVOID TcpConnect	(	char *	ipAddress,
		int	port )

透過 NET 連接所選擇的印表機

參數

[in]	ipAddress	: 印表機的IPv4或IPv6位址
[in]	port	: 印表機的埠號

傳回值

無

程式碼

TcpConnect("10.100.15.214", 9100); // IPv4
TcpConnect((char*)"fe80::208:96ff:fe40:9b04%35", 9100); // 鏈路本地 IPv6 位址
TcpConnect((char*)"2001:b030:2219:c40:208:96ff:fe40:9b04", 9100); // 全球單播 IPv6 位址

UsbConnect()

DLLEXVOID UsbConnect

(

Tuple_c

device

)

透過 USB 連接所選擇的印表機

參數

[in]

devices

: Tuple_c 用於所選 USB 裝置的 v_id 和 p_id

傳回值

無

程式碼

UsbConnect(devices[0]);

Write()

DLLEXVOID Write	(	byte *	dataOut,
		int	iDataSize )

寫入資料至印表機

參數

[in]	dataOut	: 待寫入的資料
[in]	iDataSize	: 寫入的資料量

傳回值

無

程式碼

std::string content;
content += "FEED 100";
const char* pStr = content.c_str();
Write((byte*)pStr, strlen(pStr));

WriteAndWaitForResponse()

DLLEXPBYTE WriteAndWaitForResponse	(	byte *	dataOut,
		int	iDataSize,
		int	responseStartTimeOut,
		int	responseEndTimeOut,
		char *	completetionToken )

將位元資料寫入輸出流並返回接收到的資料，返回的資料是任何接收到的資料，或者如果收到完成標誌則返回至該標誌的資料，在返回之前等待回應超時。

參數

[in]	dataOut	: 待寫入印表機的資料
[in]	iDataSize	: 寫入的資料量
[in]	responseStartTimeOut	: 等待接收第一筆資料的超時時間。這是從開始等待到接收到第一個位元資料所花費的時間
[in]	responseEndTimeOut	: 當未收到新資料時的超時時間。這是從接收到最後一個位元資料後開始計算的時間。
[in]	completetionToken	表示預期回應結束的字串標誌。如果只是想在將資料寫入連接後等待回應，這個字串可以是空字串。

傳回值

byte* 從連接中接收到的字串。 返回的資料是任何接收到的資料，或者如果收到完成標誌 (completionToken)，則返回至該標誌為止的資料。

程式碼

std::string content;
content += "FEED 100\r\n";
content += "OUT \"12345678\"\r\n";
std::cout << std::endl;
std::cout << "Send to Printer:" << std::endl;
std::cout << content;
const char* pStr = content.c_str();
byte* pResponse = WriteAndWaitForResponse((byte*)pStr, content.size(), 1000, 500, "\r\n");

變數說明文件

gBtComm

BtComm gBtComm

gBtConnection

BtConnection gBtConnection

gComComm

ComComm gComComm

gComConnection

ComConnection gComConnection

giComm

int giComm = USB_COMM

gTcpComm

TcpComm gTcpComm

gTcpConnection

TcpConnection gTcpConnection

gUsbComm

UsbComm gUsbComm

gUsbConnection

UsbConnection gUsbConnection

theApp

CCommSDKApp theApp