/FunkenJS

Just a NodeJS Javascript class / wrapper around Serialconnection interfacing with Funken. Written in ECMAScript.

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

Funken logo

FunkenJS

Just a NodeJS Javascript class / wrapper around Serialconnection interfacing with Funken.

Installing FunkenJS

FunkenJS is available as a node-module. If you are not familiar with NodeJS please visit NodeJS

Locally

For installing it inside your project locally use :

npm install --save-dev

Globally

For installing it globally use :

npm install -g 

Examples for FunkenJS

For an example on how to setup event listeners and orchestrate these events please see:

FunkenJSTEST

Documentation

I will document FunkenJS in the future. It is a rather small class and therefore kind of self explaining.

License

FunkenJS: Wrapper around Serialconnection for Funken - Serial Protocol Toolkit Arduino library (GPL) initiated by Alexander Stefas

Copyright (c) 2019, Alexander Stefas

Funken is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation.

Funken is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Funken; If not, see http://www.gnu.org/licenses/.

@license GPL-3.0 https://www.gnu.org/licenses/gpl.html

References

Stefas, A, Rossi, A and Tessmann, O. 2018. Funken: Serial Protocol Toolkit for Interactive Prototyping, In Proceedings of ECAADE 2018, Lodz. Poland