From 756a593c1bafffd58ad3d3e7e09f2de83976132d Mon Sep 17 00:00:00 2001 From: Dirk Dougherty Date: Mon, 2 May 2016 19:30:18 -0700 Subject: Remove adk docs and channels. Change-Id: I6fa367d806062a126bd1efc67772400bfca66956 --- docs/html/adk/adk.jd | 672 ------------------------------------------- docs/html/adk/adk2.jd | 652 ----------------------------------------- docs/html/adk/index.jd | 30 -- docs/html/channels/io2013.jd | 347 ---------------------- 4 files changed, 1701 deletions(-) delete mode 100755 docs/html/adk/adk.jd delete mode 100644 docs/html/adk/adk2.jd delete mode 100644 docs/html/adk/index.jd delete mode 100644 docs/html/channels/io2013.jd diff --git a/docs/html/adk/adk.jd b/docs/html/adk/adk.jd deleted file mode 100755 index d60249743c81..000000000000 --- a/docs/html/adk/adk.jd +++ /dev/null @@ -1,672 +0,0 @@ -page.title=Accessory Development Kit 2011 Guide -page.tags=adk -@jd:body - -
- -
- -

The Android Open Accessory Development Kit (ADK) is a reference implementation of an Android - Open Accessory, based on the Arduino open source electronics - prototyping platform. The accessory's hardware design files, code that implements the - accessory's firmware, and the Android application that interacts with the accessory are provided - as part of the kit to help hardware builders and software developers get started building their - own accessories. The hardware design files and firmware code are contained in the ADK package download.

- -

A limited number of kits were produced and distributed at the Google I/O 2011 developer - conference. However, many hardware builders have reproduced and enhanced the original design and - these boards are available for purchase. The following list of distributors are currently - producing Android Open Accessory compatible development boards:

- - - -

We expect more hardware distributers to create a variety of kits, so please stay tuned for - further developments.

- -

ADK Components

- -

The main hardware and software components of the ADK include:

- - - -

Getting Started with the ADK

- -

The following sections describe how to install the Arduino software on your computer, use the - Arduino IDE to install the ADK board's firmware, and install and run the accompanying - Android application for the ADK board. Before you begin, download the following items to set up - your development environment:

- - - -

Installing the Arduino software and necessary libraries

- -

To install the Arduino software:

- -
    -
  1. - Download and install the Arduino 1.0 or - higher as described on the Arduino website. - -

    Note: If you are on a Mac, install the FTDI USB Serial - Driver that is included in the Arduino package, even though the installation instructions say - otherwise.

    -
    2. - -
  2. Download and - extract the ADK package to a directory of your choice. You should have an app, - arduino_libs, and hardware directories.
    3. - -
  3. Download and extract - the CapSense package to a directory of your choice.
    4. - -
  4. Install the necessary libraries: - -

    On Windows:

    - -
      -
    1. Copy the arduino_libs/AndroidAccessory and - arduino_libs/USB_Host_Shield directories (the complete directories, - not just the files within) to the <arduino_installation_root>/libraries/ - directory.
      2. - -
    2. Copy the extracted CapSense/ library directory and its contents to the - <arduino_installation_root>/libraries/ directory.
      3. -
    - -

    On Mac:

    - -
      -
    1. Create, if it does not already exist, an Arduino - directory inside your user account's Documents directory, and within - that, a libraries directory.
      2. - -
    2. Copy the arduino_libs/AndroidAccessory and - arduino_libs/USB_Host_Shield directories (the - complete directories, not just the files within) to your - Documents/Arduino/libraries/ directory.
      3. - -
    3. Copy the extracted CapSense/ library directory and its contents to the - Documents/Arduino/libraries/ directory. -
    - -

    On Linux (Ubuntu):

    - -
      -
    1. Copy the firmware/arduino_libs/AndroidAccessory and - firmware/arduino_libs/USB_Host_Shield directories (the complete directories, - not just the files within) to the <arduino_installation_root>/libraries/ - directory.
      2. - -
    2. Copy the extracted CapSense/ library directory and its contents to the - <arduino_installation_root>/libraries/ directory.
      3. - -
    3. Install the avr-libc library by entering sudo apt-get install avr-libc - from a shell prompt.
      4. -
    -
    5. -
- -

You should now have three new directories in the Arduino libraries/ directory: - AndroidAccessory, USB_Host_Shield, and CapSense.

- -

Installing the firmware to the ADK board

- -

To install the firmware to the ADK board:

- -
    -
  1. Connect the ADK board to your computer using the micro-USB port, which allows two-way - communication and provides power to the ADK board.
    2. - -
  2. Launch the Arduino IDE.
    3. - -
  3. Click Tools > Board > Arduino Mega 2560 to specify the ADK board's - type.
    4. - -
  4. Select the appropriate USB port: - -
      -
    • On Windows: click Tools > Serial Port > COM# to specify the port - of communication. The COM port number varies depending on your computer. COM1 is usually - reserved for serial port connections. You most likely want COM2 or COM3.
      • - -
    • On Mac: Click Tools > Serial Port > dev/tty.usbserial-### to - specify the port of communication.
      • - -
    • On Linux (Ubuntu): Click Tools > Serial Port > dev/ttyUSB# to - specify the port of communication.
      • -
    -
    5. - -
  5. To open the Demokit sketch (firmware code), click File > Examples > - AndroidAccessory > demokit.
    6. - -
  6. Click Sketch > Verify/Compile to ensure that the sketch has no - errors.
    7. - -
  7. Select File > Upload. When Arduino outputs Done - uploading., the board is ready to communicate with your Android-powered device.
    8. -
