MifareUltralight

PAGE_SIZE

static val PAGE_SIZE: Int

Size of a MIFARE Ultralight page in bytes

Value: 4

TYPE_ULTRALIGHT

static val TYPE_ULTRALIGHT: Int

A MIFARE Ultralight tag

Value: 1

TYPE_ULTRALIGHT_C

static val TYPE_ULTRALIGHT_C: Int

A MIFARE Ultralight C tag

Value: 2

TYPE_UNKNOWN

static val TYPE_UNKNOWN: Int

A MIFARE Ultralight compatible tag of unknown type

Value: -1

close

fun close(): Unit

connect

fun connect(): Unit

get

static fun get(tag: Tag!): MifareUltralight!

Get an instance of MifareUltralight for the given tag.

Returns null if MifareUltralight was not enumerated in Tag.getTechList - this indicates the tag is not MIFARE Ultralight compatible, or that this Android device does not implement MIFARE Ultralight.

Does not cause any RF activity and does not block.

getMaxTransceiveLength

fun getMaxTransceiveLength(): Int

Return the maximum number of bytes that can be sent with transceive.

getTag

fun getTag(): Tag!

getTimeout

fun getTimeout(): Int

Get the current transceive timeout in milliseconds.

Requires the android.Manifest.permission#NFC permission.

getType

fun getType(): Int

Return the MIFARE Ultralight type of the tag.

One of TYPE_ULTRALIGHT or TYPE_ULTRALIGHT_C or TYPE_UNKNOWN.

Depending on how the tag has been formatted, it can be impossible to accurately classify between original MIFARE Ultralight and Ultralight C. So treat this method as a hint.

Does not cause any RF activity and does not block.

isConnected

fun isConnected(): Boolean

readPages

fun readPages(pageOffset: Int): ByteArray!

Read 4 pages (16 bytes).

The MIFARE Ultralight protocol always reads 4 pages at a time, to reduce the number of commands required to read an entire tag.

If a read spans past the last readable block, then the tag will return pages that have been wrapped back to the first blocks. MIFARE Ultralight tags have readable blocks 0x00 through 0x0F. So a read to block offset 0x0E would return blocks 0x0E, 0x0F, 0x00, 0x01. MIFARE Ultralight C tags have readable blocks 0x00 through 0x2B. So a read to block 0x2A would return blocks 0x2A, 0x2B, 0x00, 0x01.

This is an I/O operation and will block until complete. It must not be called from the main application thread. A blocked call will be canceled with IOException if #close is called from another thread.

Requires the android.Manifest.permission#NFC permission.

setTimeout

fun setTimeout(timeout: Int): Unit

Set the transceive timeout in milliseconds.

The timeout only applies to transceive on this object, and is reset to a default value when #close is called.

Setting a longer timeout may be useful when performing transactions that require a long processing time on the tag such as key generation.

Requires the android.Manifest.permission#NFC permission.

transceive

fun transceive(data: ByteArray!): ByteArray!

Send raw NfcA data to a tag and receive the response.

This is equivalent to connecting to this tag via NfcA and calling NfcA.transceive. Note that all MIFARE Classic tags are based on NfcA technology.

Use getMaxTransceiveLength to retrieve the maximum number of bytes that can be sent with transceive.

This is an I/O operation and will block until complete. It must not be called from the main application thread. A blocked call will be canceled with IOException if #close is called from another thread.

Requires the android.Manifest.permission#NFC permission.

writePage

fun writePage(
    pageOffset: Int, 
    data: ByteArray!
): Unit

Write 1 page (4 bytes).

The MIFARE Ultralight protocol always writes 1 page at a time, to minimize EEPROM write cycles.

This is an I/O operation and will block until complete. It must not be called from the main application thread. A blocked call will be canceled with IOException if #close is called from another thread.

Requires the android.Manifest.permission#NFC permission.