uwb  2.0.0.0
Functions
Public function

Functions

void uwb_cfg_setup (uwb_cfg_t *cfg)
 Config Object Initialization function. More...
 
UWB_RETVAL uwb_init (uwb_t *ctx, uwb_cfg_t *cfg)
 Initialization function. More...
 
void uwb_generic_write (uwb_t *ctx, uint8_t reg_adr, uint8_t *tx_buf, uint16_t buf_len)
 Function for writing data to register. More...
 
void uwb_generic_read (uwb_t *ctx, uint8_t reg_adr, uint8_t *rx_buf, uint16_t buf_len)
 Function for reading data from register. More...
 
void uwb_set_rst_pin_status (uwb_t *ctx, uint8_t status)
 Function for setting rst pin status. More...
 
uint8_t uwb_get_qint_pin_status (uwb_t *ctx)
 Function for getting irq pin status. More...
 
void uwb_read_otp (uwb_t *ctx, uint16_t otp_adr, uint8_t *rx_buf)
 Function for reading OTM memory. More...
 
void uwb_set_bit (uwb_t *ctx, uint8_t reg_adr, uint16_t bit_num, uint8_t bit_state)
 Function for setting single bit state. More...
 
uint8_t uwb_get_bit (uwb_t *ctx, uint8_t reg_adr, uint16_t bit_num)
 Function for getting single bit state. More...
 
uint16_t uwb_reg_data_len (uint8_t reg_adr)
 Function for getting length of register data. More...
 
void uwb_set_dev_adr_n_network_id (uwb_t *ctx, uint16_t dev_adr, uint16_t net_id)
 Function for setting device address and network ID. More...
 
uint8_t uwb_set_data_rate (uwb_t *ctx, uint8_t rate)
 Function for setting data rate. More...
 
void uwb_set_pulse_freq (uwb_t *ctx, uint8_t freq)
 Function for setting pulse frequency. More...
 
void uwb_set_preamble_len (uwb_t *ctx, uint8_t prealen)
 Function for setting preamble length. More...
 
void uwb_set_preable_code (uwb_t *ctx, uint8_t preamble)
 Function for setting preamble code. More...
 
void uwb_set_channel (uwb_t *ctx, uint8_t channel)
 Function for setting channel. More...
 
void uwb_set_transmit_type (uwb_t *ctx, const uint8_t *t_t)
 Function for setting transmit type mode. More...
 
void uwb_get_transmit (uwb_t *ctx, uint8_t *rx_buf, uint16_t len_buf)
 Function for getting transmit data. More...
 
uint8_t uwb_get_transmit_len (uwb_t *ctx)
 Function for getting transmit length. More...
 
void uwb_set_transmit (uwb_t *ctx, uint8_t *tx_buf, uint16_t len_buf)
 Function for setting transmit data. More...
 
void uwb_use_smart_power (uwb_t *ctx, uint8_t smart_power)
 Function for setting smart power option. More...
 
void uwb_frame_check (uint8_t fc)
 Function for setting frame check option. More...
 
void uwb_frame_filter (uwb_t *ctx, uint8_t ff)
 Function for setting frame filter option. More...
 
void uwb_set_mode (uwb_t *ctx, uint8_t mode)
 Function for setting device working mode. More...
 
void uwb_start_transceiver (uwb_t *ctx)
 Function for starting communication of device. More...
 
uint8_t uwb_get_transmit_status (uwb_t *ctx)
 Function for getting transmit status. More...
 
void uwb_clear_status (uwb_t *ctx)
 Function for clearing status. More...
 
void uwb_int_mask_set (uwb_t *ctx)
 Function for setting interrupt mask. More...
 
void uwb_tune_config (uwb_t *ctx)
 Function for tuneing configuration for set values. More...
 
void uwb_dev_reset (uwb_t *ctx)
 Function for reseting device. More...
 
void uwb_enable (uwb_t *ctx)
 Function for enabling device. More...
 

Detailed Description

Function Documentation

