Fork of the GitHub version
X_NUCLEO_NFC04A1_NFCTAG_Public_Functions
[X_NUCLEO_NFC04A1_NFCTAG]
Functions | |
| NFCTAG_StatusTypeDef | BSP_NFCTAG_Init (I2C *mi2cChannel, DigitalOut *mLPD) |
| Initializes peripherals used by the I2C NFCTAG driver. | |
| void | BSP_NFCTAG_DeInit (void) |
| Deinitializes peripherals used by the I2C NFCTAG driver. | |
| uint8_t | BSP_NFCTAG_isInitialized (void) |
| Check if the nfctag is initialized. | |
| NFCTAG_StatusTypeDef | BSP_NFCTAG_ReadID (uint8_t *const wai_id, I2C *mi2cChannel) |
| Read the ID of the nfctag. | |
| uint32_t | BSP_NFCTAG_GetByteSize (I2C *mi2cChannel) |
| Return the size of the nfctag. | |
| NFCTAG_StatusTypeDef | BSP_NFCTAG_IsDeviceReady (const uint32_t Trials, I2C *mi2cChannel, const uint16_t TarAddr) |
| Check if the nfctag is available. | |
| NFCTAG_StatusTypeDef | BSP_NFCTAG_ConfigIT (const uint16_t ITConfig, I2C *mi2cChannel) |
| Configure nfctag interrupt. | |
| NFCTAG_StatusTypeDef | BSP_NFCTAG_GetITStatus (uint16_t *const ITConfig, I2C *mi2cChannel) |
| Get nfctag interrupt configutration. | |
| NFCTAG_StatusTypeDef | BSP_NFCTAG_ReadData (uint8_t *const pData, const uint16_t TarAddr, const uint16_t Size, I2C *mi2cChannel) |
| Reads data in the nfctag at specific address. | |
| NFCTAG_StatusTypeDef | BSP_NFCTAG_WriteData (const uint8_t *const pData, const uint16_t TarAddr, const uint16_t Size, I2C *mi2cChannel) |
| Writes data in the nfctag at specific address. | |
| NFCTAG_StatusTypeDef | BSP_NFCTAG_ReadRegister (uint8_t *const pData, const uint16_t TarAddr, const uint16_t Size, I2C *mi2cChannel) |
| Reads nfctag Register. | |
| NFCTAG_StatusTypeDef | BSP_NFCTAG_WriteRegister (const uint8_t *const pData, const uint16_t TarAddr, const uint16_t Size, I2C *mi2cChannel) |
| Writes nfctag Register. | |
| NFCTAG_ExtDrvTypeDef * | BSP_NFCTAG_GetExtended_Drv (void) |
| Give extended features for component. | |
Function Documentation
| NFCTAG_StatusTypeDef BSP_NFCTAG_ConfigIT | ( | const uint16_t | ITConfig, |
| I2C * | mi2cChannel | ||
| ) |
Configure nfctag interrupt.
- Parameters:
-
ITConfig : store interrupt to configure - 0x01 => RF BUSY
- 0x02 => WIP
- Return values:
-
NFCTAG enum status
Definition at line 185 of file x_nucleo_nfc04a1_nfctag.cpp.
| void BSP_NFCTAG_DeInit | ( | void | ) |
Deinitializes peripherals used by the I2C NFCTAG driver.
- Parameters:
-
None
- Return values:
-
None
Definition at line 117 of file x_nucleo_nfc04a1_nfctag.cpp.
| uint32_t BSP_NFCTAG_GetByteSize | ( | I2C * | mi2cChannel ) |
Return the size of the nfctag.
- Parameters:
-
mi2cChannel : I2C channel
- Return values:
-
Size of the NFCtag in Bytes
Definition at line 155 of file x_nucleo_nfc04a1_nfctag.cpp.
| NFCTAG_ExtDrvTypeDef* BSP_NFCTAG_GetExtended_Drv | ( | void | ) |
Give extended features for component.
- Parameters:
-
None
- Return values:
-
address of the Extended Component Structure
Definition at line 295 of file x_nucleo_nfc04a1_nfctag.cpp.
| NFCTAG_StatusTypeDef BSP_NFCTAG_GetITStatus | ( | uint16_t *const | ITConfig, |
| I2C * | mi2cChannel | ||
| ) |
Get nfctag interrupt configutration.
- Parameters:
-
ITConfig : store interrupt configuration - 0x01 => RF BUSY
- 0x02 => WIP
- Return values:
-
NFCTAG enum status
Definition at line 201 of file x_nucleo_nfc04a1_nfctag.cpp.
| NFCTAG_StatusTypeDef BSP_NFCTAG_Init | ( | I2C * | mi2cChannel, |
| DigitalOut * | mLPD | ||
| ) |
Initializes peripherals used by the I2C NFCTAG driver.
- Parameters:
-
None
- Return values:
-
NFCTAG enum status
Definition at line 79 of file x_nucleo_nfc04a1_nfctag.cpp.
| NFCTAG_StatusTypeDef BSP_NFCTAG_IsDeviceReady | ( | const uint32_t | Trials, |
| I2C * | mi2cChannel, | ||
| const uint16_t | TarAddr | ||
| ) |
Check if the nfctag is available.
- Parameters:
-
Trials : Number of trials mi2cChannel : I2C channel
- Return values:
-
NFCTAG enum status
Definition at line 168 of file x_nucleo_nfc04a1_nfctag.cpp.
| uint8_t BSP_NFCTAG_isInitialized | ( | void | ) |
Check if the nfctag is initialized.
- Parameters:
-
None
- Return values:
-
0 if the nfctag is not initialized, 1 if the nfctag is already initialized
Definition at line 129 of file x_nucleo_nfc04a1_nfctag.cpp.
| NFCTAG_StatusTypeDef BSP_NFCTAG_ReadData | ( | uint8_t *const | pData, |
| const uint16_t | TarAddr, | ||
| const uint16_t | Size, | ||
| I2C * | mi2cChannel | ||
| ) |
Reads data in the nfctag at specific address.
- Parameters:
-
pData : pointer to store read data TarAddr : I2C data memory address to read Size : Size in bytes of the value to be read mi2cChannel : I2C channel
- Return values:
-
NFCTAG enum status
Definition at line 219 of file x_nucleo_nfc04a1_nfctag.cpp.
| NFCTAG_StatusTypeDef BSP_NFCTAG_ReadID | ( | uint8_t *const | wai_id, |
| I2C * | mi2cChannel | ||
| ) |
Read the ID of the nfctag.
- Parameters:
-
wai_id : the pointer where the who_am_i of the device is stored mi2cChannel : I2C channel
- Return values:
-
NFCTAG enum status
Definition at line 140 of file x_nucleo_nfc04a1_nfctag.cpp.
| NFCTAG_StatusTypeDef BSP_NFCTAG_ReadRegister | ( | uint8_t *const | pData, |
| const uint16_t | TarAddr, | ||
| const uint16_t | Size, | ||
| I2C * | mi2cChannel | ||
| ) |
Reads nfctag Register.
- Parameters:
-
pData : pointer to store read data TarAddr : I2C register address to read Size : Size in bytes of the value to be read
- Return values:
-
NFCTAG enum status
Definition at line 254 of file x_nucleo_nfc04a1_nfctag.cpp.
| NFCTAG_StatusTypeDef BSP_NFCTAG_WriteData | ( | const uint8_t *const | pData, |
| const uint16_t | TarAddr, | ||
| const uint16_t | Size, | ||
| I2C * | mi2cChannel | ||
| ) |
Writes data in the nfctag at specific address.
- Parameters:
-
pData : pointer to the data to write TarAddr : I2C data memory address to write Size : Size in bytes of the value to be written mi2cChannel : I2C channel
- Return values:
-
NFCTAG enum status
Definition at line 237 of file x_nucleo_nfc04a1_nfctag.cpp.
| NFCTAG_StatusTypeDef BSP_NFCTAG_WriteRegister | ( | const uint8_t *const | pData, |
| const uint16_t | TarAddr, | ||
| const uint16_t | Size, | ||
| I2C * | mi2cChannel | ||
| ) |
Writes nfctag Register.
- Parameters:
-
pData : pointer to the data to write TarAddr : I2C register address to write Size : Size in bytes of the value to be written mi2cChannel : I2C channel
- Return values:
-
NFCTAG enum status
Definition at line 272 of file x_nucleo_nfc04a1_nfctag.cpp.
Generated on Sat Jul 23 2022 22:19:06 by
1.7.2