實現 USB 通信的類，並繼承自 AComm 類。更多...

类 com.UniPRT.Sdk.Comm.UsbConnection 继承关系图:

类
class	DescriptorValidateResult

Public 成员函数
short	V_ID ()
	Vendor ID 更多...

short	P_ID ()

int	BytesAvailable ()

boolean	Connected ()

String	Descriptor ()
	返回 USB 連接的描述字符串。更多...

	UsbConnection (Context context, String descriptorHint)
	根据 descriptor hint 初始化该类的新实例。更多...

	UsbConnection (Context context)
	使用預設的廠商 ID 初始化类实例，目标为第一台符合已知厂商 ID 的打印机。更多...

	UsbConnection (Context context, short vendorId)
	使用指定的厂商 ID 初始化类实例，目标为第一台符合该厂商 ID 的打印机。更多...

	UsbConnection (Context context, short vendorId, short productId)
	使用指定的厂商 ID 和产品 ID 初始化类实例，目标为第一台符合两个 ID 的打印机。更多...

void	RequestUSBPermission (String ACTION_USB_PERMISSION)

void	Open ()

void	Close ()

byte[]	Read ()

void	Write (byte[] dataOut)

void	startReceivingTask ()

Public 成员函数继承自 com.UniPRT.Sdk.Comm.AComm
void	Read (OutputStream binDataIn) throws IOException

void	WaitForData (int msTimeOut)
	等待当前线程有可用数据 BytesAvailable。当前线程会休眠直到接收到数据或超时为止。此为阻塞调用。更多...

void	Write (InputStream binReader) throws IOException
	从输入流写入输出流。更多...

void	WriteAndWaitForResponse (OutputStream binDataIn, InputStream binDataOut, int responseStartTimeOut, int responseEndTimeOut, String completetionToken) throws IOException
	将 binDataOut 流数据写入输出流，并将接收到的数据返回到 binDataIn 流中。返回的数据是收到的数据或收到的完成标记。等待响应超时后返回。更多...

byte[]	WriteAndWaitForResponse (byte[] dataOut, int responseStartTimeOut, int responseEndTimeOut, String completetionToken) throws IOException
	将字节数据写入输出流并返回接收到的数据。返回的数据是接收到的任何数据或收到的完成标记。等待响应超时后返回。更多...

静态 Public 成员函数
static DescriptorValidateResult	DescriptorValidate (String descriptorHint)
	驗證 descriptorHint 提供的描述字符串。更多...

static boolean	contains (short[] array, short target)

Public 属性
UsbManager	mUsbManager

UsbDevice	mUsbDevice

静态 Public 属性
static final short	TSC_USB_VID = 0x1203

static final short	PTX_USB_VID = 0x14AE

Private 成员函数
	UsbConnection (Context context, short[] vendorIds, short productId)

Private 属性
short	_v_id = 0x0000

short	_p_id = 0x0000

boolean	_is_connected = false

UsbInterface	mUsbIntf

UsbDeviceConnection	mUsbConnection

UsbEndpoint	mUsbEndpointIn

UsbEndpoint	mUsbEndpointOut

BroadcastReceiver	usbPermissionReceiver

Context	context

PendingIntent	permissionIntent

final Semaphore	semaphore = new Semaphore(1)

final ExecutorService	executor = Executors.newSingleThreadExecutor()

Future<?>	cancelFuture

ByteArrayOutputStream	byteArrayOutputStream = new ByteArrayOutputStream()

final Object	lock = new Object()

静态 Private 属性
static final int	BLOCK_SIZE = 512

详细描述

實現 USB 通信的類，並繼承自 AComm 類。

示例

package com.test.UniPRTSdk;
 
import android.content.Context;
 
import com.UniPRT.Sdk.Comm.UsbConnection;
import com.UniPRT.Sdk.Utilities.Tuple;
 
import java.io.*;
import java.util.List;
 
public class commUsbSnippet {
    private static String ACTION_USB_PERMISSION = "com.example.UniPRTsdk_test.USB_PERMISSION";
    static Context ctx;
    public static void test(Context _ctx) {
        ctx = _ctx;
        sendPrintFile();     // send file over default printer data port
        sendPrintString();   // send print data over default printer data port
    }
 