◆ uwb_cfg_setup()

void uwb_cfg_setup ( uwb_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ uwb_clear_status()

void uwb_clear_status ( uwb_t ctx)

Function for clearing status.

Parameters
ctxClick object.

@description This function clear status.

Note
Clearing status relative to previous sleceted device mode.

◆ uwb_dev_reset()

void uwb_dev_reset ( uwb_t ctx)

Function for reseting device.

Parameters
ctxClick object.

@description This function reset device.

◆ uwb_enable()

void uwb_enable ( uwb_t ctx)

Function for enabling device.

Parameters
ctxClick object.

@description This function enables device.

◆ uwb_frame_check()

void uwb_frame_check ( uint8_t  fc)

Function for setting frame check option.

Parameters
ctxClick object.
fcFrame check data.

@description This function set frame check option.

◆ uwb_frame_filter()

void uwb_frame_filter ( uwb_t ctx,
uint8_t  ff 
)

Function for setting frame filter option.

Parameters
ctxClick object.
ffFrame filter data.

@description This function set frame filter option.

◆ uwb_generic_read()

void uwb_generic_read ( uwb_t ctx,
uint8_t  reg_adr,
uint8_t *  rx_buf,
uint16_t  buf_len 
)

Function for reading data from register.

Parameters
ctxClick object.
reg_adrRegister address.
rx_bufReceive buffer.
buf_lenReceive buffer length.

@description This function read data from register.

◆ uwb_generic_write()

void uwb_generic_write ( uwb_t ctx,
uint8_t  reg_adr,
uint8_t *  tx_buf,
uint16_t  buf_len 
)

Function for writing data to register.

Parameters
ctxClick object.
reg_adrRegister address.
tx_bufTransmit buffer.
buf_lenTransmit buffer length.

@description This function write data to register.

◆ uwb_get_bit()

uint8_t uwb_get_bit ( uwb_t ctx,
uint8_t  reg_adr,
uint16_t  bit_num 
)

Function for getting single bit state.

Parameters
ctxClick object.
reg_adrRegister address of bit.
bit_numBit number.
Returns
Bit state getting single bit state.

@description This function

◆ uwb_get_qint_pin_status()

uint8_t uwb_get_qint_pin_status ( uwb_t ctx)

Function for getting irq pin status.

Parameters
ctxClick object.
Returns
QINT pin status

@description This function gets irq pin status.

◆ uwb_get_transmit()

void uwb_get_transmit ( uwb_t ctx,
uint8_t *  rx_buf,
uint16_t  len_buf 
)

Function for getting transmit data.

Parameters
ctxClick object.
rx_bufReceive buffer.
len_bufTransmit data length.

@description This function get transmit data.

◆ uwb_get_transmit_len()

uint8_t uwb_get_transmit_len ( uwb_t ctx)

Function for getting transmit length.

Parameters
ctxClick object.
Returns
transmit length

@description This function get transmit length.

◆ uwb_get_transmit_status()

uint8_t uwb_get_transmit_status ( uwb_t ctx)

Function for getting transmit status.

Parameters
ctxClick object.
Returns
OK or ERROR macro

@description This function get transmit status.

Note
Returns status is relative to previous selected device mode.

◆ uwb_init()

UWB_RETVAL uwb_init ( uwb_t ctx,
uwb_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ uwb_int_mask_set()

void uwb_int_mask_set ( uwb_t ctx)

Function for setting interrupt mask.

Parameters
ctxClick object.

@description This function set interrupt mask.

Note
Setting interrupt mask relative to previous set device mode.

◆ uwb_read_otp()

void uwb_read_otp ( uwb_t ctx,
uint16_t  otp_adr,
uint8_t *  rx_buf 
)

Function for reading OTM memory.

Parameters
ctxClick object.
otp_adrOtp register address.
rx_bufReceive data buffer.

@description This function read OTM memory.

◆ uwb_reg_data_len()

uint16_t uwb_reg_data_len ( uint8_t  reg_adr)

Function for getting length of register data.

Parameters
ctxClick object.
reg_adrRegister address.
Returns
Register length

@description This function get length of register data

◆ uwb_set_bit()

void uwb_set_bit ( uwb_t ctx,
uint8_t  reg_adr,
uint16_t  bit_num,
uint8_t  bit_state 
)

Function for setting single bit state.

Parameters
ctxClick object.
reg_adrRegister address of bit.
bit_numBit number.
bit_stateBit state.

@description This function set single bit state.

◆ uwb_set_channel()

void uwb_set_channel ( uwb_t ctx,
uint8_t  channel 
)

Function for setting channel.

Parameters
ctxClick object.
channelDevice channel.

@description This function set channel.

◆ uwb_set_data_rate()

uint8_t uwb_set_data_rate ( uwb_t ctx,
uint8_t  rate 
)

Function for setting data rate.

Parameters
ctxClick object.
rateData rate.
Returns
OK or ERROR macro

@description This function set data rate.

◆ uwb_set_dev_adr_n_network_id()

void uwb_set_dev_adr_n_network_id ( uwb_t ctx,
uint16_t  dev_adr,
uint16_t  net_id 
)

Function for setting device address and network ID.

Parameters
ctxClick object.
dev_adrDevice address.
net_idNetwork ID.

@description This function set device address and network ID

◆ uwb_set_mode()

void uwb_set_mode ( uwb_t ctx,
uint8_t  mode 
)

Function for setting device working mode.

Parameters
ctxClick object.
modeDevice working mode.

@description This function set device working mode.

Note
Should be first function called in driver after initialization.

◆ uwb_set_preable_code()

void uwb_set_preable_code ( uwb_t ctx,
uint8_t  preamble 
)

Function for setting preamble code.

Parameters
ctxClick object.
preambleDevice preamble code.

@description This function set preamble code.

◆ uwb_set_preamble_len()

void uwb_set_preamble_len ( uwb_t ctx,
uint8_t  prealen 
)

Function for setting preamble length.

Parameters
ctxClick object.
prealenDevice preamble length.

@description This function set preamble length.

◆ uwb_set_pulse_freq()

void uwb_set_pulse_freq ( uwb_t ctx,
uint8_t  freq 
)

Function for setting pulse frequency.

Parameters
ctxClick object.
freqDevice pulse frequency.

@description This function set pulse frequency.

◆ uwb_set_rst_pin_status()

void uwb_set_rst_pin_status ( uwb_t ctx,
uint8_t  status 
)

Function for setting rst pin status.

Parameters
ctxClick object.
statusPin status.

@description This function sets rst pin status.

◆ uwb_set_transmit()

void uwb_set_transmit ( uwb_t ctx,
uint8_t *  tx_buf,
uint16_t  len_buf 
)

Function for setting transmit data.

Parameters
ctxClick object.
tx_bufTransmit buffer.
len_bufTransmit data length.

@description This function set transmit data.

◆ uwb_set_transmit_type()

void uwb_set_transmit_type ( uwb_t ctx,
const uint8_t *  t_t 
)

Function for setting transmit type mode.

Parameters
ctxClick object.
t_tTransmit type mode.

@description This function set transmit type mode.

◆ uwb_start_transceiver()

void uwb_start_transceiver ( uwb_t ctx)

Function for starting communication of device.

Parameters
ctxClick object.

@description This function start communication of device.

Note
Function is called to start transmiting or receiving data.

◆ uwb_tune_config()

void uwb_tune_config ( uwb_t ctx)

Function for tuneing configuration for set values.

Parameters
ctxClick object.

@description This function tune configuration for set values.

Note
Should be called after other configuration is set. It will do some additional configuration to device relative to some other parameteres.

◆ uwb_use_smart_power()

void uwb_use_smart_power ( uwb_t ctx,
uint8_t  smart_power 
)

Function for setting smart power option.

Parameters
ctxClick object.
smart_powerSmart power data.

@description This function set smart power option.