- -

Running the DemoKit Android application

- -

The DemoKit Android application runs on your Android-powered device and communicates with the - ADK board. The ADK board receives commands such as lighting up the board's LEDs or sends data - from the board such as joystick movement and temperature readings.

- -

After the application is installed, you can interact with the ADK board by moving the color - LED or servo sliders (make sure - the servos are connected) or by pressing the relay buttons in the application. On the ADK shield, - you can press the buttons and move the joystick to see their outputs displayed in the - application.

- -

Monitoring the ADK Board

- -

The ADK firmware consists of a few files that you should be looking at if you want to build - your own accessory. The files in the arduino_libs/AndroidAccessory - directory are the most important files and have the logic to detect and connect to - Android-powered devices that support accessory mode. Feel free to add debug statements (Arduino - Serial.println() statements) to the code located in the - <arduino_installation_root>/libraries/AndroidAccessory directory and - demokit.pde sketch and re-upload the sketch to the ADK board to - discover more about how the firmware works.

- -

You can view the debug statements in the Arduino Serial Monitor by clicking Tools > - Serial Monitor and setting the baud to 115200. The following sections about how - accessories communicate with Android-powered devices describe much of what you should be doing in - your own accessory.

- -

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 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.

- -

The important pieces of the firmware are the - arduino_libs/AndroidAccessory/examples/demokit/demokit/demokit.pde sketch, which is - the code that receives and sends data to the DemoKit application running on the Android-powered - device. The code to detect and set up communication with the Android-powered device is contained - in the arduino_libs/AndroidAccessory/AndroidAccessory.h and - arduino_libs/AndroidAccessory/AndroidAccessory.cpp files. This code - includes most of the logic that will help you implement your own accessory's firmware. It might - be useful to have all three of these files open in a text editor as you read through these next - sections.

- -

The following sections describe the firmware code in the context of the algorithm described in - Implementing the Android Accessory Protocol.

- -

Wait for and detect connected devices

- -

In the firmware code (demokit.pde), the loop() function runs - repeatedly and calls AndroidAccessory::isConnected() to check for any connected - devices. If there is a connected device, it continuously updates the input and output streams - going to and from the board and application. If nothing is connected, it continuously checks for - a device to be connected:

- 
-...
-
-AndroidAccessory acc("Google, Inc.",
-                     "DemoKit",
-                     "DemoKit Arduino Board",
-                     "1.0",
-                     "http://www.android.com",
-                     "0000000012345678");
-
-...
-void loop()
-{
-...
-    if (acc.isConnected()) {
-        //communicate with Android application
-    }
-    else{
-        //set the accessory to its default state
-    }
-...
-}
-
- -

Determine the connected device's accessory mode support

- -

When a device is connected to the ADK board, it can already be in accessory mode, support - accessory mode and is not in that mode, or does not support accessory mode. The - AndroidAccessory::isConnected() method checks for these cases and responds - accordingly when the loop() function calls it. This function first checks to see if - the device that is connected hasn't already been handled. If not, it gets the connected device's - device descriptor to figure out if the device is already in accessory mode by calling - AndroidAccessory::isAccessoryDevice(). This method checks the vendor and product ID - of the device descriptor. A device in accessory mode has a vendor ID of 0x18D1 and a product ID - of 0x2D00 or 0x2D01. If the device is in accessory mode, then the ADK board can establish communication with the device. If not, the board attempts to start the device in accessory mode.

- 
-bool AndroidAccessory::isConnected(void)
-{
-    USB_DEVICE_DESCRIPTOR *devDesc = (USB_DEVICE_DESCRIPTOR *) descBuff;
-    byte err;
-
-    max.Task();
-    usb.Task();
-
-    if (!connected &&
-        usb.getUsbTaskState() >= USB_STATE_CONFIGURING &&
-        usb.getUsbTaskState() != USB_STATE_RUNNING) {
-        Serial.print("\nDevice addressed... ");
-        Serial.print("Requesting device descriptor.");
-
-        err = usb.getDevDescr(1, 0, 0x12, (char *) devDesc);
-        if (err) {
-            Serial.print("\nDevice descriptor cannot be retrieved. Program Halted\n");
-            while(1);
-        }
-
-        if (isAccessoryDevice(devDesc)) {
-            Serial.print("found android accessory device\n");
-
-            connected = configureAndroid();
-        } else {
-            Serial.print("found possible device. switching to serial mode\n");
-            switchDevice(1);
-        }
-    } else if (usb.getUsbTaskState() == USB_DETACHED_SUBSTATE_WAIT_FOR_DEVICE) {
-        connected = false;
-    }
-
-    return connected;
-}
-
- -

Attempt to start the device in accessory mode

- -

If the device is not already in accessory mode, then the ADK board must determine whether or - not it supports it by sending control request 51 to check the version of the USB accessory - protocol that the device supports (see AndroidAccessory::getProtocol()). Protocol - version 1 is supported by Android 2.3.4 (API Level 10) and higher. Protocol version 2 is - supported by Android 4.1 (API Level 16) and higher. Versions greater than 2 may supported in - the future. - If the appropriate protocol version is returned, the board sends control request 52 (one - for each string with AndroidAcessory:sendString()) to send it's identifying - information, and tries to start the device in accessory mode with control request 53. The - AndroidAccessory::switchDevice() method takes care of this:

