Initial commit

.gitignore

@@ -0,0 +1,10 @@
+*.iml
+*.DS_Store
+*.keystore
+*.jks
+.gradle/
+.idea/
+build/
+/signing/
+/local.properties
+/publish.properties

LICENSE.md

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 Pavel Vasilev
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,139 @@
+<hr>
+<h5> [Readme in english 🇬🇧] <a href="./README_RU.md"> [Описание на русском 🇷🇺] </a> </h5>
+<hr>
+
+# NDEF emulator
+
+- [Description](#description)
+- [Usage](#usage)
+- [Supported message types](#supported-message-types)
+- [Code examples](#code-examples)
+- [Demo](#demo)
+- [Support](#support)
+- [Feedback](#feedback)
+- [License](#license)
+
+## Description
+
+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. 
+
+The library is written in Kotlin and has no extra dependencies. 
+
+This library emulates the "NFC Forum Type 4" tag that contains NDEF formatted message.
+That type of tags meets all the technical requirements and fits all the restrictions to be emulated via the Android HCE interface.
+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.
+
+This repository contains the library itself (**ndefemulation**) and the demo application (**demo**).
+
+## Usage
+
+To use the library in your project simply add it to your dependencies in `build.gradle` build script:
+```
+implementation 'com.luigivampa92:ndefemulation-android:1.0.0'
+```
+
+All actions are performed through the `NdefEmulation` class.
+This class contains property `currentEmulatedNdefData` (or `getCurrentEmulatedNdefData()`/`setCurrentEmulatedNdefData()` methods if you use Java) that is used to set the data that must be emulated.
+You will need the `Context` object to set the current emulated NDEF message or to disable the emulation.
+The class has the constructor that accepts the `Context`.
+You can create and use the `NdefEmulation` object in any Android component (Activity, Service, etc) or by providing the `Context` object via the DI.
+
+The library interface is very simple and basically fits in just a single line of code.
+
+To enable the emulation, create the required NDEF message object and set it to the `currentEmulatedNdefData` property of `NdefEmulation`:
+```
+NdefEmulation(context).currentEmulatedNdefData = UriNdefData("https://www.youtube.com/watch?v=dQw4w9WgXcQ")
+```
+
+To disable the emulation of NDEF messages simply set `null` to the `currentEmulatedNdefData` property in `NdefEmulation`:
+```
+NdefEmulation(context).currentEmulatedNdefData = null
+```
+
+## Supported message types
+
+| Type              | Class               | Android | iOS | Comment                                                                                                                                                                                                                                                                                           |
+|-------------------|---------------------|---------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 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          |
+| 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)                                                                                 |
+| 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                 |
+| 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         |
+| Phonebook Contact | ContactNdefData     | ✅       | ❌   | Phonebook contact data in the VCard format. Works natively only on Android, iOS does not react to this type of messages                                                                                                                                                                           |
+| 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 |
+
+- ✅ - 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 
+- ❌ - 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
+- 🤷 - Means that "it depends", the message will be read but its further handing depends on extra circumstances
+
+## Code examples
+
+Some code examples of emulating the messages of various types
+<br>
+
+Send the Youtube video by the HTTP URL:
+```
+NdefEmulation(this).currentEmulatedNdefData = UriNdefData("https://www.youtube.com/watch?v=dQw4w9WgXcQ")
+```
+
+Send the Youtube video by the deeplink URI:
+```
+NdefEmulation(this).currentEmulatedNdefData = UriNdefData("vnd.youtube://www.youtube.com/watch?v=dQw4w9WgXcQ")
+```
+
+Open the WhatsApp dialog by a phone number:
+```
+NdefEmulation(this).currentEmulatedNdefData = UriNdefData("https://wa.me/79123456789")
+```
+
+Open the Telegram dialog by a phone number:
+```
+NdefEmulation(this).currentEmulatedNdefData = UriNdefData("tg://msg?to=+79123456789")
+```
+
+Send some raw text:
+```
+NdefEmulation(this).currentEmulatedNdefData = TextNdefData("Whiskey Tango Foxtrot")
+```
+
+Send the geolocation point:
+```
+NdefEmulation(this).currentEmulatedNdefData = LocationNdefData(12.345678, 78.654321)
+```
+
+Send the WiFi access point name and password:
+```
+NdefEmulation(this).currentEmulatedNdefData = WifiNetworkNdefData("YourWifiName", WifiNetworkNdefDataProtectionType.PASSWORD, "YourWifiPassword")
+```
+
+Send the phonebook contact data:
+```
+NdefEmulation(this).currentEmulatedNdefData = ContactNdefData("John", "Doe", "+12345678900")
+```
+
+## Demo
+
+The demo application can be found and downloaded in Releases.  
+
+You can download the demo app [here](https://github.com/TODO).
+
+There are versions for [smartphones](https://github.com/TODO) and for [watches](https://github.com/TODO)
+
+You can also build the demo application yourself from the sources:
+```
+./gradlew clean assemblePhoneRelease
+./gradlew clean assembleWatchRelease
+```
+
+## Support
+
+* Star this GitHub repository ⭐
+
+## Feedback
+
+You can provide your feedback, suggest ideas for the new features or simply ask the questions here:
+- [Email](mailto:luigivampa92@gmail.com) ✉️
+- [Telegram](https://t.me/luigivampa92) 💬
+
+## License
+
+Please see the [LICENSE](LICENSE.md) for details.

README_RU.md

@@ -0,0 +1 @@
+Readme on russian

build.gradle

@@ -0,0 +1,21 @@
+plugins {
+    alias(libs.plugins.android.application) apply false
+    alias(libs.plugins.jetbrains.kotlin.android) apply false
+    alias(libs.plugins.android.library) apply false
+}
+
+ext {
+    versionJava = JavaVersion.VERSION_1_8
+    versionKotlin = "1.8"
+    versionSdkMin = 21
+    versionSdkTarget = 35
+    versionCodeApp = 1
+    versionNameApp = "1.0.0"
+    versionNameLibrary = "1.0.0"
+    packageGroupId = "com.luigivampa92"
+    packageNamespaceApplication = "ndefemulator"
+    packageNamespaceLibrary = "ndefemulation"
+    packageMavenArtifactIdLibrary = "ndefemulation-android"
+    packageMavenArtifactDescription = "Library that performs emulation of NFC forum type 4 tags using the android host card emulation API"
+    packageRepoUrl = "https://github.com/LuigiVampa92/ndef-emulator"
+}