aboutsummaryrefslogtreecommitdiff
path: root/drive-sdk/examples/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'drive-sdk/examples/README.md')
-rw-r--r--drive-sdk/examples/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/drive-sdk/examples/README.md b/drive-sdk/examples/README.md
new file mode 100644
index 0000000..9f5e781
--- /dev/null
+++ b/drive-sdk/examples/README.md
@@ -0,0 +1,25 @@
+Anki Drive SDK Examples
+=======================
+
+These examples show how to use the Anki Drive SDK to detect, display, connect to and control vehicles.
+
+
+## vehicle-scan
+
+A linux command line utility to scan for Anki Drive vehicles using Bluetooth LE and display information advertised by vehicles.
+This utility shows how to use the data parsing methods to extract vehicle information from Bluetooth LE advertising data packets.
+`vehicle-scan` links to code distributed with the [bluez][] library and is licensed under the GNU Public License v3.
+
+## vehicle-tool
+
+An interactive command line shell for connecting and controlling Anki Drive vehicles.
+This program demonstrates the Bluetooth LE connection procedure and shows how to interact use the message protocol to interact with vehicles.
+`vehicle-tool` links to code distributed with the [bluez][] library and is licensed under the GNU Public License v3.
+
+[bluez]: http://www.bluez.org
+
+## Building and Running Examples
+
+For a detailed description of how to build and run the example programs, see the guide to [Getting Started on Ubuntu][ubuntu-getting-started].
+
+[ubuntu-getting-started]: https://github.com/anki/drive-sdk/wiki/Getting-Started-on-Ubuntu