操作及管理NFC Tag

聲明技術(shù)

開發(fā)Tag讀寫相關(guān)應(yīng)用時(shí)，需要在應(yīng)用的屬性配置文件中，聲明與NFC相關(guān)的屬性值，比如，在module.json5文件中，聲明下面屬性值：

{
    "module": {
        // other declared attributes.

        "abilities": [
            {
                "skills": [
                    {
                        "actions": [
                            // other declared actions,

                            // add the nfc tag action
                            "ohos.nfc.tag.action.TAG_FOUND"
                        ]
                    }
                ],
                "metadata": [
                    {
                        "name": "tag-tech",
                        "value": "NfcA"
                    },
                    {
                        "name": "tag-tech",
                        "value": "IsoDep"
                    },
                    // add other technology if neccessary,
                    // such as: NfcB/NfcF/NfcV/Ndef/MifareClassic/MifareUL/NdefFormatable
                ]
            }
        ],
        "requestPermissions": [
            "name": "ohos.permission.NFC_TAG",
            "reason": "tag",
        ]
    }
}

導(dǎo)入模塊

import tag from '@ohos.nfc.tag';

tag.TagInfo

在對相關(guān)Tag類型卡片進(jìn)行讀寫之前，必須先獲取TagInfo相關(guān)屬性值，以確認(rèn)設(shè)備讀取到的Tag卡片支持哪些技術(shù)類型。這樣Tag應(yīng)用程序才能調(diào)用正確的接口和所讀取到的Tag卡片進(jìn)行通信。

import tag from '@ohos.nfc.tag';

onCreate(want, launchParam) {
    // add other code here...

    // want is initialized by nfc service, contains tag info for this found tag
    var tagInfo;
    try {
        tagInfo = tag.getTagInfo(want);
    } catch (error) {
        console.log("tag.getTagInfo catched error: " + error);
    }
    if (tagInfo == null || tagInfo == undefined) {
        console.log("no TagInfo to be created, ignore it.");
        return;
    }

    // get the supported technologies for this found tag.
    var isNfcATag =  false;
    var isIsoDepTag =  false;
    for (var i = 0; i < tagInfo.technology.length; i++) {
        if (tagInfo.technology[i] == tag.NFC_A) {
            isNfcATag = true;
        }

        if (tagInfo.technology[i] == tag.ISO_DEP) {
            isIsoDepTag = true;
        }
        // also check for technology: tag.NFC_B/NFC_F/NFC_V/NDEF/MIFARE_CLASSIC/MIFARE_ULTRALIGHT/NDEF_FORMATABLE
    }

    // use NfcA APIs to access the found tag.
    if (isNfcATag) {
        var nfcA;
        try {
            nfcA = tag.getNfcATag(taginfo);
        } catch (error) {
            console.log("tag.getNfcATag catched error: " + error);
        }
        // other code to read or write this found tag.
    }

    // use getIsoDep APIs to access the found tag.
    if (isIsoDepTag) {
        var isoDep;
        try {
            isoDep = tag.getIsoDep(taginfo);
        } catch (error) {
            console.log("tag.getIsoDep catched error: " + error);
        }
        // other code to read or write this found tag.
    }

    // use the same code to handle for "NfcA/NfcB/NfcF/NfcV/Ndef/MifareClassic/MifareUL/NdefFormatable".
}

tag.getNfcATag

getNfcATag(tagInfo: TagInfo): NfcATag

獲取NFC A類型Tag對象，通過該對象可訪問NfcA技術(shù)類型的Tag。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

tag.getNfcA9+

getNfcA(tagInfo: TagInfo): NfcATag

獲取NFC A類型Tag對象，通過該對象可訪問NfcA技術(shù)類型的Tag。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請參見NFC錯(cuò)誤碼。

tag.getNfcBTag

getNfcBTag(tagInfo: TagInfo): NfcBTag

獲取NFC B類型Tag對象，通過該對象可訪問NfcB技術(shù)類型的Tag。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

tag.getNfcB9+

getNfcB(tagInfo: TagInfo): NfcBTag

獲取NFC B類型Tag對象，通過該對象可訪問NfcB技術(shù)類型的Tag。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請參見NFC錯(cuò)誤碼。

tag.getNfcFTag

getNfcFTag(tagInfo: TagInfo): NfcFTag

獲取NFC F類型Tag對象，通過該對象可訪問NfcF技術(shù)類型的Tag。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

tag.getNfcF9+

getNfcF(tagInfo: TagInfo): NfcFTag

獲取NFC F類型Tag對象，通過該對象可訪問NfcF技術(shù)類型的Tag。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請參見NFC錯(cuò)誤碼。

tag.getNfcVTag

getNfcVTag(tagInfo: TagInfo): NfcVTag

獲取NFC V類型Tag對象，通過該對象可訪問NfcV技術(shù)類型的Tag。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

tag.getNfcV9+

getNfcV(tagInfo: TagInfo): NfcVTag

