@rhinosw/react-native-usb-serial 0.0.2

package/package.json

@@ -0,0 +1,176 @@
+{
+  "name": "@rhinosw/react-native-usb-serial",
+  "version": "0.0.2",
+  "description": "Production-ready React Native USB serial communication module for Android with Modbus RTU soil sensor support",
+  "main": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.tsx",
+      "types": "./lib/typescript/src/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "*.podspec",
+    "react-native.config.js",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "example": "yarn workspace react-native-usb-serial-example",
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
+    "prepare": "bob build",
+    "typecheck": "tsc",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "test": "jest",
+    "release": "release-it --only-version"
+  },
+  "keywords": [
+    "react-native",
+    "android",
+    "usb",
+    "serial",
+    "communication",
+    "modbus",
+    "rtu",
+    "soil-sensor",
+    "iot",
+    "hardware"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/RhinoLance/react-native-usb-serial.git"
+  },
+  "author": "Rezaul Karim <devrhinolance.official@gmail.com> (https://github.com/RhinoLance)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/RhinoLance/react-native-usb-serial/issues"
+  },
+  "homepage": "https://github.com/RhinoLance/react-native-usb-serial#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^19.8.1",
+    "@eslint/compat": "^1.3.2",
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.35.0",
+    "@react-native/babel-preset": "0.83.0",
+    "@react-native/eslint-config": "0.83.0",
+    "@release-it/conventional-changelog": "^10.0.1",
+    "@types/jest": "^29.5.14",
+    "@types/react": "^19.2.0",
+    "commitlint": "^19.8.1",
+    "del-cli": "^6.0.0",
+    "eslint": "^9.35.0",
+    "jest": "^29.7.0",
+    "lefthook": "^2.0.3",
+    "react": "19.2.0",
+    "react-native": "0.83.0",
+    "react-native-builder-bob": "^0.40.13",
+    "release-it": "^19.0.4",
+    "turbo": "^2.5.6",
+    "typescript": "^5.9.2"
+  },
+  "workspaces": [
+    "example"
+  ],
+  "packageManager": "yarn@4.11.0",
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "codegenConfig": {
+    "name": "UsbSerialSpec",
+    "type": "modules",
+    "jsSrcsDir": "src",
+    "android": {
+      "javaPackageName": "com.usbserial"
+    }
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
+        }
+      }
+    }
+  },
+  "create-react-native-library": {
+    "type": "turbo-module",
+    "languages": "kotlin-objc",
+    "tools": [
+      "eslint",
+      "jest",
+      "lefthook",
+      "release-it"
+    ],
+    "version": "0.57.2"
+  }
+}

package/src/NativeUsbSerial.ts

@@ -0,0 +1,120 @@
+import { TurboModuleRegistry, type TurboModule , Platform} from 'react-native';
+
+export type UsbDevice = {
+  deviceName: string;
+  vendorId: number;
+  productId: number;
+  manufacturer?: string | null;
+  productName?: string | null;
+  serialNumber?: string | null;
+};
+
+export type SoilData = {
+  [key: string]: number;
+};
+
+export type RawReadConfig = {
+  bufferSize?: number;
+  timeout?: number;
+};
+
+export type SoilSensorConfig = {
+  slaveId?: number;
+  startAddress?: number;
+  registerCount?: number;
+  responseDelayMs?: number;
+};
+
+export interface Spec extends TurboModule {
+  /**
+   * Multiply two numbers
+   */
+  multiply(a: number, b: number): number;
+
+  /**
+   * Returns all connected USB devices
+   */
+  getDeviceList(): UsbDevice[];
+
+  /**
+   * Check if app has permission for a specific device
+   */
+  hasPermission(device: UsbDevice): Promise<boolean>;
+
+  /**
+   * Request USB permission for a specific device
+   */
+  requestUsbPermission(device: UsbDevice): Promise<boolean>;
+
+  /**
+   * Connect to a specific USB device with optional baud rate
+   */
+  connect(device: UsbDevice, baudRate?: number): Promise<boolean>;
+
+  /**
+   * Check if serial connection is active
+   */
+  isConnected(): Promise<boolean>;
+
+  /**
+   * Disconnect the current serial device
+   */
+  disconnect(): Promise<void>;
+
+  /**
+   * Write data to the serial port
+   */
+  write(data: string): Promise<void>;
+
+  /**
+   * Read data from the serial port
+   */
+  read(bufferSize?: number, timeout?: number): Promise<string>;
+
+  /**
+   * Start listening for raw serial data at specified interval
+   */
+  onReadInterval(intervalMs: number, config?: RawReadConfig): Promise<void>;
+
+  /**
+   * Stop listening for raw serial data
+   */
+  offReadInterval(): Promise<void>;
+
+  /**
+   * Get currently connected device
+   */
+  getConnectedDevice(): Promise<UsbDevice | null>;
+
+  /**
+   * Read soil sensor data once
+   */
+  readSoilData(config?: SoilSensorConfig): Promise<SoilData | null>;
+
+  /**
+   * Start listening for soil sensor data at specified interval
+   */
+  onReadSoilDataInterval(
+    intervalMs: number,
+    config?: SoilSensorConfig
+  ): Promise<void>;
+
+  /**
+   * Stop listening for soil sensor data
+   */
+  offReadSoilDataInterval(): Promise<void>;
+}
+
+export type UsbSerialEvent = {
+  data: string;
+};
+
+export type UsbSoilEvent = {
+  [key: string]: number;
+};
+
+function getModule(): Spec {
+ return Platform.OS === 'android' ? TurboModuleRegistry.getEnforcing<Spec>('UsbSerial') : {} as Spec;
+}
+
+export default getModule();

