rs232spi  2.0.0.0
Functions
Public function

Functions

void rs232spi_cfg_setup (rs232spi_cfg_t *cfg)
 Config Object Initialization function. More...
 
RS232SPI_RETVAL rs232spi_init (rs232spi_t *ctx, rs232spi_cfg_t *cfg)
 Initialization function. More...
 
void rs232spi_default_cfg (rs232spi_t *ctx, uint32_t speed)
 Click Default Configuration function. More...
 
void rs232spi_reg_write (rs232spi_t *ctx, uint16_t write_data)
 Register write function. More...
 
uint16_t rs232spi_reg_read (rs232spi_t *ctx, uint16_t write_data)
 Register read function. More...
 
uint16_t rs232spi_transfer (rs232spi_t *ctx, uint16_t write_data)
 SPI transfer function. More...
 
uint16_t rs232spi_read_cfg (rs232spi_t *ctx)
 Read configuration function. More...
 
void rs232spi_flush (rs232spi_t *ctx)
 Flush function. More...
 
uint16_t rs232spi_data_ready (rs232spi_t *ctx)
 Data ready function. More...
 
uint16_t rs232spi_check_busy (rs232spi_t *ctx)
 Check if busy function. More...
 
void rs232spi_data_write (rs232spi_t *ctx, uint8_t write_data)
 Data write function. More...
 
void rs232spi_digital_write_rst (rs232spi_t *ctx, uint8_t signal)
 Digital write reset function. More...
 
uint8_t rs232spi_digital_read_int (rs232spi_t *ctx)
 Digital read interrupt function. More...
 

Detailed Description

Function Documentation

◆ rs232spi_cfg_setup()

void rs232spi_cfg_setup ( rs232spi_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ rs232spi_check_busy()

uint16_t rs232spi_check_busy ( rs232spi_t ctx)

Check if busy function.

Parameters
ctxClick object.

This function checks if the UART is busy.

◆ rs232spi_data_ready()

uint16_t rs232spi_data_ready ( rs232spi_t ctx)

Data ready function.

Parameters
ctxClick object.

This function checks if the UART is ready to read.

◆ rs232spi_data_write()

void rs232spi_data_write ( rs232spi_t ctx,
uint8_t  write_data 
)

Data write function.

Parameters
ctxClick object.

This function writes data using the reg_write(...) function.

◆ rs232spi_default_cfg()

void rs232spi_default_cfg ( rs232spi_t ctx,
uint32_t  speed 
)

Click Default Configuration function.

Parameters
ctxClick object.
speedSpeed variable.

This function executes default configuration for RS232 SPI click.

◆ rs232spi_digital_read_int()

uint8_t rs232spi_digital_read_int ( rs232spi_t ctx)

Digital read interrupt function.

Parameters
ctxClick object.

This function reads the digital signal from the INT pin.

◆ rs232spi_digital_write_rst()

void rs232spi_digital_write_rst ( rs232spi_t ctx,
uint8_t  signal 
)

Digital write reset function.

Parameters
ctxClick object.
signalDigital output signal.

This function writes the specified digital signal to the RST pin.

◆ rs232spi_flush()

void rs232spi_flush ( rs232spi_t ctx)

Flush function.

Parameters
ctxClick object.

This function flushes the read buffer.

◆ rs232spi_init()

RS232SPI_RETVAL rs232spi_init ( rs232spi_t ctx,
rs232spi_cfg_t cfg 
)

Initialization function.

Parameters
rs232spiClick object.
cfgClick configuration structure.

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

◆ rs232spi_read_cfg()

uint16_t rs232spi_read_cfg ( rs232spi_t ctx)

Read configuration function.

Parameters
ctxClick object.

This function reads two bytes of data from the configuration register.

◆ rs232spi_reg_read()

uint16_t rs232spi_reg_read ( rs232spi_t ctx,
uint16_t  write_data 
)

Register read function.

Parameters
ctxClick object.
write_dataWrite data variable.

This function reads two bytes of data using the SPI serial interface.

◆ rs232spi_reg_write()

void rs232spi_reg_write ( rs232spi_t ctx,
uint16_t  write_data 
)

Register write function.

Parameters
ctxClick object.
write_dataWrite data variable.

This function writes two bytes of data using the SPI serial interface.

◆ rs232spi_transfer()

uint16_t rs232spi_transfer ( rs232spi_t ctx,
uint16_t  write_data 
)

SPI transfer function.

Parameters
ctxClick object.
write_dataWrite data variable.

This function reads and writes two bytes of data using the SPI serial interface.