tfmini  2.0.0.0
tfmini.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 TFMINI_H
29 #define TFMINI_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_i2c_master.h"
38 #include "drv_uart.h"
39 
60 #define TFMINI_CMD_HEADER 0x5A
61 #define TFMINI_CMD_ID_FW_VERSION 0x01
62 #define TFMINI_CMD_ID_SYSTEM_RESET 0x02
63 #define TFMINI_CMD_ID_FRAME_RATE 0x03
64 #define TFMINI_CMD_ID_TRIGGER_DETECTION 0x04
65 #define TFMINI_CMD_ID_OUTPUT_FORMAT 0x05
66 #define TFMINI_CMD_ID_BAUD_RATE 0x06
67 #define TFMINI_CMD_ID_ENABLE_OUTPUT 0x07
68 #define TFMINI_CMD_ID_COM_SELECTION 0x0A
69 #define TFMINI_CMD_ID_SLAVE_ADDRESS 0x0B
70 #define TFMINI_CMD_ID_DATA_FRAME 0x00
71 #define TFMINI_CMD_ID_IO_MODE_ENABLE 0x3B
72 #define TFMINI_CMD_ID_RESTORE_FACTORY 0x10
73 #define TFMINI_CMD_ID_SAVE_SETTINGS 0x11
74 
79 #define TFMINI_HEADER 0x59
80 #define TFMINI_FRAME_SIZE 0x07
81 #define TFMINI_MAX_BYTES_BEFORE_HEADER 100
82 #define TFMINI_LOW_SIGNAL_STRENGTH -1
83 #define TFMINI_SIGNAL_STRENGTH_SATURATION -2
84 #define TFMINI_AMBIENT_LIGHT_SATURATION -4
85 #define TFMINI_NO_HEADER_FOUND -5
86 #define TFMINI_WRONG_CHECKSUM -6
87 
93 #define DRV_BUFFER_SIZE 500
94 
100 #define TFMINI_SET_DEV_ADDR 0x10
101  // tfmini_cmd
103 
118 #define TFMINI_MAP_MIKROBUS( cfg, mikrobus ) \
119  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
120  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
121  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
122  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX );
123  // tfmini_map // tfmini
126 
131 typedef enum
132 {
137 
142 typedef struct
143 {
144  uint8_t cmd_id;
145  uint8_t payload[ TFMINI_FRAME_SIZE ];
146  uint8_t payload_len;
149 
154 typedef struct
155 {
156  // Modules
157  i2c_master_t i2c;
158  uart_t uart;
160  // Buffers
161  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
162  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
164  uint8_t slave_address;
167 } tfmini_t;
168 
173 typedef struct
174 {
175  // Communication gpio pins
176  pin_name_t scl;
177  pin_name_t sda;
178  pin_name_t rx_pin;
179  pin_name_t tx_pin;
181  // Static variable
182  uint32_t baud_rate;
184  uart_data_bits_t data_bit;
185  uart_parity_t parity_bit;
186  uart_stop_bits_t stop_bit;
187  uint32_t i2c_speed;
188  uint8_t i2c_address;
192 } tfmini_cfg_t;
193 
198 typedef enum
199 {
201  TFMINI_ERROR = -1
202 
204 
221 
237 
252 err_t tfmini_init ( tfmini_t *ctx, tfmini_cfg_t *cfg );
253 
268 
283 
300 
313 err_t tfmini_get_firmware_version ( tfmini_t *ctx, uint32_t *fw_version );
314 
327 
340 err_t tfmini_set_frame_rate ( tfmini_t *ctx, uint16_t frame_rate );
341 
359 
372 
385 
404 err_t tfmini_get_measurement ( tfmini_t *ctx, int16_t *distance, int16_t *strength, float *temperature );
405 
406 #ifdef __cplusplus
407 }
408 #endif
409 #endif // TFMINI_H
410  // tfmini
412 
413 // ------------------------------------------------------------------------ END
tfmini_cfg_t::uart_blocking
bool uart_blocking
Definition: tfmini.h:183
tfmini_drv_t
tfmini_drv_t
TFmini Click driver selector.
Definition: tfmini.h:132
tfmini_factory_default
err_t tfmini_factory_default(tfmini_t *ctx)
TFmini factory default function.
tfmini_cfg_t::rx_pin
pin_name_t rx_pin
Definition: tfmini.h:178
tfmini_drv_interface_selection
void tfmini_drv_interface_selection(tfmini_cfg_t *cfg, tfmini_drv_t drv_sel)
TFmini driver interface setup function.
tfmini_change_interface
err_t tfmini_change_interface(tfmini_t *ctx, tfmini_drv_t drv_sel)
TFmini change interface function.
tfmini_get_response
err_t tfmini_get_response(tfmini_t *ctx, tfmini_frame_t *frame)
TFmini get response function.
tfmini_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: tfmini.h:186
tfmini_init
err_t tfmini_init(tfmini_t *ctx, tfmini_cfg_t *cfg)
TFmini initialization function.
tfmini_frame_t
TFmini Click command frame definition structure.
Definition: tfmini.h:143
TFMINI_DRV_SEL_UART
@ TFMINI_DRV_SEL_UART
Definition: tfmini.h:133
tfmini_cfg_setup
void tfmini_cfg_setup(tfmini_cfg_t *cfg)
TFmini configuration object setup function.
TFMINI_FRAME_SIZE
#define TFMINI_FRAME_SIZE
Definition: tfmini.h:80
tfmini_default_cfg
err_t tfmini_default_cfg(tfmini_t *ctx)
TFmini default configuration function.
tfmini_t::drv_sel
tfmini_drv_t drv_sel
Definition: tfmini.h:165
TFMINI_ERROR
@ TFMINI_ERROR
Definition: tfmini.h:201
tfmini_t::slave_address
uint8_t slave_address
Definition: tfmini.h:164
tfmini_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: tfmini.h:185
tfmini_cfg_t::sda
pin_name_t sda
Definition: tfmini.h:177
TFMINI_OK
@ TFMINI_OK
Definition: tfmini.h:200
tfmini_cfg_t::i2c_address
uint8_t i2c_address
Definition: tfmini.h:188
tfmini_cfg_t::baud_rate
uint32_t baud_rate
Definition: tfmini.h:182
tfmini_cfg_t::drv_sel
tfmini_drv_t drv_sel
Definition: tfmini.h:190
DRV_BUFFER_SIZE
#define DRV_BUFFER_SIZE
TFmini driver buffer size.
Definition: tfmini.h:93
TFMINI_DRV_SEL_I2C
@ TFMINI_DRV_SEL_I2C
Definition: tfmini.h:134
tfmini_frame_t::cmd_id
uint8_t cmd_id
Definition: tfmini.h:144
tfmini_send_frame
err_t tfmini_send_frame(tfmini_t *ctx, tfmini_frame_t frame)
TFmini send frame function.
tfmini_return_value_t
tfmini_return_value_t
TFmini Click return value data.
Definition: tfmini.h:199
tfmini_save_settings
err_t tfmini_save_settings(tfmini_t *ctx)
TFmini save settings function.
tfmini_get_firmware_version
err_t tfmini_get_firmware_version(tfmini_t *ctx, uint32_t *fw_version)
TFmini get firmware version function.
tfmini_t::uart
uart_t uart
Definition: tfmini.h:158
tfmini_cfg_t::scl
pin_name_t scl
Definition: tfmini.h:176
tfmini_set_frame_rate
err_t tfmini_set_frame_rate(tfmini_t *ctx, uint16_t frame_rate)
TFmini set frame rate function.
tfmini_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: tfmini.h:184
tfmini_cfg_t
TFmini Click configuration object.
Definition: tfmini.h:174
tfmini_t::i2c
i2c_master_t i2c
Definition: tfmini.h:157
tfmini_cfg_t::tx_pin
pin_name_t tx_pin
Definition: tfmini.h:179
tfmini_get_measurement
err_t tfmini_get_measurement(tfmini_t *ctx, int16_t *distance, int16_t *strength, float *temperature)
TFmini get measurement function.
tfmini_t
TFmini Click context object.
Definition: tfmini.h:155
tfmini_system_reset
err_t tfmini_system_reset(tfmini_t *ctx)
TFmini system reset function.
tfmini_frame_t::payload_len
uint8_t payload_len
Definition: tfmini.h:146
tfmini_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: tfmini.h:187