- 
-bool AndroidAccessory::switchDevice(byte addr)
-{
-    int protocol = getProtocol(addr);
-    if (protocol >= 1) {
-        Serial.print("device supports protocol 1\n");
-    } else {
-        Serial.print("could not read device protocol version\n");
-        return false;
-    }
-
-    sendString(addr, ACCESSORY_STRING_MANUFACTURER, manufacturer);
-    sendString(addr, ACCESSORY_STRING_MODEL, model);
-    sendString(addr, ACCESSORY_STRING_DESCRIPTION, description);
-    sendString(addr, ACCESSORY_STRING_VERSION, version);
-    sendString(addr, ACCESSORY_STRING_URI, uri);
-    sendString(addr, ACCESSORY_STRING_SERIAL, serial);
-
-    usb.ctrlReq(addr, 0, USB_SETUP_HOST_TO_DEVICE | USB_SETUP_TYPE_VENDOR | USB_SETUP_RECIPIENT_DEVICE,
-                ACCESSORY_START, 0, 0, 0, 0, NULL);
-    return true;
-}
-
If this method returns false, the board waits until a new device is connected. If it is -successful, the device displays itself on the USB bus as being in accessory mode when the ADK board -re-enumerates the bus. When the device is in accessory mode, the accessory then establishes communication with the device. - -

Establish communication with the device

- -

If a device is detected as being in accessory mode, the accessory must find the proper bulk - endpoints and set up communication with the device. When the ADK board detects an Android-powered - device in accessory mode, it calls the AndroidAccessory::configureAndroid() - function:

- 
-...
-if (isAccessoryDevice(devDesc)) {
-            Serial.print("found android acessory device\n");
-
-            connected = configureAndroid();
-        }
-...
-
- -

which in turn calls the findEndpoints() function:

- 
-...
-bool AndroidAccessory::configureAndroid(void)
-{
-    byte err;
-    EP_RECORD inEp, outEp;
-
-    if (!findEndpoints(1, &inEp, &outEp))
-        return false;
-...
-
- -

The AndroidAccessory::findEndpoints() function queries the Android-powered - device's configuration descriptor and finds the bulk data endpoints in which to communicate with - the USB device. To do this, it first gets the device's first four bytes of the configuration - descriptor (only need descBuff[2] and descBuff[3]), which contains the information about the - total length of data returned by getting the descriptor. This data is used to determine whether - or not the descriptor can fit in the descriptor buffer. This descriptor also contains information - about all the interfaces and endpoint descriptors. If the descriptor is of appropriate size, the - method reads the entire configuration descriptor and fills the entire descriptor buffer with this - device's configuration descriptor. If for some reason the descriptor is no longer attainable, an - error is returned.

- 
-...
-
-bool AndroidAccessory::findEndpoints(byte addr, EP_RECORD *inEp, EP_RECORD *outEp)
-{
-    int len;
-    byte err;
-    uint8_t *p;
-
-    err = usb.getConfDescr(addr, 0, 4, 0, (char *)descBuff);
-    if (err) {
-        Serial.print("Can't get config descriptor length\n");
-        return false;
-    }
-
-
-    len = descBuff[2] | ((int)descBuff[3] << 8);
-    if (len > sizeof(descBuff)) {
-        Serial.print("config descriptor too large\n");
-            /* might want to truncate here */
-        return false;
-    }
-
-    err = usb.getConfDescr(addr, 0, len, 0, (char *)descBuff);
-    if (err) {
-        Serial.print("Can't get config descriptor\n");
-        return false;
-    }
-
-...
-
- -

Once the descriptor is in memory, a pointer is assigned to the first position of the buffer - and is used to index the buffer for reading. There are two endpoint pointers (input and output) - that are passed into AndroidAccessory::findEndpoints() and their addresses are set - to 0, because the code hasn't found any suitable bulk endpoints yet. A loop reads the buffer, - parsing each configuration, interface, or endpoint descriptor. For each descriptor, Position 0 - always contains the size of the descriptor in bytes and position 1 always contains the descriptor - type. Using these two values, the loop skips any configuration and interface descriptors and - increments the buffer with the descLen variable to get to the next descriptor.

- -

Note: An Android-powered device in accessory mode can - potentially have two interfaces, one for the default communication to the device and the other - for ADB communication. The default communication interface is always indexed first, so finding - the first input and output bulk endpoints will return the default communication endpoints, which - is what the demokit.pde sketch does. If you are writing your own firmware, the logic - to find the appropriate endpoints for your accessory might be different.

- -

When it finds the first input and output endpoint descriptors, it sets the endpoint pointers - to those addresses. If the findEndpoints() function finds both an input and output endpoint, it - returns true. It ignores any other endpoints that it finds (the endpoints for the ADB interface, - if present).

- 
-...
-    p = descBuff;
-    inEp->epAddr = 0;
-    outEp->epAddr = 0;
-    while (p < (descBuff + len)){
-        uint8_t descLen = p[0];
-        uint8_t descType = p[1];
-        USB_ENDPOINT_DESCRIPTOR *epDesc;
-        EP_RECORD *ep;
-
-        switch (descType) {
-        case USB_DESCRIPTOR_CONFIGURATION:
-            Serial.print("config desc\n");
-            break;
-
-        case USB_DESCRIPTOR_INTERFACE:
-            Serial.print("interface desc\n");
-            break;
-
-        case USB_DESCRIPTOR_ENDPOINT:
-            epDesc = (USB_ENDPOINT_DESCRIPTOR *)p;
-            if (!inEp->epAddr && (epDesc->bEndpointAddress & 0x80))
-                ep = inEp;
-            else if (!outEp->epAddr)
-                ep = outEp;
-            else
-                ep = NULL;
-
-            if (ep) {
-                ep->epAddr = epDesc->bEndpointAddress & 0x7f;
-                ep->Attr = epDesc->bmAttributes;
-                ep->MaxPktSize = epDesc->wMaxPacketSize;
-                ep->sndToggle = bmSNDTOG0;
-                ep->rcvToggle = bmRCVTOG0;
-            }
-            break;
-
-        default:
-            Serial.print("unkown desc type ");
-            Serial.println( descType, HEX);
-            break;
-        }
-
-        p += descLen;
-    }
-
-    if (!(inEp->epAddr && outEp->epAddr))
-        Serial.println("can't find accessory endpoints");
-
-    return inEp->epAddr && outEp->epAddr;
-}
-
-...
-
- -

Back in the configureAndroid() function, if there were endpoints found, they are - appropriately set up for communication. The device's configuration is set to 1 and the state of - the device is set to "running", which signifies that the device is properly set up to communicate - with your USB accessory. Setting this status prevents the device from being re-detected and - re-configured in the AndroidAccessory::isConnected() function.

- 
-bool AndroidAccessory::configureAndroid(void)
-{
-    byte err;
-    EP_RECORD inEp, outEp;
-
-    if (!findEndpoints(1, &inEp, &outEp))
-        return false;
-
-    memset(&epRecord, 0x0, sizeof(epRecord));
-
-    epRecord[inEp.epAddr] = inEp;
-    if (outEp.epAddr != inEp.epAddr)
-        epRecord[outEp.epAddr] = outEp;
-
-    in = inEp.epAddr;
-    out = outEp.epAddr;
-
-    Serial.print("inEp: ");
-    Serial.println(inEp.epAddr, HEX);
-    Serial.print("outEp: ");
-    Serial.println(outEp.epAddr, HEX);
-
-    epRecord[0] = *(usb.getDevTableEntry(0,0));
-    usb.setDevTableEntry(1, epRecord);
-
-    err = usb.setConf( 1, 0, 1 );
-    if (err) {
-        Serial.print("Can't set config to 1\n");
-        return false;
-    }
-
-    usb.setUsbTaskState( USB_STATE_RUNNING );
-
-    return true;
-}
-
- -

Lastly, methods to read and write to the appropriate endpoints are needed. The - demokit.pde sketch calls these methods depending on the data that is read from the - Android-powered device or sent by the ADK board. For instance, moving the joystick on the ADK - shield writes data that is read by the DemoKit application running on the Android-powered device. - Moving sliders on the DemoKit application is read by the demokit.pde sketch and - 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);
-  return len; }
-
- -

