serialport/node-serialport
Node Serialport
Node-Serialport is a Node.js library that provides cross-platform serial port access for JavaScript applications. It wraps native serial port operations into a stream-based abstraction, enabling consistent read and write behavior across Linux, macOS, and Windows without requiring platform-specific code.
The library includes a mock serial port implementation that uses in-memory streams for testing code without physical hardware, and a parser stream pipeline that transforms raw binary data into structured messages using delimiters, line endings, or fixed byte lengths. It also provides command-line utilities for enumerating available serial ports and opening interactive terminal or REPL sessions for real-time device communication.
The project supports serial data reading and writing through a Node.js stream interface, event-driven data flow for asynchronous communication, and platform-native C++ bindings that interface with operating system serial port APIs. It enables JavaScript-to-firmware bridging for controlling microcontrollers like Arduinos, and integrates with desktop applications through Electron for hardware communication in consumer and commercial devices.
Features
- Node.js Serial Port Libraries - The definitive Node.js library for reading and writing data over serial ports across platforms.
- Serial Port Communication - Accesses serial ports consistently across Linux, macOS, and Windows for hardware communication.
- Serial Device Communication - Enables bidirectional data exchange with hardware devices via serial port streams.
- Serial Port Cross-Platform Access - Provides consistent serial port access across Linux, macOS, and Windows without platform-specific code.
- Mock Serial Port Testing - Tests serial port code by simulating hardware with a mock binding, removing the need for physical devices.
- Firmware Control Bridges - Bridges JavaScript with microcontroller firmware for controlling devices like Arduinos and drones.
- Serial Port - Implements platform-native C++ bindings to interface with operating system serial port APIs.
- Serial Port Event Emitters - Provides event-driven data flow for asynchronous serial communication in Node.js.
- Serial Message Parsers - Transforms raw binary data from a serial port into structured messages using configurable parsers.
- Serial Data Parsers - Chains transform streams to parse raw binary serial data into structured messages.
- Port Enumeration - Discovers available serial ports by querying OS-specific device lists through a unified API.
- Interactive Terminals - Provides a command-line terminal for sending and receiving data interactively over a serial port.
- Desktop Application Integrations - Integrates serial port communication into Electron desktop applications for hardware control.
- JavaScript Firmware Bridges - Bridges JavaScript code with microcontroller firmware to control devices like Arduinos and drones.
- Serial Stream Parsers - Provides a parser stream pipeline for converting raw serial bytes into structured messages.
- Serial Stream Parsers - Applies a transform stream to split raw serial bytes into structured messages using delimiters, lengths, or timeouts.
- Mock Serial Ports - Provides a virtual serial port using in-memory streams for testing without physical hardware.
- Serial Port Listings - Lists all serial ports detected on the system, showing their paths and identifiers for selection.
- Serial Port Terminal Utilities - Ships command-line utilities for enumerating ports and opening interactive serial terminal sessions.
- Serial Port Mocks - Uses a mock binding to simulate serial port communication for automated testing without real hardware.
- Hardware Interaction - Library for accessing serial ports.
