https://github.com/p5-serial/p5.serialserver
Server for use with p5.serialport
https://github.com/p5-serial/p5.serialserver
arduino javascript p5 p5js physical-computing processing serial serialport
Last synced: 3 months ago
JSON representation
Server for use with p5.serialport
- Host: GitHub
- URL: https://github.com/p5-serial/p5.serialserver
- Owner: p5-serial
- License: mit
- Created: 2015-08-27T23:56:39.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-06-18T02:25:44.000Z (about 1 year ago)
- Last Synced: 2025-03-29T11:08:30.065Z (3 months ago)
- Topics: arduino, javascript, p5, p5js, physical-computing, processing, serial, serialport
- Language: JavaScript
- Homepage: https://p5-serial.github.io/p5.serialserver
- Size: 2.45 MB
- Stars: 162
- Watchers: 7
- Forks: 70
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# p5.serialserver
## About
p5.serialserver is a [p5.js](https://p5js.org/) library that enables communication between your p5.js sketch and a serial enabled device, for example, an Arduino microcontroller.
This repository is part of the p5-serial project, for more info please visit [https://github.com/p5-serial/p5.serial.github.io/](https://github.com/p5-serial/p5.serial.github.io/).
## Installation
In order to follow these steps:
1. Connect an Arduino microcontroller or any other serial device to your computer.
2. Clone or download this repository.
3. Follow the steps to use either the Node.js version, or the Processing version.
### Node.js version
1. Open the terminal and navigate to this repository.
2. Install the dependencies with the command `npm install`.
3. Start the server with the command `node startserver.js`.
### Processing version
1. Install the latest Processing app, available at [https://processing.org/](https://processing.org/).
2. Navigate to the p5_serialserver/ folder on this repository and open the file p5_serialserver.pde with the Processing app.
3. Run this app and follow the instructions on it.
## Use
After running the server with Node.js or Processing, you can connect a client to the server.
For this you need to use the companion library p5.serialport available at [https://github.com/p5-serial/p5.serialport](https://github.com/p5-serial/p5.serialport), and follow the instructions over there.
## Contributions
Info about contributing is available at the main repository of this organization: [https://github.com/p5-serial/p5.serial.github.io/](https://github.com/p5-serial/p5.serial.github.io/).