serialport

• Version 13.0.0
• Published 10 months ago
• 12.3 kB
• 14 dependencies
• MIT license

Install

npm i serialport

yarn add serialport

pnpm add serialport

Overview

Node.js package to access serial ports. Linux, OSX and Windows. Welcome your robotic JavaScript overlords. Better yet, program them!

Index

Classes

class SerialPort<
    T extends AutoDetectTypes = AutoDetectTypes
> extends SerialPortStream<T> {}

constructor(options: any, openCallback?: ErrorCallback);

static readonly binding: AutoDetectTypes;

static list: () => Promise<import('@serialport/bindings-interface').PortInfo[]>;

class SerialPortMock extends SerialPortStream<MockBindingInterface> {}

constructor(options: SerialPortMockOpenOptions, openCallback?: ErrorCallback);

static readonly binding: MockBindingInterface;

static list: () => Promise<import('@serialport/bindings-interface').PortInfo[]>;

Type Aliases

type SerialPortMockOpenOptions = Omit<OpenOptions<MockBindingInterface>, 'binding'>;

type SerialPortOpenOptions<T extends AutoDetectTypes> = Omit<
    StreamOptions<T>,
    'binding'
> &
    OpenOptionsFromBinding<T>;

Package Files (3)

• dist/index.d.ts
• dist/serialport-mock.d.ts
• dist/serialport.d.ts

Dependencies (14)

• @serialport/binding-mock
• @serialport/bindings-cpp
• @serialport/parser-byte-length
• @serialport/parser-cctalk
• @serialport/parser-delimiter
• @serialport/parser-inter-byte-timeout
• @serialport/parser-packet-length
• @serialport/parser-readline
• @serialport/parser-ready
• @serialport/parser-regex
• @serialport/parser-slip-encoder
• @serialport/parser-spacepacket
• @serialport/stream
• debug

Dev Dependencies (1)

• typescript

Peer Dependencies (0)

No peer dependencies.

• Updated 10 months ago.
  Package analyzed in 3114 ms.
• Missing or incorrect documentation? Open an issue for this package.
• Back to top