loadcell7  2.1.0.0
loadcell7.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 LOADCELL7_H
29 #define LOADCELL7_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_spi_master.h"
38 #include "spi_specifics.h"
39 
60 #define LOADCELL7_NUM_CONVERSIONS 80
61 
70 #define LOADCELL7_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
71 #define LOADCELL7_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
72  // loadcell7_set
74 
89 #define LOADCELL7_MAP_MIKROBUS( cfg, mikrobus ) \
90  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
91  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
92  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
93  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
94  // loadcell7_map // loadcell7
97 
102 typedef struct
103 {
104  digital_in_t miso;
105  digital_out_t cs;
107  // Modules
108  spi_master_t spi;
110  int32_t tare_scale;
111  float weight_scale;
113 } loadcell7_t;
114 
119 typedef struct
120 {
121  // Communication gpio pins
122  pin_name_t miso;
123  pin_name_t mosi;
124  pin_name_t sck;
125  pin_name_t cs;
127  // static variable
128  uint32_t spi_speed;
129  spi_master_mode_t spi_mode;
132 
137 typedef enum
138 {
140  LOADCELL7_ERROR = -1
141 
143 
160 
175 
185 
195 
207 err_t loadcell7_read_raw_adc ( loadcell7_t *ctx, int32_t *data_out );
208 
221 
234 err_t loadcell7_calibrate_weight ( loadcell7_t *ctx, float cal_weight );
235 
248 err_t loadcell7_get_weight ( loadcell7_t *ctx, float *weight );
249 
250 #ifdef __cplusplus
251 }
252 #endif
253 #endif // LOADCELL7_H
254  // loadcell7
256 
257 // ------------------------------------------------------------------------ END
loadcell7_cfg_t
Load Cell 7 Click configuration object.
Definition: loadcell7.h:120
loadcell7_cfg_t::spi_speed
uint32_t spi_speed
Definition: loadcell7.h:128
loadcell7_t
Load Cell 7 Click context object.
Definition: loadcell7.h:103
loadcell7_cfg_t::miso
pin_name_t miso
Definition: loadcell7.h:122
LOADCELL7_OK
@ LOADCELL7_OK
Definition: loadcell7.h:139
loadcell7_cfg_t::cs
pin_name_t cs
Definition: loadcell7.h:125
loadcell7_t::spi
spi_master_t spi
Definition: loadcell7.h:108
loadcell7_get_weight
err_t loadcell7_get_weight(loadcell7_t *ctx, float *weight)
Load Cell 7 get weight function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
loadcell7_t::tare_scale
int32_t tare_scale
Definition: loadcell7.h:110
loadcell7_calibrate_weight
err_t loadcell7_calibrate_weight(loadcell7_t *ctx, float cal_weight)
Load Cell 7 calibrate weight function.
loadcell7_cfg_t::mosi
pin_name_t mosi
Definition: loadcell7.h:123
loadcell7_enable_device
void loadcell7_enable_device(loadcell7_t *ctx)
Load Cell 7 enable device function.
loadcell7_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: loadcell7.h:129
loadcell7_init
err_t loadcell7_init(loadcell7_t *ctx, loadcell7_cfg_t *cfg)
Load Cell 7 initialization function.
loadcell7_read_raw_adc
err_t loadcell7_read_raw_adc(loadcell7_t *ctx, int32_t *data_out)
Load Cell 7 read raw adc function.
loadcell7_cfg_t::sck
pin_name_t sck
Definition: loadcell7.h:124
loadcell7_tare_scale
err_t loadcell7_tare_scale(loadcell7_t *ctx)
Load Cell 7 tare scale function.
loadcell7_return_value_t
loadcell7_return_value_t
Load Cell 7 Click return value data.
Definition: loadcell7.h:138
loadcell7_cfg_setup
void loadcell7_cfg_setup(loadcell7_cfg_t *cfg)
Load Cell 7 configuration object setup function.
loadcell7_t::miso
digital_in_t miso
Definition: loadcell7.h:104
loadcell7_t::weight_scale
float weight_scale
Definition: loadcell7.h:111
loadcell7_disable_device
void loadcell7_disable_device(loadcell7_t *ctx)
Load Cell 7 disable device function.
LOADCELL7_ERROR
@ LOADCELL7_ERROR
Definition: loadcell7.h:140
loadcell7_t::cs
digital_out_t cs
Definition: loadcell7.h:105