Arduionview after seperating Arduinoviewlib

kfessel · Jul 2, 2017 · 8a82486 · 8a82486
1 parent 7a05cf9
commit 8a82486
Show file tree

Hide file tree

Showing 32 changed files with 657 additions and 0 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "lib/flot"]
+	path = ArduinoviewJsServ/lib/flot
+	url = https://github.com/flot/flot
diff --git a/Icon.svg → ArduinoviewJsServ/Icon.svg b/Icon.svg → ArduinoviewJsServ/Icon.svg
diff --git a/Icon128.png → ArduinoviewJsServ/Icon128.png b/Icon128.png → ArduinoviewJsServ/Icon128.png
diff --git a/Icon16.png → ArduinoviewJsServ/Icon16.png b/Icon16.png → ArduinoviewJsServ/Icon16.png
diff --git a/Icon64.png → ArduinoviewJsServ/Icon64.png b/Icon64.png → ArduinoviewJsServ/Icon64.png
diff --git a/background.js → ArduinoviewJsServ/background.js b/background.js → ArduinoviewJsServ/background.js
diff --git a/debug.html → ArduinoviewJsServ/debug.html b/debug.html → ArduinoviewJsServ/debug.html
diff --git a/debug.js → ArduinoviewJsServ/debug.js b/debug.js → ArduinoviewJsServ/debug.js
diff --git a/lib/flot → ArduinoviewJsServ/lib/flot b/lib/flot → ArduinoviewJsServ/lib/flot
diff --git a/lib/plotter.js → ArduinoviewJsServ/lib/plotter.js b/lib/plotter.js → ArduinoviewJsServ/lib/plotter.js
diff --git a/lib/shorthand.js → ArduinoviewJsServ/lib/shorthand.js b/lib/shorthand.js → ArduinoviewJsServ/lib/shorthand.js
diff --git a/manifest.json → ArduinoviewJsServ/manifest.json b/manifest.json → ArduinoviewJsServ/manifest.json
diff --git a/sandbox.html → ArduinoviewJsServ/sandbox.html b/sandbox.html → ArduinoviewJsServ/sandbox.html
diff --git a/sandbox.js → ArduinoviewJsServ/sandbox.js b/sandbox.js → ArduinoviewJsServ/sandbox.js
diff --git a/serial.js → ArduinoviewJsServ/serial.js b/serial.js → ArduinoviewJsServ/serial.js
diff --git a/stringformer.html → ArduinoviewJsServ/stringformer.html b/stringformer.html → ArduinoviewJsServ/stringformer.html
diff --git a/stringformer.js → ArduinoviewJsServ/stringformer.js b/stringformer.js → ArduinoviewJsServ/stringformer.js
diff --git a/window.css → ArduinoviewJsServ/window.css b/window.css → ArduinoviewJsServ/window.css
diff --git a/window.html → ArduinoviewJsServ/window.html b/window.html → ArduinoviewJsServ/window.html
diff --git a/Readme.md b/Readme.md
@@ -0,0 +1,4 @@
+Arduinoview is a simple framework to create control and visualsation applications for Arduino
+
+
+Read [doc/Installation.md]( doc/Installation.md ) for Information about the Installation Process
diff --git a/TODO.md b/TODO.md
@@ -0,0 +1,13 @@
+# TODO
+
+- a "website plus serial server" version where the server provides the serial interface access
+- a Electron app version
+- package ArduinoviewJSserv app
+- select further libraries to include in the app
+- easier reset an initialisation
+- expand Arduinuview-Shorthand
+    - more charts
+    - predefined styles
+- add functions to the Arduino library that map to Arduinoview Shorthand (easy access)
+- better eventhandling on Arduino
+- more examples
diff --git a/doc/Alternatives.md b/doc/Alternatives.md
@@ -0,0 +1,66 @@
+## Alternatives
+
+There are already many ways to provide a user interface for an Arduino project this chapter will name some of them.
+
+### Processing
+
+    https://processing.org/
+    https://github.com/processing
+
+Processing is a programming language and framework based on JAVA to create visual Applications. Its the base for the Arduino IDE and due this there are
+tutorials, examples and libraries available that help combining Processing and Arduino. When using processing the User writes basically two Programms and has
+to maintain their compatibility. One possibility to achieve this is by using a Firmata-firmware on the Arduino and using a matching Firmata library in
+processing.
+
+
+### Firmata
+
+    http://www.firmata.org/
+    https://github.com/firmata
+
+Firmata is a protocol based on the midi message format. It has a huge set of predefined functions to control various I/O of a microcontroller like digital
+and analog pins, I2C- and OneWire-bus, servos and other motors  which are implemented in firmata Arduino firmware. The protocol is designed to be
+expandable by the user. The PC controls the Arduino, which is supported by libraries for various programming languages and frameworks like processing,
+python, perl, ruby, JavaScript, Java ... .
+
+    http://www.acraigie.com/programming/firmatavb/sample_applications.html
+
+### Instrumentino
+
+    http://www.chemie.unibas.ch/~hauser/open-source-lab/instrumentino/index.html
+    https://github.com/yoelk/instrumentino
+    https://github.com/yoelk/controlino
+
+Graphical User Interface for Arduino based experimental instruments based on Python. The user of Instrumentino describes the experiment components in
+description files in python. These components utilize the Arduino witch runs a firmware to interface to sensors and actors. The controlino firmware (part of
+Instrumentino) provides access to various interfaces of the Arduino like analog and digital inputs digital and PWM outputs, i2c and it contains an
+PID-regulator. The PC controls the Arduino and runs the experiment.
+
+### Guino
+
+    https://github.com/madshobye/guino
+    http://www.instructables.com/id/Guino-Dashboard-for-your-Arduino/
+
+A Dashboard for Arduino based on openframeworks (c++ framework with similar targets as Processing has for Java). A Guino GUI will be programmed into the
+Arduino sketch and it will be transferred to the Guino running PC where the Guino software will interpret it into a GUI. This concept is the most similar
+one to Arduinoview. Guino provides a subset of openframeworks GUI elements.
+
+### Viewduino
+
+    http://teachduino.ufsc.br/
+
+Viewer and graphical plotter for semicolon separated values transferred via serial interface from the Arduino.
+
+### Arduviz and Appbuilder
+
+    https://github.com/hharzer/appbuilder2-pkes
+    https://github.com/hharzer/arduviz1.2-pkes
+
+The "Arduviz and Appbuilder" project was developed at the same place as Arduinoview with similar goals. It is similar to Guino and Arduinoview in that
+the Arduino carry's its GUI which runs inside a parser on the PC. Arduviz uses Python and Kivy and provides the user with a subset of its widgets.
+
+### Arduinoview
+
+with this Project Arduinoview is availible. Like Guino and Arduviz the GUI is stored inside the Arduino Programm. Unlike both it tries to avoid to develop its
+own desciption language, instead it makes the most know markup language HTML and it companion JavaScript availible to the Programmer of the UI.
+
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,4 @@
		Arduinoview is a simple framework to create control and visualsation applications for Arduino


		Read [doc/Installation.md]( doc/Installation.md ) for Information about the Installation Process