Skip to content

Latest commit

 

History

History
executable file
·
325 lines (185 loc) · 16.7 KB

File metadata and controls

executable file
·
325 lines (185 loc) · 16.7 KB

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

For Android/USB-focused details (behavior, limits, testing), see also android/README.md.

2.22.0 (2026-03-21)

Android / USB

  • Lifecycle: SerialPlugin registers Application.ActivityLifecycleCallbacks and runs SerialPortManager.cleanup() when the host Activity is destroyed (close USB ports, unregister permission receiver, shut down IO executor).
  • Listening: Incoming data is coalesced in BufferedEmitter / SerialByteAccumulator before serialData events; flush interval via serialDataFlushIntervalMs (native clamp typically 10–2000 ms).
  • USB serial (usb-serial-for-android): Read/write use configured timeouts; clearBuffer maps to purgeHwBuffers when supported; setFlowControl (RTS/CTS, XON/XOFF); SerialInputOutputManager errors trigger serialError and port cleanup.
  • bytesToRead / bytesToWrite (Android): bytesToRead returns bytes buffered in the plugin only while startListening is active (not the kernel queue — not exposed by UsbSerialPort). bytesToWrite is 0 (writes complete synchronously from the app’s perspective). Documented in JSDoc on the JS API.
  • Tooling: Gradle wrapper and android/ settings for local ./gradlew test; JVM unit tests use a real org.json artifact (Android JSON stubs break JSONObject.put in tests). Kotlin tests cover models, JSON helpers, emit pipeline, BufferedEmitter.

Features

  • guest-js: Stricter SerialportOptions / Options typing (removed open index signatures); Record<string, PortInfo> for available_ports maps.

2.21.1 (2025-11-05)

2.21.0 (2025-10-11)

Features

  • serial: emit disconnection events on serial port closure (9870d1f)

2.20.0 (2025-10-11)

Features

  • logger: add centralized logging functionality for the serial plugin (887dcf9)
  • logging: add centralized logging module with adjustable log levels (6cb8a51)
  • logging: add centralized logging module with adjustable log levels (7a7eacd)

Bug Fixes

  • readme: correct indentation and enhance serial port listening example (6e997b5)
  • readme: correct indentation and enhance serial port listening example (df46965)

2.19.0 (2025-08-26)

Features

  • serialplugin: add logging for serial port operations and cleanup (e474046)
  • serialport-manager: add custom prober for unknown USB devices (74b3915)

Bug Fixes

  • android: require USB host feature in AndroidManifest.xml (2227513)
  • serial: correct minimum timeout value for serial port (dd83ded)

2.17.1 (2025-07-02)

2.17.0 (2025-07-02)

Features

  • serial: update listen method to return unlisten function (98e881d)

Bug Fixes

  • listener-manager: handle errors in unlisten functions (30c5445)

2.16.0 (2025-07-01)

Features

  • serial: update listen method to return unlisten function (f7090e0)
  • serial: update listen method to return unlisten function (0ac67ac)

2.15.0 (2025-07-01)

Features

  • listener-manager: implement listener management for serial events (b32b01c)

2.14.0 (2025-07-01)

Features

  • serial: enhance error handling in serial port functions (1403b77)

2.13.0 (2025-07-01)

Features

  • api-iife: update event listener management in serial plugin (81f4522)

2.12.1 (2025-06-19)

Bug Fixes

  • deps: update tauri-plugin-serialplugin to version 2.12.0 (07e7526)
  • mobile_api: correct port opening error handling logic (33f43c7)

2.12.0 (2025-06-12)

Features

  • serialport: add test mode for simulating serial port behavior (22356b5)
  • serialport: add test mode for simulating serial port behavior (287ab53)
  • serialport: improve error handling and add port configuration (5844e2d)
  • tests: add comprehensive tests for serial port functionality (614901e)

2.11.1 (2025-05-25)

2.11.0 (2025-04-04)

Features

  • serial: set a default timeout for serial port connection (c252883)

Bug Fixes

  • deps: update dependencies to latest versions (0d857bb)
  • deps: update dependencies to latest versions (c8dc8f1)

2.10.2 (2025-03-27)

2.10.1 (2025-03-13)

Bug Fixes

  • serialport: update USB permission handling for Android 33+ (b9b0e70)
  • serialport: update USB permission handling for Android 33+ (8034668)

2.10.0 (2025-03-02)

Features

  • serialport-test: refactor app structure and enhance port management (22b0e7a)