See the demokit.pde sketch for information about how the ADK board - reads and writes data.

diff --git a/docs/html/adk/adk2.jd b/docs/html/adk/adk2.jd deleted file mode 100644 index d69125aeaac8..000000000000 --- a/docs/html/adk/adk2.jd +++ /dev/null @@ -1,652 +0,0 @@ -page.title=Accessory Development Kit 2012 Guide -page.tags=adk -@jd:body - -
- -
- -

The Android Accessory Development Kit (ADK) for 2012 is the latest reference implementation of an -Android Open Accessory device, -designed to help Android hardware accessory builders and software developers create accessories -for Android. The ADK 2012 is based on the Arduino open source -electronics prototyping platform, with some hardware and software extensions that allow it to -communicate with Android devices.

- -

A limited number of these kits were produced and distributed at the Google I/O 2012 developer -conference. If you did not receive one of these kits, fear not! The specifications and design files -for the hardware were also released for use by manufacturers and hobbyists. You should expect to see -kits with similar features available for purchase, or you can build one yourself!

- -

One of the important new features demonstrated by this ADK is the ability to play audio over a -USB connection. Be sure to check out the reference implementation of a USB -audio dock in this ADK if you are interested in making audio-related USB accessories for -Android.

- -

Components

- -

The ADK 2012 is based on the Arduino open source electronics prototyping platform and is an open -hardware design. The hardware design files and firmware source code are included with the ADK -software download. The ADK contains two main physical hardware components:

- -
    -
  1. Main processing board containing the microprocessor, USB connections, power connector and -input/output pins. This board can be removed and used separately from the rest of the hardware.
    2. -
  2. Shield containing sensors, LEDs, input controls, audio amplifier and speaker output, contained -in a custom, polygon box enclosure.
    3. -
- -

The main hardware features of the ADK are as follows:

- - - -

The ADK comes preloaded with an alarm clock firmware program that you can use immediately. A -companion Android application, ADK 2012, is -available on Google Play. The source code for both the Android application and the ADK firmware (an -Arduino sketch) can be downloaded from this page.

- -

The ADK 2012 also comes with additional parts to help you develop accessories with it, -including:

- - - -

Using the Alarm Clock

- -

An alarm clock program comes preloaded on the ADK. This firmware program allows you to use the -ADK as an alarm clock.

- -

To use the ADK as an alarm clock:

- -
    -
  1. Open up the ADK by gently squeezing the two widest faces of the enclosure.
    2. -
  2. Attach the provided AC power adapter (round connector) to the main ADK board, or attach a USB -cable to the port marked Computer and a USB port on your computer.
    3. -
  3. Place and hold your fingertip over the clock symbol on the control face. -

    Note: You may need to hold your finger in place for 1-2 -seconds.

    -
    4. -
  4. Use the plus (+) and minus (-) symbols inside the clock digits to set the correct time.
    5. -
  5. Place your fingertip over the alarm clock symbol to activate alarm setting.
    6. -
  6. Use the plus (+) and minus (-) symbols inside the clock digits to set the alarm time.
    7. -
  7. Use the plus (+) and minus (-) symbols inside the last two clock digits to turn the alarm on -({@code on}) or off ({@code oF}).
    8. -
  8. To set the alarm tone, place and hold your fingertip over the alarm clock symbol, then tap the -slider control on top of the enclosure.
    9. -
- -

To use the ADK 2012 companion application for the alarm clock:

- -
    -
  1. Load the companion application on your Android device running Android 3.1 (API Level 12) or -higher: -
      -
    • Using an NFC-enabled Android device, unlock and hold the device against the left side of -the ADK enclosure. Follow the prompts to install the app. -
      - or -
      • -
    • Start Google Play on your device, search for the ADK 2012 application and -install it. If you cannot find the app, your device is not compatible. Try installing on another -device.
      • -
    -
    2. -
  2. Connect your Android device to the ADK using one of the following methods: -
      -
    • To connect using Bluetooth: -
        -
      1. Plug the AC power adapter into the ADK.
        2. -
      2. On your Android device, turn Bluetooth On (Settings > -Bluetooth).
        3. -
      3. In the Settings page, press the Bluetooth option to -view paired devices.
        4. -
      4. Select Search for Devices to locate the ADK 2012 accessory and follow -the on screen instructions to connect.
        5. -
      5. After pairing is complete, start the ADK 2012 app on your Android -device.
        6. -
      6. On the start screen, select the Use Bluetooth button.
        7. -
      7. In the list of paired devices, select the ADK 2012 device.
        8. -
      8. The ADK 2012 app should switch to the menu screen and you can start -interacting with the ADK accessory.
        9. -
      -
      • - -
    • To connect using USB: -
        -
      1. Plug the AC power adapter into the ADK.
        2. -
      2. Connect the Micro USB AB connector (small, rectangular plug) to the port labeled -Phone on the ADK board.
        3. -
      3. Unlock your Android device and connect the Micro USB B connector to your device. -

        Note: Your device must support Android USB accessory -mode. Devices that support this mode include Google Nexus devices.

        -
        4. -
      4. On the Android device, you should see a prompt to connect to the ADK DemoKit -2012, select OK.
        5. -
      5. The ADK 2012 app should start automatically and you can start -interacting with the ADK.
        6. -
      -
      • -
    -
    3. -
- -

Note: When using the ADK with a USB connection to an Android -device, make sure the AC power adapter is plugged in. A USB connection to a computer does not -provide sufficient voltage to power both the ADK and a USB connection to a device.

- - -

Playing Audio

- -

The ADK 2012 comes with audio output capabilities, including an amplifier and speaker. You can -use it to play audio from your Android device using either a Bluetooth or USB connection.

- -

To play audio over Bluetooth:

- -
    -
  1. Follow the instructions in the previous section to connect your Android -device to the ADK over Bluetooth.
    2. -
  2. On your Android device, navigate to the Settings > Bluetooth page to view the -list of paired devices, and make sure the ADK is connected.
    3. -
  3. Select the settings icon next to the ADK 2012 item.
    4. -
  4. Make sure the Media Audio option is enabled.
    5. -
  5. Navigate to an application that plays music or other audio.
    6. -
  6. Play a song or sound and listen to it on the ADK speaker!
    7. -
- -

To play audio over USB, you must use a device running Android 4.1 (API Level 16) or higher:

- -
    -
  1. Plug the AC power adapter into the ADK.
    2. -
  2. Connect the Micro USB AB connector (small, rectangular plug) to the Phone port on the ADK -board.
    3. -
  3. Unlock your Android device and connect the Micro USB B connector to your device. -

    Note: Your device must support Android USB accessory -mode. Devices that support this mode include Google Nexus devices.

    -
    4. -
  4. On the Android device, you should see a prompt to connect to the ADK DemoKit -2012, select Cancel and allow the ADK to connect as a media device -only.
    5. -
  5. Navigate to an application that plays music or other audio.
    6. -
  6. Play a song or sound and listen to it on the ADK speaker!
    7. -
- -

Note: When using the ADK with a USB connection to an Android -device, make sure the AC power adapter is plugged in. A USB connection to a computer does not -provide sufficient voltage to power both the ADK and a USB connection to a device.

- - -

Developing Accessories with ADK 2012

- -

The ADK 2012 is a hardware platform and a set of software libraries for prototyping Android -accessories. This section discusses how to set up a development environment for programming the ADK -to make it do what you want and to test software for building your own Android accessories.

- -

Downloading the ADK Source

- -

The support software and hardware specifications for the ADK 2012 are available from the Android -source repository. Follow the instructions below to obtain the source material for the ADK.

- -

To download the ADK 2012 software, source code and hardware design specifications.

- -
    -
  1. Download and install Git for your development -system.
    2. -
  2. Download and setup the {@code repo} tool, as described on the Android open source -project site. -

    Note: Developers using Windows must use a Linux compatibility -package, such as cygwin, to install and run {@code repo}. -Within your compatibility environment, you must install {@code curl}, {@code git} and {@code -python} to be able to download and use the {@code repo} tool.

    -
    3. -
  3. In a terminal window, create a new directory for the downloaded source files, initialize and -synchronize a local repository: -
    -$> mkdir android-accessories
