9 |
10 |
--------------------------------------------------------------------------------
/.idea/vcs.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 |
2 | Apache License
3 | Version 2.0, January 2004
4 | http://www.apache.org/licenses/
5 |
6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7 |
8 | 1. Definitions.
9 |
10 | "License" shall mean the terms and conditions for use, reproduction,
11 | and distribution as defined by Sections 1 through 9 of this document.
12 |
13 | "Licensor" shall mean the copyright owner or entity authorized by
14 | the copyright owner that is granting the License.
15 |
16 | "Legal Entity" shall mean the union of the acting entity and all
17 | other entities that control, are controlled by, or are under common
18 | control with that entity. For the purposes of this definition,
19 | "control" means (i) the power, direct or indirect, to cause the
20 | direction or management of such entity, whether by contract or
21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 | outstanding shares, or (iii) beneficial ownership of such entity.
23 |
24 | "You" (or "Your") shall mean an individual or Legal Entity
25 | exercising permissions granted by this License.
26 |
27 | "Source" form shall mean the preferred form for making modifications,
28 | including but not limited to software source code, documentation
29 | source, and configuration files.
30 |
31 | "Object" form shall mean any form resulting from mechanical
32 | transformation or translation of a Source form, including but
33 | not limited to compiled object code, generated documentation,
34 | and conversions to other media types.
35 |
36 | "Work" shall mean the work of authorship, whether in Source or
37 | Object form, made available under the License, as indicated by a
38 | copyright notice that is included in or attached to the work
39 | (an example is provided in the Appendix below).
40 |
41 | "Derivative Works" shall mean any work, whether in Source or Object
42 | form, that is based on (or derived from) the Work and for which the
43 | editorial revisions, annotations, elaborations, or other modifications
44 | represent, as a whole, an original work of authorship. For the purposes
45 | of this License, Derivative Works shall not include works that remain
46 | separable from, or merely link (or bind by name) to the interfaces of,
47 | the Work and Derivative Works thereof.
48 |
49 | "Contribution" shall mean any work of authorship, including
50 | the original version of the Work and any modifications or additions
51 | to that Work or Derivative Works thereof, that is intentionally
52 | submitted to Licensor for inclusion in the Work by the copyright owner
53 | or by an individual or Legal Entity authorized to submit on behalf of
54 | the copyright owner. For the purposes of this definition, "submitted"
55 | means any form of electronic, verbal, or written communication sent
56 | to the Licensor or its representatives, including but not limited to
57 | communication on electronic mailing lists, source code control systems,
58 | and issue tracking systems that are managed by, or on behalf of, the
59 | Licensor for the purpose of discussing and improving the Work, but
60 | excluding communication that is conspicuously marked or otherwise
61 | designated in writing by the copyright owner as "Not a Contribution."
62 |
63 | "Contributor" shall mean Licensor and any individual or Legal Entity
64 | on behalf of whom a Contribution has been received by Licensor and
65 | subsequently incorporated within the Work.
66 |
67 | 2. Grant of Copyright License. Subject to the terms and conditions of
68 | this License, each Contributor hereby grants to You a perpetual,
69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 | copyright license to reproduce, prepare Derivative Works of,
71 | publicly display, publicly perform, sublicense, and distribute the
72 | Work and such Derivative Works in Source or Object form.
73 |
74 | 3. Grant of Patent License. Subject to the terms and conditions of
75 | this License, each Contributor hereby grants to You a perpetual,
76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 | (except as stated in this section) patent license to make, have made,
78 | use, offer to sell, sell, import, and otherwise transfer the Work,
79 | where such license applies only to those patent claims licensable
80 | by such Contributor that are necessarily infringed by their
81 | Contribution(s) alone or by combination of their Contribution(s)
82 | with the Work to which such Contribution(s) was submitted. If You
83 | institute patent litigation against any entity (including a
84 | cross-claim or counterclaim in a lawsuit) alleging that the Work
85 | or a Contribution incorporated within the Work constitutes direct
86 | or contributory patent infringement, then any patent licenses
87 | granted to You under this License for that Work shall terminate
88 | as of the date such litigation is filed.
89 |
90 | 4. Redistribution. You may reproduce and distribute copies of the
91 | Work or Derivative Works thereof in any medium, with or without
92 | modifications, and in Source or Object form, provided that You
93 | meet the following conditions:
94 |
95 | (a) You must give any other recipients of the Work or
96 | Derivative Works a copy of this License; and
97 |
98 | (b) You must cause any modified files to carry prominent notices
99 | stating that You changed the files; and
100 |
101 | (c) You must retain, in the Source form of any Derivative Works
102 | that You distribute, all copyright, patent, trademark, and
103 | attribution notices from the Source form of the Work,
104 | excluding those notices that do not pertain to any part of
105 | the Derivative Works; and
106 |
107 | (d) If the Work includes a "NOTICE" text file as part of its
108 | distribution, then any Derivative Works that You distribute must
109 | include a readable copy of the attribution notices contained
110 | within such NOTICE file, excluding those notices that do not
111 | pertain to any part of the Derivative Works, in at least one
112 | of the following places: within a NOTICE text file distributed
113 | as part of the Derivative Works; within the Source form or
114 | documentation, if provided along with the Derivative Works; or,
115 | within a display generated by the Derivative Works, if and
116 | wherever such third-party notices normally appear. The contents
117 | of the NOTICE file are for informational purposes only and
118 | do not modify the License. You may add Your own attribution
119 | notices within Derivative Works that You distribute, alongside
120 | or as an addendum to the NOTICE text from the Work, provided
121 | that such additional attribution notices cannot be construed
122 | as modifying the License.
123 |
124 | You may add Your own copyright statement to Your modifications and
125 | may provide additional or different license terms and conditions
126 | for use, reproduction, or distribution of Your modifications, or
127 | for any such Derivative Works as a whole, provided Your use,
128 | reproduction, and distribution of the Work otherwise complies with
129 | the conditions stated in this License.
130 |
131 | 5. Submission of Contributions. Unless You explicitly state otherwise,
132 | any Contribution intentionally submitted for inclusion in the Work
133 | by You to the Licensor shall be under the terms and conditions of
134 | this License, without any additional terms or conditions.
135 | Notwithstanding the above, nothing herein shall supersede or modify
136 | the terms of any separate license agreement you may have executed
137 | with Licensor regarding such Contributions.
138 |
139 | 6. Trademarks. This License does not grant permission to use the trade
140 | names, trademarks, service marks, or product names of the Licensor,
141 | except as required for reasonable and customary use in describing the
142 | origin of the Work and reproducing the content of the NOTICE file.
143 |
144 | 7. Disclaimer of Warranty. Unless required by applicable law or
145 | agreed to in writing, Licensor provides the Work (and each
146 | Contributor provides its Contributions) on an "AS IS" BASIS,
147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 | implied, including, without limitation, any warranties or conditions
149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 | PARTICULAR PURPOSE. You are solely responsible for determining the
151 | appropriateness of using or redistributing the Work and assume any
152 | risks associated with Your exercise of permissions under this License.
153 |
154 | 8. Limitation of Liability. In no event and under no legal theory,
155 | whether in tort (including negligence), contract, or otherwise,
156 | unless required by applicable law (such as deliberate and grossly
157 | negligent acts) or agreed to in writing, shall any Contributor be
158 | liable to You for damages, including any direct, indirect, special,
159 | incidental, or consequential damages of any character arising as a
160 | result of this License or out of the use or inability to use the
161 | Work (including but not limited to damages for loss of goodwill,
162 | work stoppage, computer failure or malfunction, or any and all
163 | other commercial damages or losses), even if such Contributor
164 | has been advised of the possibility of such damages.
165 |
166 | 9. Accepting Warranty or Additional Liability. While redistributing
167 | the Work or Derivative Works thereof, You may choose to offer,
168 | and charge a fee for, acceptance of support, warranty, indemnity,
169 | or other liability obligations and/or rights consistent with this
170 | License. However, in accepting such obligations, You may act only
171 | on Your own behalf and on Your sole responsibility, not on behalf
172 | of any other Contributor, and only if You agree to indemnify,
173 | defend, and hold each Contributor harmless for any liability
174 | incurred by, or claims asserted against, such Contributor by reason
175 | of your accepting any such warranty or additional liability.
176 |
177 | END OF TERMS AND CONDITIONS
178 |
179 | APPENDIX: How to apply the Apache License to your work.
180 |
181 | To apply the Apache License to your work, attach the following
182 | boilerplate notice, with the fields enclosed by brackets "[]"
183 | replaced with your own identifying information. (Don't include
184 | the brackets!) The text should be enclosed in the appropriate
185 | comment syntax for the file format. We also recommend that a
186 | file or class name and description of purpose be included on the
187 | same "printed page" as the copyright notice for easier
188 | identification within third-party archives.
189 |
190 | Copyright 2014-2018 Radius Networks
191 |
192 | Licensed under the Apache License, Version 2.0 (the "License");
193 | you may not use this file except in compliance with the License.
194 | You may obtain a copy of the License at
195 |
196 | http://www.apache.org/licenses/LICENSE-2.0
197 |
198 | Unless required by applicable law or agreed to in writing, software
199 | distributed under the License is distributed on an "AS IS" BASIS,
200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 | See the License for the specific language governing permissions and
202 | limitations under the License.
203 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ## Overview
2 |
3 | This is a Kotlin reference app for the AndroidBeaconLibrary
4 |
5 | ## Project Setup
6 |
7 | 1. Install [Android Studio](https://developer.android.com/sdk/installing/studio.html) Android Studio Hedgehog | 2023.1.1+
8 | 2. Open this project
9 |
10 | See the [Java refernce app here.](https://github.com/davidgyoung/android-beacon-library-reference-java)
11 |
--------------------------------------------------------------------------------
/android-beacon-library:
--------------------------------------------------------------------------------
1 | ../android-beacon-library
--------------------------------------------------------------------------------
/app/.gitignore:
--------------------------------------------------------------------------------
1 | /build
--------------------------------------------------------------------------------
/app/build.gradle:
--------------------------------------------------------------------------------
1 | apply plugin: 'com.android.application'
2 | apply plugin: 'kotlin-android'
3 |
4 | android {
5 | compileSdkVersion 34
6 | buildToolsVersion "34.0.0"
7 |
8 | defaultConfig {
9 | applicationId "org.altbeacon.beaconreference"
10 | minSdkVersion 26
11 | targetSdkVersion 34
12 | versionCode 1
13 | versionName "1.0"
14 |
15 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
16 | }
17 |
18 | buildTypes {
19 | release {
20 | minifyEnabled false
21 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
22 | }
23 | }
24 | buildFeatures {
25 | viewBinding true
26 | }
27 | compileOptions {
28 | sourceCompatibility JavaVersion.VERSION_17
29 | targetCompatibility JavaVersion.VERSION_17
30 | }
31 | kotlinOptions {
32 | jvmTarget = '17'
33 | }
34 | namespace 'org.altbeacon.beaconreference'
35 | }
36 |
37 | dependencies {
38 | implementation fileTree(dir: "libs", include: ["*.jar"])
39 | implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
40 | implementation 'androidx.core:core-ktx:1.3.1'
41 | implementation 'androidx.appcompat:appcompat:1.3.1'
42 | implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
43 | implementation('com.davidgyoungtech:beacon-parsers:1.0') {
44 | exclude group: 'org.altbeacon'
45 | }
46 | implementation 'org.altbeacon:android-beacon-library:2+'
47 | //implementation project(':android-beacon-library:lib')
48 |
49 | //coroutines
50 | implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.2'
51 | implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.2"
52 | //coroutine scopes
53 | implementation "androidx.lifecycle:lifecycle-runtime-ktx:2.2.0"
54 | testImplementation 'junit:junit:4.12'
55 | androidTestImplementation 'androidx.test.ext:junit:1.1.1'
56 | androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
57 | }
58 |
--------------------------------------------------------------------------------
/app/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # You can control the set of applied configuration files using the
3 | # proguardFiles setting in build.gradle.
4 | #
5 | # For more details, see
6 | # http://developer.android.com/guide/developing/tools/proguard.html
7 |
8 | # If your project uses WebView with JS, uncomment the following
9 | # and specify the fully qualified class name to the JavaScript interface
10 | # class:
11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12 | # public *;
13 | #}
14 |
15 | # Uncomment this to preserve the line number information for
16 | # debugging stack traces.
17 | #-keepattributes SourceFile,LineNumberTable
18 |
19 | # If you keep the line number information, uncomment this to
20 | # hide the original source file name.
21 | #-renamesourcefileattribute SourceFile
--------------------------------------------------------------------------------
/app/src/androidTest/java/org/altbeacon/beaconreference/ExampleInstrumentedTest.kt:
--------------------------------------------------------------------------------
1 | package org.altbeacon.beaconreference
2 |
3 | import androidx.test.platform.app.InstrumentationRegistry
4 | import androidx.test.ext.junit.runners.AndroidJUnit4
5 |
6 | import org.junit.Test
7 | import org.junit.runner.RunWith
8 |
9 | import org.junit.Assert.*
10 |
11 | /**
12 | * Instrumented test, which will execute on an Android device.
13 | *
14 | * See [testing documentation](http://d.android.com/tools/testing).
15 | */
16 | @RunWith(AndroidJUnit4::class)
17 | class ExampleInstrumentedTest {
18 | @Test
19 | fun useAppContext() {
20 | // Context of the app under test.
21 | val appContext = InstrumentationRegistry.getInstrumentation().targetContext
22 | assertEquals("org.altbeacon.beaconreference", appContext.packageName)
23 | }
24 | }
--------------------------------------------------------------------------------
/app/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
12 |
13 |
14 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
30 |
31 |
32 |
--------------------------------------------------------------------------------
/app/src/main/java/org/altbeacon/beacon/permissions/PermissionsActivity.kt:
--------------------------------------------------------------------------------
1 | package org.altbeacon.beacon.permissions
2 |
3 | import android.Manifest
4 | import android.annotation.SuppressLint
5 | import android.app.AlertDialog
6 | import android.content.Context
7 | import android.content.pm.PackageManager
8 | import android.graphics.Color
9 | import android.os.Build
10 | import android.os.Bundle
11 | import android.util.Log
12 | import android.view.Gravity
13 | import android.view.View
14 | import android.widget.Button
15 | import android.widget.LinearLayout
16 | import android.widget.TextView
17 | import androidx.activity.result.contract.ActivityResultContracts
18 | import androidx.appcompat.app.AppCompatActivity
19 | import androidx.core.content.ContextCompat
20 | import androidx.core.view.setPadding
21 |
22 | open class PermissionsActivity: AppCompatActivity() {
23 |
24 | val requestPermissionsLauncher =
25 | registerForActivityResult(
26 | ActivityResultContracts.RequestMultiplePermissions()
27 | ) { permissions ->
28 | // Handle Permission granted/rejected
29 | permissions.entries.forEach {
30 | val permissionName = it.key
31 | val isGranted = it.value
32 | if (isGranted) {
33 | Log.d(TAG, "$permissionName permission granted: $isGranted")
34 | // Permission is granted. Continue the action or workflow in your
35 | // app.
36 | } else {
37 | Log.d(TAG, "$permissionName permission granted: $isGranted")
38 | // Explain to the user that the feature is unavailable because the
39 | // features requires a permission that the user has denied. At the
40 | // same time, respect the user's decision. Don't link to system
41 | // settings in an effort to convince the user to change their
42 | // decision.
43 | }
44 | }
45 | }
46 |
47 | companion object {
48 | const val TAG = "PermissionsActivity"
49 | }
50 | }
51 |
52 | class PermissionsHelper(val context: Context) {
53 | // Manifest.permission.ACCESS_BACKGROUND_LOCATION
54 | // Manifest.permission.ACCESS_FINE_LOCATION
55 | // Manifest.permission.BLUETOOTH_CONNECT
56 | // Manifest.permission.BLUETOOTH_SCAN
57 | fun isPermissionGranted(permissionString: String): Boolean {
58 | return (ContextCompat.checkSelfPermission(context, permissionString) == PackageManager.PERMISSION_GRANTED)
59 | }
60 | fun setFirstTimeAskingPermission(permissionString: String, isFirstTime: Boolean) {
61 | val sharedPreference = context.getSharedPreferences("org.altbeacon.permisisons",
62 | AppCompatActivity.MODE_PRIVATE
63 | )
64 | sharedPreference.edit().putBoolean(permissionString,
65 | isFirstTime).apply()
66 | }
67 |
68 | fun isFirstTimeAskingPermission(permissionString: String): Boolean {
69 | val sharedPreference = context.getSharedPreferences(
70 | "org.altbeacon.permisisons",
71 | AppCompatActivity.MODE_PRIVATE
72 | )
73 | return sharedPreference.getBoolean(
74 | permissionString,
75 | true
76 | )
77 | }
78 | fun beaconScanPermissionGroupsNeeded(backgroundAccessRequested: Boolean = false): List> {
79 | val permissions = ArrayList>()
80 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
81 | // As of version M (6) we need FINE_LOCATION (or COARSE_LOCATION, but we ask for FINE)
82 | permissions.add(arrayOf(Manifest.permission.ACCESS_FINE_LOCATION))
83 | }
84 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
85 | // As of version Q (10) we need FINE_LOCATION and BACKGROUND_LOCATION
86 | if (backgroundAccessRequested) {
87 | permissions.add(arrayOf(Manifest.permission.ACCESS_BACKGROUND_LOCATION))
88 | }
89 | }
90 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
91 | // As of version S (12) we need FINE_LOCATION, BLUETOOTH_SCAN and BACKGROUND_LOCATION
92 | // Manifest.permission.BLUETOOTH_CONNECT is not absolutely required to do just scanning,
93 | // but it is required if you want to access some info from the scans like the device name
94 | // and the aditional cost of requsting this access is minimal, so we just request it
95 | permissions.add(arrayOf(Manifest.permission.BLUETOOTH_SCAN, Manifest.permission.BLUETOOTH_CONNECT, Manifest.permission.BLUETOOTH_ADVERTISE))
96 | }
97 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
98 | // As of version nonBeaconBeaconRegionT (13) we POST_NOTIFICATIONS permissions if using a foreground service
99 | permissions.add(arrayOf(Manifest.permission.POST_NOTIFICATIONS))
100 | }
101 | return permissions
102 | }
103 |
104 | }
105 |
106 |
107 |
108 | open class BeaconScanPermissionsActivity: PermissionsActivity() {
109 | lateinit var layout: LinearLayout
110 | lateinit var permissionGroups: List>
111 | lateinit var continueButton: Button
112 | var scale: Float = 1.0f
113 | get() {
114 | return this.getResources().getDisplayMetrics().density
115 | }
116 |
117 | override fun onCreate(savedInstanceState: Bundle?) {
118 | super.onCreate(savedInstanceState)
119 |
120 | layout = LinearLayout(this)
121 | layout.setPadding(dp(20))
122 | layout.gravity = Gravity.CENTER
123 | layout.setBackgroundColor(Color.WHITE)
124 | layout.orientation = LinearLayout.VERTICAL
125 | val backgroundAccessRequested = intent.getBooleanExtra("backgroundAccessRequested", true)
126 | val title = intent.getStringExtra("title") ?: "Permissions Needed"
127 | val message = intent.getStringExtra("message") ?: "In order to scan for beacons, this app requrires the following permissions from the operating system. Please tap each button to grant each required permission."
128 | val continueButtonTitle = intent.getStringExtra("continueButtonTitle") ?: "Continue"
129 | val permissionButtonTitles = intent.getBundleExtra("permissionBundleTitles") ?: getDefaultPermissionTitlesBundle()
130 |
131 | permissionGroups = PermissionsHelper(this).beaconScanPermissionGroupsNeeded(backgroundAccessRequested)
132 |
133 | val params = LinearLayout.LayoutParams(
134 | LinearLayout.LayoutParams.MATCH_PARENT,
135 | LinearLayout.LayoutParams.WRAP_CONTENT
136 | )
137 | params.setMargins(dp(0), dp(10), dp(0), dp(10))
138 |
139 |
140 | val titleView = TextView(this)
141 | titleView.setGravity(Gravity.CENTER)
142 | titleView.textSize = dp(10).toFloat()
143 | titleView.text = title
144 | titleView.layoutParams = params
145 |
146 | layout.addView(titleView)
147 | val messageView = TextView(this)
148 | messageView.text = message
149 | messageView.setGravity(Gravity.CENTER)
150 | messageView.textSize = dp(5).toFloat()
151 | messageView.textAlignment = TextView.TEXT_ALIGNMENT_CENTER
152 | messageView.layoutParams = params
153 | layout.addView(messageView)
154 |
155 | var index = 0
156 | for (permissionGroup in permissionGroups) {
157 | val button = Button(this)
158 | val buttonTitle = permissionButtonTitles.getString(permissionGroup.first())
159 | button.id = index
160 | button.text = buttonTitle
161 | button.layoutParams = params
162 | button.setOnClickListener(buttonClickListener)
163 | layout.addView(button)
164 | index += 1
165 | }
166 |
167 | continueButton = Button(this)
168 | continueButton.text = continueButtonTitle
169 | continueButton.isEnabled = false
170 | continueButton.setOnClickListener {
171 | this.finish()
172 | }
173 | continueButton.layoutParams = params
174 | layout.addView(continueButton)
175 |
176 | setContentView(layout)
177 | }
178 |
179 | fun dp(value: Int): Int {
180 | return (value * scale + 0.5f).toInt()
181 | }
182 |
183 | val buttonClickListener = View.OnClickListener { button ->
184 | val permissionsGroup = permissionGroups.get(button.id)
185 | promptForPermissions(permissionsGroup)
186 | }
187 |
188 | @SuppressLint("InlinedApi")
189 | fun getDefaultPermissionTitlesBundle(): Bundle {
190 | val bundle = Bundle()
191 | bundle.putString(Manifest.permission.ACCESS_FINE_LOCATION, "Location")
192 | bundle.putString(Manifest.permission.ACCESS_BACKGROUND_LOCATION, "Background Location")
193 | bundle.putString(Manifest.permission.BLUETOOTH_SCAN, "Bluetooth")
194 | bundle.putString(Manifest.permission.POST_NOTIFICATIONS, "Notifications")
195 | return bundle
196 | }
197 |
198 |
199 | fun allPermissionGroupsGranted(): Boolean {
200 | for (permissionsGroup in permissionGroups) {
201 | if (!allPermissionsGranted(permissionsGroup)) {
202 | return false
203 | }
204 | }
205 | return true
206 | }
207 |
208 | fun setButtonColors() {
209 | var index = 0
210 | for (permissionsGroup in this.permissionGroups) {
211 | val button = findViewById