speedradar  2.1.0.0
speedradar.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 SPEEDRADAR_H
29 #define SPEEDRADAR_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
59 #define SPEEDRADAR_CMD_PREFIX "$"
60 #define SPEEDRADAR_CMD_ENTER "\r\n"
61 #define SPEEDRADAR_CMD_RSP_PREFIX_VAL 0x40
62 #define SPEEDRADAR_ASCII_CHAR_0 48
63 #define SPEEDRADAR_NO_DET 0
64 #define SPEEDRADAR_MLP_TENS 10
65 #define SPEEDRADAR_MLP_HUNDREDS 100
66 
72 #define SPEEDRADAR_CMD_SAMPLING_RATE "S04"
73 #define SPEEDRADAR_CMD_START_UP_LEARN "S05"
74 #define SPEEDRADAR_CMD_FUN_MISC_OUT "S06"
75 #define SPEEDRADAR_CMD_THOLD_OFFSET_MIN "S07"
76 #define SPEEDRADAR_CMD_THOLD_OFFSET_MAX "S08"
77 #define SPEEDRADAR_CMD_THOLD_NOISE "S09"
78 #define SPEEDRADAR_CMD_FFT_AVERAGE "S0A"
79 #define SPEEDRADAR_CMD_SENS_POT "S0B"
80 #define SPEEDRADAR_CMD_HOLD_TIME_POT "S0C"
81 #define SPEEDRADAR_CMD_MICRO_DETECTION "S0D"
82 
88 #define SPEEDRADAR_CMD_HOLD_TIME "D00"
89 #define SPEEDRADAR_CMD_SENSITIVITY "D01"
90 #define SPEEDRADAR_CMD_IMMUNITY "D02"
91 #define SPEEDRADAR_CMD_DIR_DETECT "D03"
92 #define SPEEDRADAR_CMD_SPEED_LIM_LOW "D04"
93 #define SPEEDRADAR_CMD_SPEED_LIM_HIGH "D05"
94 #define SPEEDRADAR_CMD_THOLD_SPEED_RANGE "D06"
95 #define SPEEDRADAR_CMD_THOLD_MICRO_DET "D07"
96 #define SPEEDRADAR_CMD_FFT_FILTER_WIDTH "D08"
97 
103 #define SPEEDRADAR_CMD_HOLD_TIME_0 "A00"
104 #define SPEEDRADAR_CMD_HOLD_TIME_1 "A01"
105 #define SPEEDRADAR_CMD_HOLD_TIME_2 "A02"
106 #define SPEEDRADAR_CMD_HOLD_TIME_3 "A03"
107 #define SPEEDRADAR_CMD_HOLD_TIME_4 "A04"
108 #define SPEEDRADAR_CMD_HOLD_TIME_5 "A05"
109 #define SPEEDRADAR_CMD_HOLD_TIME_6 "A06"
110 #define SPEEDRADAR_CMD_HOLD_TIME_7 "A07"
111 #define SPEEDRADAR_CMD_HOLD_TIME_8 "A08"
112 #define SPEEDRADAR_CMD_HOLD_TIME_9 "A09"
113 #define SPEEDRADAR_CMD_HOLD_TIME_10 "A10"
114 #define SPEEDRADAR_CMD_HOLD_TIME_11 "A11"
115 #define SPEEDRADAR_CMD_HOLD_TIME_12 "A12"
116 #define SPEEDRADAR_CMD_HOLD_TIME_13 "A13"
117 #define SPEEDRADAR_CMD_HOLD_TIME_14 "A14"
118 #define SPEEDRADAR_CMD_HOLD_TIME_15 "A15"
119 #define SPEEDRADAR_CMD_HOLD_TIME_16 "A16"
120 #define SPEEDRADAR_CMD_HOLD_TIME_17 "A17"
121 #define SPEEDRADAR_CMD_HOLD_TIME_18 "A18"
122 #define SPEEDRADAR_CMD_HOLD_TIME_19 "A19"
123 #define SPEEDRADAR_CMD_HOLD_TIME_20 "A20"
124 #define SPEEDRADAR_CMD_HOLD_TIME_21 "A21"
125 #define SPEEDRADAR_CMD_HOLD_TIME_22 "A22"
126 #define SPEEDRADAR_CMD_HOLD_TIME_23 "A23"
127 #define SPEEDRADAR_CMD_HOLD_TIME_24 "A24"
128 #define SPEEDRADAR_CMD_HOLD_TIME_25 "A25"
129 #define SPEEDRADAR_CMD_HOLD_TIME_26 "A26"
130 #define SPEEDRADAR_CMD_HOLD_TIME_27 "A27"
131 #define SPEEDRADAR_CMD_HOLD_TIME_28 "A28"
132 #define SPEEDRADAR_CMD_HOLD_TIME_29 "A29"
133 
139 #define SPEEDRADAR_CMD_GET_SW_VERSION "F00"
140 #define SPEEDRADAR_CMD_GET_TYPE_OF_DEVICE "F01"
141 
147 #define SPEEDRADAR_CMD_GET_DET_REG "R00"
148 #define SPEEDRADAR_CMD_GET_DET_SPEED "R01"
149 #define SPEEDRADAR_CMD_GET_DET_MAG "R02"
150 #define SPEEDRADAR_CMD_GET_NOISE_LVL "R03"
151 #define SPEEDRADAR_CMD_GET_OP_STATE "R04"
152 #define SPEEDRADAR_CMD_GET_H_TIME_POT_IDX "R05"
153 #define SPEEDRADAR_CMD_GET_SENS_POT_IDX "R06"
154 
160 #define SPEEDRADAR_CMD_RESET_PROCESSOR "W00"
161 #define SPEEDRADAR_CMD_RST_FAC_STG "W01"
162 #define SPEEDRADAR_CMD_SET_UART_BAUD_RATE "W02"
163 
169 #define SPEEDRADAR_CMD_GET_DETECTION_STR "C00"
170 #define SPEEDRADAR_CMD_GET_TARGET_STR "C01"
171 #define SPEEDRADAR_CMD_GET_EEPROM "C02"
172 #define SPEEDRADAR_CMD_GET_FFT_SPECTRUM "C03"
173 #define SPEEDRADAR_CMD_GET_ADC_IQ "C04"
174 #define SPEEDRADAR_CMD_GET_ADC_IQ_ADD_PARAM "C05"
175 #define SPEEDRADAR_CMD_GET_ALL_DATA "C06"
176 
182 #define SPEEDRADAR_CMD_ACT_TEST_MODE "T00"
183 #define SPEEDRADAR_CMD_FORCE_DET_OUT "T01"
184 #define SPEEDRADAR_CMD_FORCE_MISC_OUT "T02"
185 
190 #define SPEEDRADAR_SET_SAMPLING_RATE_X1 "01"
191 #define SPEEDRADAR_SET_SAMPLING_RATE_X2 "02"
192 #define SPEEDRADAR_SET_SAMPLING_RATE_X3 "03"
193 #define SPEEDRADAR_SET_SAMPLING_RATE_X4 "04"
194 #define SPEEDRADAR_SET_SAMPLING_RATE_X5 "05"
195 #define SPEEDRADAR_SET_SAMPLING_RATE_X6 "06"
196 #define SPEEDRADAR_SET_SAMPLING_RATE_X7 "07"
197 #define SPEEDRADAR_SET_SAMPLING_RATE_X8 "08"
198 #define SPEEDRADAR_SET_SAMPLING_RATE_X9 "09"
199 #define SPEEDRADAR_SET_SAMPLING_RATE_X10 "0A"
200 
205 #define SPEEDRADAR_SET_MISC_OUT_DET "00"
206 #define SPEEDRADAR_SET_MISC_OUT_DIR "01"
207 #define SPEEDRADAR_SET_MISC_OUT_RNG "02"
208 #define SPEEDRADAR_SET_MISC_OUT_MDET "03"
209 
210 // Error messages
215 #define SPEEDRADAR_ERR_VAL_OUT_LIM "@E01"
216 #define SPEEDRADAR_ERR_PAR_NUM_NOT_EXIST "@E02"
217 #define SPEEDRADAR_ERR_CMD_NOT_EXIST "@E03"
218 #define SPEEDRADAR_ERR_WR_EEPROM "@E04"
219 #define SPEEDRADAR_ERR_CMD_FORMAT "@E05"
220 #define SPEEDRADAR_ERR_UART_COMM "@E06"
221 
227 #define SPEEDRADAR_TX_DRV_BUFFER_SIZE 100
228 #define SPEEDRADAR_RX_DRV_BUFFER_SIZE 200
229  // speedradar_cmd
231 
246 #define SPEEDRADAR_MAP_MIKROBUS( cfg, mikrobus ) \
247  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
248  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
249  cfg.dir = MIKROBUS( mikrobus, MIKROBUS_AN ); \
250  cfg.det = MIKROBUS( mikrobus, MIKROBUS_INT );
251  // speedradar_map // speedradar
254 
259 typedef struct
260 {
261  // Input pins
262  digital_in_t dir;
263  digital_in_t det;
265  // Modules
266  uart_t uart;
268  // Buffers
269  uint8_t uart_rx_buffer[ SPEEDRADAR_RX_DRV_BUFFER_SIZE ];
270  uint8_t uart_tx_buffer[ SPEEDRADAR_TX_DRV_BUFFER_SIZE ];
272 } speedradar_t;
273 
278 typedef struct
279 {
280  // Communication gpio pins
281  pin_name_t rx_pin;
282  pin_name_t tx_pin;
284  // Additional gpio pins
285  pin_name_t dir;
286  pin_name_t det;
288  // Static variable
289  uint32_t baud_rate;
291  uart_data_bits_t data_bit;
292  uart_parity_t parity_bit;
293  uart_stop_bits_t stop_bit;
296 
301 typedef enum
302 {
304  SPEEDRADAR_ERROR = -1
305 
307 
324 
339 
353 
366 err_t speedradar_generic_write ( speedradar_t *ctx, uint8_t *data_in, uint16_t len );
367 
380 err_t speedradar_generic_read ( speedradar_t *ctx, uint8_t *data_out, uint16_t len );
381 
395 err_t speedradar_send_command ( speedradar_t *ctx, uint8_t *cmd );
396 
411 err_t speedradar_send_command_value ( speedradar_t *ctx, uint8_t *cmd, uint8_t *cmd_value );
412 
430 
442 
443 #ifdef __cplusplus
444 }
445 #endif
446 #endif // SPEEDRADAR_H
447  // speedradar
449 
450 // ------------------------------------------------------------------------ END
speedradar_cfg_t::dir
pin_name_t dir
Definition: speedradar.h:285
speedradar_cfg_t::det
pin_name_t det
Definition: speedradar.h:286
speedradar_get_direction
uint8_t speedradar_get_direction(speedradar_t *ctx)
Speed Radar get direction function.
speedradar_cfg_t::tx_pin
pin_name_t tx_pin
Definition: speedradar.h:282
SPEEDRADAR_OK
@ SPEEDRADAR_OK
Definition: speedradar.h:303
speedradar_cfg_setup
void speedradar_cfg_setup(speedradar_cfg_t *cfg)
Speed Radar configuration object setup function.
speedradar_t
Speed Radar Click context object.
Definition: speedradar.h:260
speedradar_default_cfg
err_t speedradar_default_cfg(speedradar_t *ctx)
Speed Radar default configuration function.
speedradar_generic_read
err_t speedradar_generic_read(speedradar_t *ctx, uint8_t *data_out, uint16_t len)
Speed Radar data reading function.
speedradar_send_command
err_t speedradar_send_command(speedradar_t *ctx, uint8_t *cmd)
Speed Radar send command function.
speedradar_init
err_t speedradar_init(speedradar_t *ctx, speedradar_cfg_t *cfg)
Speed Radar initialization function.
speedradar_t::uart
uart_t uart
Definition: speedradar.h:266
SPEEDRADAR_ERROR
@ SPEEDRADAR_ERROR
Definition: speedradar.h:304
speedradar_send_command_value
err_t speedradar_send_command_value(speedradar_t *ctx, uint8_t *cmd, uint8_t *cmd_value)
Speed Radar send command function.
SPEEDRADAR_RX_DRV_BUFFER_SIZE
#define SPEEDRADAR_RX_DRV_BUFFER_SIZE
Definition: speedradar.h:228
speedradar_cfg_t
Speed Radar Click configuration object.
Definition: speedradar.h:279
speedradar_t::dir
digital_in_t dir
Definition: speedradar.h:262
SPEEDRADAR_TX_DRV_BUFFER_SIZE
#define SPEEDRADAR_TX_DRV_BUFFER_SIZE
Speed Radar driver buffer size.
Definition: speedradar.h:227
speedradar_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: speedradar.h:293
speedradar_get_detection
uint8_t speedradar_get_detection(speedradar_t *ctx)
Speed Radar get detection function.
speedradar_cfg_t::uart_blocking
bool uart_blocking
Definition: speedradar.h:290
speedradar_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: speedradar.h:292
speedradar_cfg_t::rx_pin
pin_name_t rx_pin
Definition: speedradar.h:281
speedradar_return_value_t
speedradar_return_value_t
Speed Radar Click return value data.
Definition: speedradar.h:302
speedradar_generic_write
err_t speedradar_generic_write(speedradar_t *ctx, uint8_t *data_in, uint16_t len)
Speed Radar data writing function.
speedradar_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: speedradar.h:291
speedradar_t::det
digital_in_t det
Definition: speedradar.h:263
speedradar_cfg_t::baud_rate
uint32_t baud_rate
Definition: speedradar.h:289