Skip to content

Commit 42cfc19

Browse files
LuigiVampa92LuigiVampa92
committed
Initial commit
0 parents  commit 42cfc19

File tree

80 files changed

+2803
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+2803
-0
lines changed

‎.gitignore

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
*.iml
2+
*.DS_Store
3+
*.keystore
4+
*.jks
5+
.gradle/
6+
.idea/
7+
build/
8+
/signing/
9+
/local.properties
10+
/publish.properties

‎LICENSE.md

+190
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
Copyright 2024 Pavel Vasilev
179+
180+
Licensed under the Apache License, Version 2.0 (the "License");
181+
you may not use this file except in compliance with the License.
182+
You may obtain a copy of the License at
183+
184+
http://www.apache.org/licenses/LICENSE-2.0
185+
186+
Unless required by applicable law or agreed to in writing, software
187+
distributed under the License is distributed on an "AS IS" BASIS,
188+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189+
See the License for the specific language governing permissions and
190+
limitations under the License.

‎README.md

+139
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
<hr>
2+
<h5> [Readme in english 🇬🇧] <a href="./README_RU.md"> [Описание на русском 🇷🇺] </a> </h5>
3+
<hr>
4+
5+
# NDEF emulator
6+
7+
- [Description](#description)
8+
- [Usage](#usage)
9+
- [Supported message types](#supported-message-types)
10+
- [Code examples](#code-examples)
11+
- [Demo](#demo)
12+
- [Support](#support)
13+
- [Feedback](#feedback)
14+
- [License](#license)
15+
16+
## Description
17+
18+
Tiny and effective library for Android that allows you to emulate NDEF formatted messages via Android device NFC antenna, using the Android host card emulation API.
19+
20+
The library is written in Kotlin and has no extra dependencies.
21+
22+
This library emulates the "NFC Forum Type 4" tag that contains NDEF formatted message.
23+
That type of tags meets all the technical requirements and fits all the restrictions to be emulated via the Android HCE interface.
24+
It is also natively supported in most of the software products that can read NDEF formatted messages via NFC and it is also natively supported on the both mobile operating systems - Android and iOS.
25+
26+
This repository contains the library itself (**ndefemulation**) and the demo application (**demo**).
27+
28+
## Usage
29+
30+
To use the library in your project simply add it to your dependencies in `build.gradle` build script:
31+
```
32+
implementation 'com.luigivampa92:ndefemulation-android:1.0.0'
33+
```
34+
35+
All actions are performed through the `NdefEmulation` class.
36+
This class contains property `currentEmulatedNdefData` (or `getCurrentEmulatedNdefData()`/`setCurrentEmulatedNdefData()` methods if you use Java) that is used to set the data that must be emulated.
37+
You will need the `Context` object to set the current emulated NDEF message or to disable the emulation.
38+
The class has the constructor that accepts the `Context`.
39+
You can create and use the `NdefEmulation` object in any Android component (Activity, Service, etc) or by providing the `Context` object via the DI.
40+
41+
The library interface is very simple and basically fits in just a single line of code.
42+
43+
To enable the emulation, create the required NDEF message object and set it to the `currentEmulatedNdefData` property of `NdefEmulation`:
44+
```
45+
NdefEmulation(context).currentEmulatedNdefData = UriNdefData("https://www.youtube.com/watch?v=dQw4w9WgXcQ")
46+
```
47+
48+
To disable the emulation of NDEF messages simply set `null` to the `currentEmulatedNdefData` property in `NdefEmulation`:
49+
```
50+
NdefEmulation(context).currentEmulatedNdefData = null
51+
```
52+
53+
## Supported message types
54+
55+
| Type | Class | Android | iOS | Comment |
56+
|-------------------|---------------------|---------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
57+
| Normal URI | UriNdefData | ✅ | ✅ | The standard URI. The most useful thing and something that you will probably use in 95% of cases. Any normal URIs and URLs can be used here. The transferred message can be used to trigger IPC, open apps, performing actions etc. Perfectly and natively works on both Android and iOS |
58+
| Location GEO-URI | LocationNdefData | ✅ | 🤷 | Geolocation point. Works natively on Android, however to properly receive this kind of message on iOS, you must have an application that supports the `geo://` URI scheme installed (like "MapsMe", for instance) |
59+
| Raw Text | TextNdefData | ❌ | ❌ | Simple raw text. While it is the simplest type of message it can not be interpreted out-of-the-box by neither Android nor iOS without the special software that will expect some specific content in it. The OS will read this message, but will not parse it or do anything else |
60+
| WiFi Connection | WifiNetworkNdefData | ✅ | ❌ | Wifi access point connection data - name and password. Only OPEN (no password) and WPA/WPA2-PSK (standard password) types of wifi are supported. The EAP connections with user certificates is not supported. Works natively only on Android, iOS does not react to this type of messages |
61+
| Phonebook Contact | ContactNdefData | ✅ | ❌ | Phonebook contact data in the VCard format. Works natively only on Android, iOS does not react to this type of messages |
62+
| Another Raw NDEF | NdefRecordData | 🤷 | 🤷 | Any NdefRecord class from Android framework can be emulated. For example, you can receive NDEF record by intent in your application and then set it to be emulated without even parsing it. Very useful but whether it will be received or not on the reader side depends on the message contents |
63+
64+
- ✅ - Means that the mentioned OS can natively read and parse that type of message. You do not need any specific third-party applications on the device that will read the emulated tag. After the message will be transferred to the reading device, you will see some notification of some action will be performed right away
65+
- ❌ - Means that the mentioned OS can natively read but will not parse that type of message, and will not perform any actions after it. Some third party applications may have the implementations that will handle this type of message but not the OS itself
66+
- 🤷 - Means that "it depends", the message will be read but its further handing depends on extra circumstances
67+
68+
## Code examples
69+
70+
Some code examples of emulating the messages of various types
71+
<br>
72+
73+
Send the Youtube video by the HTTP URL:
74+
```
75+
NdefEmulation(this).currentEmulatedNdefData = UriNdefData("https://www.youtube.com/watch?v=dQw4w9WgXcQ")
76+
```
77+
78+
Send the Youtube video by the deeplink URI:
79+
```
80+
NdefEmulation(this).currentEmulatedNdefData = UriNdefData("vnd.youtube://www.youtube.com/watch?v=dQw4w9WgXcQ")
81+
```
82+
83+
Open the WhatsApp dialog by a phone number:
84+
```
85+
NdefEmulation(this).currentEmulatedNdefData = UriNdefData("https://wa.me/79123456789")
86+
```
87+
88+
Open the Telegram dialog by a phone number:
89+
```
90+
NdefEmulation(this).currentEmulatedNdefData = UriNdefData("tg://msg?to=+79123456789")
91+
```
92+
93+
Send some raw text:
94+
```
95+
NdefEmulation(this).currentEmulatedNdefData = TextNdefData("Whiskey Tango Foxtrot")
96+
```
97+
98+
Send the geolocation point:
99+
```
100+
NdefEmulation(this).currentEmulatedNdefData = LocationNdefData(12.345678, 78.654321)
101+
```
102+
103+
Send the WiFi access point name and password:
104+
```
105+
NdefEmulation(this).currentEmulatedNdefData = WifiNetworkNdefData("YourWifiName", WifiNetworkNdefDataProtectionType.PASSWORD, "YourWifiPassword")
106+
```
107+
108+
Send the phonebook contact data:
109+
```
110+
NdefEmulation(this).currentEmulatedNdefData = ContactNdefData("John", "Doe", "+12345678900")
111+
```
112+
113+
## Demo
114+
115+
The demo application can be found and downloaded in Releases.
116+
117+
You can download the demo app [here](https://github.com/TODO).
118+
119+
There are versions for [smartphones](https://github.com/TODO) and for [watches](https://github.com/TODO)
120+
121+
You can also build the demo application yourself from the sources:
122+
```
123+
./gradlew clean assemblePhoneRelease
124+
./gradlew clean assembleWatchRelease
125+
```
126+
127+
## Support
128+
129+
* Star this GitHub repository ⭐
130+
131+
## Feedback
132+
133+
You can provide your feedback, suggest ideas for the new features or simply ask the questions here:
134+
- [Email](mailto:[email protected]) ✉️
135+
- [Telegram](https://t.me/luigivampa92) 💬
136+
137+
## License
138+
139+
Please see the [LICENSE](LICENSE.md) for details.

‎README_RU.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Readme on russian

‎build.gradle

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
plugins {
2+
alias(libs.plugins.android.application) apply false
3+
alias(libs.plugins.jetbrains.kotlin.android) apply false
4+
alias(libs.plugins.android.library) apply false
5+
}
6+
7+
ext {
8+
versionJava = JavaVersion.VERSION_1_8
9+
versionKotlin = "1.8"
10+
versionSdkMin = 21
11+
versionSdkTarget = 35
12+
versionCodeApp = 1
13+
versionNameApp = "1.0.0"
14+
versionNameLibrary = "1.0.0"
15+
packageGroupId = "com.luigivampa92"
16+
packageNamespaceApplication = "ndefemulator"
17+
packageNamespaceLibrary = "ndefemulation"
18+
packageMavenArtifactIdLibrary = "ndefemulation-android"
19+
packageMavenArtifactDescription = "Library that performs emulation of NFC forum type 4 tags using the android host card emulation API"
20+
packageRepoUrl = "https://github.com/LuigiVampa92/ndef-emulator"
21+
}

0 commit comments

Comments
 (0)