force5.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 FORCE5_H
#define FORCE5_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"
 
#define FORCE5_STATES_BIT_MASK                                        0x03
#define FORCE5_STATES_NORMAL_OPERATION                                0x00
#define FORCE5_STATES_COMMAND_MODE                                    0x01
#define FORCE5_STATES_STALE_DATA                                      0x02
#define FORCE5_STATES_DIAGNOSTIC_CONDITION                            0x03
 
#define FORCE5_FORCE_SENSOR_10_N                                      10.0
#define FORCE5_FORCE_SENSOR_25_N                                      25.0
 
#define FORCE5_FORCE_MAX_VALUE                                     14745.0
 
#define FORCE5_SET_DEV_ADDR  0x28
 
 // force5_set
 
#define FORCE5_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // force5_map
 // force5
 
typedef struct
{
    // Modules
    i2c_master_t i2c;                                
    // I2C slave address
    uint8_t slave_address;                           
} force5_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    uint32_t  i2c_speed;                                
    uint8_t   i2c_address;                              
} force5_cfg_t;
 
typedef struct
{
    uint8_t status_data;
    uint16_t force_data;
    uint16_t temp_data;
}force5_data_t;
 
typedef struct
{
    uint16_t force_claib_data;
}force5_calibration_t; 
 
typedef enum
{
   FORCE5_OK = 0,
   FORCE5_ERROR = -1
 
} force5_return_value_t;
 
void force5_cfg_setup ( force5_cfg_t *cfg );
 
err_t force5_init ( force5_t *ctx, force5_cfg_t *cfg );
 
err_t force5_generic_write ( force5_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t force5_generic_read ( force5_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t force5_read_byte ( force5_t *ctx, uint8_t *rx_data, uint8_t n_bytes );
 
void force5_read_all_data ( force5_t *ctx, force5_data_t *force_data );
 
uint8_t force5_get_force_value ( force5_t *ctx, uint16_t *force );
 
uint8_t force5_get_temperature_value ( force5_t *ctx, uint16_t *temp );
 
uint8_t force5_calibration ( force5_t *ctx, force5_calibration_t *calib_data );
 
float force5_get_force ( force5_t *ctx, force5_calibration_t calib_data );
 
float force5_get_temperature ( force5_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // FORCE5_H
 
 // force5
 
// ------------------------------------------------------------------------ END