first draft for arduino manual

This commit is contained in:
Matthias Ringwald 2015-06-02 22:15:09 +02:00
parent 47b96280ff
commit d73e6e8305
4 changed files with 68 additions and 0 deletions

View File

@ -0,0 +1,21 @@
# BTstack Arduino Manual
Thanks for checking out BTstack on the Arduino platform!
In this manual, we first provide a quick tutorial that helps install the BTstack Library for the Arduino IDE and gets you started with the examples.
In the second part, we'll explain the examples to get you starting in creating your own Sketches that use the BTstack LE Arduino Shield.
## Supported Harware
BTstack LE Arduino Shield together with Arduino boards with at least 64 kB Flash - tested with Arduino.cc IDE v1.6.4:
- Arduino Mega 2560 R3
- Arduino Mega 2560
- Arduino Mega 1280
- Sparkfun Mega 3.3
It should work with any board that provides 64 kB Flash and a working SPI driver, please let us know if you get it working with your hardware.
## Discussion and Community Support
[BTstack Google Group](http://groups.google.com/group/btstack-dev)

Binary file not shown.

After

Width:  |  Height:  |  Size: 173 KiB

View File

@ -0,0 +1,46 @@
# Quick Start
## Arduino IDE
Please install the latest version of the Arduino IDE from <http://arduino.cc>
This tutorial was created & tested with version 1.6.4, but it should work with all newer versions.
## BTstack Library
To install the BTstack library, please download it from <http://bluekitchen-gmbh.com/files/btstack-arduino-latest.zip>
and unpack it into your Arduino libraries folder. On OS X, that's:
~/Documents/Arduino/libraries
After installing the BTstack Library, you have to restart the Arduino IDE to make it show up in the examples section.
## Hardware
Please plug the BTstack LE Shield into one of the supported Arduino boards listed on [the Welcome page](../)
With an Arduino Mega 2560, it should look like this:
![Image of BTstack LE Shield plugged into Arduion Mega 2560](picts/setup.jpg)
## Test
As a first test, open the iBeaconScanner example via File->Examples->BTstack->iBeaconScanner.
In the Sketch window, press the Upload button. After it was successfully uploaded to the board,
open the Serial Console.
The output should look similar to this:
BTstackManager::setup()
Local Address: 0C:F3:EE:00:00:00
--> READY <--
Start scanning
Device discovered: 00:21:3C:AC:F7:38, RSSI -55
Device discovered: 00:21:3C:AC:F7:38, RSSI -55
Device discovered: D0:39:72:CD:83:45, RSSI -55
Device discovered: D0:39:72:CD:83:45, RSSI -55
Device discovered: D0:39:72:CD:83:45, RSSI -55
Device discovered: D0:39:72:CD:83:45, RSSI -55
This examples listens for BLE Advertisements and prints the Bluetooth BD_ADDR (similar to a Wifi MAC) address and the received signal strength. For iBeacons, also the Major and Minor ID as well as the iBeacon UUID is shown.
Please have a look at the other [examples](../examples/generated.md), too.

View File

@ -2,6 +2,7 @@ site_name: BTstack Arduino Manual
site_dir: btstack-arduino
pages:
- [index.md, Welcome]
- [tutorial.md, Quick Start]
- [examples/intro.md, Examples]
- [examples/generated.md, List of Examples]
theme: readthedocs