spirit 2.0.0.0
Macros

Topics

 MikroBUS
 
 Module power state
 
 Driver define
 
 Mode
 
 Spirit at command standard
 
 Information register
 
 Configuration register
 
 Config parameters
 
 Baud rate
 
 CS mode
 
 CRC mode
 
 TX RX led
 
 Modulation
 
 Test mode
 
 SPIRIT Click Driver
 API for configuring and manipulating SPIRIT Click driver.
 

Data Structures

struct  spirit_t
 SPIRIT Click context object. More...
 
struct  spirit_cfg_t
 SPIRIT Click configuration object. More...
 

Enumerations

enum  spirit_return_value_t { SPIRIT_OK = 0 , SPIRIT_ERROR = -1 }
 SPIRIT Click return value data. More...
 

Variables

digital_out_t rst
 
digital_out_t cmd
 
digital_out_t shd
 
uart_t uart
 
char uart_rx_buffer [DRV_RX_BUFFER_SIZE]
 
char uart_tx_buffer [DRV_TX_BUFFER_SIZE]
 
pin_name_t rx_pin
 
pin_name_t tx_pin
 
pin_name_t rst
 
pin_name_t cmd
 
pin_name_t shd
 
uint32_t baud_rate
 
bool uart_blocking
 
uart_data_bits_t data_bit
 
uart_parity_t parity_bit
 
uart_stop_bits_t stop_bit
 

Detailed Description

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Enumeration Type Documentation

◆ spirit_return_value_t

SPIRIT Click return value data.

Predefined enum values for driver return values.

Enumerator
SPIRIT_OK 
SPIRIT_ERROR 

Variable Documentation

◆ baud_rate

uint32_t baud_rate

Clock speed.

◆ cmd [1/2]

digital_out_t cmd

Description.

◆ cmd [2/2]

pin_name_t cmd

Description.

◆ data_bit

uart_data_bits_t data_bit

Data bits.

◆ parity_bit

uart_parity_t parity_bit

Parity bit.

◆ rst [1/2]

digital_out_t rst

Description.

◆ rst [2/2]

pin_name_t rst

Description.

◆ rx_pin

pin_name_t rx_pin

RX pin.

◆ shd [1/2]

digital_out_t shd

Description.

◆ shd [2/2]

pin_name_t shd

Description.

◆ stop_bit

uart_stop_bits_t stop_bit

Stop bits.

◆ tx_pin

pin_name_t tx_pin

TX pin.

◆ uart

uart_t uart

UART driver object.

◆ uart_blocking

bool uart_blocking

Wait for interrupt or not.

◆ uart_rx_buffer

char uart_rx_buffer[DRV_RX_BUFFER_SIZE]

Buffer size.

◆ uart_tx_buffer

char uart_tx_buffer[DRV_TX_BUFFER_SIZE]

Buffer size.