loadcell5.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 LOADCELL5_H
#define LOADCELL5_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_spi_master.h"
    
    
#define LOADCELL5_MODE_POWER_DOWN             0x00
#define LOADCELL5_MODE_POWER_UP               0x01
 
 // pwr_mode
 
#define LOADCELL5_UPDATE_RATE_16_7_Hz         0x00
#define LOADCELL5_UPDATE_RATE_10_Hz           0x01
 
 // fil_sel
 
#define LOADCELL5_GAIN_1                        1
#define LOADCELL5_GAIN_128                    128
 
 // gain
 
 
 // loadcell5_set
 
#define LOADCELL5_NEW_DATA_IS_AVAILABLE         0
#define LOADCELL5_NO_DATA                       1
 
 // check_data_ready
 
#define LOADCELL5_STATUS_PAT_ADC_PERFORMED_NOT_CORRECTLY           0x00
#define LOADCELL5_STATUS_PAT_ADC_PERFORMED_CORRECTLY               0x01
#define LOADCELL5_STATUS_GAIN_128                                  0x00
#define LOADCELL5_STATUS_GAIN_1                                    0x04
#define LOADCELL5_STATUS_BITS_ID_0                                 0x08
#define LOADCELL5_STATUS_BITS_ID_1                                 0x10    
#define LOADCELL5_STATUS_ERROR                                     0x20
#define LOADCELL5_STATUS_FILTER_UPDATE_RATE_16_7_HZ                0x00
#define LOADCELL5_STATUS_FILTER_UPDATE_RATE_10_HZ                  0x40
#define LOADCELL5_STATUS_CONVERSION_NOT_AVAILABLE                  0x80
#define LOADCELL5_STATUS_CONVERSION_IS_AVAILABLE                   0x00
#define LOADCELL5_STATUS_CONVERSION_NOT_AVAILABLE                  0x80
 
#define LOADCELL5_DATA_NO_DATA                                     0
#define LOADCELL5_DATA_OK                                          1   
 
 // status
 
 
 // loadcell5_get
 
#define LOADCELL5_WEIGHT_ZERO                                      0
#define LOADCELL5_WEIGHT_100G                                      100
#define LOADCELL5_WEIGHT_500G                                      500
#define LOADCELL5_WEIGHT_1000G                                     1000
#define LOADCELL5_WEIGHT_5000G                                     5000
#define LOADCELL5_WEIGHT_10000G                                    10000
 
 // weight
 
#define LOADCELL5_STATUS_PAT_ADC_PERFORMED_NOT_CORRECTLY           0x00
#define LOADCELL5_STATUS_PAT_ADC_PERFORMED_CORRECTLY               0x01
#define LOADCELL5_STATUS_GAIN_128                                  0x00
#define LOADCELL5_STATUS_GAIN_1                                    0x04
#define LOADCELL5_STATUS_BITS_ID_0                                 0x08
#define LOADCELL5_STATUS_BITS_ID_1                                 0x10    
#define LOADCELL5_STATUS_ERROR                                     0x20
#define LOADCELL5_STATUS_FILTER_UPDATE_RATE_16_7_HZ                0x00
#define LOADCELL5_STATUS_FILTER_UPDATE_RATE_10_HZ                  0x40
#define LOADCELL5_STATUS_CONVERSION_NOT_AVAILABLE                  0x80
#define LOADCELL5_STATUS_CONVERSION_IS_AVAILABLE                   0x00
#define LOADCELL5_STATUS_CONVERSION_NOT_AVAILABLE                  0x80
 
 // status
 
 
 // loadcell5_cfg_data
 
#define LOADCELL5_MAP_MIKROBUS( cfg, mikrobus )     \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK );  \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS );   \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );   \
    cfg.gn = MIKROBUS( mikrobus, MIKROBUS_PWM );    \
    cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // loadcell5_map
 // loadcell5
 
typedef struct
{
    // Output pins
 
     digital_out_t  rst;     
     digital_out_t  gn;      
    // Input pins
 
    digital_in_t  rdy;       
    // Modules
 
    spi_master_t  spi;       
    pin_name_t  chip_select; 
} loadcell5_t;
 
typedef struct
{
    // Communication gpio pins
 
    pin_name_t  miso;       
    pin_name_t  mosi;       
    pin_name_t  sck;        
    pin_name_t  cs;         
    // Additional gpio pins
 
    pin_name_t  rst;        
    pin_name_t  gn;         
    pin_name_t  rdy;        
    // static variable
 
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} loadcell5_cfg_t;
 
typedef struct
{
    float tare;
    uint8_t tare_ok;
    float weight_coeff_100g;
    uint8_t weight_data_100g_ok;
    float weight_coeff_500g;
    uint8_t weight_data_500g_ok;
    float weight_coeff_1000g;
    uint8_t weight_data_1000g_ok;
    float weight_coeff_5000g;
    uint8_t weight_data_5000g_ok;
    float weight_coeff_10000g;
    uint8_t weight_data_10000g_ok;
}
loadcell5_data_t;
 
typedef enum
{
    LOADCELL5_OK = 0,
    LOADCELL5_ERROR = -1
 
} loadcell5_return_value_t;
 
void loadcell5_cfg_setup ( loadcell5_cfg_t *cfg );
 
err_t loadcell5_init ( loadcell5_t *ctx, loadcell5_cfg_t *cfg );
 
err_t loadcell5_default_cfg ( loadcell5_t *ctx );
 
err_t loadcell5_set_power_mode ( loadcell5_t *ctx, uint8_t pwr_mode );
 
void loadcell5_hw_reset ( loadcell5_t *ctx );
 
err_t loadcell5_filter_select ( loadcell5_t *ctx, uint8_t fil_sel );
 
err_t loadcell5_set_gain ( loadcell5_t *ctx, uint8_t gain );
 
err_t loadcell5_get_data ( loadcell5_t *ctx, uint8_t *status, uint32_t *adc_data );
 
uint32_t loadcell5_read_adc ( loadcell5_t *ctx );
 
void loadcell5_tare ( loadcell5_t *ctx, loadcell5_data_t *cell_data );
 
err_t loadcell5_calibration ( loadcell5_t *ctx, uint16_t cal_val, loadcell5_data_t *cell_data );
 
float loadcell5_get_weight ( loadcell5_t *ctx, loadcell5_data_t *cell_data );
 
uint8_t loadcell5_check_data_ready ( loadcell5_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // LOADCELL5_H
 
 // loadcell5
 
// ------------------------------------------------------------------------ END