    public static void sendPrintFile() {
        String fileName = "C:\\testFiles\\Hello.pgl";
 
        UsbConnection ptrUsbComm = new UsbConnection(ctx); // sending through default data port
        ptrUsbComm.RequestUSBPermission(ACTION_USB_PERMISSION);
        try {
            ptrUsbComm.Open();
            if (new File(fileName).exists()) {
                try (InputStream binReader = new BufferedInputStream(new FileInputStream(fileName))) {
                    System.out.println("Sending \"" + fileName + "\" to printer");
 
                    byte[] buffer = new byte[1024];
                    while ((binReader.read(buffer)) != -1) {
                        ptrUsbComm.Write(buffer);
                    }
                }
            } else {
                System.out.println("File \"" + fileName + "\" not found");
            }
        } catch (Exception e) {
            System.out.println("Exception Msg: " + e.getMessage());
        } finally {
            ptrUsbComm.Close();
        }
    }
 
    public static void sendPrintString() {
        String dataToPrint =
                "~CREATE;C39;72\n" +
                        "SCALE;DOT\n" +
                        "PAGE;30;40\n" +
                        "ALPHA\n" +
                        "C10;1;33;0;0;@HELLO@\n" +
                        "C16;54;37;0;0;@*World*@\n" +
                        "STOP\n" +
                        "BARCODE\n" +
                        "C128C;XRD3:3:6:6:9:9:12:12;H6;10;32\n" +
                        "@World@\n" +
                        "STOP\n" +
                        "END\n" +
                        "~EXECUTE;C39\n" +
                        "~NORMAL\n";
 
        UsbConnection ptrUsbComm = new UsbConnection(ctx); // sending through default data port
        ptrUsbComm.RequestUSBPermission(ACTION_USB_PERMISSION);
        try {
            ptrUsbComm.Open();
            if (ptrUsbComm.Connected()) {
                byte[] outBytes = dataToPrint.getBytes("US-ASCII");
                ptrUsbComm.Write(outBytes);
            } else {
                System.out.println("Not connected to printer");
            }
        } catch (Exception e) {
            System.out.println("Exception Msg: " + e.getMessage());
        } finally {
            ptrUsbComm.Close();
        }
    }
}

构造及析构函数说明

◆ UsbConnection() [1/5]

com.UniPRT.Sdk.Comm.UsbConnection.UsbConnection	(	Context	context,
		String	descriptorHint
	)

根据 descriptor hint 初始化该类的新实例。

参数

context	应用程序的 Context。
descriptorHint	描述提示字符串。

引用了 com.UniPRT.Sdk.Comm.UsbConnection.context , 以及 com.UniPRT.Sdk.Comm.UsbConnection.DescriptorValidate().

◆ UsbConnection() [2/5]

com.UniPRT.Sdk.Comm.UsbConnection.UsbConnection ( Context context )

使用預設的廠商 ID 初始化类实例，目标为第一台符合已知厂商 ID 的打印机。

参数

context 软件上下文。

引用了 com.UniPRT.Sdk.Comm.UsbConnection.context, com.UniPRT.Sdk.Comm.UsbConnection.PTX_USB_VID , 以及 com.UniPRT.Sdk.Comm.UsbConnection.TSC_USB_VID.

◆ UsbConnection() [3/5]

com.UniPRT.Sdk.Comm.UsbConnection.UsbConnection	(	Context	context,
		short	vendorId
	)

使用指定的厂商 ID 初始化类实例，目标为第一台符合该厂商 ID 的打印机。

参数

context	软件上下文。
vendorId	指定目标打印机的厂商 ID（例如 TSC 或 PRINTRONIX）。

引用了 com.UniPRT.Sdk.Comm.UsbConnection.context.

◆ UsbConnection() [4/5]

com.UniPRT.Sdk.Comm.UsbConnection.UsbConnection	(	Context	context,
		short	vendorId,
		short	productId
	)

使用指定的厂商 ID 和产品 ID 初始化类实例，目标为第一台符合两个 ID 的打印机。

参数

context	软件上下文。
vendorId	指定目标打印机的厂商 ID（例如 TSC 或 PRINTRONIX）。
productId	指定目标打印机的产品 ID。

引用了 com.UniPRT.Sdk.Comm.UsbConnection.context.

◆ UsbConnection() [5/5]

com.UniPRT.Sdk.Comm.UsbConnection.UsbConnection	(	Context	context,
		short[]	vendorIds,
		short	productId
	)

private

