Skip to content
abolger edited this page Oct 26, 2013 · 9 revisions

Welcome to the awesomesauce-rfduino wiki!

Getting Started

Before you can use this code at all make sure you have what's listed on this page:

[Getting Started](http://github.com/abolger/awesomesauce-rfduino/wiki/Getting Started)

The RFDuino Example Library

[Prebuilt APK file to install on your Android Device](TODO: link here to latest APK): If all you want is a pre-built Android app to test your board with, you want this

[Latest Stable Example App and Code](TODO: Link latest tag here)

[Latest Tagged Library (v0.1)](TODO: Link to compiled library here) for use in your own Android apps

[Documentation for the Library](TODO: add link here)

Bleeding Edge Development Branch

Further Useful Examples

This library relies heavily on advice and standards from Google Android's Accessory Development Kit. Google has published standards for how to talk to all accessories over Bluetooth or USB Host protocols, and they even provide Arduino sketches to go with them. Google has also published a set of examples and a developer's guide specifically dealing with Bluetooth Low Energy connections.

LGPL Compliance

This, like the rest of this repository, is released under the LGPL. Read the license. To comply with the license, the main practical consideration when you build your Android application and use our pre-built library is make sure that this library is NOT code obscured by Android's "Proguard" feature. That way, it can be deleted and replaced by a different version if the user so chooses. Remember, the intent of the LGPL is to allow a user to update to the latest library even if they install your app. You should also include a written notice that some parts of your application are powered by a library released under the LGPL, and a link to or copy of the library source code to enable users to take advantage of Free Software.

If you make significant modifications to the library, it should be released as a derivative work to comply with the LGPL. However, if you really like your modifications, please consider submitting them as a patch here so as many users as possible can benefit!

Clone this wiki locally