skjolber / ndef-tools-for-android Goto Github PK

View Code? Open in Web Editor NEW

139.0 10.0 42.0 1.81 MB

NDEF Tools for Android

License: Apache License 2.0

Java 100.00%

android nfc ndef ndef-format library

ndef-tools-for-android's Introduction

Overview

This site hosts a library for Near Field Communication on Android using the NDEF format.

The current (version <= 14.0) Android SDK only comes with a low-level NDEF API which does not expose developers to the full potential of the NDEF format. Rather than sweating over byte arrays, developers should have access to high-level representations.

Features:

NDEF object representation library (no more byte arrays!)
- Simple conversion to and from Android SDK low-level equivalent
JSE module with the corresponding Android classes for use in regular Java

In short, this projects helps you to handle dynamic NDEF content at runtime.

License

Apache 2.0

Obtain

The project is built with Gradle and is available on the central Maven repository. For Gradle, configure the property

ext {
  ndefToolsForAndroidVersion = '2.0.1'
}

and add the dependency

api("com.github.skjolber.ndef-tools-for-android:ndeftools:${ndefToolsForAndroidVersion}")

Usage

So a Message consists of a list of Records in the NDEF standard. Browse the source for an overview of supported record types.

Creating new NDEF records

Compose an Android Application Record:

AndroidApplicationRecord aar = new AndroidApplicationRecord();
aar.setPackageName("org.ndeftools.boilerplate");

Compose a Mime Record

MimeRecord mimeRecord = new MimeRecord();
mimeRecord.setMimeType("text/plain");
mimeRecord.setData("This is my data".getBytes("UTF-8"));

Create new NDEF message

From above, simply

Message message = new Message(); //  com.github.skjolber.ndef.Message
message.add(androidApplicationRecord);
message.add(mimeRecord);

or from bytes

byte[] messageBytes = ...; // get your bytes
Message message = Message.parseNdefMessage(messageBytes);

Converting to and from native Android NdefMessage

Use

NdefMessage lowLevel = ...; // get from existing code
Message highLevel = new Message(lowLevel);
// read from high-level records

Message highLevel = ...// compose high-level records
NdefMessage lowLevel = highLevel.getNdefMessage();
// .. pass low-level NdefMessage to existing code

JSE module

A few NFC classes copied from the Android open source project, so that the NDEF library can be used on regular Java (i.e. Java 8 or 11).

Example

For a working example see android-nfc-lifecycle-wrapper.

Acknowledgements

This project springs out the NFC Tools for Java and NFC Eclipse plugin projects.

History

April 2024: Version 2.0.1 maintenance release.

August 2020: Version 2.0.0 maintenance release:

Maven coordinates updated; group is now com.github.skjolber.ndef-tools-for-android
Packages renamed to com.github.skjolber.ndef
Added Gradle build (now dual builds with Maven)
Moved utilities and examples to seperate project
Minor improvements

March 28th 2013: Version 1.2.3 released.
February 5th 2013: Version 1.2.2 released.
January 1st 2013: Version 1.2.1 released.
October 18th 2012: Version 1.2 released.
September 15th 2012: Initial release.

ndef-tools-for-android's People

Contributors

Stargazers

Watchers

ndef-tools-for-android's Issues

Patch for /ndeftools-util/src/org/ndeftools/util/activity/NfcReaderActivity.java

mnmnm

Original issue reported on code.google.com by [email protected] on 14 Feb 2014 at 7:37

Attachments:

NfcReaderActivity.java.patch

Garbage chars displayed for (Abosulte) URI Record

Hello!

After installing nfc-eclipse-plugin I am trying to create Test.ndef file and add a record there: "Absolute URI Record" or "URI Record":

Then I try to scan the resulting QR image by using the popular ZXing Barcode Scanner app.

Unfortunately the resulting QR image seems to contain 2 garbage chars:

Why does it happen please?

Mavenize

This is a very useful library! Makes reading/writing NFC tags so much easier.

But it would be even better and greatly improves integrating this library into 
Android projects if you make this a Maven project and push the artifacts to 
Maven central repository.

Thank you!

Original issue reported on code.google.com by [email protected] on 23 Feb 2013 at 8:21

Blocked on: #2

Refresh project

Add more NDEF records, if they exist
Update or retire examples.
Update documentation
Make wrappers for utilities (so that extending activities is not required)
Move to gradle

add instructions for and compatibility with gradle build process in Android Studio

Eclipse is now deprecated as a development platform for Android applications. 

This library should be updated to be compatible with the "dependency" style of 
inclusion in Android projects and made available for use in that manner.

Original issue reported on code.google.com by [email protected] on 18 Oct 2014 at 2:39

NfcDetectorActivity should use onSaveInstanceState

I run into a problem with NfcDetectorActivity. I completely understand tag dispatch system, and know that each onNewIntent call sets the new Intent as current activity intent. There is a field named "intentProcessed" which ensures no double detections of the same intent when activity is paused and resumed. A problem arises when you just change activity's orientation which in turn triggers (default) activity recreation, and when activity is resumed - tag detection callback is performed again. This leads to write failure callbacks in NfcTagWritterActivity as it thinks that a new tag is in range. I suggest to override onSaveInstanceState in NfcDetectorActivity and store intentProcessed value. This should be read in onCreate callback too. BTW. This project is awesome!

Question: Writing vCard etc

Hi,

first of all lovely lib. I was able to read&write tags in almost no time. I am now interested in writing vCards (phone numbers and contact name), website url, etc on tags.

Can this awesome lib do this aswell? Tried finding some sample code for this purpose, but no luck.

Add http://ndef.codeplex.com/ compatibility

Add automated tests for verifying compatibility to http://ndef.codeplex.com/ 
code NDEF output.

Original issue reported on code.google.com by thomas.skjolberg on 6 May 2013 at 9:33

Blocking: #1