tfmini.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef TFMINI_H
#define TFMINI_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_uart.h"
 
#define TFMINI_CMD_HEADER                   0x5A
#define TFMINI_CMD_ID_FW_VERSION            0x01
#define TFMINI_CMD_ID_SYSTEM_RESET          0x02
#define TFMINI_CMD_ID_FRAME_RATE            0x03
#define TFMINI_CMD_ID_TRIGGER_DETECTION     0x04
#define TFMINI_CMD_ID_OUTPUT_FORMAT         0x05
#define TFMINI_CMD_ID_BAUD_RATE             0x06
#define TFMINI_CMD_ID_ENABLE_OUTPUT         0x07
#define TFMINI_CMD_ID_COM_SELECTION         0x0A
#define TFMINI_CMD_ID_SLAVE_ADDRESS         0x0B
#define TFMINI_CMD_ID_DATA_FRAME            0x00
#define TFMINI_CMD_ID_IO_MODE_ENABLE        0x3B
#define TFMINI_CMD_ID_RESTORE_FACTORY       0x10
#define TFMINI_CMD_ID_SAVE_SETTINGS         0x11
 
#define TFMINI_HEADER                       0x59
#define TFMINI_FRAME_SIZE                   0x07
#define TFMINI_MAX_BYTES_BEFORE_HEADER      100
#define TFMINI_LOW_SIGNAL_STRENGTH          -1
#define TFMINI_SIGNAL_STRENGTH_SATURATION   -2
#define TFMINI_AMBIENT_LIGHT_SATURATION     -4
#define TFMINI_NO_HEADER_FOUND              -5
#define TFMINI_WRONG_CHECKSUM               -6
 
#define DRV_BUFFER_SIZE                     500
 
#define TFMINI_SET_DEV_ADDR                 0x10
 
 // tfmini_cmd
 
#define TFMINI_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX );
 
 // tfmini_map
 // tfmini
 
typedef enum
{
    TFMINI_DRV_SEL_UART,     
    TFMINI_DRV_SEL_I2C       
} tfmini_drv_t;
 
typedef struct
{
    uint8_t cmd_id;                         
    uint8_t payload[ TFMINI_FRAME_SIZE ];   
    uint8_t payload_len;                    
} tfmini_frame_t;
 
typedef struct
{
    // Modules
    i2c_master_t i2c;                               
    uart_t       uart;                              
    // Buffers
    char uart_rx_buffer[ DRV_BUFFER_SIZE ];         
    char uart_tx_buffer[ DRV_BUFFER_SIZE ];         
    uint8_t      slave_address;                     
    tfmini_drv_t drv_sel;                           
} tfmini_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t scl;                     
    pin_name_t sda;                     
    pin_name_t rx_pin;                  
    pin_name_t tx_pin;                  
    // Static variable
    uint32_t          baud_rate;        
    bool              uart_blocking;    
    uart_data_bits_t  data_bit;         
    uart_parity_t     parity_bit;       
    uart_stop_bits_t  stop_bit;         
    uint32_t          i2c_speed;        
    uint8_t           i2c_address;      
    tfmini_drv_t      drv_sel;          
} tfmini_cfg_t;
 
typedef enum
{
    TFMINI_OK = 0,
    TFMINI_ERROR = -1
 
} tfmini_return_value_t;
 
void tfmini_cfg_setup ( tfmini_cfg_t *cfg );
 
void tfmini_drv_interface_selection ( tfmini_cfg_t *cfg, tfmini_drv_t drv_sel );
 
err_t tfmini_init ( tfmini_t *ctx, tfmini_cfg_t *cfg );
 
err_t tfmini_default_cfg ( tfmini_t *ctx );
 
err_t tfmini_send_frame ( tfmini_t *ctx, tfmini_frame_t frame );
 
err_t tfmini_get_response ( tfmini_t *ctx, tfmini_frame_t *frame );
 
err_t tfmini_get_firmware_version ( tfmini_t *ctx, uint32_t *fw_version );
 
err_t tfmini_system_reset ( tfmini_t *ctx );
 
err_t tfmini_set_frame_rate ( tfmini_t *ctx, uint16_t frame_rate );
 
err_t tfmini_change_interface ( tfmini_t *ctx, tfmini_drv_t drv_sel );
 
err_t tfmini_factory_default ( tfmini_t *ctx );
 
err_t tfmini_save_settings ( tfmini_t *ctx );
 
err_t tfmini_get_measurement ( tfmini_t *ctx, int16_t *distance, int16_t *strength, float *temperature );
 
#ifdef __cplusplus
}
#endif
#endif // TFMINI_H
 
 // tfmini
 
// ------------------------------------------------------------------------ END