引用了 com.UniPRT.Sdk.Comm.UsbConnection._p_id, com.UniPRT.Sdk.Comm.UsbConnection._v_id, com.UniPRT.Sdk.Comm.UsbConnection.contains(), com.UniPRT.Sdk.Comm.UsbConnection.context, com.UniPRT.Sdk.Comm.UsbConnection.mUsbDevice , 以及 com.UniPRT.Sdk.Comm.UsbConnection.mUsbManager.

成员函数说明

◆ BytesAvailable()

int com.UniPRT.Sdk.Comm.UsbConnection.BytesAvailable ( )

Get the number of bytes available to read.

返回: Number of bytes available to read.

实现了 com.UniPRT.Sdk.Comm.IComm.

引用了 com.UniPRT.Sdk.Comm.UsbConnection.byteArrayOutputStream.

◆ Close()

void com.UniPRT.Sdk.Comm.UsbConnection.Close ( )

Close the connection.

实现了 com.UniPRT.Sdk.Comm.IComm.

引用了 com.UniPRT.Sdk.Comm.UsbConnection._is_connected, com.UniPRT.Sdk.Comm.UsbConnection.byteArrayOutputStream, com.UniPRT.Sdk.Comm.UsbConnection.cancelFuture, com.UniPRT.Sdk.Comm.UsbConnection.executor, com.UniPRT.Sdk.Comm.UsbConnection.mUsbConnection, com.UniPRT.Sdk.Comm.UsbConnection.mUsbIntf , 以及 com.UniPRT.Sdk.Comm.UsbConnection.semaphore.

◆ Connected()

boolean com.UniPRT.Sdk.Comm.UsbConnection.Connected ( )

Check if connection is established.

返回: true if connection is established, otherwise false.

实现了 com.UniPRT.Sdk.Comm.IComm.

引用了 com.UniPRT.Sdk.Comm.UsbConnection._is_connected.

◆ contains()

static boolean com.UniPRT.Sdk.Comm.UsbConnection.contains	(	short[]	array,
		short	target
	)

static

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.UsbConnection().

◆ Descriptor()

String com.UniPRT.Sdk.Comm.UsbConnection.Descriptor ( )

返回 USB 連接的描述字符串。

返回格式：

USB:V_ID:<v_id>; P_ID:<p_id>
p_id 和 v_id 是 short 整數，例如：V_ID:4611; P_ID:1234

实现了 com.UniPRT.Sdk.Comm.IComm.

引用了 com.UniPRT.Sdk.Comm.UsbConnection._p_id , 以及 com.UniPRT.Sdk.Comm.UsbConnection._v_id.

◆ DescriptorValidate()

static DescriptorValidateResult com.UniPRT.Sdk.Comm.UsbConnection.DescriptorValidate ( String descriptorHint )

static

驗證 descriptorHint 提供的描述字符串。

descriptorHint 可接受的格式：

"USB"
"USB:V_ID:4611"
"USB:V_ID:4611; P_ID:1234"
V_ID 和 P_ID 可為十進制或十六進制（例如 0x1203）

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.UsbConnection().

◆ Open()

void com.UniPRT.Sdk.Comm.UsbConnection.Open ( )

Open the connection.

实现了 com.UniPRT.Sdk.Comm.IComm.

引用了 com.UniPRT.Sdk.Comm.UsbConnection._is_connected, com.UniPRT.Sdk.Comm.UsbConnection.mUsbConnection, com.UniPRT.Sdk.Comm.UsbConnection.mUsbDevice, com.UniPRT.Sdk.Comm.UsbConnection.mUsbEndpointIn, com.UniPRT.Sdk.Comm.UsbConnection.mUsbEndpointOut, com.UniPRT.Sdk.Comm.UsbConnection.mUsbIntf, com.UniPRT.Sdk.Comm.UsbConnection.mUsbManager , 以及 com.UniPRT.Sdk.Comm.UsbConnection.startReceivingTask().

◆ P_ID()

short com.UniPRT.Sdk.Comm.UsbConnection.P_ID ( )

引用了 com.UniPRT.Sdk.Comm.UsbConnection._p_id.

◆ Read()

byte [] com.UniPRT.Sdk.Comm.UsbConnection.Read ( )

Read all available bytes.

返回: Array of bytes read.

实现了 com.UniPRT.Sdk.Comm.IComm.

