Skip to content

Latest commit

 

History

History
99 lines (60 loc) · 2.6 KB

getting_started_kotlin.md

File metadata and controls

99 lines (60 loc) · 2.6 KB

Basic usage (Kotlin)

Build SerialPort instance

val serialPort = SerialPortBuilder.build(this)

Search device

Use the method doDiscovery(context) to search for devices:

serialPort.doDiscovery(this)

Use the methods getPairedDevicesListBD() and getUnPairedDevicesListBD() to get search results:

serialPort.getPairedDevicesListBD()		//Get a list of paired devices
serialPort.getUnPairedDevicesListBD()	//Get a list of unpaired devices

If the search is not over, the list of unpaired devices may be empty or incomplete.

Connect the device

Setting the correct UUID is an essential step in order to successfully connect the device and complete the communication.

Set legacy device UUID

Use the static method setLegacyUUID(uuid) of SerialPort to set the UUID of the legacy device:

SerialPort.setLegacyUUID("00001101-0000-1000-8000-00805F9B34FB")

For traditional devices generally, you can use the default UUID without setting UUID.

Set BLE device UUID

Use the static method setLegacyUUID(uuid) of SerialPort to set the UUID of the BLE device:

SerialPort.setBleUUID("0000ffe1-0000-1000-8000-00805f9b34fb")

In most cases, BLE devices need to set UUID. For specific UUID, you can check the manual or consult the seller.

In addition, you can also use the method printPossibleBleUUID() to print out a feasible UUID, and try it yourself:

serialPort.printPossibleBleUUID()

Establish connection

Use the method openDiscoveryActivity() to open the built-in search page and select a device to connect to:

serialPort.openDiscoveryActivity()

**What if you don't want to use the built-in search page? **

You can set up a custom search page or connect directly using the device address. See Use a custom interface

Receive message

Use the method setReceivedDataCallback(receivedDataCallback) to set up a received message listener:

serialPort.setReceivedDataCallback { data ->

        }

In addition to this, you can also configure the listener when building the instance:

val serialPort = SerialPortBuilder
            .setReceivedDataCallback { data ->

            }
            .build(this)

Send a message

Send a message using the method sendData(data):

serialPort.sendData("Hello World")

**At this point, you can quickly develop a serial port application that can complete basic sending and receiving data. Of course, SerialPort has many more functions, please continue to read the documentation. **