hputzek / little-stream-protocol

A javascript implementation to send data via little stream

little-stream-protocol

https://hputzek.github.io/little-stream-protocol/

A javascript implementation to send data via little stream and pixels protocols

Requirement: Node >v12, because it uses es6 modules and no bundler.

Install

This lib is not yet released via npm. You can install it directly from github until it is listed in npm.

Add this to your package.json as a dependency:

"little-stream-protocol": "git+https://[e-mail]/hputzek/little-stream-protocol.git"

Usage

Implement in your own project

You can use this library to use pixels protocol, s protocol or both.

Example with comments

You can find information about the protocols at their corresponding repos, too:

• Udpx by Martin Fasani - firmware
• Pixels by Samuel Archibald - A super simple LED application layer
• s - Little Stream - Embedded streaming layer for UDPX

How to use the testing tool

To

• quickly test possible parameters/options
• benchmark performance
• quick test led stripes using pixels(+s)

you can use the testing tool. In this case you can set all configuration options for both pixels & s via a gui. See next section for how to start it.

Test

Checkout the repo, then

• node --version
  • if you got wrong version (< 12) the easiest solution is node version manager: win / mac/linux
• npm install
• npm run test to run a basic test file from examples folder. (outputs to console)
• npm run dev to start testing tool locally using browser-sync