README.md
1
2Android BatchStepSensor Sample
3===================================
4
5Sample demonstrating how to set up SensorEventListeners for step
6detectors and step counters.
7
8Introduction
9------------
10
11This sample demonstrates the use of the two step [sensors][1] (step detector and counter) and
12sensor batching.
13
14It shows how to register a [SensorEventListener][2] with and without
15batching and shows how these events are received.
16
17The Step Detector sensor fires an
18event when a step is detected, while the step counter returns the total number of
19steps since a listener was first registered for this sensor.
20
21Both sensors only count steps while a listener is registered. This sample only covers the
22basic case, where a listener is only registered while the app is running. Likewise,
23batched sensors can be used in the background (when the CPU is suspended), which
24requires manually flushing the [sensor event][3] queue before it overflows, which is not
25covered in this sample.
26
27[1]: https://developer.android.com/reference/android/hardware/Sensor.html
28[2]: https://developer.android.com/reference/android/hardware/SensorEventListener.html
29[3]: https://developer.android.com/reference/android/hardware/SensorEvent.html
30
31Pre-requisites
32--------------
33
34- Android SDK 28
35- Android Build Tools v28.0.3
36- Android Support Repository
37
38Screenshots
39-------------
40
41<img src="screenshots/screenshot1.png" height="400" alt="Screenshot"/> <img src="screenshots/screenshot2.png" height="400" alt="Screenshot"/> <img src="screenshots/screenshot3.png" height="400" alt="Screenshot"/> <img src="screenshots/screenshot4.png" height="400" alt="Screenshot"/> <img src="screenshots/screenshot5.png" height="400" alt="Screenshot"/> <img src="screenshots/screenshot6.png" height="400" alt="Screenshot"/>
42
43Getting Started
44---------------
45
46This sample uses the Gradle build system. To build this project, use the
47"gradlew build" command or use "Import Project" in Android Studio.
48
49Support
50-------
51
52- Google+ Community: https://plus.google.com/communities/105153134372062985968
53- Stack Overflow: http://stackoverflow.com/questions/tagged/android
54
55If you've found an error in this sample, please file an issue:
56https://github.com/googlesamples/android-BatchStepSensor
57
58Patches are encouraged, and may be submitted by forking this project and
59submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
60
61License
62-------
63
64Copyright 2019 The Android Open Source Project, Inc.
65
66Licensed to the Apache Software Foundation (ASF) under one or more contributor
67license agreements. See the NOTICE file distributed with this work for
68additional information regarding copyright ownership. The ASF licenses this
69file to you under the Apache License, Version 2.0 (the "License"); you may not
70use this file except in compliance with the License. You may obtain a copy of
71the License at
72
73http://www.apache.org/licenses/LICENSE-2.0
74
75Unless required by applicable law or agreed to in writing, software
76distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
77WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
78License for the specific language governing permissions and limitations under
79the License.
80
