xref: /aosp_15_r20/developers/build/prebuilts/gradle/NfcProvisioning/README.md (revision d353a188ca6ec4b5eba25b5fbd7bcb8ce61322fb)
1*d353a188SXin Li
2*d353a188SXin LiAndroid NfcProvisioning Sample
3*d353a188SXin Li===================================
4*d353a188SXin Li
5*d353a188SXin LiThis sample demonstrates how to use NFC to provision a new device with a device owner. Device owner
6*d353a188SXin Liis a specialized type of device administrator that can control device security and configuration.
7*d353a188SXin LiThis sample itself is not a device owner, but it is a programming app that sends NFC message to an
8*d353a188SXin Liunprovisioned peer device and tells it to set up the specified device owner app.
9*d353a188SXin Li
10*d353a188SXin LiIntroduction
11*d353a188SXin Li------------
12*d353a188SXin Li
13*d353a188SXin LiNFC Provisioning app is nothing but an ordinary Android Beam app that just sends out provisioning
14*d353a188SXin Livalues to the peer device. This sample uses the values below.
15*d353a188SXin Li
16*d353a188SXin Li* `EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME` - The package name of the mobile device management
17*d353a188SXin Li  application that will be set as the profile owner or device owner.
18*d353a188SXin Li* `EXTRA_PROVISIONING_LOCALE` - The Locale that the device will be set to.
19*d353a188SXin Li* `EXTRA_PROVISIONING_TIME_ZONE` - The time zone AlarmManager that the device will be set to.
20*d353a188SXin Li* `EXTRA_PROVISIONING_WIFI_SSID` - The ssid of the wifi network that should be used during nfc
21*d353a188SXin Li  device owner provisioning for downloading the mobile device management application.
22*d353a188SXin Li* `EXTRA_PROVISIONING_WIFI_PASSWORD` - The password of the wifi network in
23*d353a188SXin Li  EXTRA_PROVISIONING_WIFI_SSID.
24*d353a188SXin Li
25*d353a188SXin LiStore values in an instance of Properties. Get a byte array representation of the Properties using
26*d353a188SXin LiByteArrayOutputStream. Create an NdefRecord with the MIME type of
27*d353a188SXin Li[DevicePolicyManager.MIME_TYPE_PROVISIONING_NFC][1]. Use [NfcAdapter#setNdefPushMessage][2] to set
28*d353a188SXin Lithe NdefMessage as the message to be sent.
29*d353a188SXin Li
30*d353a188SXin Li[1]: https://developer.android.com/reference/android/app/admin/DevicePolicyManager.html#MIME_TYPE_PROVISIONING_NFC
31*d353a188SXin Li[2]: http://developer.android.com/reference/android/nfc/NfcAdapter.html#setNdefPushMessage(android.nfc.NdefMessage,%20android.app.Activity,%20android.app.Activity...)
32*d353a188SXin Li
33*d353a188SXin LiPre-requisites
34*d353a188SXin Li--------------
35*d353a188SXin Li
36*d353a188SXin Li- Android SDK 27
37*d353a188SXin Li- Android Build Tools v27.0.2
38*d353a188SXin Li- Android Support Repository
39*d353a188SXin Li
40*d353a188SXin LiScreenshots
41*d353a188SXin Li-------------
42*d353a188SXin Li
43*d353a188SXin Li<img src="screenshots/1-main.png" height="400" alt="Screenshot"/>
44*d353a188SXin Li
45*d353a188SXin LiGetting Started
46*d353a188SXin Li---------------
47*d353a188SXin Li
48*d353a188SXin LiThis sample uses the Gradle build system. To build this project, use the
49*d353a188SXin Li"gradlew build" command or use "Import Project" in Android Studio.
50*d353a188SXin Li
51*d353a188SXin LiSupport
52*d353a188SXin Li-------
53*d353a188SXin Li
54*d353a188SXin Li- Google+ Community: https://plus.google.com/communities/105153134372062985968
55*d353a188SXin Li- Stack Overflow: http://stackoverflow.com/questions/tagged/android
56*d353a188SXin Li
57*d353a188SXin LiIf you've found an error in this sample, please file an issue:
58*d353a188SXin Lihttps://github.com/googlesamples/android-NfcProvisioning
59*d353a188SXin Li
60*d353a188SXin LiPatches are encouraged, and may be submitted by forking this project and
61*d353a188SXin Lisubmitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
62*d353a188SXin Li
63*d353a188SXin LiLicense
64*d353a188SXin Li-------
65*d353a188SXin Li
66*d353a188SXin LiCopyright 2017 The Android Open Source Project, Inc.
67*d353a188SXin Li
68*d353a188SXin LiLicensed to the Apache Software Foundation (ASF) under one or more contributor
69*d353a188SXin Lilicense agreements.  See the NOTICE file distributed with this work for
70*d353a188SXin Liadditional information regarding copyright ownership.  The ASF licenses this
71*d353a188SXin Lifile to you under the Apache License, Version 2.0 (the "License"); you may not
72*d353a188SXin Liuse this file except in compliance with the License.  You may obtain a copy of
73*d353a188SXin Lithe License at
74*d353a188SXin Li
75*d353a188SXin Lihttp://www.apache.org/licenses/LICENSE-2.0
76*d353a188SXin Li
77*d353a188SXin LiUnless required by applicable law or agreed to in writing, software
78*d353a188SXin Lidistributed under the License is distributed on an "AS IS" BASIS, WITHOUT
79*d353a188SXin LiWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
80*d353a188SXin LiLicense for the specific language governing permissions and limitations under
81*d353a188SXin Lithe License.
82