# noflo-serialport

> Serialport for NoFlo

Latest version **0.1.2** (published 2016-05-11) · 0 weekly downloads

## Install

```sh
npm install noflo-serialport
pnpm add noflo-serialport
yarn add noflo-serialport
bun add noflo-serialport
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2016-05-11 |
| First published | 2015-10-18 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Rafael Azuero Hurtado |
| Maintainers | razueroh |
| Keywords | noflo, noflo-nodejs, serialport |

## Links

- npm: https://www.npmjs.com/package/noflo-serialport
- Repository: https://github.com/razueroh/noflo-serialport
- Homepage: https://github.com/razueroh/noflo-serialport#readme
- Issues: https://github.com/razueroh/noflo-serialport/issues
- npm.io page: https://npm.io/package/noflo-serialport

## Dependencies (2)

- [noflo](https://npm.io/package/noflo.md) ~0.7.5
- [serialport](https://npm.io/package/serialport.md) ^3.1.1

## Recent versions

- 0.1.2 (latest) — 2016-05-11
- 0.1.1 — 2016-02-15
- 0.1.0 — 2015-10-18

## README

# Serialport for NoFlo
[![Build Status](https://secure.travis-ci.org/razueroh/noflo-serialport.png?branch=master)](http://travis-ci.org/razueroh/noflo-serialport) [![npm version](https://badge.fury.io/js/noflo-serialport.svg)](https://badge.fury.io/js/noflo-serialport)

This package provides utility components to access serial ports in the NoFlo Node.js runtime. Based on [node-serialport](https://github.com/voodootikigod/node-serialport).

## Package installation

    npm install noflo-serialport --save

## Basic usage

- Install and set up a [noflo-nodejs runtime](https://github.com/noflo/noflo-nodejs#noflo-nodejs-runtime-environment). Follow [this guide](http://docs.flowhub.io/article/84-getting-started-node-js)
- Install the component library locally with `npm`
- Start the runtime and log into [Flowhub](http://app.flowhub.io). The runtime should show up
- Connect the serial device to the computer
- Create a Flowhub project
- To open the serial port add a `serialport/Open` node and configure the port parameters. The output of the component is a serialport object
- To write or read to the port add a `serialport/Write` and a `serialport/Read` nodes. The `serialport` input must be connected to the output of the `serialport/Open` node

## Component usage

### Close

Close the serial port

Port | Name | Datatype | Description
-----|------|----------|-------------
InPort | serialport | ```string``` | Serialport object
InPort | stop | ```bang``` | Signal to close the serial port
OutPort | error | ```string``` | Message if an error occurs

### Error

Sends a message if an error occurs

Port | Name | Datatype | Description
-----|------|----------|-------------
InPort | serialport | ```string``` | Serialport object
OutPort | error | ```string``` | Message if an error occurs

### Open

Opens the serial port

Port | Name | Datatype | Description
-----|------|----------|-------------
InPort | port | ```string``` | Port name or path
InPort | baudrate | ```number``` | Baud Rate, defaults to `9600`
InPort | databits | ```number``` | Data Bits, defaults to `8`. Must be one of: `5`, `6`, `7`, or `8`
InPort | stopbits | ```number``` | Stop Bits, defaults to `1`. Must be one of: `1` or `2`
InPort | parity | ```string``` | Parity, defaults to `'none'`. Must be one of: `'none'`, `'even'`, `'mark'`, `'odd'`, `'space'`
InPort | buffersize | ```number``` | Size of read buffer, defaults to `255`. Must be an integer value
InPort | parser | ```string``` | The parser engine to use with read data, defaults to `'raw'`
OutPort | out | ```string``` | Serialport object

### Read

Reads the serial port

Port | Name | Datatype | Description
-----|------|----------|-------------
InPort | serialport | ```string``` | Serialport object
OutPort | out | ```object``` | Message. New data from the Serial Port

### Write

Writes data to the serial port

Port | Name | Datatype | Description
-----|------|----------|-------------
InPort | serialport | ```string``` | Serialport object
InPort | message | ```string``` | Message. New data to the Serial Port
InPort | drain | ```boolean``` | Waits until all output data has been transmitted
InPort | start | ```bang``` | Signal to write the message to the serial port

## Example

Name | Gist | Flowhub
-----|------|--------
Serialport Echo | [code](https://gist.github.com/razueroh/0b0f5fbd8485c69391fb) | [example](https://app.flowhub.io/#example/0b0f5fbd8485c69391fb)

---
_Source: https://npm.io/package/noflo-serialport · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._