magicrfid  2.0.0.0
Modules | Functions
Magic RFID Click Driver

API for configuring and manipulating Magic RFID Click driver. More...

Modules

 Magic RFID Device Settings
 Settings for registers of Magic RFID Click driver.
 
 Magic RFID MikroBUS Map
 MikroBUS pin mapping of Magic RFID Click driver.
 

Functions

void magicrfid_cfg_setup (magicrfid_cfg_t *cfg)
 Magic RFID configuration object setup function. More...
 
err_t magicrfid_init (magicrfid_t *ctx, magicrfid_cfg_t *cfg)
 Magic RFID initialization function. More...
 
void magicrfid_default_cfg (magicrfid_t *ctx)
 Magic RFID default configuration function. More...
 
err_t magicrfid_generic_write (magicrfid_t *ctx, char *data_buf, uint16_t len)
 Magic RFID data writing function. More...
 
err_t magicrfid_generic_read (magicrfid_t *ctx, char *data_buf, uint16_t max_len)
 Magic RFID data reading function. More...
 
void magicrfid_device_reset (magicrfid_t *ctx)
 Magic RFID device reset function. More...
 
void magicrfid_send_command (magicrfid_t *ctx, uint8_t opcode, uint8_t *data_in, uint8_t size)
 Magic RFID send command function. More...
 
int8_t magicrfid_get_tag_rssi (magicrfid_data_t *data_obj)
 Get Tag RSSI value. More...
 
void magicrfid_process (magicrfid_t *ctx, magicrfid_data_t *data_obj)
 General collecting response function. More...
 
uint8_t magicrfid_get_data_status (magicrfid_data_t *data_obj)
 Get current data status. More...
 
void magicrfid_reset_data (magicrfid_data_t *data_obj)
 Reset collecting data and start new measurement. More...
 
void magicrfid_tag_parser (magicrfid_data_t *data_obj)
 Gets Tag value after parsing. More...
 
void magicrfid_write_data (magicrfid_t *ctx, uint8_t bank, uint32_t address, uint8_t *data_in, uint8_t len, uint16_t timeout)
 Magic RFID data writing function. More...
 
void magicrfid_read_data (magicrfid_t *ctx, uint8_t bank, uint32_t address, uint8_t *data_out, uint8_t tx_len, uint8_t *rx_len, uint16_t time_out)
 Magic RFID data read function. More...
 
uint16_t magicrfid_calculate_crc (uint8_t *data_val, uint8_t len)
 Magic RFID calculate CRC function. More...
 
void magicrfid_set_tag_protocol (magicrfid_t *ctx, uint8_t protocol)
 Magic RFID set protocol function. More...
 
void magicrfid_set_region (magicrfid_t *ctx, uint8_t region)
 Magic RFID set region function. More...
 
void magicrfid_set_antenna_port (magicrfid_t *ctx)
 Magic RFID turn on antena port function. More...
 
void magicrfid_set_antenna_search_list (magicrfid_t *ctx)
 Magic RFID turn on antena search list function. More...
 
void magicrfid_set_baud_rate (magicrfid_t *ctx, uint32_t baud_rate)
 Magic RFID set baud rate function. More...
 
void magicrfid_set_read_power (magicrfid_t *ctx, uint16_t power_setting)
 Magic RFID set read function power. More...
 
void magicrfid_set_write_power (magicrfid_t *ctx, uint16_t power_setting)
 Magic RFID set write function power. More...
 
void magicrfid_set_reader_configuration (magicrfid_t *ctx, uint8_t option1, uint8_t option2)
 Magic RFID set reader configuration function. More...
 
void magicrfid_start_reading (magicrfid_t *ctx)
 Magic RFID enable reading function. More...
 

Detailed Description

API for configuring and manipulating Magic RFID Click driver.

Function Documentation

◆ magicrfid_calculate_crc()

uint16_t magicrfid_calculate_crc ( uint8_t *  data_val,
uint8_t  len 
)

Magic RFID calculate CRC function.

This function calculates CRC of the selected input data.

Parameters
[in]data_val: Data to be calculated.
[in]len: Number of bytes to be calculated.
Returns
CRC value.

◆ magicrfid_cfg_setup()

void magicrfid_cfg_setup ( magicrfid_cfg_t cfg)

Magic RFID configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See magicrfid_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ magicrfid_default_cfg()

void magicrfid_default_cfg ( magicrfid_t ctx)

Magic RFID default configuration function.

This function executes a default configuration of Magic RFID click board.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ magicrfid_device_reset()

void magicrfid_device_reset ( magicrfid_t ctx)

Magic RFID device reset function.

Device reset and wake up module.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
Returns
Nothing.

◆ magicrfid_generic_read()

err_t magicrfid_generic_read ( magicrfid_t ctx,
char *  data_buf,
uint16_t  max_len 
)

Magic RFID data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
[out]data_buf: Output read data.
[in]max_len: Number of bytes to be read.
Returns
  • >0 - Number of data bytes read,
  • <=0 - Error/Empty Ring buffer.
See #err_t definition for detailed explanation.

◆ magicrfid_generic_write()

err_t magicrfid_generic_write ( magicrfid_t ctx,
char *  data_buf,
uint16_t  len 
)

Magic RFID data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
[in]data_buf: Data buffer for sending.
[in]len: Number of bytes for sending.
Returns
  • >=0 - Success,
  • <0 - Error.
See #err_t definition for detailed explanation.

◆ magicrfid_get_data_status()

uint8_t magicrfid_get_data_status ( magicrfid_data_t data_obj)

