remove unused error averaging from Utilities
[zumo-cc3200/zumo-cc3200.git] / README.md
1 [![download](etc/build.svg)](https://git.ti.com/zumo-cc3200/zumo-cc3200/archive-tarball/master)
3 #[Zumo CC3200][ZumoCC3200]
5 The Zumo CC3200 project was created to enable makers to easily create
6 applications that leverage the power of a [TI CC3200][CC3200] connected to a
7 motorized hardware platform equipped with Inertial Measurement (IMU) 
8 sensors.
10 This repository provides an Energia library, ZumoCC3200, that provides core
11 functions that make it possible to create applications with very little code
12 and without requiring in-depth knowledge of the CC3200 or the specific IMU
13 sensors used to enable closed-loop motor control.  As with most libraries, 
14 ZumoCC3200 includes numerous examples that serve as starting points for
15 new projects.
17 Each of the ZumoCC3200 examples consists of two programs: an Energia program
18 that runs on the Zumo CC3200 robot and a [Processing][Processing]
19 sketch that runs on your laptop. These two programs communicate with one
20 another via WiFi, enabling you to view telemetry data and control the bot
21 from your laptop.
23 ##[The ZumoCC3200 Library][ZumoCC3200Folder]
25 To use the ZumoCC3200 library, 
27 * [Download the ZumoCC3200 library][ZumoCC3200Download], 
28 * [Install the ZumoCC3200 library][ZumoCC3200LibInstall] into your Energia
29   sketchbook, and
30 * [Build and run an example][ZumoCC3200Build]
32 Like most Energia/Arduino libraries, the ZumoCC3200 library includes serveral
33 examples that serve as simple starting points for your project.
35 ##[Processing Sketches][ProcessingFolder]
37 The Processing sketches that communicate with the ZumoCC3200 bot are also 
38 [included in this repo][ProcessingFolder].  Note that some of these sketches
39 rely on freely available Contributed libraries that must be installed.  
41 Prerequisite libraries and installation instructions for these sketches is
42 [here][ProcessingLibInstall].
44 ##[License](license.html)
45 All of the files in this repo are Open Source and most are licensed under 
46 either a BSD 3-clause or MIT license.  However, one file does come with a
47 GPL-2.0 license.  
49 Complete license details are provided [here](license.html).
51 ##Contributing
53 [Zumo CC3200][ZumoCC3200] is a collaborative project originally created as a part of the TI Santa Barbara 2015 Summer Intern program by [Adam Dai and Tony Oliverio][Credits], and you are invited to help. 
55 In-depth details about contributing code, bug fixes, and documentation are
56 forthcoming.  
58 [CC3200]: http://www.ti.com/product/cc3200
59 [Credits]: http://processors.wiki.ti.com/index.php/ZumoCC3200#Credits "Interns"
61 [Processing]: https:/processing.org "Processing Home Page"
62 [ProcessingFolder]: https://gitorious.design.ti.com/sb/zumo/trees/master/src/Processing "ZumoCC3200 Processing Sketch Sources"
63 [ProcessingLibInstall]: http://processors.wiki.ti.com/index.php/ZumoCC3200Demos#Install_Processing_Libraries "Processing Library Install Instructions"
65 [ZumoCC3200]: http://processors.wiki.ti.com/index.php/ZumoCC3200#The_Zumo_CC3200 "ZumoCC3200 Home Page"
66 [ZumoCC3200Build]: http://processors.wiki.ti.com/index.php/ZumoCC3200Demos#Build_and_Upload_a_Zumo_CC3200_Example "ZumoCC3200 Energia Build Instructions"
67 [ZumoCC3200Download]: https://git.ti.com/zumo-cc3200/zumo-cc3200/archive-tarball/master "ZumoCC3200 Repo Download"
68 [ZumoCC3200Folder]: https://gitorious.design.ti.com/sb/zumo/trees/master/src/Energia/libraries "ZumoCC3200 Energia Library Sources"
69 [ZumoCC3200LibInstall]: http://processors.wiki.ti.com/index.php/ZumoCC3200Demos#Install_the_Energia_ZumoCC3200_Library "ZumoCC3200 Energia Library Install Instructions"