package/src/index.tsx

@@ -0,0 +1,121 @@
+import UsbSerial, {
+  type UsbDevice,
+  type SoilData,
+  type RawReadConfig,
+  type SoilSensorConfig,
+} from './NativeUsbSerial';
+
+/**
+ * Get list of all connected USB devices
+ */
+export function getDeviceList(): UsbDevice[] {
+  return UsbSerial.getDeviceList();
+}
+
+/**
+ * Check if app has permission for a device
+ */
+export function hasPermission(device: UsbDevice): Promise<boolean> {
+  return UsbSerial.hasPermission(device);
+}
+
+/**
+ * Request USB permission for a device
+ */
+export function requestUsbPermission(device: UsbDevice): Promise<boolean> {
+  return UsbSerial.requestUsbPermission(device);
+}
+
+/**
+ * Connect to a USB device
+ */
+export function connect(
+  device: UsbDevice,
+  baudRate?: number
+): Promise<boolean> {
+  return UsbSerial.connect(device, baudRate);
+}
+
+/**
+ * Check if currently connected
+ */
+export function isConnected(): Promise<boolean> {
+  return UsbSerial.isConnected();
+}
+
+/**
+ * Disconnect from device
+ */
+export function disconnect(): Promise<void> {
+  return UsbSerial.disconnect();
+}
+
+/**
+ * Write data to serial port
+ */
+export function write(data: string): Promise<void> {
+  return UsbSerial.write(data);
+}
+
+/**
+ * Read data from serial port
+ */
+export function read(bufferSize?: number, timeout?: number): Promise<string> {
+  return UsbSerial.read(bufferSize, timeout);
+}
+
+/**
+ * Start listening for raw serial data
+ */
+export function onReadInterval(
+  intervalMs: number,
+  config?: RawReadConfig
+): Promise<void> {
+  return UsbSerial.onReadInterval(intervalMs, config);
+}
+
+/**
+ * Stop listening for raw serial data
+ */
+export function offReadInterval(): Promise<void> {
+  return UsbSerial.offReadInterval();
+}
+
+/**
+ * Get currently connected device
+ */
+export function getConnectedDevice(): Promise<UsbDevice | null> {
+  return UsbSerial.getConnectedDevice();
+}
+
+/**
+ * Read soil sensor data once
+ */
+export function readSoilData(
+  config?: SoilSensorConfig
+): Promise<SoilData | null> {
+  return UsbSerial.readSoilData(config);
+}
+
+/**
+ * Start listening for soil sensor data
+ */
+export function onReadSoilDataInterval(
+  intervalMs: number,
+  config?: SoilSensorConfig
+): Promise<void> {
+  return UsbSerial.onReadSoilDataInterval(intervalMs, config);
+}
+
+/**
+ * Stop listening for soil sensor data
+ */
+export function offReadSoilDataInterval(): Promise<void> {
+  return UsbSerial.offReadSoilDataInterval();
+}
+
+// Export types
+export type { UsbDevice, SoilData, RawReadConfig, SoilSensorConfig };
+
+// Export native module
+export default UsbSerial;