uwb3 2.1.0.0
uwb3.h File Reference

This file contains API for UWB 3 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures

struct  uwb3_t
 UWB 3 Click context object. More...
 
struct  uwb3_cfg_t
 UWB 3 Click configuration object. More...
 

Macros

#define UWB3_CMD_HELP   "help"
 UWB 3 anytime commands.
 
#define UWB3_CMD_STAT   "stat"
 
#define UWB3_CMD_DECA   "deca$"
 
#define UWB3_CMD_STOP   "stop"
 
#define UWB3_CMD_SAVE   "save"
 
#define UWB3_CMD_THREAD   "thread"
 
#define UWB3_CMD_LISTENER2   "listener2"
 UWB 3 application selection commands.
 
#define UWB3_CMD_TCFM   "tcfm"
 
#define UWB3_CMD_TCWM   "tcwm"
 
#define UWB3_CMD_RESPF   "respf"
 
#define UWB3_CMD_INITF   "initf"
 
#define UWB3_CMD_LSTAT   "lstat"
 UWB 3 listener options commands.
 
#define UWB3_CMD_PAVRG   "pavrg"
 UWB 3 FiRa options commands.
 
#define UWB3_CMD_ANTTXA   "anttxa"
 UWB 3 IDLE time commands.
 
#define UWB3_CMD_ANTRXA   "antrxa"
 
#define UWB3_CMD_XTALTRIM   "xtaltrim"
 
#define UWB3_CMD_PDOAOFF   "pdoaoff"
 
#define UWB3_CMD_UART   "uart"
 
#define UWB3_CMD_RESTORE   "restore"
 UWB 3 service commands.
 
#define UWB3_CMD_DIAG   "diag"
 
#define UWB3_CMD_UWBCFG   "uwbcfg"
 
#define UWB3_CMD_STSKEYIV   "stskeyiv"
 
#define UWB3_CMD_TXPOWER   "txpower"
 
#define UWB3_CMD_ANTENNA   "antenna"
 
#define UWB3_CMD_DECAID   "decaid"
 
#define UWB3_CMD_VERSION   "version"
 
#define UWB3_RSP_OK   "ok"
 UWB 3 device response to commands.
 
#define UWB3_RSP_ERROR   "error"
 
#define UWB3_TX_DRV_BUFFER_SIZE   100
 UWB 3 driver buffer size.
 
#define UWB3_RX_DRV_BUFFER_SIZE   1000
 
#define UWB3_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  uwb3_return_value_t { UWB3_OK = 0 , UWB3_ERROR = -1 , UWB3_ERROR_TIMEOUT = -2 }
 UWB 3 Click return value data. More...
 

Functions

void uwb3_cfg_setup (uwb3_cfg_t *cfg)
 UWB 3 configuration object setup function.
 
err_t uwb3_init (uwb3_t *ctx, uwb3_cfg_t *cfg)
 UWB 3 initialization function.
 
err_t uwb3_generic_write (uwb3_t *ctx, uint8_t *data_in, uint16_t len)
 UWB 3 data writing function.
 
err_t uwb3_generic_read (uwb3_t *ctx, uint8_t *data_out, uint16_t len)
 UWB 3 data reading function.
 
void uwb3_send_cmd (uwb3_t *ctx, uint8_t *cmd)
 UWB 3 send cmd function.
 
void uwb3_send_cmd_with_parameter (uwb3_t *ctx, uint8_t *cmd, uint8_t *param)
 UWB 3 send cmd with parameter function.
 
void uwb3_set_rst_pin (uwb3_t *ctx, uint8_t state)
 UWB 3 set rst pin function.
 
void uwb3_reset_device (uwb3_t *ctx)
 UWB 3 reset device function.
 

Detailed Description

This file contains API for UWB 3 Click Driver.

Enumeration Type Documentation

◆ uwb3_return_value_t

UWB 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
UWB3_OK 
UWB3_ERROR 
UWB3_ERROR_TIMEOUT