-$> cd android-accessories
-$> repo init -u https://android.googlesource.com/accessories/manifest
-$> repo sync
-
    -
    4. -
- -

After successfully completing this process, you should have the source code and tools for -working with the ADK 2012:

- - - - -

Setting Up the Development Environment

- -

The ADK 2012 comes with an integrated development environment (IDE) that you use to develop -software and program the ADK 2012 accessory. The following instructions explain how to setup and run -the ADK 2012 IDE.

- -

To set up and run the ADK 2012 IDE:

- -
    -
  1. Download and install the Java Development Kit 6 or higher from java.oracle.com.
    2. -
  2. Download the ADK 2012 IDE for your development platform: - -
    3. -
  3. Unpack the downloaded archive.
    4. -
  4. Run the application by navigating to the unpacked {@code ADK2012_IDE/} folder and execute - the {@code arduino} file.
    5. -
- -

After you have successfully installed and run the ADK 2012 IDE, you must configure it to use -the ADK 2012 library.

- -

To configure the ADK 2012 IDE for use with the ADK libraries:

- -
    -
  1. Start the ADK 2012 IDE and choose File > Preferences.
    2. -
  2. In the Preferences dialog, make a note of the Sketchbook -location directory.
    3. -
  3. Copy the {@code <adk-source-download>/adk2012/board/library/ADK2} directory and its -contents into your {@code sketchbook/libraries/} directory, so that you create a {@code -sketchbook/libraries/ADK2} directory.
    4. -
  4. Stop and restart the ADK 2012 IDE.
    5. -
  5. In the IDE, choose File > Examples > ADK2 and then choose one of the example -sketches: -
      -
    • clock - The sketch that is preloaded onto the ADK 2012.
      • -
    • BluetoothScan - An example sketch demonstrating code that connects an -accessory to an Android device over Bluetooth.
      • -
    • usbaccessory - An example sketch demonstrating code that connects an -accessory to an Android device through a USB cable.
      • -
    -
    6. -
  6. Connect a Micro USB cable from the Computer port on the ADK board to your -development computer.
    7. -
  7. In the ADK 2012 IDE, establish a serial port connection with the ADK by -selecting Tools > Serial Port and selecting the serial port for the ADK.
    8. -
  8. In the ADK 2012 IDE, choose the ADK by selectingTools > Board > -Google ADK2.
    9. -
  9. Modify an example sketch or create your own.
    10. -
  10. Upload the sketch to the ADK by choosing File > Upload. When the ADK -2012 IDE reports Done uploading, the sketch is uploaded and the ADK is -ready to communicate with your Android device.
    11. -
- -

Using the ADK Alternative Build System

- -

An alternative, make file-based build and upload system is also available for the ADK 2012. This -system is command line based and intended for production environments where using an IDE environment -to load software onto accessory hardware may be inconvenient or undesirable.

- -

To setup the environment:

-
    -
  1. Download the ADK 2012 source code files.
    2. -
  2. In a terminal window, navigate to {@code -<adk-source-download>/adk2012/board/MakefileBasedBuild}.
    3. -
  3. Execute the following command and follow the instructions: - 
    $> ./setup
    -
    4. -
- -

To build a program for your accessory:

-
    -
  1. Place your accessory code in the {@code MakefileBasedBuild/app} directory, including all -required library files. See the {@code app/main.c} file for an example of the program format.
    2. -
  2. Execute the following command and follow the instructions: - 
    $> ./build
    -
    3. -
- -

To load the program on your accessory hardware:

-
    -
  1. Run the build process above and make sure your program compiled successfully.
    2. -
  2. Attach the accessory via USB cable to your development computer.
    3. -
  3. Check which port the accessory is attached to and modify the {@code UART} variable in the -{@code flash} script to the correct port address. On linux machines, the port address is typically -{@code /dev/ttyUSB0}.
    4. -
  4. Execute the following command to load the program on the accessory: - 
    $> ./flash
    5. -
- -

How the ADK Connects with Android Devices

- -

The essential feature of any Android accessory is its ability to connect and communicate with an -Android device. Creating a fast and reliable connection between your accessory and Android devices -is the first order of business when building software for an accessory. This section describes the -connection and communication essentials used in the ADK 2012 so that you can apply them to -developing your own Android accessories.

- -

ADK Connection over Bluetooth

- -

The ADK 2012 app and hardware accessory use a Bluetooth Serial Port Profile (SPP) connection to -communicate. This connection allows two way communication between the ADK accessory and Android -devices.

- -

Note: The implementation of the ADK hardware allows the use of -other profiles and multiple connections. However, the basic communication between the ADK 2012 -accessory and the Android application uses SPP.

- -

Accessory Bluetooth Code

- -

In order to enable Bluetooth communications, the {@code clock.ino} sketch for the ADK 2012 -accessory calls a {@code btStart()} method during the {@code setup()} method to enable radio -frequency communications and start listening for Bluetooth connections:

- -
-ADK L;
-void setup() {
- L.adkInit();
- L.btStart();
-}
-...
-void btStart(){
-    uint8_t i, dlci;
-    int f;
-
-    L.btEnable(adkBtConnectionRequest, adkBtLinkKeyRequest, adkBtLinkKeyCreated,
-               adkBtPinRequest, NULL);
-
-    dlci = L.btRfcommReserveDlci(RFCOMM_DLCI_NEED_EVEN);
-
-    if(!dlci) dbgPrintf("BTADK: failed to allocate DLCI\n");
-    else{
-
-        //change descriptor to be valid...
-        for(i = 0, f = -1; i < sizeof(sdpDescrADK); i++){
-
-            if(sdpDescrADK[i] == MAGIX){
-                if(f == -1) f = i;
-                else break;
-            }
-        }
-
-        if(i != sizeof(sdpDescrADK) || f == -1){
-
-            dbgPrintf("BTADK: failed to find a single marker in descriptor\n");
-            L.btRfcommReleaseDlci(dlci);
-            return;
-        }
-
-        sdpDescrADK[f] = dlci >> 1;
-
-        dbgPrintf("BTADK has DLCI %u\n", dlci);
-
-        L.btRfcommRegisterPort(dlci, btAdkPortOpen, btAdkPortClose, btAdkPortRx);
-        L.btSdpServiceDescriptorAdd(sdpDescrADK, sizeof(sdpDescrADK));
-    }
-}
-
- -

Notice that the {@code sdpDescrADK} object contains a Universally Unique Identifier (UUID) in the -variable {@code BT_ADK_UUID}. This identifier must match the device UUID provided in the -{@link android.bluetooth.BluetoothSocket} connection request in the Android application code.

- -

Once Bluetooth is enabled with the code shown above, the accessory listens for connection -requests. The ADK library handles listening and connection details, so the accessory calls -{@code ADK::adkEventProcess()} once during each loop execution:

- -
-void loop(void)
-{
-  ...
-  L.adkEventProcess(); //let the adk framework do its thing
-  ...
-}
-
- -

If a Bluetooth connection has been established, any commands are routed to the -{@code btAdkPortRx()} callback method (which was registered with the ADK library as part of the -{@code btStart()} method) and processed accordingly. The ADK accessory sends messages back through -the Bluetooth connection using the {@code ADK::btRfcommPortTx()} method. -For more details, review the implementations of these methods in the {@code clock.ino} sketch.

- -

Android App Bluetooth Code

- -

In the ADK 2012 Android app, the code for handling Bluetooth connections is encapsulated in in a -{@code BTConnection} class. In this class, the application requests access to the Bluetooth adapter -and negotiates a connection with the ADK 2012 accessory. Here is a summary of the relevant code:

- -
-mAdapter = BluetoothAdapter.getDefaultAdapter();
-BluetoothDevice device = mAdapter.getRemoteDevice(address);
-mSocket = device.createInsecureRfcommSocketToServiceRecord(ADK_UUID);
-mSocket.connect();
-
- -

Note the {@code ADK_UUID} parameter in the second line. This identifier must match the identifier -output by the accessory (the {@code BT_ADK_UUID} variable mentioned earlier), otherwise the protocol -negotiation fails and the {@link android.bluetooth.BluetoothSocket} is not created. Once a -connection is established, you obtain {@link java.io.InputStream} and {@link java.io.OutputStream} -objects from the socket to communicate with the accessory:

- -
-mInStream = mSocket.getInputStream();
-mOutStream = mSocket.getOutputStream();
-
- -

Review the {@code BTConnection.java} file provided in the ADK 2012 software download for more -implementation details.

- -

ADK Connection over USB

- -

The ADK 2012 app and hardware accessory can also use a USB connection to communicate, similar to -the original ADK.

- -

Accessory USB Code

- -

The ADK library takes care of most of the implementation details for a USB connection, the -accessory code must make a few calls to initialize USB connectivity, including setting the accessory -identification strings:

- -
-ADK L;
-void setup() {
-  L.adkInit();
-  L.usbSetAccessoryStringVendor(...);
-  L.usbSetAccessoryStringName(...);
-  L.usbSetAccessoryStringLongname(...);
-  L.usbSetAccessoryStringVersion(...);
-  L.usbSetAccessoryStringUrl(...);
-  L.usbSetAccessoryStringSerial(...);
-
-  L.usbStart();
-}
-
- -

Note: The identification strings must match the USB accessory -filter settings specified in the connecting Android application,otherwise the application cannot -connect with the accessory.

- -

Once USB is enabled with code shown above, the accessory listens for connection requests. The ADK -library handles listening and connection details, so the accessory calls {@code -ADK::adkEventProcess()} once during each loop execution:

- -
-void loop(void)
-{
-  ...
-  L.adkEventProcess(); //let the adk framework do its thing
-  ...
-}
-
- -

The accessory must then check for a live USB connection to process commands and send -messages. Here is a summary of the relevant code:

- -
-void loop() {
-  if (L.accessoryConnected()) {
-    int recvLen = L.accessoryReceive(msg, sizeof(msg));
-    if (recvLen > 0) {
-      ... // process message
-    }
-
-    L.accessorySend(outmsg, outmsgLen);
-  }
-  L.adkEventProcess();
-}
-
- -

For more details, review the implementations of these methods in the {@code clock.ino} -sketch.

- -

Android App USB Code

- -

In the ADK 2012 Android app, the code for handling USB connections is encapsulated in a -{@code UsbConnection} class. This class sets up a {@link android.content.BroadcastReceiver} to -listen for USB events and then attempts to connect when a matching connection event is received. -Here is a summary of the relevant code:

- -
-import com.android.future.usb.UsbAccessory;
-import com.android.future.usb.UsbManager;
-
-mUSBManager = UsbManager.getInstance(this);
-UsbAccessory acc = mUSBManager.getAccessoryList()[0];
-
-if (!mUSBManager.hasPermission(acc)) return;
-
- -