Get current data status.

This function gets data status.

Parameters
[out]data_obj: Tag data structure.
Returns
Data status

◆ magicrfid_get_tag_rssi()

int8_t magicrfid_get_tag_rssi ( magicrfid_data_t data_obj)

Get Tag RSSI value.

This function reads RSSI value of the tag.

Parameters
[out]data_obj: Tag data structure.
Returns
RSSI value

◆ magicrfid_init()

err_t magicrfid_init ( magicrfid_t ctx,
magicrfid_cfg_t cfg 
)

Magic RFID initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters
[out]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See magicrfid_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ magicrfid_process()

void magicrfid_process ( magicrfid_t ctx,
magicrfid_data_t data_obj 
)

General collecting response function.

This function reads data from the tag.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
[out]data_obj: Tag data structure.
Returns
Nothing.

◆ magicrfid_read_data()

void magicrfid_read_data ( magicrfid_t ctx,
uint8_t  bank,
uint32_t  address,
uint8_t *  data_out,
uint8_t  tx_len,
uint8_t *  rx_len,
uint16_t  time_out 
)

Magic RFID data read function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
[in]bank: User data bank.
[in]address: Address of the register.
[out]data_out: Output read data.
[in]tx_len: Number of bytes for sending.
[out]rx_len: Number of read bytes.
[in]timeout: Number of ms before stop waiting for response from module.
Returns
Nothing.

◆ magicrfid_reset_data()

void magicrfid_reset_data ( magicrfid_data_t data_obj)

Reset collecting data and start new measurement.

This function resets data of data object structure.

Parameters
[out]data_obj: Tag data structure.
Returns
Nothing.

◆ magicrfid_send_command()

void magicrfid_send_command ( magicrfid_t ctx,
uint8_t  opcode,
uint8_t *  data_in,
uint8_t  size 
)

Magic RFID send command function.

Send command function.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
[in]opcode: Operation code of the command.
[in]data_in: Data buffer.
[in]size: Number of the bytes in buffer.
Returns
Nothing.

◆ magicrfid_set_antenna_port()

void magicrfid_set_antenna_port ( magicrfid_t ctx)

Magic RFID turn on antena port function.

This function is used for setting up antenna port of Magic RFID Click Board by using UART serial interface.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
Returns
Nothing.

◆ magicrfid_set_antenna_search_list()

void magicrfid_set_antenna_search_list ( magicrfid_t ctx)

Magic RFID turn on antena search list function.

This function is used for setting up antenna search list of Magic RFID Click Board by using UART serial interface.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
Returns
Nothing.

◆ magicrfid_set_baud_rate()

void magicrfid_set_baud_rate ( magicrfid_t ctx,
uint32_t  baud_rate 
)

Magic RFID set baud rate function.

This function is used for setting up baud rate of Magic RFID Click Board by using UART serial interface.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
[in]baud_rate: Baud rate value.
Returns
Nothing.

◆ magicrfid_set_read_power()

void magicrfid_set_read_power ( magicrfid_t ctx,
uint16_t  power_setting 
)

Magic RFID set read function power.

This function is used for setting up read power of Magic RFID Click Board in dBm by using UART serial interface.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
[in]power_setting: Power setting value in dBm.
Returns
Nothing.

◆ magicrfid_set_reader_configuration()

void magicrfid_set_reader_configuration ( magicrfid_t ctx,
uint8_t  option1,
uint8_t  option2 
)

Magic RFID set reader configuration function.

This function is used for sending optional parameters to Magic RFID Click BoardSends optional parameters by using the UART serial interface.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
Returns
Nothing.

◆ magicrfid_set_region()

void magicrfid_set_region ( magicrfid_t ctx,
uint8_t  region 
)

Magic RFID set region function.

This function is used for setting up region of Magic RFID Click Board by using UART serial interface.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
[in]region: Selected region.
Returns
Nothing.

◆ magicrfid_set_tag_protocol()

void magicrfid_set_tag_protocol ( magicrfid_t ctx,
uint8_t  protocol 
)

Magic RFID set protocol function.

This function is used for setting up protocol of Magic RFID Click Board by using UART serial interface.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
[in]protocol: Selected protocol.
Returns
Nothing.

◆ magicrfid_set_write_power()

void magicrfid_set_write_power ( magicrfid_t ctx,
uint16_t  power_setting 
)

Magic RFID set write function power.

This function is used for setting up write power of Magic RFID Click Board in dBm by using UART serial interface.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
[in]power_setting: Power setting value in dBm.
Returns
Nothing.

◆ magicrfid_start_reading()

void magicrfid_start_reading ( magicrfid_t ctx)

Magic RFID enable reading function.

This function is used for setting up Magic RFID Click Board in continuous reading mode by using the UART serial interface.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
Returns
Nothing.

◆ magicrfid_tag_parser()

void magicrfid_tag_parser ( magicrfid_data_t data_obj)

Gets Tag value after parsing.

This function is used to parse data after reading it.

Parameters
[out]data_obj: Tag data structure.
Returns
Nothing.

◆ magicrfid_write_data()

void magicrfid_write_data ( magicrfid_t ctx,
uint8_t  bank,
uint32_t  address,
uint8_t *  data_in,
uint8_t  len,
uint16_t  timeout 
)

Magic RFID data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See magicrfid_t object definition for detailed explanation.
[in]bank: User data bank.
[in]address: Address of the register.
[in]data_in: Data buffer for sending.
[in]len: Number of bytes for sending.
[in]timeout: Number of ms before stop waiting for response from module.
Returns
Nothing.