Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.
added in API level 10

IsoDep

public final class IsoDep
extends Object implements TagTechnology

java.lang.Object
   ↳ android.nfc.tech.IsoDep


Provides access to ISO-DEP (ISO 14443-4) properties and I/O operations on a Tag.

Acquire an IsoDep object using get(Tag).

The primary ISO-DEP I/O operation is transceive(byte[]). Applications must implement their own protocol stack on top of transceive(byte[]).

Tags that enumerate the IsoDep technology in Tag.getTechList() will also enumerate NfcA or NfcB (since IsoDep builds on top of either of these).

Note: Methods that perform I/O operations require the Manifest.permission.NFC permission.

Summary

Public methods

void close()

Disable I/O operations to the tag from this TagTechnology object, and release resources.

void connect()

Enable I/O operations to the tag from this TagTechnology object.

static IsoDep get(Tag tag)

Get an instance of IsoDep for the given tag.

byte[] getHiLayerResponse()

Return the higher layer response bytes for NfcB tags.

byte[] getHistoricalBytes()

Return the ISO-DEP historical bytes for NfcA tags.

int getMaxTransceiveLength()

Return the maximum number of bytes that can be sent with transceive(byte[]).

Tag getTag()

Get the Tag object backing this TagTechnology object.

int getTimeout()

Get the current timeout for transceive(byte[]) in milliseconds.

boolean isConnected()

Helper to indicate if I/O operations should be possible.

boolean isExtendedLengthApduSupported()

Standard APDUs have a 1-byte length field, allowing a maximum of 255 payload bytes, which results in a maximum APDU length of 261 bytes.

void setTimeout(int timeout)

Set the timeout of transceive(byte[]) in milliseconds.

byte[] transceive(byte[] data)

Send raw ISO-DEP data to the tag and receive the response.

Inherited methods

Public methods

close

added in API level 10
public void close ()

Disable I/O operations to the tag from this TagTechnology object, and release resources.

Also causes all blocked I/O operations on other thread to be canceled and return with IOException.

Requires the Manifest.permission.NFC permission.

Throws
IOException

connect

added in API level 10
public void connect ()

Enable I/O operations to the tag from this TagTechnology object.

May cause RF activity and may block. Must not be called from the main application thread. A blocked call will be canceled with IOException by calling close() from another thread.

Only one TagTechnology object can be connected to a Tag at a time.

Applications must call close() when I/O operations are complete.

Requires the Manifest.permission.NFC permission.

Throws
IOException

get

added in API level 10
public static IsoDep get (Tag tag)

Get an instance of IsoDep for the given tag.

Does not cause any RF activity and does not block.

Returns null if IsoDep was not enumerated in Tag.getTechList(). This indicates the tag does not support ISO-DEP.

Parameters
tag Tag: an ISO-DEP compatible tag

Returns
IsoDep ISO-DEP object

getHiLayerResponse

added in API level 10
public byte[] getHiLayerResponse ()

Return the higher layer response bytes for NfcB tags.

Does not cause any RF activity and does not block.

The higher layer response bytes can be used to help identify a tag. They are present only on IsoDep tags that are based on NfcB RF technology. If this tag is not NfcB then null is returned.

In ISO 14443-4 terminology, the higher layer bytes are a subset of the ATTRIB response.

Returns
byte[] ISO-DEP historical bytes, or null if this is not a NfcB tag

getHistoricalBytes

added in API level 10
public byte[] getHistoricalBytes ()

Return the ISO-DEP historical bytes for NfcA tags.

Does not cause any RF activity and does not block.

The historical bytes can be used to help identify a tag. They are present only on IsoDep tags that are based on NfcA RF technology. If this tag is not NfcA then null is returned.

In ISO 14443-4 terminology, the historical bytes are a subset of the RATS response.

Returns
byte[] ISO-DEP historical bytes, or null if this is not a NfcA tag

getMaxTransceiveLength

added in API level 14
public int getMaxTransceiveLength ()

Return the maximum number of bytes that can be sent with transceive(byte[]).

Returns
int the maximum number of bytes that can be sent with transceive(byte[]).

getTag

added in API level 10
public Tag getTag ()

Get the Tag object backing this TagTechnology object.

Returns
Tag the Tag backing this TagTechnology object.

getTimeout

added in API level 14
public int getTimeout ()

Get the current timeout for transceive(byte[]) in milliseconds.

Requires the Manifest.permission.NFC permission.

Returns
int timeout value in milliseconds

isConnected

added in API level 10
public boolean isConnected ()

Helper to indicate if I/O operations should be possible.

Returns true if connect() has completed, and close() has not been called, and the Tag is not known to be out of range.

Does not cause RF activity, and does not block.

Returns
boolean true if I/O operations should be possible

isExtendedLengthApduSupported

added in API level 16
public boolean isExtendedLengthApduSupported ()

Standard APDUs have a 1-byte length field, allowing a maximum of 255 payload bytes, which results in a maximum APDU length of 261 bytes.

Extended length APDUs have a 3-byte length field, allowing 65535 payload bytes.

Some NFC adapters, like the one used in the Nexus S and the Galaxy Nexus do not support extended length APDUs. They are expected to be well-supported in the future though. Use this method to check for extended length APDU support.

Returns
boolean whether the NFC adapter on this device supports extended length APDUs.

setTimeout

added in API level 10
public void setTimeout (int timeout)

Set the timeout of transceive(byte[]) in milliseconds.

The timeout only applies to ISO-DEP transceive(byte[]), 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 Manifest.permission.NFC permission.

Parameters
timeout int: timeout value in milliseconds

transceive

added in API level 10
public byte[] transceive (byte[] data)

Send raw ISO-DEP data to the tag and receive the response.

Applications must only send the INF payload, and not the start of frame and end of frame indicators. Applications do not need to fragment the payload, it will be automatically fragmented and defragmented by transceive(byte[]) if it exceeds FSD/FSC limits.

Use getMaxTransceiveLength() to retrieve the maximum number of bytes that can be sent with transceive(byte[]).

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 Manifest.permission.NFC permission.

Parameters
data byte: command bytes to send, must not be null

Returns
byte[] response bytes received, will not be null

Throws
if the tag leaves the field
IOException if there is an I/O failure, or this operation is canceled