ndef 0.1.0

A Dart library to decode & encode NDEF records, supporting multiple types.

ndef

ndef is a Dart library to decode & encode NDEF records, supporting multiple types including (grouped by Type Name Format):

• NFC Well Known
  • Text
  • URI with well-known prefix
  • Digital signature
  • Smart poster
  • Connection handover
• Media (MIME data)
  • Bluetooth easy pairing / Bluetooth low energy
  • other MIME data
• Absolute URI

This library is still under active development and subject to breaking API changes and malfunction. Pull requests and issues are most welcomed.

Usage

import 'package:ndef/ndef.dart' as ndef;

// encoding
var uriRecord = new ndef.UriRecord.fromUriString("https://github.com/nfcim/ndef");
var textRecord = new ndef.TextRecord(text: "Hello");
var encodedUriRecord = ndef.ByteUtils.list2hexString(uriRecord.encode()); // encode a single record
var encodedAllRecords = ndef.ByteUtils.list2hexString(ndef.encodeNdefMessage([uriRecord, textRecord])); // encode several records as a message

// decoding
var encodedTextRecord = "d1010f5402656e48656c6c6f20576f726c6421";
var decodedRecords = ndef.decodeRawNdefMessage(ndef.ByteUtils.hexString2list(encodedTextRecord));
assert(decodedRecords.length == 1);
if (decodedRecords[0] is ndef.TextRecord) {
  assert(decodeRecords[0].text == "Hello");
}  else {
  // no we will not reach here
}

// data-binding (by implementing payload as dynamic getter / setter)
var origPayload = uriRecord.payload;
print(origPayload);
uriRecord.uriData = "github.com/nfcim/flutter_nfc_kit";
print(uriRecord.payload); // changed
uriRecord.payload = origPayload;
print(uriRecord.uriData); // changed back

// decoding by providing parts of a record
var partiallyDecodedUrlRecord = ndef.decodePartialNdefMessage(ndef.TypeNameFormat.nfcWellKnown, utf8.encode("U"), origPayload, id: Uint8List.fromList([0x1, 0x2]));

See examples for a more complete example.

Refer to the documentation for more information.

TODO

1. security
2. class design (add getter/setter)
3. more types
4. print methods