Tizen Native API
5.0
|
TAG API provide functions for read/write operation on NDEF and also provide low level API of Mifare.
Required Header
#include <nfc.h>
Overview
The TAG api provides functions to read or write NDEF and low level transaction APIs with Non NDEF tag.
- read NDEF from NDEF compatible TAG
- write NDEF to NDEF compatible TAG
- check whether tag has NDEF or not
- format NFC forum tag to be compatible with NDEF
- read specific attributes from tag by ISO14443
- low level api of MIFARE classic and MIFARE ultra light
Related Features
This API is related with the following features:
It is recommended to design feature related codes in your application for reliability.
You can check if a device supports the related features for this API by using System Information, thereby controlling the procedure of your application.
To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.
More details on featuring your application can be found from Feature Element.
Functions | |
int | nfc_tag_get_type (nfc_tag_h tag, nfc_tag_type_e *type) |
Gets the type of NFC tag. | |
int | nfc_tag_is_support_ndef (nfc_tag_h tag, bool *is_supported) |
Checks whether the given NFC tag supports NDEF messages. | |
int | nfc_tag_get_maximum_ndef_size (nfc_tag_h tag, unsigned int *maximum_ndef_bytes_size) |
Gets the maximum NDEF message size that can be stored in NFC tag. | |
int | nfc_tag_get_ndef_size (nfc_tag_h tag, unsigned int *ndef_bytes_size) |
Gets size of NDEF message that stored in the tag. | |
int | nfc_tag_foreach_information (nfc_tag_h tag, nfc_tag_information_cb callback, void *user_data) |
Retrieves all tag information. | |
int | nfc_tag_transceive (nfc_tag_h tag, unsigned char *buffer, int buffer_size, nfc_tag_transceive_completed_cb callback, void *user_data) |
Transceives the data of the raw format card. | |
int | nfc_tag_read_ndef (nfc_tag_h tag, nfc_tag_read_completed_cb callback, void *user_data) |
Reads NDEF formatted data from NFC tag. | |
int | nfc_tag_write_ndef (nfc_tag_h tag, nfc_ndef_message_h msg, nfc_tag_write_completed_cb callback, void *user_data) |
Writes NDEF formatted data. | |
int | nfc_tag_format_ndef (nfc_tag_h tag, unsigned char *key, int key_size, nfc_tag_format_completed_cb callback, void *user_data) |
Formats the detected tag that can store NDEF message. | |
Typedefs | |
typedef struct _net_nfc_target_info_s * | nfc_tag_h |
The handle to the NFC tag. | |
typedef bool(* | nfc_tag_information_cb )(const char *key, const unsigned char *value, int value_size, void *user_data) |
Called once for each tag information. | |
typedef void(* | nfc_tag_transceive_completed_cb )(nfc_error_e result, unsigned char *buffer, int buffer_size, void *user_data) |
Called after nfc_tag_transceive() has completed. | |
typedef void(* | nfc_tag_write_completed_cb )(nfc_error_e result, void *user_data) |
Called after the nfc_tag_write_ndef() has completed. | |
typedef void(* | nfc_tag_read_completed_cb )(nfc_error_e result, nfc_ndef_message_h message, void *user_data) |
Called after the nfc_tag_read_ndef() has completed. | |
typedef void(* | nfc_tag_format_completed_cb )(nfc_error_e result, void *user_data) |
Called after the nfc_tag_format_ndef() has completed. |
Typedef Documentation
typedef void(* nfc_tag_format_completed_cb)(nfc_error_e result, void *user_data) |
Called after the nfc_tag_format_ndef() has completed.
- Since :
- 2.3.1
- Parameters:
-
[in] result The result of function call [in] user_data The user data passed from nfc_tag_format_ndef()
- See also:
- nfc_tag_format_ndef()
typedef struct _net_nfc_target_info_s* nfc_tag_h |
The handle to the NFC tag.
- Since :
- 2.3.1
typedef bool(* nfc_tag_information_cb)(const char *key, const unsigned char *value, int value_size, void *user_data) |
Called once for each tag information.
- Since :
- 2.3.1
- Remarks:
- key and value will be automatically destroyed when the callback function returns. (Do not release key and value.)
- Parameters:
-
[in] key The key of information [in] value The value of information [in] value_size The data size in bytes [in] user_data The user data passed from the foreach function
- Returns:
true
to continue with the next iteration of the loop,
false
to break out of the loop.
- Precondition:
- nfc_tag_foreach_information() invokes this callback.
- See also:
- nfc_tag_foreach_information()
typedef void(* nfc_tag_read_completed_cb)(nfc_error_e result, nfc_ndef_message_h message, void *user_data) |
Called after the nfc_tag_read_ndef() has completed.
- Since :
- 2.3.1
- Remarks:
- message will be automatically destroyed when the callback function returns. (Do not release message.)
- Parameters:
-
[in] result The result of function call [in] message The NDEF message [in] user_data The user data passed from nfc_tag_read_ndef()
- See also:
- nfc_tag_read_ndef()
typedef void(* nfc_tag_transceive_completed_cb)(nfc_error_e result, unsigned char *buffer, int buffer_size, void *user_data) |
Called after nfc_tag_transceive() has completed.
- Since :
- 2.3.1
- Remarks:
- buffer will be automatically destroyed when the callback function returns. (Do not release buffer.)
- Parameters:
-
[in] result The result of function call [in] buffer The result data [in] buffer_size The size of buffer in bytes [in] user_data The user data passed from nfc_tag_transceive()
- See also:
- nfc_tag_transceive()
typedef void(* nfc_tag_write_completed_cb)(nfc_error_e result, void *user_data) |
Called after the nfc_tag_write_ndef() has completed.
- Since :
- 2.3.1
- Parameters:
-
[in] result The result of function call [in] user_data The user data passed from nfc_manager_initialize()
- See also:
- nfc_tag_write_ndef()
Enumeration Type Documentation
enum nfc_tag_type_e |
Enumerations for NFC tag types.
- Since :
- 2.3.1
- Enumerator:
Function Documentation
int nfc_tag_foreach_information | ( | nfc_tag_h | tag, |
nfc_tag_information_cb | callback, | ||
void * | user_data | ||
) |
Retrieves all tag information.
- Since :
- 2.3.1
- Parameters:
-
[in] tag The handle to NFC tag [in] callback The callback function to invoke [in] user_data The user data to be passed to the callback function
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
NFC_ERROR_NONE Successful NFC_ERROR_NOT_SUPPORTED Not supported NFC NFC_ERROR_NOT_INITIALIZED Not initialized NFC NFC_ERROR_INVALID_PARAMETER Invalid parameter NFC_ERROR_OUT_OF_MEMORY Out of memory
- See also:
- nfc_manager_initialize()
int nfc_tag_format_ndef | ( | nfc_tag_h | tag, |
unsigned char * | key, | ||
int | key_size, | ||
nfc_tag_format_completed_cb | callback, | ||
void * | user_data | ||
) |
Formats the detected tag that can store NDEF message.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/nfc
Some tags are required authentication. If the detected target doesn't need authentication, key can be NULL.
- Parameters:
-
[in] tag The handle to NFC tag [in] key The key value that may need to format the tag [in] key_size The size of key in byte [in] callback The callback function to invoke after this function has completed
It can be null if notification is not required[in] user_data The user data to be passed to the callback function
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
NFC_ERROR_NONE Successful NFC_ERROR_NOT_SUPPORTED Not supported NFC NFC_ERROR_NOT_INITIALIZED Not initialized NFC NFC_ERROR_OUT_OF_MEMORY Out of memory NFC_ERROR_INVALID_PARAMETER Invalid parameter NFC_ERROR_DEVICE_BUSY Device is too busy to handle your request NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag NFC_ERROR_NOT_ACTIVATED NFC is not activated NFC_ERROR_NOT_NDEF_FORMAT Not ndef format tag NFC_ERROR_OPERATION_FAILED Operation failed
- Postcondition:
- It invokes nfc_tag_format_completed_cb() when it has completed to format the NFC tag.
The Callback can receive error code when process is done.
int nfc_tag_get_maximum_ndef_size | ( | nfc_tag_h | tag, |
unsigned int * | maximum_ndef_bytes_size | ||
) |
Gets the maximum NDEF message size that can be stored in NFC tag.
- Since :
- 2.3.1
- Remarks:
- This max size indicates the maximum size of NDEF message that can be stored in this detected tag.
- Parameters:
-
[in] tag The handle to NFC tag [out] maximum_ndef_bytes_size The maximum bytes size of NDEF message that can be stored in this detected tag.
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
NFC_ERROR_NONE Successful NFC_ERROR_NOT_SUPPORTED Not supported NFC NFC_ERROR_NOT_INITIALIZED Not initialized NFC NFC_ERROR_INVALID_PARAMETER Invalid parameter
- See also:
- nfc_manager_initialize()
int nfc_tag_get_ndef_size | ( | nfc_tag_h | tag, |
unsigned int * | ndef_bytes_size | ||
) |
Gets size of NDEF message that stored in the tag.
- Since :
- 2.3.1
- Parameters:
-
[in] tag The handle to NFC tag [out] ndef_bytes_size The NDEF message bytes size that stored in the tag
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
NFC_ERROR_NONE Successful NFC_ERROR_NOT_SUPPORTED Not supported NFC NFC_ERROR_NOT_INITIALIZED Not initialized NFC NFC_ERROR_INVALID_PARAMETER Invalid parameter
- See also:
- nfc_manager_initialize()
int nfc_tag_get_type | ( | nfc_tag_h | tag, |
nfc_tag_type_e * | type | ||
) |
Gets the type of NFC tag.
- Since :
- 2.3.1
- Parameters:
-
[in] tag The handle to NFC tag [out] type The type of NFC tag
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
NFC_ERROR_NONE Successful NFC_ERROR_NOT_SUPPORTED Not supported NFC NFC_ERROR_NOT_INITIALIZED Not initialized NFC NFC_ERROR_INVALID_PARAMETER Invalid parameter NFC_ERROR_OPERATION_FAILED Operation failed
- See also:
- nfc_manager_initialize()
int nfc_tag_is_support_ndef | ( | nfc_tag_h | tag, |
bool * | is_supported | ||
) |
Checks whether the given NFC tag supports NDEF messages.
- Since :
- 2.3.1
- Parameters:
-
[in] tag The handle to NFC tag [out] is_supported true
when NFC tag supports NDEF messages, otherwisefalse
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
NFC_ERROR_NONE Successful NFC_ERROR_NOT_SUPPORTED Not supported NFC NFC_ERROR_NOT_INITIALIZED Not initialized NFC NFC_ERROR_INVALID_PARAMETER Invalid parameter
int nfc_tag_read_ndef | ( | nfc_tag_h | tag, |
nfc_tag_read_completed_cb | callback, | ||
void * | user_data | ||
) |
Reads NDEF formatted data from NFC tag.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/nfc
- Parameters:
-
[in] tag The handle to NFC tag [in] callback The callback function to invoke after this function has completed
It can be null if notification is not required[in] user_data The user data to be passed to the callback function
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
NFC_ERROR_NONE Successful NFC_ERROR_NOT_SUPPORTED Not supported NFC NFC_ERROR_NOT_INITIALIZED Not initialized NFC NFC_ERROR_OUT_OF_MEMORY Out of memory NFC_ERROR_INVALID_PARAMETER Invalid parameter NFC_ERROR_DEVICE_BUSY Device is too busy to handle your request NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag NFC_ERROR_NOT_ACTIVATED NFC is not activated NFC_ERROR_NOT_NDEF_FORMAT Not ndef format tag NFC_ERROR_OPERATION_FAILED Operation failed
- Postcondition:
- It invokes nfc_tag_read_completed_cb() when it has completed to read NDEF formatted data.
The Callback can receive error code when process is done.
int nfc_tag_transceive | ( | nfc_tag_h | tag, |
unsigned char * | buffer, | ||
int | buffer_size, | ||
nfc_tag_transceive_completed_cb | callback, | ||
void * | user_data | ||
) |
Transceives the data of the raw format card.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/nfc
This function is the only way to access the raw format card (not formated), each tag type requires own command to access tags.
This function provides the low level access of tag operation and you require the knowledge of each tag technology.
- Parameters:
-
[in] tag The handle to NFC tag [in] buffer The binary data for parameter or additional commands [in] buffer_size The size of buffer in bytes [in] callback The callback function to invoke after this function has completed
It can be null if a notification is not required[in] user_data The user data to be passed to the callback function
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
NFC_ERROR_NONE Successful NFC_ERROR_NOT_SUPPORTED Not supported NFC NFC_ERROR_NOT_INITIALIZED Not initialized NFC NFC_ERROR_OUT_OF_MEMORY Out of memory NFC_ERROR_INVALID_PARAMETER Invalid parameter NFC_ERROR_DEVICE_BUSY Device is too busy to handle your request NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag NFC_ERROR_NOT_ACTIVATED NFC is not activated NFC_ERROR_OPERATION_FAILED Operation failed
- Postcondition:
- It invokes nfc_tag_transceive_completed_cb() when it has completed to transceive data.
The Callback can receive error code when process is done.
int nfc_tag_write_ndef | ( | nfc_tag_h | tag, |
nfc_ndef_message_h | msg, | ||
nfc_tag_write_completed_cb | callback, | ||
void * | user_data | ||
) |
Writes NDEF formatted data.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/nfc
- Parameters:
-
[in] tag The handle to NFC tag [in] msg The message will be write to the tag [in] callback The callback function to invoke after this function has completed
It can be null if notification is not required[in] user_data The user data to be passed to the callback function
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
NFC_ERROR_NONE Successful NFC_ERROR_NOT_SUPPORTED Not supported NFC NFC_ERROR_NOT_INITIALIZED Not initialized NFC NFC_ERROR_OUT_OF_MEMORY Out of memory NFC_ERROR_INVALID_PARAMETER Invalid parameter NFC_ERROR_DEVICE_BUSY Device is too busy to handle your request NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag NFC_ERROR_NOT_ACTIVATED NFC is not activated NFC_ERROR_NOT_NDEF_FORMAT Not ndef format tag NFC_ERROR_OPERATION_FAILED Operation failed
- Postcondition:
- It invokes nfc_tag_write_completed_cb() when it has completed to write NDEF data.
The Callback can receive error code when process is done.