引用了 com.UniPRT.Sdk.Comm.UsbConnection.byteArrayOutputStream , 以及 com.UniPRT.Sdk.Comm.UsbConnection.semaphore.

◆ RequestUSBPermission()

void com.UniPRT.Sdk.Comm.UsbConnection.RequestUSBPermission ( String ACTION_USB_PERMISSION )

引用了 com.UniPRT.Sdk.Comm.UsbConnection.context, com.UniPRT.Sdk.Comm.UsbConnection.mUsbDevice, com.UniPRT.Sdk.Comm.UsbConnection.mUsbManager , 以及 com.UniPRT.Sdk.Comm.UsbConnection.permissionIntent.

◆ startReceivingTask()

void com.UniPRT.Sdk.Comm.UsbConnection.startReceivingTask ( )

引用了 com.UniPRT.Sdk.Comm.UsbConnection.BLOCK_SIZE, com.UniPRT.Sdk.Comm.UsbConnection.byteArrayOutputStream, com.UniPRT.Sdk.Comm.UsbConnection.cancelFuture, com.UniPRT.Sdk.Comm.UsbConnection.executor, com.UniPRT.Sdk.Comm.UsbConnection.lock, com.UniPRT.Sdk.Comm.UsbConnection.mUsbConnection, com.UniPRT.Sdk.Comm.UsbConnection.mUsbEndpointIn , 以及 com.UniPRT.Sdk.Comm.UsbConnection.semaphore.

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.Open().

◆ V_ID()

short com.UniPRT.Sdk.Comm.UsbConnection.V_ID ( )

Vendor ID

引用了 com.UniPRT.Sdk.Comm.UsbConnection._v_id.

◆ Write()

void com.UniPRT.Sdk.Comm.UsbConnection.Write ( byte[] dataOut )

Write all bytes from the array passed in.

参数

dataOut Byte array to write.

实现了 com.UniPRT.Sdk.Comm.IComm.

引用了 com.UniPRT.Sdk.Comm.UsbConnection.lock, com.UniPRT.Sdk.Comm.UsbConnection.mUsbConnection , 以及 com.UniPRT.Sdk.Comm.UsbConnection.mUsbEndpointOut.

类成员变量说明

◆ _is_connected

boolean com.UniPRT.Sdk.Comm.UsbConnection._is_connected = false

private

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.Close(), com.UniPRT.Sdk.Comm.UsbConnection.Connected() , 以及 com.UniPRT.Sdk.Comm.UsbConnection.Open().

◆ _p_id

short com.UniPRT.Sdk.Comm.UsbConnection._p_id = 0x0000

private

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.Descriptor(), com.UniPRT.Sdk.Comm.UsbConnection.P_ID() , 以及 com.UniPRT.Sdk.Comm.UsbConnection.UsbConnection().

◆ _v_id

short com.UniPRT.Sdk.Comm.UsbConnection._v_id = 0x0000

private

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.Descriptor(), com.UniPRT.Sdk.Comm.UsbConnection.UsbConnection() , 以及 com.UniPRT.Sdk.Comm.UsbConnection.V_ID().

◆ BLOCK_SIZE

final int com.UniPRT.Sdk.Comm.UsbConnection.BLOCK_SIZE = 512

staticprivate

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.startReceivingTask().

◆ byteArrayOutputStream

ByteArrayOutputStream com.UniPRT.Sdk.Comm.UsbConnection.byteArrayOutputStream = new ByteArrayOutputStream()

private

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.BytesAvailable(), com.UniPRT.Sdk.Comm.UsbConnection.Close(), com.UniPRT.Sdk.Comm.UsbConnection.Read() , 以及 com.UniPRT.Sdk.Comm.UsbConnection.startReceivingTask().

◆ cancelFuture

Future<?> com.UniPRT.Sdk.Comm.UsbConnection.cancelFuture

private

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.Close() , 以及 com.UniPRT.Sdk.Comm.UsbConnection.startReceivingTask().

◆ context

Context com.UniPRT.Sdk.Comm.UsbConnection.context

private

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.RequestUSBPermission() , 以及 com.UniPRT.Sdk.Comm.UsbConnection.UsbConnection().

◆ executor

final ExecutorService com.UniPRT.Sdk.Comm.UsbConnection.executor = Executors.newSingleThreadExecutor()

private

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.Close() , 以及 com.UniPRT.Sdk.Comm.UsbConnection.startReceivingTask().

