前言

概述

BS2XV100通过API（Application Programming Interface）向开发者提供NFC TAG的相关接口，包括初始化、参数设置、NDEF消息组装、NDEF消息配置、侦听模式开启、关闭等接口

产品版本

与本文档对应的产品版本如下。

产品名称	产品版本
BS2X	V100

读者对象

本文档主要适用以下工程师：

• 技术支持工程

• 软件开发工程师

符号约定

在本文中可能出现下列标志，它们所代表的含义如下。

符号	说明
	表示如不避免则将会导致死亡或严重伤害的具有高等级风险的危害。
	表示如不避免则可能导致死亡或严重伤害的具有中等级风险的危害。
	表示如不避免则可能导致轻微或中度伤害的具有低等级风险的危害。
	用于传递设备或环境安全警示信息。如不避免则可能会导致设备损坏、数据丢失、设备性能降低或其它不可预知的结果。 “须知”不涉及人身伤害。
	对正文中重点信息的补充说明。 “说明”不是安全警示信息，不涉及人身、设备及环境伤害信息。

修改记录

文档版本	发布日期	修改说明
02	2025-11-07	更新“接口说明”章节内容。
01	2024-05-15	第一次正式版本发布。
00B01	2024-01-08	第一次临时版本发布

概述

BS2XV100通过API（Application Programming Interface）向开发者提供NFC TAG的相关接口，其接口功能说明如下：

TAG芯片接口：提供TAG芯片的参数配置、行为控制等功能。

说明： 该文档描述各个模块功能的基本流程和API接口描述。

开发指导

错误码

NFC TAG使错误码指示用户当前任务执行结果，错误码说明如下：

表 1 错误码

序号	定义	实际数值	描述
1	NFC_OK	0	执行成功错误码。
2	NFC_ERR_PTR_NULL	0x80005F00	输入参数中有空指针。
3	NFC_ERR_INVALID_LENGTH	0x80005F01	输入参数长度非法。
5	NFC_ERR_INVALID_PARAM	0x80005F02	输入参数中有非法参数。
6	NFC_ERR_INVALID_STATE	0x80005F03	TAG状态异常。
7	NFC_ERR_MEMCPY_FAIL	0x80005F04	内存拷贝异常。

接口说明

表 1 TAG芯片接口描述

接口名称	描述	参数说明	返回信息说明
NFC_T2T_Init	初始化T2T模块	handle：注册的回调函数	void
NFC_T2T_SetConfig	配置T2T参数	id：参数ID data：参数数据 len：参数长度	接口返回值：错误码。
NFC_T2T_StartEmulation	开启RF侦听	void	接口返回值：错误码。
NFC_T2T_StopEmulation	停止RF侦听	void	接口返回值：错误码。
NFC_T2T_SetNdef	设置NDEF消息	data：ndef数据 len：ndef长度，最大长度988字节	接口返回值：错误码。
NFC_T2T_SetTagArea	将NDEF消息的存储位置放到用户自定义的空间	buff：用户空间指针 len：用户空间长度	接口返回值：错误码。

开发流程

1. 调用NFC_T2T_Init初始化一个T2T环境。

2. 使用NFC_T2T_SetConfig配置感兴趣的参数，可选。

3. 组装NDEF消息，之后使用NFC_T2T_SetNdef接口配置到Tag模块。

4. 开启侦听NFC_T2T_StartEmulation。