UniPRT 軟體開發套件 v2.0-so (Python)
 
載入中...
搜尋中...
無符合項目
CommSDK.CommSDK 類別 參考文件

公開方法(Public Methods)

 __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)
 取得印表機目前使用的連接介面。
 

公開屬性

 giComm
 

保護屬性

 _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("/dev/ttyUSB0", 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。

傳回值
int
程式碼
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印表機的IPv4或IPv6位址
[in]port印表機的埠號
傳回值
程式碼
TcpConnection("10.100.15.214", 9100)
TcpConnection("fe80::208:96ff:fe40:9b04%ens33", 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