Diego Ostuni / ST25R3911

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

ST25R3911.h File Reference
Data Structures | Enumerations | Functions

ST25R3911.h File Reference

ST25R3911 declaration file. More...

Go to the source code of this file.

Data Structures

struct  st25r3911StreamConfig
struct  st25r3911WakeUpConfig

Enumerations

enum  st25r3911WumPeriod {
  ST25R3911_WUM_PERIDOD_10MS = 0x00, ST25R3911_WUM_PERIDOD_20MS = 0x01, ST25R3911_WUM_PERIDOD_30MS = 0x02, ST25R3911_WUM_PERIDOD_40MS = 0x03,
  ST25R3911_WUM_PERIDOD_50MS = 0x04, ST25R3911_WUM_PERIDOD_60MS = 0x05, ST25R3911_WUM_PERIDOD_70MS = 0x06, ST25R3911_WUM_PERIDOD_80MS = 0x07,
  ST25R3911_WUM_PERIDOD_100MS = 0x10, ST25R3911_WUM_PERIDOD_200MS = 0x11, ST25R3911_WUM_PERIDOD_300MS = 0x12, ST25R3911_WUM_PERIDOD_400MS = 0x13,
  ST25R3911_WUM_PERIDOD_500MS = 0x14, ST25R3911_WUM_PERIDOD_600MS = 0x15, ST25R3911_WUM_PERIDOD_700MS = 0x16, ST25R3911_WUM_PERIDOD_800MS = 0x17
}
enum  st25r3911WumAAWeight { ST25R3911_WUM_AA_WEIGHT_4 = 0x00, ST25R3911_WUM_AA_WEIGHT_8 = 0x01, ST25R3911_WUM_AA_WEIGHT_16 = 0x02, ST25R3911_WUM_AA_WEIGHT_32 = 0x03 }

Functions

void st25r3911OscOn (SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Turn on Oscillator and Regulator.
void st25r3911TxRxOn (SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Turn On Tx and Rx.
void st25r3911TxRxOff (SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Turn Off Tx and Rx.
void st25r3911Initialize (SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Initialise ST25R3911 driver.
void st25r3911Deinitialize (SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Deinitialize ST25R3911 driver.
ReturnCode st25r3911SetBitrate (uint8_t txRate, uint8_t rxRate, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Sets the bitrate registers.
ReturnCode st25r3911AdjustRegulators (uint16_t *result_mV, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Adjusts supply regulators according to the current supply voltage.
void st25r3911MeasureRF (uint8_t *result, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Measure RF.
void st25r3911MeasureCapacitance (uint8_t *result, SPI *mspiChannel, DigitalOut *gpio_cs)
 Measure Capacitance.
uint16_t st25r3911MeasureVoltage (uint8_t mpsv, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Measure Voltage.
void st25r3911CalibrateAntenna (uint8_t *result, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Calibrate antenna.
void st25r3911MeasureAntennaResonance (uint8_t *result, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Check antenna resonance.
void st25r3911CalibrateModulationDepth (uint8_t *result, SPI *mspiChannel, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Calibrate modulation depth.
void st25r3911CalibrateCapacitiveSensor (uint8_t *result, SPI *mspiChannel, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Calibrate Capacitive Sensor.
ReturnCode st25r3911SetNoResponseTime_64fcs (uint32_t nrt_64fcs, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 set no response time
ReturnCode st25r3911SetStartNoResponseTime_64fcs (uint32_t nrt_64fcs, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_06)
 set no response time
ReturnCode st25r3911PerformCollisionAvoidance (uint8_t FieldONCmd, uint8_t pdThreshold, uint8_t caThreshold, uint8_t nTRFW, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Perform Collision Avoidance.
uint8_t st25r3911GetNumFIFOLastBits (void)
 Get amount of bits of the last FIFO byte if incomplete.
uint32_t st25r3911GetNoResponseTime_64fcs (void)
 Get NRT time.
void st25r3911SetGPTime_8fcs (uint16_t gpt_8fcs, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 set general purpose timer timeout
void st25r3911StartGPTimer_8fcs (uint16_t gpt_8fcs, uint8_t trigger_source, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Starts GPT with given timeout.
bool st25r3911CheckReg (uint8_t reg, uint8_t mask, uint8_t val, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Checks if register contains a expected value.
void st25r3911SetNumTxBits (uint32_t nBits, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Sets the number Tx Bits.
bool st25r3911CheckChipID (uint8_t *rev, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Check Identity.
bool st25r3911IsCmdValid (uint8_t cmd)
 Check if command is valid.
ReturnCode st25r3911StreamConfigure (const struct st25r3911StreamConfig *config, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Configure the stream mode of ST25R3911.
ReturnCode st25r3911GetRegsDump (uint8_t *resRegDump, uint8_t *sizeRegDump, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Retrieves all internal registers from st25r3911.
bool st25r3911IrqIsWakeUpCap (SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Cheks if a Wakeup IRQ due to Capacitive measument has happen.
bool st25r3911IrqIsWakeUpPhase (SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Cheks if a Wakeup IRQ due to Phase measument has happen.
bool st25r3911IrqIsWakeUpAmplitude (SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Cheks if a Wakeup IRQ due to Amplitude measument has happen.

Detailed Description

ST25R3911 declaration file.

Author:
Ulrich Herrmann

API:

Definition in file ST25R3911.h.

Generated on Tue Jul 12 2022 18:07:56 by  doxygen 1.7.2