diff --git a/platforms/arduino/docs/docs/index.md b/platforms/arduino/docs/docs/index.md index 7b22782c9..69a3c211a 100644 --- a/platforms/arduino/docs/docs/index.md +++ b/platforms/arduino/docs/docs/index.md @@ -4,18 +4,19 @@ 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. +In the second part, we'll explain the examples to get you starting with 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: +It should work with any board that provides at least 64 kB Flash and a working SPI driver. +So far, we did test the BTstack LE Arduino Shield together with these Arduino boards: - 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. +Please let us know if you got it working with other Arduino clones. ## Discussion and Community Support [BTstack Google Group](http://groups.google.com/group/btstack-dev) diff --git a/platforms/arduino/docs/docs/tutorial.md b/platforms/arduino/docs/docs/tutorial.md index f3cac9c7d..032c2b71f 100644 --- a/platforms/arduino/docs/docs/tutorial.md +++ b/platforms/arduino/docs/docs/tutorial.md @@ -1,8 +1,8 @@ -# Quick Start +# Tutorial ## Arduino IDE -Please install the latest version of the Arduino IDE from +Please install the latest version of the Arduino IDE from . This tutorial was created & tested with version 1.6.4, but it should work with all newer versions. ## BTstack Library @@ -16,15 +16,19 @@ After installing the BTstack Library, you have to restart the Arduino IDE to mak ## 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: +Please plug the BTstack LE Shield into one of the supported Arduino boards listed on the [Welcome page](../). +With an Arduino Mega 2560, it looks 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, +In the Sketch window, press the Upload button. + +![Image of Arduino IDE Sketch](picts/sketch.jpg) + +After it was successfully uploaded to the board, open the Serial Console. The output should look similar to this: @@ -40,7 +44,7 @@ The output should look similar to this: 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. +This example 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 ID, the Minor ID and the iBeacon UUID are shown. -Please have a look at the other [examples](../examples/generated.md), too. +Please have a look at the other [examples](../examples/generated/), too. diff --git a/platforms/arduino/docs/mkdocs.yml b/platforms/arduino/docs/mkdocs.yml index bd1609209..68460ed52 100644 --- a/platforms/arduino/docs/mkdocs.yml +++ b/platforms/arduino/docs/mkdocs.yml @@ -2,7 +2,7 @@ site_name: BTstack Arduino Manual site_dir: btstack-arduino pages: - [index.md, Welcome] -- [tutorial.md, Quick Start] +- [tutorial.md, Tutorial] - [examples/intro.md, Examples] - [examples/generated.md, List of Examples] theme: readthedocs