loadcell7.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 LOADCELL7_H
#define LOADCELL7_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"
#include "spi_specifics.h"
 
#define LOADCELL7_NUM_CONVERSIONS           80
 
#define LOADCELL7_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define LOADCELL7_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // loadcell7_set
 
#define LOADCELL7_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 );
 
 // loadcell7_map
 // loadcell7
 
typedef struct
{
    digital_in_t miso;              
    digital_out_t cs;               
    // Modules
    spi_master_t spi;               
    int32_t      tare_scale;        
    float        weight_scale;      
} loadcell7_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;                
    pin_name_t mosi;                
    pin_name_t sck;                 
    pin_name_t cs;                  
    // static variable
    uint32_t            spi_speed;  
    spi_master_mode_t   spi_mode;   
} loadcell7_cfg_t;
 
typedef enum
{
    LOADCELL7_OK = 0,
    LOADCELL7_ERROR = -1
 
} loadcell7_return_value_t;
 
void loadcell7_cfg_setup ( loadcell7_cfg_t *cfg );
 
err_t loadcell7_init ( loadcell7_t *ctx, loadcell7_cfg_t *cfg );
 
void loadcell7_enable_device ( loadcell7_t *ctx );
 
void loadcell7_disable_device ( loadcell7_t *ctx );
 
err_t loadcell7_read_raw_adc ( loadcell7_t *ctx, int32_t *data_out );
 
err_t loadcell7_tare_scale ( loadcell7_t *ctx );
 
err_t loadcell7_calibrate_weight ( loadcell7_t *ctx, float cal_weight );
 
err_t loadcell7_get_weight ( loadcell7_t *ctx, float *weight );
 
#ifdef __cplusplus
}
#endif
#endif // LOADCELL7_H
 
 // loadcell7
 
// ------------------------------------------------------------------------ END