summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorattila-csipa <git@csipa.net>2017-07-11 20:24:24 +0100
committerattila-csipa <git@csipa.net>2017-07-11 20:24:24 +0100
commit77cc0ce77eaa693a369b3fdd920dd22f1d5783a1 (patch)
tree5122dc790840e896a0df5e847d5744111c2e508e
parentfc3515056b29afc92f1d3ebc58d4c9d1dbb247eb (diff)
documentation and attribution
-rw-r--r--AUTHORS.md1
-rw-r--r--OPENTRACK-LICENSING.txt8
-rw-r--r--README.md2
-rw-r--r--tracker-s2bot/README.md34
4 files changed, 45 insertions, 0 deletions
diff --git a/AUTHORS.md b/AUTHORS.md
index ca3ba840..bf02d78e 100644
--- a/AUTHORS.md
+++ b/AUTHORS.md
@@ -6,5 +6,6 @@ chronological order:
- Donovan Baarda <<abo@minkirri.apana.org.au>>
- Xavier Hallade <<xavier.hallade@intel.com>>
- Michael Welter <<mw.pub@welter-4d.de>>
+- Attila Csipa <<git@csipa.net>>
See OPENTRACK-LICENSING.txt for licensing information.
diff --git a/OPENTRACK-LICENSING.txt b/OPENTRACK-LICENSING.txt
index 068fb101..2402beae 100644
--- a/OPENTRACK-LICENSING.txt
+++ b/OPENTRACK-LICENSING.txt
@@ -73,6 +73,14 @@ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
+# S2Bot tracker
+
+Copyright (c) 2017, Attila Csipa
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
# EOF
# vim: noai:ts=4:sw=4:tw=79
diff --git a/README.md b/README.md
index 78513e8a..3a34c672 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,7 @@ For the latest releases visit: <<https://github.com/opentrack/opentrack/releases
- Windows Phone [tracker](https://github.com/ZanderAdam/OpenTrack.WindowsPhone/wiki) over opentrack UDP protocol
- Arduino with custom firmware
- Intel RealSense 3D cameras (Windows)
+- BBC micro:bit, LEGO, sensortag support via [S2Bot](http://www.picaxe.com/Teaching/Other-Software/Scratch-Helper-Apps/)
# Output
@@ -64,6 +65,7 @@ Don't be afraid to submit an issue/feature request if need arises.
- Xavier Hallade (Intel RealSense tracker author and maintainer)
- furax49 (hatire tracker author)
- Michael Welter (contributor)
+- Attila Csipa (Micro:Bit author)
# Thanks
diff --git a/tracker-s2bot/README.md b/tracker-s2bot/README.md
new file mode 100644
index 00000000..140bf006
--- /dev/null
+++ b/tracker-s2bot/README.md
@@ -0,0 +1,34 @@
+# S2Bot plugin for opentrack
+This is a tracker providing 3D head tracking using the S2Bot helper application.
+
+S2Bot is originally a plugin that connect embedded devices with the [Scratch programming environment](https://scratch.mit.edu/). This plugin emulates the Scratch interface to get access to the sensor data from the various boards. It was developed and tested using the [micro:bit](https://www.microbit.co.uk) board, but should work with any of the S2Bot supported sensor boards that have accelerometers and/or magnetometers. S2Bot is available for Windows, Mac and Linux.
+
+More information on S2Bot can be found [here](http://www.picaxe.com/Teaching/Other-Software/Scratch-Helper-Apps/)
+
+# Installation and usage
+
+1. Download & install S2Bot
+2. Connect BL112 USB dongle
+3. Connect micro:bit to computer via USB
+4. Start S2Bot
+5. Flash micro:bit with s2bot hex firmware from the S2Bot app
+6. Select micro:bit from device selection dropdown
+7. Press scan and select device (the device connection LED should go green after a few seconds, and accelerometer data should appear in the S2Bot status window)
+8. Start opentrack
+9. Select S2Bot plugin as input
+10. Press start to start tracking (the Scratch connection LED will go green as S2Bot treats opentract as a Scratch environment)
+
+# ISC License
+Copyright (c) 2017, Attila Csipa
+
+ Author: Attila Csipa <git@csipa.net>
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+# Attribution
+
+S2Bot and PICAXE® products are developed and distributed by Revolution Education Ltd
+BBC micro:bit is created by the British Broadcasting Corporation or BBC partners.
+Scratch is created by the MIT Media Lab