The ADK 2012 app uses the support library to implement the USB accessory connections, in order to -support devices running Android 2.3.4 (API Level 10). If you only need to support Android -3.1 (API Level 12) and higher devices, you can replace the first 4 lines the following code:

- -
-import android.hardware.usb.UsbAccessory
-import android.hardware.usb.UsbManager
-
-mUSBManager = (UsbManager) getSystemService(Context.USB_SERVICE);
-UsbAccessory acc = (UsbAccessory)
-                   intent.getParcelableExtra(UsbManager.EXTRA_ACCESSORY);
-
- -

Note that the app only receives events when the USB accessory identification information matches -the information in the {@code res/xml/usb_accessory_filter.xml} file, referenced by the -application’s manifest statement:

- -
-<meta-data
-    android:name="android.hardware.usb.action.USB_ACCESSORY_ATTACHED"
-    android:resource="@xml/usb_accessory_filter" />
-
- -

Connections from other USB devices are not received by the ADK 2012 accessory.

- -

Once the connection is established, the app can communicate with the accessory through file input -and output streams, as shown in the following example code:

- -
-ParcelFileDescriptor mFD = mUSBManager.openAccessory(acc);
-if (mFD != null) {
-  FileDescripter fd = mFD.getFileDescriptor();
-  mIS = new FileInputStream(fd);  // use this to receive messages
-  mOS = new FileOutputStream(fd); // use this to send commands
-}
-
- -

Review the {@code UsbConnection.java} file provided in the ADK 2012 source code for more -implementation details.

- -

USB Audio Dock Implementation

- -

One of the important new features introduced with the ADK 2012 is the ability to play audio over -a USB connection. This innovation was introduced as an update to Android Open Accessory (AOA) -protocol 2.0 and is -available on devices running Android 4.1 (API Level 16) and higher.

- -

The ADK 2012 provides a reference implementation of this functionality for accessory developers. -No software application is required to be installed on the connected Android device, accessory -developers only need to support AOA v2. This implementation demonstrates audio output of 16bit, -44.1kHz stereo PCM source data compressed into a single channel due to the audio hardware available -on the accessory.

- -

Using the audio output features provided by the ADK library requires only a few function calls. -The first few calls are in the accessory {@code setup()} routine, which prepare the accessory for -USB connections and audio output, as summarized in the code example below:

- -
-ADK L;
-void setup() {
-  L.audioInit();
-  L.usbh_init()
-  L.usbStart();
-}
-
- -

For more information about the {@code ADK::audioInit()} function, see the {@code -libraries/ADK/Audio.c} library file. For more information about the {@code ADK::usbh_init()} -function, see the {@code libraries/ADK/Usbh.c} library file.

- -

After completing this setup, the {@code loop()} function calls {@code ADK::adkEventProcess()} to -handle audio output and other ADK functions:

- -
-void loop(void)
-{
-  ...
-  L.adkEventProcess(); //let the adk framework do its thing
-  ...
-}
-
- -

This call executes task queuing for the ADK and as part of the execution process, the task queue -executes {@code usbh_work()} in {@code libraries/ADK/Usbh.c}, which handles audio output requests. -Review the implementation of this function for details. For additional implementation details on -audio output, see the {@code libraries/ADK/accessory.c} library file.

diff --git a/docs/html/adk/index.jd b/docs/html/adk/index.jd deleted file mode 100644 index e08748fc3b42..000000000000 --- a/docs/html/adk/index.jd +++ /dev/null @@ -1,30 +0,0 @@ -page.title=Accessory Development Kit -page.tags=adk -@jd:body - -

The Accessory Development Kit (ADK) is a reference implementation for hardware manufacturers and -hobbyists to use as a starting point for building accessories for Android. Each ADK release is -provided with source code and hardware specifications to make the process of developing your own -accessories easier. Creating new and alternative hardware based on the ADK is encouraged!

- -

Android accessories can be audio docking stations, exercise machines, personal medical testing -devices, weather stations, or any other external hardware device that adds to the functionality of -Android.

- -

Accessories use the Android Open Accessory (AOA) protocol to communicate with Android -devices, over a USB cable or through a Bluetooth connection. If you are building an accessory that -uses USB, make sure you understand how to implement the AOA protocol to establish communication -between your accessory hardware and Android. For more information, see the -Android Open Acessory protocol. -

- -

The following sections provide more information about the Android Accessory Development Kits, how -to use them, and how to get started building your own accessories for Android.

- -
-
ADK 2012 Guide
-
Guide to getting started with the ADK released at Google I/O 2012.
- -
ADK 2011 Guide
-
Guide to getting started with the original ADK, released at Google I/O 2011.
-
diff --git a/docs/html/channels/io2013.jd b/docs/html/channels/io2013.jd deleted file mode 100644 index 2efda28d2b8c..000000000000 --- a/docs/html/channels/io2013.jd +++ /dev/null @@ -1,347 +0,0 @@ -excludeFromSuggestions=true -fullpage=true -page.title=Google I/O 13 -@jd:body - - - - - - - - - -
- -
-

Android @ Google I/O 13

-
-
- - Your video is supposed to appear here.
- Make sure you have the Flash® Player. -
-
-
-
- -
-

Most Popular

- -
-
- -
- -
- - More on YouTube - - -
-
-

All Videos

-
    - - - -
-
- -
- -
- - - - - - - - - - - - - \ No newline at end of file -- cgit v1.2.3-59-g8ed1b