◆ lock

final Object com.UniPRT.Sdk.Comm.UsbConnection.lock = new Object()

private

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.startReceivingTask() , 以及 com.UniPRT.Sdk.Comm.UsbConnection.Write().

◆ mUsbConnection

UsbDeviceConnection com.UniPRT.Sdk.Comm.UsbConnection.mUsbConnection

private

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.Close(), com.UniPRT.Sdk.Comm.UsbConnection.Open(), com.UniPRT.Sdk.Comm.UsbConnection.startReceivingTask() , 以及 com.UniPRT.Sdk.Comm.UsbConnection.Write().

◆ mUsbDevice

UsbDevice com.UniPRT.Sdk.Comm.UsbConnection.mUsbDevice

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.Open(), com.UniPRT.Sdk.Comm.UsbConnection.RequestUSBPermission() , 以及 com.UniPRT.Sdk.Comm.UsbConnection.UsbConnection().

◆ mUsbEndpointIn

UsbEndpoint com.UniPRT.Sdk.Comm.UsbConnection.mUsbEndpointIn

private

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.Open() , 以及 com.UniPRT.Sdk.Comm.UsbConnection.startReceivingTask().

◆ mUsbEndpointOut

UsbEndpoint com.UniPRT.Sdk.Comm.UsbConnection.mUsbEndpointOut

private

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.Open() , 以及 com.UniPRT.Sdk.Comm.UsbConnection.Write().

◆ mUsbIntf

UsbInterface com.UniPRT.Sdk.Comm.UsbConnection.mUsbIntf

private

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.Close() , 以及 com.UniPRT.Sdk.Comm.UsbConnection.Open().

◆ mUsbManager

UsbManager com.UniPRT.Sdk.Comm.UsbConnection.mUsbManager

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.Open(), com.UniPRT.Sdk.Comm.UsbConnection.RequestUSBPermission() , 以及 com.UniPRT.Sdk.Comm.UsbConnection.UsbConnection().

◆ permissionIntent

PendingIntent com.UniPRT.Sdk.Comm.UsbConnection.permissionIntent

private

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.RequestUSBPermission().

◆ PTX_USB_VID

final short com.UniPRT.Sdk.Comm.UsbConnection.PTX_USB_VID = 0x14AE

static

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.UsbConnection().

◆ semaphore

final Semaphore com.UniPRT.Sdk.Comm.UsbConnection.semaphore = new Semaphore(1)

private

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.Close(), com.UniPRT.Sdk.Comm.UsbConnection.Read() , 以及 com.UniPRT.Sdk.Comm.UsbConnection.startReceivingTask().

◆ TSC_USB_VID

final short com.UniPRT.Sdk.Comm.UsbConnection.TSC_USB_VID = 0x1203

static

被这些函数引用 com.UniPRT.Sdk.Comm.UsbConnection.UsbConnection().

◆ usbPermissionReceiver

BroadcastReceiver com.UniPRT.Sdk.Comm.UsbConnection.usbPermissionReceiver

private

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

app/src/main/java/com/UniPRT/Sdk/Comm/UsbConnection.java

类

Public 成员函数

静态 Public 成员函数

Public 属性

静态 Public 属性

Private 成员函数

Private 属性

静态 Private 属性

详细描述

示例

构造及析构函数说明

◆ UsbConnection() [1/5]

◆ UsbConnection() [2/5]

◆ UsbConnection() [3/5]

◆ UsbConnection() [4/5]

◆ UsbConnection() [5/5]

成员函数说明

◆ BytesAvailable()

◆ Close()

◆ Connected()

◆ contains()

◆ Descriptor()

◆ DescriptorValidate()

◆ Open()

◆ P_ID()

◆ Read()

◆ RequestUSBPermission()

◆ startReceivingTask()

◆ V_ID()

◆ Write()

类成员变量说明

◆ _is_connected

◆ _p_id

◆ _v_id

◆ BLOCK_SIZE

◆ byteArrayOutputStream

◆ cancelFuture

◆ context

◆ executor

◆ lock

◆ mUsbConnection

◆ mUsbDevice

◆ mUsbEndpointIn

◆ mUsbEndpointOut

◆ mUsbIntf

◆ mUsbManager

◆ permissionIntent

◆ PTX_USB_VID

◆ semaphore

◆ TSC_USB_VID

◆ usbPermissionReceiver