Serial Node Arduino


A Node.js library for serial communication with Arduino devices. Provides a simple event-based interface to interact with Arduino devices through serial communication.

Features

- Event-based serial communication
- Automatic connection/disconnection management
- Command sending with custom aliases
- Support for timeouts and asynchronous responses
- Typed and structured messages
- Support for CommonJS and ES Modules
- Native TypeScript with included type definitions

Installation

Important: This library requires the following peer dependencies that must be installed explicitly:

``bash
npm install @danidoble/serial-node-arduino-tester serialport serial-core
`

Or using yarn:

`bash
yarn add @danidoble/serial-node-arduino-tester serialport serial-core
`

Or using pnpm:

`bash
pnpm add @danidoble/serial-node-arduino-tester serialport serial-core
`

Requirements

- Node.js >= 18.0.0
- serialport ^13.0.0
- serial-core ^0.2.0-dev.3

Usage

$3

`typescript
import { Arduino } from '@danidoble/serial-node-arduino-tester';

// Configure Arduino connection
const arduino = new Arduino({
path: '/dev/ttyUSB0', // Your Arduino serial port
baudRate: 9600,
autoOpen: true
});

// Listen to connection events
arduino.on('serial:connected', info => {
console.log('Arduino connected:', info);
});

arduino.on('serial:disconnected', reason => {
console.log('Arduino disconnected:', reason);
});

// Listen to Arduino messages
arduino.on('serial:message', message => {
console.log('Message received:', message);
});

// Listen to errors
arduino.on('serial:error', error => {
console.error('Error:', error);
});
`

$3

`typescript
// Send predefined commands
await arduino.sayHi();
await arduino.sayCredits();

// Perform multiple actions
await arduino.doSomething();

// Stop the connection
await arduino.stop();
`

$3

Received messages have the following structure:

`typescript
interface SerialMessage {
code: Buffer | string; // Raw code received
name: string; // Message name
description: string; // Message description
request: string; // Alias of the command that generated the response
no_code: number; // Numeric message code
}
`

Predefined Message Types:

- connected (code: 100) - Connection established
- thanks (code: 101) - Credits message from Arduino
- hello there (code: 102) - Greeting message
- ara ara (code: 404) - Easter egg message
- unknown (code: 400) - Unknown/unrecognized message

$3

- serial:status - Serial connection status changes
- serial:connected - Connection established with the device
- serial:disconnected - Device disconnected
- serial:message - Structured message received from Arduino
- serial:data - Raw data received from Arduino
- serial:error - Communication errors

API Documentation

The library includes comprehensive JSDoc comments for all public methods and classes. For detailed information about the Arduino class and its methods, refer to the source code:

- Arduino class - Main class for serial communication
- Types - TypeScript type definitions

$3

- constructor(config: SerialConfig) - Creates an Arduino instance with configuration
- start(): void - Starts the serial service
- stop(): Promise - Stops and disconnects from the Arduino
- sayHi(): Promise - Sends HI command to Arduino
- sayCredits(): Promise - Sends CREDITS command to Arduino
- sayAra(): Promise - Sends OTHER command (ara ara message)
- doSomething(): Promise - Executes all commands concurrently

Arduino Code Example

`c
// serial.ino

void setup() {
Serial.begin(9600);
}

void loop() {
if (Serial.available() > 0) { // Check if data to read is available
String comando = Serial.readStringUntil('\n'); // read the data until a new line is found
comando.trim(); // remove leading/trailing whitespace and \r characters

if(comando == "CONNECT"){
Serial.println("connected");
} else if (comando == "CREDITS") {
Serial.println("created by danidoble");
} else if (comando == "HI") {
Serial.println("hello there");
} else {
Serial.println("ara ara, what are you doing?");
}
}
}
`

Development

$3

`bash
npm install
`

$3

`bash
npm run test
`

$3

`bash
npm run build
`

$3

`bash
npm run format
`

$3

`bash
npm run lint
`

$3

`bash
npm run dev
``

Contributing

Contributions are welcome. Please read CONTRIBUTING.md for more details about our code of conduct and the process for submitting pull requests.

License

This project is licensed under the GPL-3.0 License - see the LICENSE.md file for details.

Author

Danidoble - danidoble@gmail.com

Links

- GitHub Repository
- Report Issues
- NPM Package