Getting started
Example app and development
The example terminal app, running the tests, security and license.
Example app
examples/serialport-test
is a terminal with port picker, settings, AT console and hotplug, for desktop,
Android and iOS:
pnpm install && pnpm build
pnpm playground # desktop
Development
cargo fmt --all --check && cargo clippy --workspace --all-targets -- -D warnings
cargo test --workspace
cargo test -p android-usb-serial --features fake-transport,serialport-compat
pnpm typecheck && pnpm test && pnpm build # build also runs publint, attw and an ESM/CJS check
cd android && ./gradlew lintDebug test
Tests run without hardware: PTY pairs, a local TCP bridge, a fake 27.010 modem,
commands through the Tauri IPC path, and a fake USB transport for the Android
drivers. For manual testing, socat -d -d pty,raw,echo=0 pty,raw,echo=0 gives a
virtual serial pair. See
CONTRIBUTING.md
and PUBLISHING.md.
Security · Support · License
Report vulnerabilities privately as described in SECURITY.md. If the plugin helps you, you can support it via DonationAlerts.
Dual-licensed under MIT or Apache-2.0 (LICENSE-MIT, LICENSE-APACHE).