radar.h File Reference

This file contains API for Radar 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
union	radar_float_bytes_t
	Radar Click float bytes type object. More...
struct	radar_t
	Radar Click context object. More...
struct	radar_cfg_t
	Radar Click configuration object. More...

Macros
#define	RADAR_CMD_HEADER   0xD9
	Radar control commands.
#define	RADAR_CMD_ID_VERSION   0x00
#define	RADAR_CMD_ID_ACK   0x02
#define	RADAR_CMD_ID_MAX_DETECT_RANGE   0x03
#define	RADAR_CMD_ID_SENSITIVITY   0x04
#define	RADAR_CMD_ID_DETECT_OUT   0x05
#define	RADAR_CMD_ID_DETECT_IN_EVT   0x06
#define	RADAR_CMD_ID_DETECT_OUT_EVT   0x07
#define	RADAR_CMD_ID_RESET_CONFIG   0x08
#define	RADAR_CMD_ID_GET_DETECT_STATUS   0x09
#define	RADAR_CMD_ID_DETECT_ENABLE   0x0A
#define	RADAR_CMD_ID_RFCW_MODE   0x0B
#define	RADAR_CMD_ID_CHIP_TEMPERATURE   0x0D
#define	RADAR_CMD_ID_SLEEP_MODE   0x0E
#define	RADAR_CMD_ID_CALIB_MODE   0x0F
#define	RADAR_CMD_ID_CALIB_MSG   0x10
#define	RADAR_CMD_ID_CALIB_MSG_RATE   0x11
#define	RADAR_CMD_ID_MIN_DETECT_RANGE   0x30
#define	RADAR_CMD_ID_MACRO_THRESHOLD   0x31
#define	RADAR_CMD_ID_MICRO_THRESHOLD   0x32
#define	RADAR_CMD_ID_MACRO_VALID   0x33
#define	RADAR_CMD_ID_MICRO_VALID   0x34
#define	RADAR_CMD_ID_DETECT_MODE   0x35
#define	RADAR_CMD_ID_MACRO_DETECT_RANGE   0x36
#define	RADAR_CMD_ID_MACRO_DETECT_DELAY   0x37
#define	RADAR_CMD_ID_CHIRP_PER_FRAME   0x38
#define	RADAR_CMD_ID_UNIQUE_ID   0xF7
#define	RADAR_SET_CMD_FAIL   0x00
	Radar set command results.
#define	RADAR_SET_CMD_SUCCESS   0x01
#define	RADAR_TIMEOUT   1000
	Radar response timeout value.
#define	RADAR_DEFAULT_MIN_RANGE   0.0
	Radar detection range values.
#define	RADAR_DEFAULT_MAX_RANGE   3.0
#define	DRV_BUFFER_SIZE   256
	Radar driver buffer size.
#define	RADAR_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	radar_return_value_t { RADAR_OK = 0 , RADAR_ERROR = -1 }
	Radar Click return value data. More...

Functions
void	radar_cfg_setup (radar_cfg_t *cfg)
	Radar configuration object setup function.
err_t	radar_init (radar_t *ctx, radar_cfg_t *cfg)
	Radar initialization function.
err_t	radar_default_cfg (radar_t *ctx)
	Radar default configuration function.
err_t	radar_generic_write (radar_t *ctx, uint8_t *data_buf, uint16_t len)
	Radar data writing function.
err_t	radar_generic_read (radar_t *ctx, uint8_t *data_buf, uint16_t max_len)
	Radar data reading function.
void	radar_enable_device (radar_t *ctx)
	Radar enable device function.
void	radar_disable_device (radar_t *ctx)
	Radar disable device function.
uint8_t	radar_get_gpio2_pin (radar_t *ctx)
	Radar get gpio 2 pin function.
uint8_t	radar_get_gpio1_pin (radar_t *ctx)
	Radar get gpio 1 pin function.
uint8_t	radar_get_gpio0_pin (radar_t *ctx)
	Radar get gpio 0 pin function.
err_t	radar_set_command (radar_t *ctx, uint8_t cmd_id, uint8_t *payload, uint8_t payload_size)
	Radar set command function.
err_t	radar_get_command (radar_t *ctx, uint8_t cmd_id, uint8_t *payload, uint8_t *payload_size)
	Radar get command function.
err_t	radar_get_event (radar_t *ctx, uint8_t *evt_id, uint8_t *payload, uint8_t *payload_size)
	Radar get event function.
err_t	radar_get_temperature (radar_t *ctx, float *temperature)
	Radar get temperature function.
err_t	radar_set_detection_range (radar_t *ctx, float min, float max)
	Radar set detection range function.
err_t	radar_reset_config (radar_t *ctx)
	Radar reset config function.
void	radar_float_ieee_to_mchip (float *f_data)
	Radar float ieee to mchip function.
void	radar_float_mchip_to_ieee (float *f_data)
	Radar float ieee to mchip function.

Detailed Description

This file contains API for Radar Click Driver.

Enumeration Type Documentation

radar_return_value_t

enum radar_return_value_t

Radar Click return value data.

Predefined enum values for driver return values.

Enumerator
RADAR_OK
RADAR_ERROR