lightranger7  2.1.0.0
lightranger7.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 LIGHTRANGER7_H
29 #define LIGHTRANGER7_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 LIGHTRANGER7_CMD_START 's'
70 #define LIGHTRANGER7_CMD_STOP 'p'
71 
77 #define LIGHTRANGER7_TX_DRV_BUFFER_SIZE 100
78 #define LIGHTRANGER7_RX_DRV_BUFFER_SIZE 1000
79  // lightranger7_cmd
81 
96 #define LIGHTRANGER7_MAP_MIKROBUS( cfg, mikrobus ) \
97  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
98  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
99  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX );
100  // lightranger7_map // lightranger7
103 
108 typedef struct
109 {
110  // Output pins
111  digital_out_t rst;
113  // Modules
114  uart_t uart;
116  // Buffers
117  uint8_t uart_rx_buffer[ LIGHTRANGER7_RX_DRV_BUFFER_SIZE ];
118  uint8_t uart_tx_buffer[ LIGHTRANGER7_TX_DRV_BUFFER_SIZE ];
121 
126 typedef struct
127 {
128  // Communication gpio pins
129  pin_name_t rx_pin;
130  pin_name_t tx_pin;
131  pin_name_t rst;
133  // Static variable
134  uint32_t baud_rate;
136  uart_data_bits_t data_bit;
137  uart_parity_t parity_bit;
138  uart_stop_bits_t stop_bit;
141 
146 typedef enum
147 {
149  LIGHTRANGER7_ERROR = -1
150 
152 
169 
184 
197 err_t lightranger7_generic_write ( lightranger7_t *ctx, uint8_t *data_in, uint16_t len );
198 
211 err_t lightranger7_generic_read ( lightranger7_t *ctx, uint8_t *data_out, uint16_t len );
212 
225 
238 
248 
258 
268 
269 #ifdef __cplusplus
270 }
271 #endif
272 #endif // LIGHTRANGER7_H
273  // lightranger7
275 
276 // ------------------------------------------------------------------------ END
lightranger7_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: lightranger7.h:136
lightranger7_t::rst
digital_out_t rst
Definition: lightranger7.h:111
LIGHTRANGER7_RX_DRV_BUFFER_SIZE
#define LIGHTRANGER7_RX_DRV_BUFFER_SIZE
Definition: lightranger7.h:78
lightranger7_generic_write
err_t lightranger7_generic_write(lightranger7_t *ctx, uint8_t *data_in, uint16_t len)
LightRanger 7 data writing function.
lightranger7_cfg_t::rx_pin
pin_name_t rx_pin
Definition: lightranger7.h:129
lightranger7_cfg_setup
void lightranger7_cfg_setup(lightranger7_cfg_t *cfg)
LightRanger 7 configuration object setup function.
LIGHTRANGER7_ERROR
@ LIGHTRANGER7_ERROR
Definition: lightranger7.h:149
lightranger7_cfg_t
LightRanger 7 Click configuration object.
Definition: lightranger7.h:127
lightranger7_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: lightranger7.h:137
lightranger7_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: lightranger7.h:138
lightranger7_enable_device
void lightranger7_enable_device(lightranger7_t *ctx)
LightRanger 7 enable device function.
lightranger7_reset_device
void lightranger7_reset_device(lightranger7_t *ctx)
LightRanger 7 reset device function.
lightranger7_cfg_t::tx_pin
pin_name_t tx_pin
Definition: lightranger7.h:130
lightranger7_cfg_t::uart_blocking
bool uart_blocking
Definition: lightranger7.h:135
lightranger7_return_value_t
lightranger7_return_value_t
LightRanger 7 Click return value data.
Definition: lightranger7.h:147
lightranger7_generic_read
err_t lightranger7_generic_read(lightranger7_t *ctx, uint8_t *data_out, uint16_t len)
LightRanger 7 data reading function.
lightranger7_init
err_t lightranger7_init(lightranger7_t *ctx, lightranger7_cfg_t *cfg)
LightRanger 7 initialization function.
lightranger7_cfg_t::rst
pin_name_t rst
Definition: lightranger7.h:131
lightranger7_disable_device
void lightranger7_disable_device(lightranger7_t *ctx)
LightRanger 7 disable device function.
LIGHTRANGER7_TX_DRV_BUFFER_SIZE
#define LIGHTRANGER7_TX_DRV_BUFFER_SIZE
LightRanger 7 driver buffer size.
Definition: lightranger7.h:77
lightranger7_t::uart
uart_t uart
Definition: lightranger7.h:114
lightranger7_start_measurement
err_t lightranger7_start_measurement(lightranger7_t *ctx)
LightRanger 7 start measurement function.
lightranger7_t
LightRanger 7 Click context object.
Definition: lightranger7.h:109
lightranger7_stop_measurement
err_t lightranger7_stop_measurement(lightranger7_t *ctx)
LightRanger 7 stop measurement function.
lightranger7_cfg_t::baud_rate
uint32_t baud_rate
Definition: lightranger7.h:134
LIGHTRANGER7_OK
@ LIGHTRANGER7_OK
Definition: lightranger7.h:148