radar  2.0.0.0
radar.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef RADAR_H
29 #define RADAR_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_uart.h"
48 
69 #define RADAR_CMD_HEADER 0xD9
70 #define RADAR_CMD_ID_VERSION 0x00
71 #define RADAR_CMD_ID_ACK 0x02
72 #define RADAR_CMD_ID_MAX_DETECT_RANGE 0x03
73 #define RADAR_CMD_ID_SENSITIVITY 0x04
74 #define RADAR_CMD_ID_DETECT_OUT 0x05
75 #define RADAR_CMD_ID_DETECT_IN_EVT 0x06
76 #define RADAR_CMD_ID_DETECT_OUT_EVT 0x07
77 #define RADAR_CMD_ID_RESET_CONFIG 0x08
78 #define RADAR_CMD_ID_GET_DETECT_STATUS 0x09
79 #define RADAR_CMD_ID_DETECT_ENABLE 0x0A
80 #define RADAR_CMD_ID_RFCW_MODE 0x0B
81 #define RADAR_CMD_ID_CHIP_TEMPERATURE 0x0D
82 #define RADAR_CMD_ID_SLEEP_MODE 0x0E
83 #define RADAR_CMD_ID_CALIB_MODE 0x0F
84 #define RADAR_CMD_ID_CALIB_MSG 0x10
85 #define RADAR_CMD_ID_CALIB_MSG_RATE 0x11
86 #define RADAR_CMD_ID_MIN_DETECT_RANGE 0x30
87 #define RADAR_CMD_ID_MACRO_THRESHOLD 0x31
88 #define RADAR_CMD_ID_MICRO_THRESHOLD 0x32
89 #define RADAR_CMD_ID_MACRO_VALID 0x33
90 #define RADAR_CMD_ID_MICRO_VALID 0x34
91 #define RADAR_CMD_ID_DETECT_MODE 0x35
92 #define RADAR_CMD_ID_MACRO_DETECT_RANGE 0x36
93 #define RADAR_CMD_ID_MACRO_DETECT_DELAY 0x37
94 #define RADAR_CMD_ID_CHIRP_PER_FRAME 0x38
95 #define RADAR_CMD_ID_UNIQUE_ID 0xF7
96 
101 #define RADAR_SET_CMD_FAIL 0x00
102 #define RADAR_SET_CMD_SUCCESS 0x01
103 
108 #define RADAR_TIMEOUT 1000
109 
114 #define RADAR_DEFAULT_MIN_RANGE 0.0
115 #define RADAR_DEFAULT_MAX_RANGE 3.0
116 
122 #define DRV_BUFFER_SIZE 256
123  // radar_cmd
125 
140 #define RADAR_MAP_MIKROBUS( cfg, mikrobus ) \
141  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
142  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
143  cfg.gp2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
144  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
145  cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
146  cfg.gp0 = MIKROBUS( mikrobus, MIKROBUS_INT );
147  // radar_map // radar
150 
155 typedef union
156 {
157  uint8_t b_data[ 4 ];
158  float f_data;
159 
161 
166 typedef struct
167 {
168  // Output pins
169  digital_out_t rst;
171  // Input pins
172  digital_in_t gp2;
173  digital_in_t gp1;
174  digital_in_t gp0;
176  // Modules
177  uart_t uart;
179  // Buffers
180  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
181  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
183 } radar_t;
184 
189 typedef struct
190 {
191  // Communication gpio pins
192  pin_name_t rx_pin;
193  pin_name_t tx_pin;
195  // Additional gpio pins
196  pin_name_t rst;
197  pin_name_t gp2;
198  pin_name_t gp1;
199  pin_name_t gp0;
201  // Static variable
202  uint32_t baud_rate;
204  uart_data_bits_t data_bit;
205  uart_parity_t parity_bit;
206  uart_stop_bits_t stop_bit;
208 } radar_cfg_t;
209 
214 typedef enum
215 {
216  RADAR_OK = 0,
217  RADAR_ERROR = -1
218 
220 
237 
251 err_t radar_init ( radar_t *ctx, radar_cfg_t *cfg );
252 
265 err_t radar_default_cfg ( radar_t *ctx );
266 
279 err_t radar_generic_write ( radar_t *ctx, uint8_t *data_buf, uint16_t len );
280 
293 err_t radar_generic_read ( radar_t *ctx, uint8_t *data_buf, uint16_t max_len );
294 
304 
314 
323 uint8_t radar_get_gpio2_pin ( radar_t *ctx );
324 
333 uint8_t radar_get_gpio1_pin ( radar_t *ctx );
334 
343 uint8_t radar_get_gpio0_pin ( radar_t *ctx );
344 
359 err_t radar_set_command ( radar_t *ctx, uint8_t cmd_id, uint8_t *payload, uint8_t payload_size );
360 
374 err_t radar_get_command ( radar_t *ctx, uint8_t cmd_id, uint8_t *payload, uint8_t *payload_size );
375 
389 err_t radar_get_event ( radar_t *ctx, uint8_t *evt_id, uint8_t *payload, uint8_t *payload_size );
390 
402 err_t radar_get_temperature ( radar_t *ctx, float *temperature );
403 
416 err_t radar_set_detection_range ( radar_t *ctx, float min, float max );
417 
429 
436 void radar_float_ieee_to_mchip ( float *f_data );
437 
444 void radar_float_mchip_to_ieee ( float *f_data );
445 
446 #ifdef __cplusplus
447 }
448 #endif
449 #endif // RADAR_H
450  // radar
452 
453 // ------------------------------------------------------------------------ END
radar_get_gpio1_pin
uint8_t radar_get_gpio1_pin(radar_t *ctx)
Radar get gpio 1 pin function.
radar_get_temperature
err_t radar_get_temperature(radar_t *ctx, float *temperature)
Radar get temperature function.
radar_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: radar.h:206
radar_float_ieee_to_mchip
void radar_float_ieee_to_mchip(float *f_data)
Radar float ieee to mchip function.
radar_t::gp2
digital_in_t gp2
Definition: radar.h:172
radar_cfg_setup
void radar_cfg_setup(radar_cfg_t *cfg)
Radar configuration object setup function.
radar_init
err_t radar_init(radar_t *ctx, radar_cfg_t *cfg)
Radar initialization function.
radar_get_gpio0_pin
uint8_t radar_get_gpio0_pin(radar_t *ctx)
Radar get gpio 0 pin function.
radar_cfg_t::gp2
pin_name_t gp2
Definition: radar.h:197
radar_t
Radar Click context object.
Definition: radar.h:167
radar_cfg_t::tx_pin
pin_name_t tx_pin
Definition: radar.h:193
radar_cfg_t::gp1
pin_name_t gp1
Definition: radar.h:198
radar_float_bytes_t::f_data
float f_data
Definition: radar.h:158
radar_get_event
err_t radar_get_event(radar_t *ctx, uint8_t *evt_id, uint8_t *payload, uint8_t *payload_size)
Radar get event function.
radar_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: radar.h:205
radar_t::gp1
digital_in_t gp1
Definition: radar.h:173
RADAR_ERROR
@ RADAR_ERROR
Definition: radar.h:217
radar_cfg_t::rx_pin
pin_name_t rx_pin
Definition: radar.h:192
radar_cfg_t
Radar Click configuration object.
Definition: radar.h:190
radar_float_mchip_to_ieee
void radar_float_mchip_to_ieee(float *f_data)
Radar float ieee to mchip function.
radar_t::uart
uart_t uart
Definition: radar.h:177
DRV_BUFFER_SIZE
#define DRV_BUFFER_SIZE
Radar driver buffer size.
Definition: radar.h:122
radar_set_detection_range
err_t radar_set_detection_range(radar_t *ctx, float min, float max)
Radar set detection range function.
radar_t::gp0
digital_in_t gp0
Definition: radar.h:174
radar_get_gpio2_pin
uint8_t radar_get_gpio2_pin(radar_t *ctx)
Radar get gpio 2 pin function.
radar_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: radar.h:204
radar_cfg_t::gp0
pin_name_t gp0
Definition: radar.h:199
radar_generic_read
err_t radar_generic_read(radar_t *ctx, uint8_t *data_buf, uint16_t max_len)
Radar data reading function.
RADAR_OK
@ RADAR_OK
Definition: radar.h:216
radar_set_command
err_t radar_set_command(radar_t *ctx, uint8_t cmd_id, uint8_t *payload, uint8_t payload_size)
Radar set command function.
radar_t::rst
digital_out_t rst
Definition: radar.h:169
radar_cfg_t::baud_rate
uint32_t baud_rate
Definition: radar.h:202
radar_enable_device
void radar_enable_device(radar_t *ctx)
Radar enable device function.
radar_cfg_t::rst
pin_name_t rst
Definition: radar.h:196
radar_float_bytes_t
Radar Click float bytes type object.
Definition: radar.h:156
radar_disable_device
void radar_disable_device(radar_t *ctx)
Radar disable device function.
radar_generic_write
err_t radar_generic_write(radar_t *ctx, uint8_t *data_buf, uint16_t len)
Radar data writing function.
radar_get_command
err_t radar_get_command(radar_t *ctx, uint8_t cmd_id, uint8_t *payload, uint8_t *payload_size)
Radar get command function.
radar_return_value_t
radar_return_value_t
Radar Click return value data.
Definition: radar.h:215
radar_cfg_t::uart_blocking
bool uart_blocking
Definition: radar.h:203
radar_default_cfg
err_t radar_default_cfg(radar_t *ctx)
Radar default configuration function.
radar_reset_config
err_t radar_reset_config(radar_t *ctx)
Radar reset config function.