uhf-uart-reader v0.0.6

UHF UART Reader

UHF RFID reader module through UART interface designed for rk3128_box device.

Installation

To install run:

pnpm add uhf-uart-reader

or

npm install uhf-uart-reader

or

yarn add uhf-uart-reader

This module contains an Expo Config Plugin that will automatically add the changes to gradle configuration files when the module is installed. If you are not using Expo, you will need to manually add the changes to the gradle configuration files.

Expo Config Plugin

Add uhf-uart-reader to the plugins in app.json or app.config.ts:

{
	"expo": {
		"plugins": ["uhf-uart-reader"]
	}
}

Manual Installation

android/build.gradle

Update the minSdkVersion and targetSdkVersion to 21:

android/app/build.gradle

Add the following:

...
android {
  ...
  defaultConfig {
    ...
    ndk {
      abiFilters "armeabi-v7a", "armeabi"
    }
  }
}
...

Usage

connectUhfReader

This connects to the UHF reader on the given serial port and specified baud rate, starts reading in the background and returns a boolean indicating if the connection was successful.

import { connectUhfReader } from "uhf-uart-reader";

const connected = await connectUhfReader("/dev/ttyS0", 115200);

setReaderPower

This sets the power of the UHF reader, the power should be a number between 0 and 100.

import { setReaderPower } from "uhf-uart-reader";

setReaderPower(50);

addUhfListener

Note: This function should be called after connectUhfReader has been called.

This adds a listener to the UHF reader, the listener will be called every time a new tag is read.

import { addUhfListener } from "uhf-uart-reader";

addUhfListener((tag) => {
	console.log(`Tag EPC: ${tag.epc}`);
});

This returns a function that can be called to remove the listener.

disconnectUhfReader

This disconnects the UHF reader, it should be called when the reader is no longer needed.

import { disconnectUhfReader } from "uhf-uart-reader";

disconnectUhfReader();

isUhfReaderConnected

This returns a boolean indicating if the UHF reader is connected.

import { isUhfReaderConnected } from "uhf-uart-reader";

const connected = isUhfReaderConnected();

listSerialPorts

This returns a list of available serial ports on the device (the options that can be passed to connectUhfReader).

import { listSerialPorts } from "uhf-uart-reader";

const ports = await listSerialPorts();

listBaudRates

This returns a list of available baud rates that can be passed to connectUhfReader. The baud rates are hardcoded to the following values: [9600, 19200, 38400, 57600, 115200].

import { listBaudRates } from "uhf-uart-reader";

const baudRates = listBaudRates();