ultrasonic5  2.1.0.0
ultrasonic5.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 ULTRASONIC5_H
29 #define ULTRASONIC5_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_spi_master.h"
38 #include "spi_specifics.h"
39 #include "drv_analog_in.h"
40 #include "drv_pwm.h"
41 
62 #define ULTRASONIC5_REG_BPF_CONFIG_1 0x10
63 #define ULTRASONIC5_REG_BPF_CONFIG_2 0x11
64 #define ULTRASONIC5_REG_DEV_CTRL_1 0x12
65 #define ULTRASONIC5_REG_DEV_CTRL_2 0x13
66 #define ULTRASONIC5_REG_DEV_CTRL_3 0x14
67 #define ULTRASONIC5_REG_VDRV_CTRL 0x16
68 #define ULTRASONIC5_REG_ECHO_INT_CONFIG 0x17
69 #define ULTRASONIC5_REG_ZC_CONFIG 0x18
70 #define ULTRASONIC5_REG_BURST_PULSE 0x1A
71 #define ULTRASONIC5_REG_TOF_CONFIG 0x1B
72 #define ULTRASONIC5_REG_DEV_STAT 0x1C
73 #define ULTRASONIC5_REG_DEVICE_ID 0x1D
74 #define ULTRASONIC5_REG_REV_ID 0x1E
75  // ultrasonic5_reg
77 
92 #define ULTRASONIC5_BPF_CONFIG_1_FC_TRIM_FRC 0x80
93 #define ULTRASONIC5_BPF_CONFIG_1_BYPASS 0x40
94 #define ULTRASONIC5_BPF_CONFIG_1_HPF_FREQ_MASK 0x3F
95 #define ULTRASONIC5_BPF_CONFIG_1_RESET 0x00
96 
101 #define ULTRASONIC5_BPF_CONFIG_2_Q_SEL_4 0x00
102 #define ULTRASONIC5_BPF_CONFIG_2_Q_SEL_5 0x10
103 #define ULTRASONIC5_BPF_CONFIG_2_Q_SEL_2 0x20
104 #define ULTRASONIC5_BPF_CONFIG_2_Q_SEL_3 0x30
105 #define ULTRASONIC5_BPF_CONFIG_2_Q_SEL_MASK 0x30
106 #define ULTRASONIC5_BPF_CONFIG_2_FC_TRIM_MASK 0x0F
107 #define ULTRASONIC5_BPF_CONFIG_2_RESET 0x00
108 
113 #define ULTRASONIC5_DEV_CTRL_1_LOGAMP_FRC 0x80
114 #define ULTRASONIC5_DEV_CTRL_1_LOGAMP_SLP_ADJ_MASK 0x70
115 #define ULTRASONIC5_DEV_CTRL_1_LOGAMP_INT_ADJ_MASK 0x0F
116 #define ULTRASONIC5_DEV_CTRL_1_RESET 0x00
117 
122 #define ULTRASONIC5_DEV_CTRL_2_LOGAMP_DIS_FIRST 0x80
123 #define ULTRASONIC5_DEV_CTRL_2_LOGAMP_DIS_LAST 0x40
124 #define ULTRASONIC5_DEV_CTRL_2_VOUT_SCALE_SEL_5V 0x04
125 #define ULTRASONIC5_DEV_CTRL_2_LNA_GAIN_15V 0x00
126 #define ULTRASONIC5_DEV_CTRL_2_LNA_GAIN_10V 0x01
127 #define ULTRASONIC5_DEV_CTRL_2_LNA_GAIN_20V 0x02
128 #define ULTRASONIC5_DEV_CTRL_2_LNA_GAIN_12_5V 0x03
129 #define ULTRASONIC5_DEV_CTRL_2_LNA_GAIN_MASK 0x03
130 #define ULTRASONIC5_DEV_CTRL_2_RESET 0x00
131 
136 #define ULTRASONIC5_DEV_CTRL_3_DRV_PLS_FLT_DT_64US 0x00
137 #define ULTRASONIC5_DEV_CTRL_3_DRV_PLS_FLT_DT_48US 0x04
138 #define ULTRASONIC5_DEV_CTRL_3_DRV_PLS_FLT_DT_32US 0x08
139 #define ULTRASONIC5_DEV_CTRL_3_DRV_PLS_FLT_DT_24US 0x0C
140 #define ULTRASONIC5_DEV_CTRL_3_DRV_PLS_FLT_DT_16US 0x10
141 #define ULTRASONIC5_DEV_CTRL_3_DRV_PLS_FLT_DT_8US 0x14
142 #define ULTRASONIC5_DEV_CTRL_3_DRV_PLS_FLT_DT_4US 0x18
143 #define ULTRASONIC5_DEV_CTRL_3_DRV_PLS_FLT_DT_DIS 0x1C
144 #define ULTRASONIC5_DEV_CTRL_3_DRV_PLS_FLT_DT_MASK 0x1C
145 #define ULTRASONIC5_DEV_CTRL_3_IO_MODE_0 0x00
146 #define ULTRASONIC5_DEV_CTRL_3_IO_MODE_1 0x01
147 #define ULTRASONIC5_DEV_CTRL_3_IO_MODE_2 0x02
148 #define ULTRASONIC5_DEV_CTRL_3_IO_MODE_3 0x03
149 #define ULTRASONIC5_DEV_CTRL_3_IO_MODE_MASK 0x03
150 #define ULTRASONIC5_DEV_CTRL_3_RESET 0x00
151 
156 #define ULTRASONIC5_VDRV_CTRL_DIS_VDRV_REG_LSTN 0x40
157 #define ULTRASONIC5_VDRV_CTRL_VDRV_HI_Z 0x20
158 #define ULTRASONIC5_VDRV_CTRL_VDRV_CURR_LVL_20MA 0x10
159 #define ULTRASONIC5_VDRV_CTRL_VDRV_VOLT_LVL_5V 0x00
160 #define ULTRASONIC5_VDRV_CTRL_VDRV_VOLT_LVL_MASK 0x0F
161 #define ULTRASONIC5_VDRV_CTRL_RESET 0x20
162 
167 #define ULTRASONIC5_ECHO_INT_CONFIG_CMP_EN 0x10
168 #define ULTRASONIC5_ECHO_INT_CONFIG_THR_SEL_MASK 0x0F
169 #define ULTRASONIC5_ECHO_INT_CONFIG_RESET 0x07
170 
175 #define ULTRASONIC5_ZC_CONFIG_CMP_EN 0x80
176 #define ULTRASONIC5_ZC_CONFIG_EN_ECHO_INT 0x40
177 #define ULTRASONIC5_ZC_CONFIG_CMP_IN_SEL 0x20
178 #define ULTRASONIC5_ZC_CONFIG_CMP_STG_SEL_MASK 0x18
179 #define ULTRASONIC5_ZC_CONFIG_CMP_HYST_MASK 0x07
180 #define ULTRASONIC5_ZC_CONFIG_RESET 0x14
181 
186 #define ULTRASONIC5_BURST_PULSE_HALF_BRG_MODE 0x80
187 #define ULTRASONIC5_BURST_PULSE_PRE_DRIVER_MODE 0x40
188 #define ULTRASONIC5_BURST_PULSE_BURST_PULSE_16 0x0F
189 #define ULTRASONIC5_BURST_PULSE_BURST_PULSE_MASK 0x3F
190 #define ULTRASONIC5_BURST_PULSE_RESET 0x00
191 
196 #define ULTRASONIC5_TOF_CONFIG_SLEEP_MODE_EN 0x80
197 #define ULTRASONIC5_TOF_CONFIG_STDBY_MODE_EN 0x40
198 #define ULTRASONIC5_TOF_CONFIG_VDRV_TRIGGER 0x02
199 #define ULTRASONIC5_TOF_CONFIG_CMD_TRIGGER 0x01
200 #define ULTRASONIC5_TOF_CONFIG_RESET 0x00
201 
206 #define ULTRASONIC5_DEF_FREQ 40000
207 #define ULTRASONIC5_DEF_DYTY 0.5f
208 
213 #define ULTRASONIC5_DEVICE_ID 0xB9
214 
219 #define ULTRASONIC5_ODD_PARITY 0x01
220 
229 #define ULTRASONIC5_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
230 #define ULTRASONIC5_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
231  // ultrasonic5_set
233 
248 #define ULTRASONIC5_MAP_MIKROBUS( cfg, mikrobus ) \
249  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
250  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
251  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
252  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
253  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
254  cfg.io1 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
255  cfg.io2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
256  cfg.out4 = MIKROBUS( mikrobus, MIKROBUS_INT )
257  // ultrasonic5_map // ultrasonic5
260 
265 typedef struct
266 {
267  // Output pins
268  digital_out_t io1;
270  // Input pins
271  digital_in_t out4;
273  // Modules
274  spi_master_t spi;
275  analog_in_t adc;
276  pwm_t pwm;
278  // ctx variable
279  uint32_t pwm_freq;
280  pin_name_t chip_select;
282 } ultrasonic5_t;
283 
288 typedef struct
289 {
290  // Communication gpio pins
291  pin_name_t miso;
292  pin_name_t mosi;
293  pin_name_t sck;
294  pin_name_t cs;
295  pin_name_t an;
296  pin_name_t io2;
298  // Additional gpio pins
299  pin_name_t io1;
300  pin_name_t out4;
302  uint32_t spi_speed;
303  spi_master_mode_t spi_mode;
304  spi_master_chip_select_polarity_t cs_polarity;
306  analog_in_resolution_t resolution;
307  float vref;
309  uint32_t dev_pwm_freq;
312 
317 typedef enum
318 {
320  ULTRASONIC5_ERROR = -1
321 
323 
340 
355 
369 
382 err_t ultrasonic5_write_register ( ultrasonic5_t *ctx, uint8_t reg, uint8_t data_in );
383 
396 err_t ultrasonic5_read_register ( ultrasonic5_t *ctx, uint8_t reg, uint8_t *data_out );
397 
409 
419 
429 
439 
451 err_t ultrasonic5_read_an_pin_value ( ultrasonic5_t *ctx, uint16_t *data_out );
452 
466 err_t ultrasonic5_read_an_pin_voltage ( ultrasonic5_t *ctx, float *data_out );
467 
479 err_t ultrasonic5_set_duty_cycle ( ultrasonic5_t *ctx, float duty_cycle );
480 
492 
504 
505 #ifdef __cplusplus
506 }
507 #endif
508 #endif // ULTRASONIC5_H
509  // ultrasonic5
511 
512 // ------------------------------------------------------------------------ END
ultrasonic5_cfg_t
Ultrasonic 5 Click configuration object.
Definition: ultrasonic5.h:289
ultrasonic5_get_out4_pin
uint8_t ultrasonic5_get_out4_pin(ultrasonic5_t *ctx)
Ultrasonic 5 get out4 pin function.
ultrasonic5_cfg_t::mosi
pin_name_t mosi
Definition: ultrasonic5.h:292
ultrasonic5_t::out4
digital_in_t out4
Definition: ultrasonic5.h:271
ultrasonic5_read_an_pin_value
err_t ultrasonic5_read_an_pin_value(ultrasonic5_t *ctx, uint16_t *data_out)
Ultrasonic 5 read AN pin value function.
ultrasonic5_cfg_t::an
pin_name_t an
Definition: ultrasonic5.h:295
spi_specifics.h
This file contains SPI specific macros, functions, etc.
ultrasonic5_pwm_start
err_t ultrasonic5_pwm_start(ultrasonic5_t *ctx)
Ultrasonic 5 start PWM module.
ULTRASONIC5_ERROR
@ ULTRASONIC5_ERROR
Definition: ultrasonic5.h:320
ULTRASONIC5_OK
@ ULTRASONIC5_OK
Definition: ultrasonic5.h:319
ultrasonic5_default_cfg
err_t ultrasonic5_default_cfg(ultrasonic5_t *ctx)
Ultrasonic 5 default configuration function.
ultrasonic5_write_register
err_t ultrasonic5_write_register(ultrasonic5_t *ctx, uint8_t reg, uint8_t data_in)
Ultrasonic 5 data writing function.
ultrasonic5_t::pwm
pwm_t pwm
Definition: ultrasonic5.h:276
ultrasonic5_cfg_t::vref
float vref
Definition: ultrasonic5.h:307
ultrasonic5_read_register
err_t ultrasonic5_read_register(ultrasonic5_t *ctx, uint8_t reg, uint8_t *data_out)
Ultrasonic 5 data reading function.
ultrasonic5_cfg_t::resolution
analog_in_resolution_t resolution
Definition: ultrasonic5.h:306
ultrasonic5_t::spi
spi_master_t spi
Definition: ultrasonic5.h:274
ultrasonic5_cfg_t::io1
pin_name_t io1
Definition: ultrasonic5.h:299
ultrasonic5_init
err_t ultrasonic5_init(ultrasonic5_t *ctx, ultrasonic5_cfg_t *cfg)
Ultrasonic 5 initialization function.
ultrasonic5_cfg_t::miso
pin_name_t miso
Definition: ultrasonic5.h:291
ultrasonic5_pwm_stop
err_t ultrasonic5_pwm_stop(ultrasonic5_t *ctx)
Ultrasonic 5 stop PWM module.
ultrasonic5_read_an_pin_voltage
err_t ultrasonic5_read_an_pin_voltage(ultrasonic5_t *ctx, float *data_out)
Ultrasonic 5 read AN pin voltage level function.
ultrasonic5_t::chip_select
pin_name_t chip_select
Definition: ultrasonic5.h:280
ultrasonic5_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: ultrasonic5.h:309
ultrasonic5_cfg_t::io2
pin_name_t io2
Definition: ultrasonic5.h:296
ultrasonic5_cfg_t::spi_speed
uint32_t spi_speed
Definition: ultrasonic5.h:302
ultrasonic5_t
Ultrasonic 5 Click context object.
Definition: ultrasonic5.h:266
ultrasonic5_t::pwm_freq
uint32_t pwm_freq
Definition: ultrasonic5.h:279
ultrasonic5_cfg_setup
void ultrasonic5_cfg_setup(ultrasonic5_cfg_t *cfg)
Ultrasonic 5 configuration object setup function.
ultrasonic5_cfg_t::cs
pin_name_t cs
Definition: ultrasonic5.h:294
ultrasonic5_cfg_t::out4
pin_name_t out4
Definition: ultrasonic5.h:300
ultrasonic5_t::io1
digital_out_t io1
Definition: ultrasonic5.h:268
ultrasonic5_t::adc
analog_in_t adc
Definition: ultrasonic5.h:275
ultrasonic5_clear_io1_pin
void ultrasonic5_clear_io1_pin(ultrasonic5_t *ctx)
Ultrasonic 5 clear io1 pin function.
ultrasonic5_set_io1_pin
void ultrasonic5_set_io1_pin(ultrasonic5_t *ctx)
Ultrasonic 5 set io1 pin function.
ultrasonic5_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: ultrasonic5.h:304
ultrasonic5_check_communication
err_t ultrasonic5_check_communication(ultrasonic5_t *ctx)
Ultrasonic 5 check communication function.
ultrasonic5_cfg_t::sck
pin_name_t sck
Definition: ultrasonic5.h:293
ultrasonic5_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: ultrasonic5.h:303
ultrasonic5_return_value_t
ultrasonic5_return_value_t
Ultrasonic 5 Click return value data.
Definition: ultrasonic5.h:318
ultrasonic5_set_duty_cycle
err_t ultrasonic5_set_duty_cycle(ultrasonic5_t *ctx, float duty_cycle)
Ultrasonic 5 sets PWM duty cycle.