From bffb5235ac726cbb011818b78e621e36e246ed9d Mon Sep 17 00:00:00 2001 From: Robert Ly Date: Thu, 19 May 2011 09:48:33 -0700 Subject: [PATCH] cherry pick from hc mr1 Change-Id: I6f48d245e2837226096fe42d08fb0243e416dbbc Change-Id: I77ae1a4f999ae0f4fff925bf8a7f9caf0b868329 --- docs/html/guide/topics/usb/adk.jd | 70 +++++++++++++++---------------- 1 file changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/html/guide/topics/usb/adk.jd b/docs/html/guide/topics/usb/adk.jd index 8aaa65c9fd0b4..e4e12157468b8 100644 --- a/docs/html/guide/topics/usb/adk.jd +++ b/docs/html/guide/topics/usb/adk.jd @@ -24,8 +24,7 @@ page.title=Android Open Accessory Development Kit
  • - How an Accessory Communicates with an Android-powered Device in Accessory - Mode + Implementing the Android Accessory Protocol
    1. Wait for and detect connected devices
      2. @@ -40,8 +39,7 @@ page.title=Android Open Accessory Development Kit
    2. - How the ADK board communicates with an Android-powered Device in - Accessory Mode + How the ADK board implements the Android Accessory Protocol
      1. Wait for and detect connected devices
        2. @@ -56,7 +54,7 @@ page.title=Android Open Accessory Development Kit
      - +

      See also

      @@ -64,7 +62,7 @@ page.title=Android Open Accessory Development Kit
    3. Google I/O Session Video
    4. USB Accessory Dev Guide
    - +

    Where to buy

      @@ -78,6 +76,9 @@ page.title=Android Open Accessory Development Kit
    1. DIY Drones
      2. + +
    2. + Modern Device
    @@ -86,7 +87,7 @@ page.title=Android Open Accessory Development Kit support, which allows external USB hardware (an Android USB accessory) to interact with an Android-powered device in a special "accessory" mode. When an Android-powered powered device is in accessory mode, the connected accessory acts as the USB host (powers the bus and enumerates - devices) and the Android-powered device acts as the device. Android USB accessories are + devices) and the Android-powered device acts as the USB device. Android USB accessories are specifically designed to attach to Android-powered devices and adhere to a simple protocol (Android accessory protocol) that allows them to detect Android-powered devices that support accessory mode. Accessories must also provide 500mA at 5V for charging power. Many previously @@ -112,6 +113,8 @@ page.title=Android Open Accessory Development Kit
  • DIY Drones provides an Arduino-compatible board geared towards RC (radio controlled) and UAV (unmanned aerial vehicle) enthusiasts.
    • +
  • Modern + Device provides an Arduino-compatible board that supports the ADK firmware.

    • We expect more hardware distributers to create a variety of kits, so please stay tuned for @@ -380,14 +383,11 @@ page.title=Android Open Accessory Development Kit accessories communicate with Android-powered devices describe much of what you should be doing in your own accessory.

    -

    How an Accessory Communicates with an Android-powered Device in Accessory Mode

    +

    Implementing the Android Accessory Protocol

    -

    When you connect an accessory to an Android-powered device, the accessory's firmware must - carry out some standard steps to set up communication with the Android-powered device. If you are - building an accessory along with an application, this section goes over some general steps that - your firmware should carry out.

    - -

    In general, an accessory should carry out the following steps:

    +

    An Android USB accessory must adhere to Android Accessory Protocol, which defines how + an accessory detects and sets up communication with an Android-powered device. In general, an + accessory should carry out the following steps:

    1. Wait for and detect connected devices
      2. @@ -399,6 +399,8 @@ page.title=Android Open Accessory Development Kit
    2. Establish communication with the device if it supports the Android accessory protocol
    +

    The following sections go into depth about how to implement these steps.

    +

    Wait for and detect connected devices

    Your accessory should have logic to continuously check @@ -476,12 +478,12 @@ data zero terminated UTF8 string sent from accessory to device

    The following string IDs are supported, with a maximum size of 256 bytes for each string (must be zero terminated with \0).

    -manufacturer name:  1
-model name:         2
-description:        3
-version:            4
-URI:                5
-serial number:      6
+manufacturer name:  0
+model name:         1
+description:        2
+version:            3
+URI:                4
+serial number:      5
    @@ -520,12 +522,11 @@ data: none device's configuration to a value of 1 with a SET_CONFIGURATION (0x09) device request, then communicate using the endpoints.

    -

    How the ADK board communicates with an Android-powered Device in Accessory - Mode

    +

    How the ADK board implements the Android Accessory protocol

    If you have access to the ADK board and shield, the following sections describe the firmware code that you installed onto the ADK board. The firmware demonstrates a practical example of how - to communicate with an Android-powered device. Even if you do not have the ADK board and shield, + to implement the Android Accessory protocol. Even if you do not have the ADK board and shield, reading through how the hardware detects and interacts with devices in accessory mode is still useful if you want to port the code over for your own accessories.

    @@ -540,8 +541,7 @@ data: none sections.

    The following sections describe the firmware code in the context of the algorithm described in - How an Accessory Communicates with an Android-powered Device in Accessory - Mode.

    + Implementing the Android Accessory Protocol.

    Wait for and detect connected devices

    @@ -559,13 +559,13 @@ AndroidAccessory acc("Google, Inc.", "1.0", "http://www.android.com", "0000000012345678"); - + ... void loop() { ... - if (acc.isConnected()) { - //communicate with Android application + if (acc.isConnected()) { + //communicate with Android application } else{ //set the accessory to its default state @@ -728,7 +728,7 @@ bool AndroidAccessory::findEndpoints(byte addr, EP_RECORD *inEp, EP_RECORD *outE Serial.print("Can't get config descriptor\n"); return false; } - + ... @@ -859,13 +859,13 @@ bool AndroidAccessory::configureAndroid(void) changes the state of the accessory, such as lighting up or changing the color of the LED lights.

    -int AndroidAccessory::read(void *buff, int len, unsigned int nakLimit) { 
-  return usb.newInTransfer(1, in, len, (char *)buff, nakLimit); } 
-  
-int AndroidAccessory::write(void *buff, int len) { 
-  usb.outTransfer(1, out, len, (char *)buff); 
+int AndroidAccessory::read(void *buff, int len, unsigned int nakLimit) {
+  return usb.newInTransfer(1, in, len, (char *)buff, nakLimit); }
+
+int AndroidAccessory::write(void *buff, int len) {
+  usb.outTransfer(1, out, len, (char *)buff);
   return len; }
-  
+

    See the firmware/demokit/demokit.pde file for information about how the ADK board