npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

serial-transport

v0.0.1

Published

A promise-based API for serial protocols

Downloads

7

Readme

Serial-Transport

serial-transport is a wrapper around SerialPort that takes the complexity of asynchonous serial communication away, replacing it with a clean and simple promise-based API that understands the request/response nature of serial protocols.

serial-transport lets you define how your packet responses are structured and routes those responses back to the requesting code.

Platform support

https://www.npmjs.com/package/serialport#platform-support

Get started

Setup

npm install serial-transport

Usage

About serial communication

The serial or "comm" port is named as such because the data is in series as opposed to being transmitted in parallel.

However, the serial port only handles the "physical" and "data link" layers of communication. It does not pre-suppose most of the "transport" layer. (Side note: there is no network layer since serial communication is point-to-point and generally does not have to deal with addressing.)

The transport layer is responsible for:

  • flow control - tells the transmitting station to "back-off" when no message buffers are available. (which is included in serial communication.)
  • message segmentation - re-assembling a message made up of smaller segments.
  • message acknowledgement - for relaible end-to-end message delivery.

Limitations of serial port communication

Due to the lack of a standard for message segmentation, serial ports are not able to tell when a message starts or ends. What you get are "data" events that indicate some bytes have been redeived on the port. The data buffer may contain a fragment of a packet, a whole packet, more than one packet, or some combination of the end of a packet, one or more whole packets, and the beginning of another packet.

Packet Handling

serial-transport provides a way to handle the most common "Transport" layer implementations on the serial port.

  • Fixed lenth packets
  • String-delimted packets

Or you can create your own custom packet strategy.

serial-transport also inludes a packet timeout feature that ensures incomplete packets are processed so that transmission errors don't leave junk data on the receive buffer.

Constructor

openOptions https://node-serialport.github.io/node-serialport/global.html#openOptions