獲取NFC V類型Tag對象，通過該對象可訪問NfcV技術(shù)類型的Tag。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請參見NFC錯(cuò)誤碼。

tag.getIsoDep9+

getIsoDep(tagInfo: TagInfo): IsoDepTag

獲取IsoDep類型Tag對象，通過該對象可訪問支持IsoDep技術(shù)類型的Tag。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請參見NFC錯(cuò)誤碼。

tag.getNdef9+

getNdef(tagInfo: TagInfo): NdefTag

獲取NDEF類型Tag對象，通過該對象可訪問支持NDEF技術(shù)類型的Tag。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請參見NFC錯(cuò)誤碼。

tag.getMifareClassic9+

getMifareClassic(tagInfo: TagInfo): MifareClassicTag

獲取MIFARE Classic類型Tag對象，通過該對象訪問支持MIFARE Classic技術(shù)類型的Tag。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請參見NFC錯(cuò)誤碼。

tag.getMifareUltralight9+

getMifareUltralight(tagInfo: TagInfo): MifareUltralightTag

獲取MIFARE Ultralight類型Tag對象，通過該對象可訪問支持MIFARE Ultralight技術(shù)類型的Tag。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請參見NFC錯(cuò)誤碼。

tag.getNdefFormatable9+

getNdefFormatable(tagInfo: TagInfo): NdefFormatableTag

獲取NDEF Formatable類型Tag對象，通過該對象可訪問支持NDEF Formatable技術(shù)類型的Tag。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請參見NFC錯(cuò)誤碼。

tag.getTagInfo9+

getTagInfo(want: Want): TagInfo

從Want中獲取TagInfo，Want是被NFC服務(wù)初始化，包含了TagInfo所需的屬性值。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

tag.ndef.makeUriRecord9+

makeUriRecord(uri: string): NdefRecord;

根據(jù)輸入的URI，構(gòu)建NDEF標(biāo)簽的Record數(shù)據(jù)對象。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

示例：

import tag from '@ohos.nfc.tag';

try {
    let uri = "https://gitee.com/openharmony"; // change it to be correct.
    let ndefRecord = tag.ndef.makeUriRecord(uri);
    if (ndefRecord != undefined) {
        console.log("ndefMessage makeUriRecord rtdType: " + ndefRecord.rtdType);
        console.log("ndefMessage makeUriRecord payload: " + ndefRecord.payload);
    } else {
        console.log("ndefMessage makeUriRecord ndefRecord: " + ndefRecord);
    }
} catch (busiError) {
    console.log("ndefMessage makeUriRecord catched busiError: " + busiError);
}

tag.ndef.makeTextRecord9+

makeTextRecord(text: string, locale: string): NdefRecord;

根據(jù)輸入的文本數(shù)據(jù)和編碼類型，構(gòu)建NDEF標(biāo)簽的Record。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

示例：

import tag from '@ohos.nfc.tag';

try {
    let text = "Hello World";   // change it to be correct.
    let locale = "en"; // change it to be correct.
    let ndefRecord = tag.ndef.makeTextRecord(text, locale);
    if (ndefRecord != undefined) {
        console.log("ndefMessage makeTextRecord rtdType: " + ndefRecord.rtdType);
        console.log("ndefMessage makeTextRecord payload: " + ndefRecord.payload);
    } else {
        console.log("ndefMessage makeTextRecord ndefRecord: " + ndefRecord);
    }
} catch (busiError) {
    console.log("ndefMessage makeTextRecord catched busiError: " + busiError);
}

tag.ndef.makeMimeRecord9+

makeMimeRecord(mimeType: string, mimeData: number[]): NdefRecord;

根據(jù)輸入的MIME數(shù)據(jù)和類型，構(gòu)建NDEF標(biāo)簽的Record。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

示例：

import tag from '@ohos.nfc.tag';

try {
    let mimeType = "text/plain";   // change it to be correct.
    let mimeData = [0x01, 0x02, 0x03, 0x04]; // change it to be correct.
    let ndefRecord = tag.ndef.makeMimeRecord(mimeType, mimeData);
    if (ndefRecord != undefined) {
        console.log("ndefMessage makeMimeRecord rtdType: " + ndefRecord.rtdType);
        console.log("ndefMessage makeMimeRecord payload: " + ndefRecord.payload);
    } else {
        console.log("ndefMessage makeMimeRecord ndefRecord: " + ndefRecord);
    }
} catch (busiError) {
    console.log("ndefMessage makeMimeRecord catched busiError: " + busiError);
}

tag.ndef.makeExternalRecord9+

makeExternalRecord(domainName: string, type: string, externalData: number[]): NdefRecord;

根據(jù)應(yīng)用程序特定的外部數(shù)據(jù)，構(gòu)建NDEF標(biāo)簽的Record。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

示例：

import tag from '@ohos.nfc.tag';

