Diff: AndroidAccessory.h

Revision:

1:ed3873f4f745

Parent:

0:8a0d4584ca86

Child:

2:0d8581013b28

--- a/AndroidAccessory.h	Mon Jul 11 20:51:05 2011 +0000
+++ b/AndroidAccessory.h	Tue Jul 12 14:42:12 2011 +0000
@@ -33,6 +33,30 @@
 
 bool switchDevice(int device);
 
+/** AndroidAccessory class, using Peter Barrett's USBHost library
+ *
+ * Example:
+ * @code
+ * class Demokit : public AndroidAccessory
+ * {
+ *   public:
+ *   Demokit() : AndroidAccessory      (3,3,
+ *                                      "Google, Inc.",
+ *                                      "DemoKit",
+ *                                      "DemoKit Arduino Board",
+ *                                      "1.0",
+ *                                      "http://www.android.com",
+ *                                      "0000000012345678") {};
+ *   virtual int callbackRead(u8 *buff, int len);
+ *   virtual void setupDevice();
+ *   virtual void resetDevice();
+ *   void switchchk();
+ * private:
+ *
+ *   u8 sw1b,sw2b,sw3b; //swich data
+ * };
+ * @endcode
+ */
 class AndroidAccessory {
 public: