/*
* Copyright (C) 2012 The Android Open Source Project
*
* 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.
*/
package android.nfc.tech;
import android.nfc.Tag;
import android.os.Bundle;
import android.os.RemoteException;
Provides access to tags containing just a barcode.
Acquire an NfcBarcode object using get.
/**
* Provides access to tags containing just a barcode.
*
* <p>Acquire an {@link NfcBarcode} object using {@link #get}.
*
*/
public final class NfcBarcode extends BasicTagTechnology {
Kovio Tags /** Kovio Tags */
public static final int TYPE_KOVIO = 1;
public static final int TYPE_UNKNOWN = -1;
@hide
/** @hide */
public static final String EXTRA_BARCODE_TYPE = "barcodetype";
private int mType;
Get an instance of NfcBarcode for the given tag. Returns null if NfcBarcode was not enumerated in Tag.getTechList.
Does not cause any RF activity and does not block.
Params: - tag – an NfcBarcode compatible tag
Returns: NfcBarcode object
/**
* Get an instance of {@link NfcBarcode} for the given tag.
*
* <p>Returns null if {@link NfcBarcode} was not enumerated in {@link Tag#getTechList}.
*
* <p>Does not cause any RF activity and does not block.
*
* @param tag an NfcBarcode compatible tag
* @return NfcBarcode object
*/
public static NfcBarcode get(Tag tag) {
if (!tag.hasTech(TagTechnology.NFC_BARCODE)) return null;
try {
return new NfcBarcode(tag);
} catch (RemoteException e) {
return null;
}
}
Internal constructor, to be used by NfcAdapter
@hide
/**
* Internal constructor, to be used by NfcAdapter
* @hide
*/
public NfcBarcode(Tag tag) throws RemoteException {
super(tag, TagTechnology.NFC_BARCODE);
Bundle extras = tag.getTechExtras(TagTechnology.NFC_BARCODE);
if (extras != null) {
mType = extras.getInt(EXTRA_BARCODE_TYPE);
} else {
throw new NullPointerException("NfcBarcode tech extras are null.");
}
}
Returns the NFC Barcode tag type.
Currently only one of TYPE_KOVIO or TYPE_UNKNOWN.
Does not cause any RF activity and does not block.
Returns: the NFC Barcode tag type
/**
* Returns the NFC Barcode tag type.
*
* <p>Currently only one of {@link #TYPE_KOVIO} or {@link #TYPE_UNKNOWN}.
*
* <p>Does not cause any RF activity and does not block.
*
* @return the NFC Barcode tag type
*/
public int getType() {
return mType;
}
Returns the barcode of an NfcBarcode tag.
Tags of TYPE_KOVIO return 16 bytes:
The first byte is 0x80 ORd with a manufacturer ID, corresponding
to ISO/IEC 7816-6.
The second byte describes the payload data format. Defined data
format types include the following:
- 0x00: Reserved for manufacturer assignment
- 0x01: 96-bit URL with "http://www." prefix
- 0x02: 96-bit URL with "https://www." prefix
- 0x03: 96-bit URL with "http://" prefix
- 0x04: 96-bit URL with "https://" prefix
- 0x05: 96-bit GS1 EPC
- 0x06-0xFF: reserved
The following 12 bytes are payload:
- In case of a URL payload, the payload is encoded in US-ASCII,
following the limitations defined in RFC3987.
{@see RFC 3987}
- In case of GS1 EPC data, see
GS1 Electronic Product Code (EPC) Tag Data Standard (TDS) for more details.
The last 2 bytes comprise the CRC.
Does not cause any RF activity and does not block.
See Also: Returns: a byte array containing the barcode
/**
* Returns the barcode of an NfcBarcode tag.
*
* <p> Tags of {@link #TYPE_KOVIO} return 16 bytes:
* <ul>
* <p> The first byte is 0x80 ORd with a manufacturer ID, corresponding
* to ISO/IEC 7816-6.
* <p> The second byte describes the payload data format. Defined data
* format types include the following:<ul>
* <li>0x00: Reserved for manufacturer assignment</li>
* <li>0x01: 96-bit URL with "http://www." prefix</li>
* <li>0x02: 96-bit URL with "https://www." prefix</li>
* <li>0x03: 96-bit URL with "http://" prefix</li>
* <li>0x04: 96-bit URL with "https://" prefix</li>
* <li>0x05: 96-bit GS1 EPC</li>
* <li>0x06-0xFF: reserved</li>
* </ul>
* <p>The following 12 bytes are payload:<ul>
* <li> In case of a URL payload, the payload is encoded in US-ASCII,
* following the limitations defined in RFC3987.
* {@see <a href="http://www.ietf.org/rfc/rfc3987.txt">RFC 3987</a>}</li>
* <li> In case of GS1 EPC data, see <a href="http://www.gs1.org/gsmp/kc/epcglobal/tds/">
* GS1 Electronic Product Code (EPC) Tag Data Standard (TDS)</a> for more details.
* </li>
* </ul>
* <p>The last 2 bytes comprise the CRC.
* </ul>
* <p>Does not cause any RF activity and does not block.
*
* @return a byte array containing the barcode
* @see <a href="http://www.thinfilm.no/docs/thinfilm-nfc-barcode-datasheet.pdf">
* Thinfilm NFC Barcode tag specification (previously Kovio NFC Barcode)</a>
* @see <a href="http://www.thinfilm.no/docs/thinfilm-nfc-barcode-data-format.pdf">
* Thinfilm NFC Barcode data format (previously Kovio NFC Barcode)</a>
*/
public byte[] getBarcode() {
switch (mType) {
case TYPE_KOVIO:
// For Kovio tags the barcode matches the ID
return mTag.getId();
default:
return null;
}
}
}