UniPRT 软件开发工具包 v2.0-pyd (Python)
 
载入中...
搜索中...
未找到
CommSDK.CommSDK类 参考

Public 成员函数

 __init__ (self)
 
int GetBytesAvailable (self)
 取得可读取数据数量 (bytes)。
 
bool Connected (self)
 打印机是否处于连接状态。
 
 Read (self, buffer, size)
 从打印机读取数据。
 
 Write (self, data_out, data_size)
 写入数据至打印机。
 
 WriteAndWaitForResponse (self, data_out, data_size, response_start_time_out, response_end_time_out, completion_token)
 将位数据写入输出流并返回接收到的数据,返回的数据是任何接收到的数据,或者如果收到完成标志则返回至该标志的数据,在返回之前等待回应超时。
 
 Close (self)
 从打印机断开联机。
 
 Open (self)
 开启打印机。
 
 SendPrintFile (self, ipAddress, fileName)
 透过 NET 接口写入档案至打印机。
 
 SendPrintString (self, ipAddress, data, iDataSize)
 透过 NET 接口写入字符串至打印机。
 
Tuple[List[Tuple_c], int] GetAvailableDevices (self)
 传回有效设备的v_id和p_id,格式为Tuple_c。 「v_id」指供货商ID,「p_id」指供货商ID。

 
 UsbConnection (self, Tuple_c device)
 透过 USB 连接所选择的打印机
 
 TcpConnection (self, str ipAddress, int port)
 透过 NET 连接所选择的打印机。
 
 BtConnection (self, str macAddress)
 透过 Bluetooth 连接所选择的打印机。
 
 ComConnection (self, str comport, int baudrate)
 透过串行端口连接所选择的打印机。
 
Union[CObject, None] GetComm (self)
 取得打印机目前使用的连接接口。
 

Public 属性

 giComm
 

Protected 属性

 _socket
 

构造及析构函数说明

◆ __init__()

CommSDK.CommSDK.__init__ ( self)

成员函数说明

◆ BtConnection()

CommSDK.CommSDK.BtConnection ( self,
str macAddress )

透过 Bluetooth 连接所选择的打印机。

参数
[in]macAddress: 蓝芽装置的 MAC 地址
返回
程序代码
BtConnection("34:81:F4:43:3D:A8")

◆ Close()

CommSDK.CommSDK.Close ( self)

从打印机断开联机。

返回
程序代码
Close()

◆ ComConnection()

CommSDK.CommSDK.ComConnection ( self,
str comport,
int baudrate )

透过串行端口连接所选择的打印机。

参数
[in]comport: 串行端口名称
[in]baudrate: 波特率, 设置范围 (9600 bps ~ 115200 bps)
返回
程序代码
Comm_Sdk_Instance.ComConnection("COM5", 9600)

◆ Connected()

bool CommSDK.CommSDK.Connected ( self)

打印机是否处于连接状态。

返回
  • 真 : 连接
  • 假 : 没连接
程序代码
if Connected():
print("Connected")

◆ GetAvailableDevices()

Tuple[List[Tuple_c], int] CommSDK.CommSDK.GetAvailableDevices ( self)

传回有效设备的v_id和p_id,格式为Tuple_c。 「v_id」指供货商ID,「p_id」指供货商ID。

返回
devices, count
程序代码
devices = None
count = 0
GetAvailableDevices()

◆ GetBytesAvailable()

int CommSDK.CommSDK.GetBytesAvailable ( self)

取得可读取数据数量 (bytes)。

返回
  • 大于 0 : 可读取的数据数量
  • 等于 0 : 无资料
程序代码
iBytes = GetBytesAvailable()

◆ GetComm()

Union[CObject, None] CommSDK.CommSDK.GetComm ( self)

取得打印机目前使用的连接接口。

返回
程序代码
commPtr = None
GetComm(commPtr)

◆ Open()

CommSDK.CommSDK.Open ( self)

开启打印机。

返回
程序代码
Open()

◆ Read()

CommSDK.CommSDK.Read ( self,
buffer,
size )

从打印机读取数据。

参数
[in]buffer储存数据的缓冲区
[in]size缓冲区大小
返回
程序代码
i_bytes = GetBytesAvailable()
p_buf = bytearray(i_bytes)
Read(p_buf, i_bytes)

◆ SendPrintFile()

CommSDK.CommSDK.SendPrintFile ( self,
ipAddress,
fileName )

透过 NET 接口写入档案至打印机。

参数
[in]ipAddress打印机的IP地址
[in]fileName档案路径
返回
程序代码
SendPrintFile("10.0.10.172", "rfid.pgl")

◆ SendPrintString()

CommSDK.CommSDK.SendPrintString ( self,
ipAddress,
data,
iDataSize )

透过 NET 接口写入字符串至打印机。

参数
[in]ipAddress打印机的IP地址
[in]data待写入打印机的数据
[in]iDataSize写入的资料量
返回
程序代码
SendPrintString("10.0.10.172", "FEED 100", len("FEED 100"))

◆ TcpConnection()

CommSDK.CommSDK.TcpConnection ( self,
str ipAddress,
int port )

透过 NET 连接所选择的打印机。

参数
[in]ipAddress打印机的IPv44或IPv6地址
[in]port打印机的端口号
返回
程序代码
TcpConnection("10.100.15.214", 9100)
TcpConnection("fe80::208:96ff:fe40:9b04%35", 9100) // 链路本地 IPv6 地址
TcpConnection("2001:b030:2219:c40:208:96ff:fe40:9b04", 9100) // 全球单播 IPv6 地址

◆ UsbConnection()

CommSDK.CommSDK.UsbConnection ( self,
Tuple_c device )

透过 USB 连接所选择的打印机

参数
[in]devices: Tuple_c 用于所选 USB 装置的 v_id 和 p_id
返回
程序代码
UsbConnect(devices[0]);

◆ Write()

CommSDK.CommSDK.Write ( self,
data_out,
data_size )

写入数据至打印机。

参数
[in]data_Out待写入的资料
[in]data_size写入的资料量
返回
程序代码
content = "FEED 100"
p_str = content.encode('utf-8')
Write(p_str, len(p_str))

◆ WriteAndWaitForResponse()

CommSDK.CommSDK.WriteAndWaitForResponse ( self,
data_out,
data_size,
response_start_time_out,
response_end_time_out,
completion_token )

将位数据写入输出流并返回接收到的数据,返回的数据是任何接收到的数据,或者如果收到完成标志则返回至该标志的数据,在返回之前等待回应超时。

参数
[in]data_out待写入打印机的数据
[in]data_size写入的资料量
[in]response_start_time_out等待接收第一笔数据的超时时间。这是从开始等待到接收到第一个位数据所花费的时间
[in]response_end_time_out当未收到新数据时的超时时间。这是从接收到最后一个位数据后开始计算的时间
[in]completion_token表示预期响应结束的字符串标志。如果只是想在将数据写入连接后等待响应,这个字符串可以是空字符串
返回
从连接中接收到的字符串。返回的数据是任何接收到的数据,或者如果收到完成标志 (completionToken),则返回至该标志为止的数据
程序代码
content = "FEED 100\r\nOUT \"12345678\"\r\n"
print("Send to Printer:")
print(content)
p_response = WriteAndWaitForResponse(content.encode('utf-8'), len(content), 1000, 500, "\r\n")

类成员变量说明

◆ _socket

CommSDK.CommSDK._socket
protected

◆ giComm

CommSDK.CommSDK.giComm