try {
    let domainName = "ohos.nfc.application"; // change it to be correct.
    let type = "test"; // change it to be correct.
    let externalData = [0x01, 0x02, 0x03, 0x04]; // change it to be correct.
    let ndefRecord = tag.ndef.makeExternalRecord(domainName, type, externalData);
    if (ndefRecord != undefined) {
        console.log("ndefMessage makeExternalRecord rtdType: " + ndefRecord.rtdType);
        console.log("ndefMessage makeExternalRecord payload: " + ndefRecord.payload);
    } else {
        console.log("ndefMessage makeExternalRecord ndefRecord: " + ndefRecord);
    }
} catch (busiError) {
    console.log("ndefMessage makeExternalRecord catched busiError: " + busiError);
}

tag.ndef.messageToBytes9+

messageToBytes(ndefMessage: NdefMessage): number[];

把輸入的NDEF消息數(shù)據(jù)對象，轉(zhuǎn)換為字節(jié)格式的數(shù)據(jù)。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

示例：

import tag from '@ohos.nfc.tag';

let rawData = [0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43]; // MUST can be parsed as NDEF Record.
let ndefMessage;
try {
    ndefMessage = tag.ndef.createNdefMessage(rawData);
    console.log("ndef createNdefMessage, ndefMessage: " + ndefMessage);
} catch (busiError) {
    console.log("ndef createNdefMessage busiError: " + busiError);
}

try {
    let rawData2 = tag.ndef.messageToBytes(ndefMessage);
    console.log("ndefMessage messageToBytes rawData2: " + rawData2);
} catch (busiError) {
    console.log("ndefMessage messageToBytes catched busiError: " + busiError);
}

tag.ndef.createNdefMessage9+

createNdefMessage(data: number[]): NdefMessage

使用原始字節(jié)數(shù)據(jù)創(chuàng)建NDEF標(biāo)簽的Message。該數(shù)據(jù)必須符合NDEF Record數(shù)據(jù)格式，如果不符合格式，則返回的NdeMessage數(shù)據(jù)對象，所包含的NDE Record列表會為空。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

示例：

import tag from '@ohos.nfc.tag';

let rawData = [0xD1, 0x01, 0x03, 0x54, 0x4E, 0x46, 0x43];  // MUST can be parsed as NDEF Record.
let ndefMessage;
try {
    ndefMessage = tag.ndef.createNdefMessage(rawData);
    console.log("ndef createNdefMessage, ndefMessage: " + ndefMessage);
} catch (busiError) {
    console.log("ndef createNdefMessage busiError: " + busiError);
}

tag.ndef.createNdefMessage9+

createNdefMessage(ndefRecords: NdefRecord[]): NdefMessage

使用NDEF Records列表，創(chuàng)建NDEF Message。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

參數(shù)：

返回值：

示例：

import tag from '@ohos.nfc.tag';

let uriRecord = tag.ndef.makeUriRecord("https://gitee.com/openharmony");
let textRecord = tag.ndef.makeTextRecord("Hello World", "en");
let ndefRecords = [uriRecord, textRecord];
let ndefMessage;
try {
    ndefMessage = tag.ndef.createNdefMessage(ndefRecords);
    console.log("ndef createNdefMessage ndefMessage: " + ndefMessage);
} catch (busiError) {
    console.log("ndef createNdefMessage busiError: " + busiError);
}

TagInfo

NFC服務(wù)在讀取到標(biāo)簽時(shí)給出的對象，通過改對象屬性，應(yīng)用知道該標(biāo)簽支持哪些技術(shù)類型，并使用匹配的技術(shù)類型來調(diào)用相關(guān)接口。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

需要權(quán)限： ohos.permission.NFC_TAG

NdefRecord9+

NDEF標(biāo)簽Record屬性的定義，參考NDEF標(biāo)簽技術(shù)規(guī)范《NFCForum-TS-NDEF_1.0》的定義細(xì)節(jié)。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

技術(shù)類型定義

NFC Tag有多種不同的技術(shù)類型，定義常量描述不同的技術(shù)類型。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

TnfType9+

NDEF Record的TNF(Type Name Field)類型值，參考NDEF標(biāo)簽技術(shù)規(guī)范《NFCForum-TS-NDEF_1.0》的定義細(xì)節(jié)。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

NDEF Record RTD類型定義

NDEF Record的RTD(Record Type Definition)類型值，參考NDEF標(biāo)簽技術(shù)規(guī)范《NFCForum-TS-NDEF_1.0》的定義細(xì)節(jié)。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

NfcForumType9+

NFC Forum標(biāo)準(zhǔn)里面Tag類型的定義。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

MifareClassicType9+

MIFARE Classic標(biāo)簽類型的定義。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

MifareClassicSize9+

MIFARE Classic標(biāo)簽存儲大小的定義。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag

MifareUltralightType9+

MIFARE Ultralight標(biāo)簽類型的定義。

系統(tǒng)能力： SystemCapability.Communication.NFC.Tag