Bug Fixes

  • serialport: update USB permission handling for Android 33+ (e71cca9)

2.9.0 (2025-02-05)

Features

  • android: enable hardware acceleration in AndroidManifest.xml (2f16b06)
  • serialport: register USB receiver in SerialPortManager (5f32352)

Bug Fixes

  • device_filter: remove outdated USB device entries (3236183)

2.8.2 (2025-02-02)

Bug Fixes

  • serialport: improve timeout handling and error messages (de2233c)

2.8.1 (2025-02-02)

Bug Fixes

  • permissions: add read-binary command permissions (76262b1)

2.8.0 (2025-01-30)

Features

  • serial: add read_binary command to read binary data from serial port (1a17f99)
  • serial: add read_binary command to read binary data from serial port (83a873d)
  • serial: add read_binary command to read binary data from serial port (09e6a32)
  • serial: add readBinary method for reading binary data (5a62544)

2.7.0 (2025-01-27)

Features

  • mobile_api: update managed_ports to return a list of port names (77e6799)

2.6.1 (2025-01-27)

2.6.0 (2025-01-14)

Features

  • app: add managed ports functionality and UI integration (a3465ce)
  • build: add managed_ports command to the serial plugin (6a79bbb)
  • permissions: add managed_ports command permissions (634b713)
  • permissions: add managed_ports permissions and update documentation (9714453)
  • README: add documentation for managed ports feature (b241c13)
  • schemas: add commands for webview and window background color (67b9670)
  • serial: add managed_ports command to list open serial ports (7eb727d)
  • serialplugin: add managedPorts command to retrieve active ports (378ee2a)
  • serialplugin: add method to list all managed serial ports (d04b991)

2.4.13 (2024-12-24)

Bug Fixes

  • package: update version numbers in package files to 2.4.12 (323a1f9)

2.4.11 (2024-11-29)

2.4.10 (2024-11-29)

2.4.9 (2024-11-29)

2.4.7 (2024-11-29)

2.4.6 (2024-11-29)

2.4.4 (2024-11-29)

2.4.5 (2024-11-29)

2.4.4 (2024-11-29)

Bug Fixes

  • size and timeout settings not working. (e49197d)

[2.3.1] - 2024-11-10

Added

  • Automatic cleanup of existing listeners before starting new ones

[2.3.0] - 2024-11-10

Added

  • New startListening command for explicit port monitoring control
  • New stopListening command for manual monitoring termination

[2.2.0] - 2024-11-10

Added

  • Automatic port listening on connection
  • Background thread management for port monitoring

Changed

  • Refactored read operation to be synchronous instead of event-based
  • Improved port cleanup on close
  • Modified TypeScript interface to return string data directly from read operation
  • Changed port reading logic to use direct synchronous reads
  • Added automatic port monitoring on connection

[2.1.0] - 2024-11-01

Added

  • New serial port control methods:
    • set_baud_rate: Set the baud rate
    • set_data_bits: Set the data bits configuration
    • set_flow_control: Set the flow control mode
    • set_parity: Set the parity checking mode
    • set_stop_bits: Set the stop bits configuration
    • set_timeout: Set the timeout duration
    • write_request_to_send: Set RTS control signal
    • write_data_terminal_ready: Set DTR control signal
    • read_clear_to_send: Read CTS signal state
    • read_data_set_ready: Read DSR signal state
    • read_ring_indicator: Read RI signal state
    • read_carrier_detect: Read CD signal state
    • bytes_to_read: Get available bytes to read
    • bytes_to_write: Get bytes waiting to be written
    • clear_buffer: Clear input/output buffers
    • set_break: Start break signal
    • clear_break: Stop break signal
  • New permissions for all added methods
  • Enhanced error handling for serial port operations

Changed

  • Improved error handling system
  • Enhanced documentation for all methods
  • Updated TypeScript definitions with JSDoc comments

Fixed

  • Error conversion between serialport and internal errors
  • Type conversion issues in serial port operations

[2.0.2] - 2023-12-20

Added

  • Support for direct port scanning on Windows, Linux, and macOS

Changed

  • Updated dependencies to latest versions
  • Improved error messages

Fixed

  • Port detection issues on various platforms

[2.0.1] - 2023-12-10

Changed

  • Updated dependencies
  • Improved available_ports_direct logic
  • Updated test UI

[2.0.0-rc.3] - 2023-12-01

Added

  • Initial implementation of available_ports_direct