radar.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef RADAR_H
#define RADAR_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
 
#define RADAR_CMD_HEADER                0xD9
#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
#define RADAR_SET_CMD_SUCCESS           0x01
 
#define RADAR_TIMEOUT                   1000
 
#define RADAR_DEFAULT_MIN_RANGE         0.0
#define RADAR_DEFAULT_MAX_RANGE         3.0
 
#define DRV_BUFFER_SIZE                 256
 
 // radar_cmd
 
#define RADAR_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.gp2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.gp0 = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // radar_map
 // radar
 
typedef union
{
    uint8_t b_data[ 4 ];
    float f_data;
    
} radar_float_bytes_t;
 
typedef struct
{
    // Output pins
    digital_out_t rst;                          
    // Input pins
    digital_in_t gp2;                           
    digital_in_t gp1;                           
    digital_in_t gp0;                           
    // Modules
    uart_t uart;                                
    // Buffers
    char uart_rx_buffer[ DRV_BUFFER_SIZE ];     
    char uart_tx_buffer[ DRV_BUFFER_SIZE ];     
} radar_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                          
    pin_name_t tx_pin;                          
    // Additional gpio pins
    pin_name_t rst;                             
    pin_name_t gp2;                             
    pin_name_t gp1;                             
    pin_name_t gp0;                             
    // Static variable
    uint32_t          baud_rate;                
    bool              uart_blocking;            
    uart_data_bits_t  data_bit;                 
    uart_parity_t     parity_bit;               
    uart_stop_bits_t  stop_bit;                 
} radar_cfg_t;
 
typedef enum
{
    RADAR_OK = 0,
    RADAR_ERROR = -1
 
} radar_return_value_t;
 
void radar_cfg_setup ( radar_cfg_t *cfg );
 
err_t radar_init ( radar_t *ctx, radar_cfg_t *cfg );
 
err_t radar_default_cfg ( radar_t *ctx );
 
err_t radar_generic_write ( radar_t *ctx, uint8_t *data_buf, uint16_t len );
 
err_t radar_generic_read ( radar_t *ctx, uint8_t *data_buf, uint16_t max_len );
 
void radar_enable_device ( radar_t *ctx );
 
void radar_disable_device ( radar_t *ctx );
 
uint8_t radar_get_gpio2_pin ( radar_t *ctx );
 
uint8_t radar_get_gpio1_pin ( radar_t *ctx );
 
uint8_t radar_get_gpio0_pin ( radar_t *ctx );
 
err_t radar_set_command ( radar_t *ctx, uint8_t cmd_id, uint8_t *payload, uint8_t payload_size );
 
err_t radar_get_command ( radar_t *ctx, uint8_t cmd_id, uint8_t *payload, uint8_t *payload_size );
 
err_t radar_get_event ( radar_t *ctx, uint8_t *evt_id, uint8_t *payload, uint8_t *payload_size );
 
err_t radar_get_temperature ( radar_t *ctx, float *temperature );
 
err_t radar_set_detection_range ( radar_t *ctx, float min, float max );
 
err_t radar_reset_config ( radar_t *ctx );
 
void radar_float_ieee_to_mchip ( float *f_data );
 
void radar_float_mchip_to_ieee ( float *f_data );
 
#ifdef __cplusplus
}
#endif
#endif // RADAR_H
 
 // radar
 
// ------------------------------------------------------------------------ END