README.md
1
2Android AlwaysOn Sample
3===================================
4
5A basic sample showing how to support ambient mode for native Android Wear apps.
6
7Introduction
8------------
9
10[WearableActivity][1] offers methods for supporting your native app staying on the screen when the Wear device enters ambient mode.
11
12This example extends [WearableActivity][1] and overrides onEnterAmbient, onUpdateAmbient, and onExitAmbient to allow the simple native Wear app to support ambient mode.
13
14In ambient mode, this app follows best practices by keeping most pixels black, avoiding large blocks of white pixels, using only black and white, and disabling anti-aliasing (following the [design guidelines for Watch Faces][2]).
15
16In addition and most importantly, the app sleeps while in ambient mode for 20 seconds between any updates to conserving battery life (processor allowed to sleep). If you can hold off on updates for a full minute, you can throw away the Handler and just use onUpdateAmbient to save even more battery life.
17
18As always, you will still want to apply the [performance guidelines][3] outlined in the Watch Faces documention to your app.
19
20[1]: http://developer.android.com/reference/android/support/wearable/activity/WearableActivity.html
21[2]: https://developer.android.com/training/wearables/watch-faces/designing.html#DesignGuidelines
22[3]: https://developer.android.com/training/wearables/watch-faces/performance.html
23
24Pre-requisites
25--------------
26
27- Android SDK 27
28- Android Build Tools v27.0.2
29- Android Support Repository
30
31Screenshots
32-------------
33
34<img src="screenshots/1-main-active.png" height="400" alt="Screenshot"/> <img src="screenshots/2-main-ambient.png" height="400" alt="Screenshot"/> <img src="screenshots/3-main-active-round.png" height="400" alt="Screenshot"/> <img src="screenshots/4-main-ambient-round.png" height="400" alt="Screenshot"/>
35
36Getting Started
37---------------
38
39This sample uses the Gradle build system. To build this project, use the
40"gradlew build" command or use "Import Project" in Android Studio.
41
42Support
43-------
44
45- Google+ Community: https://plus.google.com/communities/105153134372062985968
46- Stack Overflow: http://stackoverflow.com/questions/tagged/android
47
48If you've found an error in this sample, please file an issue:
49https://github.com/googlesamples/android-AlwaysOn
50
51Patches are encouraged, and may be submitted by forking this project and
52submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
53
54License
55-------
56
57Copyright 2017 The Android Open Source Project, Inc.
58
59Licensed to the Apache Software Foundation (ASF) under one or more contributor
60license agreements. See the NOTICE file distributed with this work for
61additional information regarding copyright ownership. The ASF licenses this
62file to you under the Apache License, Version 2.0 (the "License"); you may not
63use this file except in compliance with the License. You may obtain a copy of
64the License at
65
66http://www.apache.org/licenses/LICENSE-2.0
67
68Unless required by applicable law or agreed to in writing, software
69distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
70WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
71License for the specific language governing permissions and limitations under
72the License.
73
