Merge "Updated app pattern documentation." into mnc-io-docs am: 5d0f016f4b

am: 40ee002949

* commit '40ee002949616f2fe36fe543c6a3557984e3f606':
  docs: Iterating on Wear docs - Get Started, Download/Test, Program Overview

Change-Id: I91ec11bdbfa062840643a3bdfa967ec439a52dd5
This commit is contained in:
Bert McMeen
2016-05-18 01:06:10 +00:00
committed by android-build-merger
3 changed files with 148 additions and 91 deletions

View File

@@ -4,6 +4,7 @@ page.tags="wear-preview"
page.image=images/cards/card-n-sdk_2x.png page.image=images/cards/card-n-sdk_2x.png
@jd:body @jd:body
<div style="position:relative; min-height:600px"> <div style="position:relative; min-height:600px">
<div class="wrap" id="tos" style="position:absolute;display:none;width:inherit;"> <div class="wrap" id="tos" style="position:absolute;display:none;width:inherit;">
@@ -192,17 +193,17 @@ This is the Android Wear SDK Preview License Agreement (the “License Agreement
</ul> </ul>
<p> <p>
If you want an environment for basic <strong>compatibility If you want an environment for basic compatibility
testing</strong> of your app, you can use your current APK and a testing of your app, you can use your current APK and a
supported watch or an emulator. As described below, you don't necessarily supported watch or an emulator. As described below, you don't necessarily
need to update your full development environment to do basic testing. need to update your full development environment to do basic testing.
</p> </p>
<p> <p>
However, if you want to <strong>modify</strong> your app to target However, if you want to modify your app to target
Android Wear 2.0 or use new APIs, you need to update your development Android Wear 2.0 or use new APIs, you need to update your development
environment. See <a href="{@docRoot}wear/preview/start.html">Get Started environment. See <a href="{@docRoot}wear/preview/start.html">Get Started
with the Android Wear 2.0 Preview</a>. with the Preview</a>.
</p> </p>
<h2 id="set_up_a_watch"> <h2 id="set_up_a_watch">
@@ -211,7 +212,7 @@ This is the Android Wear SDK Preview License Agreement (the “License Agreement
<p> <p>
You can download a system image and manually flash it to a matching You can download a system image and manually flash it to a matching
watch. See the table below to download the system image for your test watch. See the table below to download the image for your test
watch. watch.
</p> </p>
@@ -221,9 +222,9 @@ This is the Android Wear SDK Preview License Agreement (the “License Agreement
testing. testing.
</p> </p>
<p> <p class="warning">
Installing a system image on a watch <strong>removes all data from the <strong>Warning:</strong> Installing a system image on a watch removes all data from the
watch</strong>, so you should back up your data first. watch, so you should back up your data first.
</p> </p>
<h3 id="preview_system_images"> <h3 id="preview_system_images">
@@ -240,78 +241,79 @@ This is the Android Wear SDK Preview License Agreement (the “License Agreement
Preview image for LGE Watch Urbane 2nd Edition Preview image for LGE Watch Urbane 2nd Edition
</h4> </h4>
<p> <p class="caution">
<strong>Please note the following:</strong> <strong>Caution:</strong> Flashing your device will
Flashing your device will
require unlocking the bootloader which may require unlocking the bootloader which may
void the device's warranty--proceed at your own risk. void the device's warranty--proceed at your own risk.
</p> </p>
<table> <table>
<tr> <tr>
<th scope="col"> <th style="width:300px">
Type of LGE Watch Urbane 2nd Edition image Type of LGE Watch Urbane 2nd Edition image
</th> </th>
<th scope="col"> <th>
Download/Checksums Download/Checksums
</th> </th>
</tr> </tr>
<tr id="download-3-placeholder">
<tr id="nemo-preview">
<td> <td>
Preview image for testing Preview image for testing
</td> </td>
<td><a href="#top" onclick="onDownload(this)">download-3-placeholder.tgz</a><br> <td><a href="#top" onclick="onDownload(this)">nemo-nvd36h-factory-fb7a294a.tgz</a><br>
MD5: [string]<br> MD5: 9dd0572fdab02e474ea9c761d1d2b70b<br>
SHA-1: [string] SHA-1: fb7a294a91ec71280262e7a1a60fcf940131e6c3
</td> </td>
</tr> </tr>
<tr id="download-4-placeholder">
<tr id="nemo-non-preview">
<td> <td>
Non-preview image (for after testing) Non-preview image (for after testing)
</td> </td>
<td><a href="#top" onclick="onDownload(this)">download-4-placeholder.tgz</a><br> <td><a href="#top" onclick="onDownload(this)">nemo-mnc40x-factory-fa528bec.tgz</a><br>
MD5: [string]<br> MD5: 0b8ba3653d5a93cb854f4d7409d7b6c9<br>
SHA-1: [string] SHA-1: fa528bec8aba3bf6c7d901ba63cd6ea0a08dbeb0
</td> </td>
</tr> </tr>
</table> </table>
<h4 id="preview_image_for_huawei_watch"> <h4 id="preview_image_for_huawei_watch">
Preview image for Huawei Watch Preview image for Huawei Watch
</h4> </h4>
<p> <p class="caution">
<strong>Please note the following:</strong> <strong>Caution:</strong> Flashing your device will require unlocking
Flashing your device will require unlocking
the bootloader which the bootloader which
shall void the device's warranty--proceed at your own risk. shall void the device's warranty--proceed at your own risk.
</p> </p>
<table> <table>
<tr> <tr>
<th scope="col"> <th style="width:300px">
Type of Huawei Watch image Type of Huawei Watch image
</th> </th>
<th scope="col"> <th>
Download/Checksums Download/Checksums
</th> </th>
</tr> </tr>
<tr id="download-1-placeholder"> <tr id="sturgeon-preview">
<td> <td>
Preview image for testing Preview image for testing
</td> </td>
<td><a href="#top" onclick="onDownload(this)">download-1-placeholder.tgz</a><br> <td><a href="#top" onclick="onDownload(this)">sturgeon-nvd36h-factory-fd1f1582.tgz</a><br>
MD5: [string]<br> MD5: b54f4ff5ebcd3d50d6d1bfde93056c2a<br>
SHA-1: [string] SHA-1: fd1f158257dba0999738ca7e0bfacec97afe35df
</td> </td>
</tr> </tr>
<tr id="download-2-placeholder"> <tr id="sturgeon-non-preview">
<td> <td>
Non-preview image (for after testing) Non-preview image (for after testing)
</td> </td>
<td><a href="#top" onclick="onDownload(this)">download-2-placeholder.tgz</a><br> <td><a href="#top" onclick="onDownload(this)">sturgeon-mec23l-factory-48003078.tgz</a><br>
MD5: [string]<br> MD5: 417b5cbddb29a2262bce133e283d2732<br>
SHA-1: [string] SHA-1: 4800307843580f818557dd7c43d8ba2161e289b2
</td> </td>
</tr> </tr>
</table> </table>
@@ -323,18 +325,24 @@ This is the Android Wear SDK Preview License Agreement (the “License Agreement
<p> <p>
The steps for flashing an image to a watch are similar to the <a href= The steps for flashing an image to a watch are similar to the <a href=
"https://developers.google.com/android/nexus/images">steps provided for "https://developers.google.com/android/nexus/images">steps provided for
flashing to a phone</a>. After you <strong>back up your watch flashing to a phone</a>. After you back up your watch
data</strong>, use steps in this section to flash the image to the data, use steps in this section to flash the image to the
<strong>specific watch</strong> that matches the image (e.g., you must specific watch that matches the image (e.g., you must
use an LGE Watch Urbane 2nd Edition for the corresponding image). use an LGE Watch Urbane 2nd Edition for the corresponding image).
</p> </p>
<p class="warning">
<strong>Warning:</strong> Installing a system image on a watch removes all data from the
watch, so you should back up your data first.
</p>
<h4 id="set_up_the_watch_to_be_flashed"> <h4 id="set_up_the_watch_to_be_flashed">
Set up the watch to be flashed Set up the watch to be flashed
</h4> </h4>
<p> <p>
On the watch, enable the Developer Options menu and ADB debugging as From the phone, unpair ("Forget") the watch.
Then on the watch, enable the Developer Options menu and ADB debugging as
follows: follows:
</p> </p>
@@ -386,8 +394,8 @@ This is the Android Wear SDK Preview License Agreement (the “License Agreement
</p> </p>
<ol> <ol>
<li>Download and unzip the appropriate system image from the "Preview <li>Download and unzip the appropriate system image from a "Preview
system image" column in the <a href="#preview_system_images">table image for testing" row in a <a href="#preview_system_images">table
above</a>. above</a>.
</li> </li>
@@ -404,9 +412,9 @@ This is the Android Wear SDK Preview License Agreement (the “License Agreement
<code>adb reboot bootloader</code> <code>adb reboot bootloader</code>
</li> </li>
<li>If necessary, use <strong>one</strong> of following two commands to <li>If necessary, use one of following two commands to
unlock the device's bootloader. This step <strong>erases all data on the unlock the device's bootloader. This step erases all data on the
device</strong>: <code>fastboot flashing unlock</code> or, for some device: <code>fastboot flashing unlock</code> or, for some
devices, <code>fastboot oem unlock</code> devices, <code>fastboot oem unlock</code>
</li> </li>
@@ -420,8 +428,43 @@ This is the Android Wear SDK Preview License Agreement (the “License Agreement
</li> </li>
</ol> </ol>
<h4 id="set_up_watch">
Set up the watch and begin testing
</h4>
<p>
After the <code>flash-all</code> script finishes, your watch reboots
and soon will be ready for testing with the preview image.
</p>
<ol>
<li>Attach the watch charger to the watch and plug the USB cord
into your computer, if it is not already plugged in.
</li>
<li>Use the following <a href="{@docRoot}tools/help/adb.html">adb
command</a> to confirm that the watch is available:
<code>adb devices</code>
</li>
<li>Use the following adb command to start the device in fastboot mode:
<code>adb reboot bootloader</code>
</li>
<li>Use the following command to
lock the device's bootloader: <code>fastboot flashing lock</code> or, for some
devices, <code>fastboot oem lock</code>
</li>
<li>On the watch, continue the boot by touching <strong>'0'</strong>.
</li>
</ol>
<p> <p>
After the script finishes, your watch reboots. Pair the watch with a Pair the watch with a
phone or tablet. The preview now is available for testing on the watch. phone or tablet. The preview now is available for testing on the watch.
Before installing an app, enable the Developer Options menu, and ADB Before installing an app, enable the Developer Options menu, and ADB
debugging, on the watch as follows: debugging, on the watch as follows:
@@ -477,20 +520,21 @@ This is the Android Wear SDK Preview License Agreement (the “License Agreement
<p> <p>
When testing is completed, follow the steps for <a href= When testing is completed, follow the steps for <a href=
"#uninstall_the_preview_from_a_watch">uninstalling the preview</a>. "#remove_the_preview_from_a_watch">removing the preview</a>.
</p> </p>
<h3 id="uninstall_the_preview_from_a_watch"> <h3 id="remove_the_preview_from_a_watch">
Uninstall the preview from a watch Remove the preview from a watch
</h3> </h3>
<p> <p>
When testing with the preview is done, restore the watch as follows: When testing with the preview is done, unpair ("Forget") the watch from the phone and
restore the watch as follows:
</p> </p>
<ol> <ol>
<li>Download and unzip the appropriate system image from the "Non-preview <li>Download and unzip the appropriate system image from a "Non-preview
system image" column in the <a href="#preview_system_images">table image" row in a <a href="#preview_system_images">table
above</a>. above</a>.
</li> </li>
@@ -523,8 +567,10 @@ This is the Android Wear SDK Preview License Agreement (the “License Agreement
<li>Click <strong>Create Virtual Device</strong>. <li>Click <strong>Create Virtual Device</strong>.
</li> </li>
<li>In the <strong>Category</strong> pane, select Wear, choose a name <li>In the <strong>Category</strong> pane, select Wear, choose a hardware profile,
(such as Android Wear Round), and click <strong>Next</strong>. and click <strong>Next</strong>. The Android Wear 2.0 Developer Preview
is only optimized for round devices currently, so we recommend not
using the square or chin profiles for now.
</li> </li>
<li>Select an <strong>N</strong> image to download. The images may be on <li>Select an <strong>N</strong> image to download. The images may be on
@@ -554,7 +600,7 @@ This is the Android Wear SDK Preview License Agreement (the “License Agreement
<script> <script>
var urlRoot = "http://storage.googleapis.com/androiddevelopers/shareables/wear/preview/"; var urlRoot = "http://storage.googleapis.com/androiddevelopers/shareables/wear-preview/";
function onDownload(link) { function onDownload(link) {
$("#downloadForRealz").html("Download " + $(link).text()); $("#downloadForRealz").html("Download " + $(link).text());

View File

@@ -25,7 +25,7 @@ page.image=images/cards/card-n-sdk_2x.png
</h5> </h5>
<p> <p>
Run and test your apps on a range of devices or on an emulator. Run and test your apps on supported Wear devices or the emulator.
</p> </p>
</div> </div>
@@ -71,8 +71,10 @@ page.image=images/cards/card-n-sdk_2x.png
</h5> </h5>
<p> <p>
Report issues and give us feedback using our issue tracker. Report issues and give us feedback using our
Connect with other developers in the Wear Developer Community. <a href="https://g.co/wearpreviewbug">issue tracker</a>.
Connect with other developers in
the <a href="https://g.co/androidweardev">Wear Developer Community</a>.
</p> </p>
</div> </div>
@@ -128,7 +130,8 @@ page.image=images/cards/card-n-sdk_2x.png
apps and plan migration or feature work needed to target the new apps and plan migration or feature work needed to target the new
platform. This is the priority period in which to give us your feedback platform. This is the priority period in which to give us your feedback
on features and APIs and file compatibility issues — for all of these, on features and APIs and file compatibility issues — for all of these,
please use the issue tracker. You can expect some API changes across please use the <a href="https://g.co/wearpreviewbug">issue tracker</a>.
You can expect some API changes across
these updates. these updates.
</p> </p>
@@ -144,8 +147,6 @@ page.image=images/cards/card-n-sdk_2x.png
<p> <p>
As you test and develop on Android Wear 2.0, we strongly recommend As you test and develop on Android Wear 2.0, we strongly recommend
keeping your development environment up-to-date as updates are released. keeping your development environment up-to-date as updates are released.
Updated preview images will be available that you can download and flash
manually.
</p> </p>
<p> <p>
@@ -195,18 +196,25 @@ page.image=images/cards/card-n-sdk_2x.png
</h3> </h3>
<p> <p>
You can download these hardware system images for Nexus devices from the You can download these hardware system images at <a href=
Downloads page: "{@docRoot}wear/preview/downloads.html">Download and Test with a
Device</a>:
</p> </p>
<ul> <ul>
<li>LG Watch Urbane 2nd Edition “nemo” <li>LGE Watch Urbane 2nd Edition
</li> </li>
<li>Huawei Watch “sturgeon” <li>Huawei Watch
</li> </li>
</ul> </ul>
<p>
Please keep in mind that the Developer Preview system images
are for app developers only, and for compatibility testing and
early development only, and are not ready for day-to-day use.
</p>
<h3 id="documentation_and_sample_code"> <h3 id="documentation_and_sample_code">
Documentation and sample code Documentation and sample code
</h3> </h3>
@@ -216,17 +224,22 @@ page.image=images/cards/card-n-sdk_2x.png
</p> </p>
<ul> <ul>
<li>[comment placeholder] Get Started has step-by-step instructions for <li><a href=
"{@docRoot}wear/preview/start.html">Get Started</a>
has step-by-step instructions for
setting up the SDK. setting up the SDK.
</li> </li>
<li>Documentation of new APIs, including an API Overview, downloadable <li>Documentation of new APIs, including an
API Reference, and developer guides on key features such as <a href="{@docRoot}wear/preview/api-overview.html">API Overview</a>,
complications, design patterns for Wear, and building standalone Android downloadable
Wear apps. <a href="{@docRoot}wear/preview/start.html#get_the_preview_reference_documentation">API Reference</a>,
and developer guides on key features such as
<a href="{@docRoot}wear/preview/features/complications.html">complications</a>
and design patterns for Wear.
</li> </li>
<li>Sample code that demonstrates how to implement [comment placeholder] <li>Sample code that demonstrates how to implement
complications and other new features. complications and other new features.
</li> </li>
</ul> </ul>
@@ -241,7 +254,8 @@ page.image=images/cards/card-n-sdk_2x.png
</p> </p>
<ul> <ul>
<li>Wear Developer Preview Issue Tracker is your primary feedback <li>Wear Developer Preview
<a href="https://g.co/wearpreviewbug">Issue Tracker</a> is your primary feedback
channel. You can report bugs, performance issues, and general feedback channel. You can report bugs, performance issues, and general feedback
through the issue tracker. You can also check for known issues and find through the issue tracker. You can also check for known issues and find
workaround steps. workaround steps.

View File

@@ -1,4 +1,4 @@
page.title=Get Started with the Android Wear 2.0 Developer Preview page.title=Get Started with the Preview
meta.keywords="wear-preview" meta.keywords="wear-preview"
page.tags="wear-preview" page.tags="wear-preview"
page.image=images/cards/card-n-sdk_2x.png page.image=images/cards/card-n-sdk_2x.png
@@ -28,8 +28,8 @@ page.image=images/cards/card-n-sdk_2x.png
</div> </div>
<p> <p>
If you want an environment for basic <strong>compatibility If you want an environment for basic compatibility
testing</strong> of your app, you can use your current APK and a testing of your app, you can use your current APK and a
supported watch or an emulator. You don't necessarily need to update your supported watch or an emulator. You don't necessarily need to update your
full development environment to do basic testing. To simply test your full development environment to do basic testing. To simply test your
app's compatibility with a preview system image, see <a href= app's compatibility with a preview system image, see <a href=
@@ -97,19 +97,20 @@ page.image=images/cards/card-n-sdk_2x.png
<table> <table>
<tr> <tr>
<th scope="col"> <th style="width:300px">
Reference documentation Reference documentation
</th> </th>
<th scope="col"> <th>
Notes Checksums
</th> </th>
</tr> </tr>
<tr> <tr>
<td> <td>
[zip file name] <a href="http://storage.googleapis.com/androiddevelopers/shareables/wear-preview/wearable-support-preview-1-docs.zip">wearable-support-preview-1-docs.zip</a>
</td> </td>
<td> <td>MD5: eff101c848aff7d0fa7a0812c7670145<br>
SHA-1: da1eba1869aaaf8bde30ecfb7e0d624125a41586
</td> </td>
</tr> </tr>
</table> </table>
@@ -137,8 +138,8 @@ page.image=images/cards/card-n-sdk_2x.png
</li> </li>
<li>If prompted by the Android SDK Manager for the SDK version to use for <li>If prompted by the Android SDK Manager for the SDK version to use for
the project, select <strong>Use</strong> <strong>Android Studio's the project, select <strong>Use Android Studio's
SDK</strong>. &lt;//li&gt; SDK</strong>.
</li> </li>
<li>If prompted to update the Gradle plugin, update the version of the <li>If prompted to update the Gradle plugin, update the version of the
@@ -151,12 +152,10 @@ page.image=images/cards/card-n-sdk_2x.png
'com.google.android.support:wearable:1.4.0'</code>) by changing it to the 'com.google.android.support:wearable:1.4.0'</code>) by changing it to the
following, which requires that your the Google Repository <a href= following, which requires that your the Google Repository <a href=
"#install_android_studio_and_the_latest_packages">is the latest "#install_android_studio_and_the_latest_packages">is the latest
version</a>:: version</a>:
<pre>
<pre> compile 'com.google.android.support:wearable:2.0.0-alpha1'
compile 'com.google.android.support:wearable:2.0.0-alpha1' </pre>
</pre>
</li> </li>
<li>See the following page for setting up a watch or emulator with a <li>See the following page for setting up a watch or emulator with a
@@ -195,11 +194,9 @@ page.image=images/cards/card-n-sdk_2x.png
<code>dependencies</code> section, update the existing reference to the <code>dependencies</code> section, update the existing reference to the
Wearable Support Library (perhaps <code>compile Wearable Support Library (perhaps <code>compile
'com.google.android.support:wearable:1.4.0'</code>) to: 'com.google.android.support:wearable:1.4.0'</code>) to:
<pre>
<pre> compile 'com.google.android.support:wearable:2.0.0-alpha1'
compile 'com.google.android.support:wearable:2.0.0-alpha1' </pre>
</pre>
</li> </li>
<li>See the following page for setting up a watch or emulator with a <li>See the following page for setting up a watch or emulator with a