loadcell2  2.0.0.0
loadcell2.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
32 // ----------------------------------------------------------------------------
33 
34 #ifndef LOADCELL2_H
35 #define LOADCELL2_H
36 
41 #ifdef PREINIT_SUPPORTED
42 #include "preinit.h"
43 #endif
44 
45 #ifdef MikroCCoreVersion
46  #if MikroCCoreVersion >= 1
47  #include "delays.h"
48  #endif
49 #endif
50 
51 #include "drv_digital_in.h"
52 #include "drv_i2c_master.h"
53 
54 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define LOADCELL2_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
67  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
68  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
69 
75 #define LOADCELL2_RETVAL uint8_t
76 
77 #define LOADCELL2_OK 0x00
78 #define LOADCELL2_INIT_ERROR 0xFF
79 
85 #define LOADCELL2_SLAVE_ADDRESS 0x2A
86 
92 #define LOADCELL2_REG_PU_CTRL 0x00
93 #define LOADCELL2_REG_CTRL1 0x01
94 #define LOADCELL2_REG_CTRL2 0x02
95 #define LOADCELL2_REG_OCAL1_B2 0x03
96 #define LOADCELL2_REG_OCAL1_B1 0x04
97 #define LOADCELL2_REG_OCAL1_B0 0x05
98 #define LOADCELL2_REG_GCAL1_B3 0x06
99 #define LOADCELL2_REG_GCAL1_B2 0x07
100 #define LOADCELL2_REG_GCAL1_B1 0x08
101 #define LOADCELL2_REG_GCAL1_B0 0x09
102 #define LOADCELL2_REG_OCAL2_B2 0x0A
103 #define LOADCELL2_REG_OCAL2_B1 0x0B
104 #define LOADCELL2_REG_OCAL2_B0 0x0C
105 #define LOADCELL2_REG_GCAL2_B3 0x0D
106 #define LOADCELL2_REG_GCAL2_B2 0x0E
107 #define LOADCELL2_REG_GCAL2_B0 0x0F
108 #define LOADCELL2_REG_GCAL2_B1 0x10
109 #define LOADCELL2_REG_I2C_CTRL 0x11
110 #define LOADCELL2_REG_ADC_B2 0x12
111 #define LOADCELL2_REG_ADC_B1 0x13
112 #define LOADCELL2_REG_ADC_B0 0x14
113 #define LOADCELL2_REG_ADC_REG 0x15
114 #define LOADCELL2_REG_OTP_B1 0x16
115 #define LOADCELL2_REG_OTP_B0 0x17
116 #define LOADCELL2_REG_RES_00 0x18
117 #define LOADCELL2_REG_RES_01 0x19
118 #define LOADCELL2_REG_RES_02 0x1A
119 #define LOADCELL2_REG_PGA_REG 0x1B
120 #define LOADCELL2_REG_POW_CTRL 0x1C
121 #define LOADCELL2_REG_RES_03 0x1D
122 #define LOADCELL2_REG_RES_04 0x1E
123 #define LOADCELL2_REG_REV_ID 0x1F
124 
130 #define LOADCELL2_ERROR 0x00
131 #define LOADCELL2_SUCCESS 0x01
132 
138 #define LOADCELL2_AVDDS 0x80
139 #define LOADCELL2_OSCS 0x40
140 #define LOADCELL2_CR 0x20
141 #define LOADCELL2_CS 0x10
142 #define LOADCELL2_PUR 0x08
143 #define LOADCELL2_PUA 0x04
144 #define LOADCELL2_PUD 0x02
145 #define LOADCELL2_RR 0x01
146 
157 #define LOADCELL2_GAIN_VAL_x128 128
158 #define LOADCELL2_GAIN_VAL_x64 64
159 #define LOADCELL2_GAIN_VAL_x32 32
160 #define LOADCELL2_GAIN_VAL_x16 16
161 #define LOADCELL2_GAIN_VAL_x8 8
162 #define LOADCELL2_GAIN_VAL_x4 4
163 #define LOADCELL2_GAIN_VAL_x2 2
164 #define LOADCELL2_GAIN_VAL_x1 1
165 
179 #define LOADCELL2_CONV_RATE_SPS_320 320
180 #define LOADCELL2_CONV_RATE_SPS_80 80
181 #define LOADCELL2_CONV_RATE_SPS_40 40
182 #define LOADCELL2_CONV_RATE_SPS_20 20
183 #define LOADCELL2_CONV_RATE_SPS_10 10
184 
192 #define LOADCELL2_DATA_NO_DATA 0
193 #define LOADCELL2_DATA_OK 1
194 
200 #define LOADCELL2_GET_RESULT_ERROR 0
201 #define LOADCELL2_GET_RESULT_OK 1
202 
208 #define LOADCELL2_WEIGHT_100G 100
209 #define LOADCELL2_WEIGHT_500G 500
210 #define LOADCELL2_WEIGHT_1000G 1000
211 #define LOADCELL2_WEIGHT_5000G 5000
212 #define LOADCELL2_WEIGHT_10000G 10000
213 
219 #define LOADCELL2_DEFAULT_WEIGHT_SCALE_COEFFICIENT 0.088495575221
220  // End group macro
223 // --------------------------------------------------------------- PUBLIC TYPES
232 typedef struct
233 {
234  //digital_out_t rdy;
235 
236  // Input pins
237 
238  digital_in_t rdy;
239 
240  // Modules
241 
242  i2c_master_t i2c;
243 
244  // ctx variable
245 
246  uint8_t slave_address;
247 
248 } loadcell2_t;
249 
253 typedef struct
254 {
255  // Communication gpio pins
256 
257  pin_name_t scl;
258  pin_name_t sda;
259 
260  // Additional gpio pins
261 
262  pin_name_t rdy;
263 
264  // static variable
265 
266  uint32_t i2c_speed;
267  uint8_t i2c_address;
268 
270 
274 typedef struct
275 {
276  float tare;
277  uint8_t tare_ok;
288 }
290  // End types group
292 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
293 
299 #ifdef __cplusplus
300 extern "C"{
301 #endif
302 
312 
322 
338 
349 void loadcell2_generic_write ( loadcell2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
350 
361 void loadcell2_generic_read ( loadcell2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
362 
376 
386 
400 
410 
428 void loadcell2_set_gain ( loadcell2_t *ctx, uint8_t gain_val );
429 
444 void loadcell2_set_sample_rate ( loadcell2_t *ctx, uint8_t rate_sps );
445 
455 
465 
479 
489 
497 void loadcell2_tare ( loadcell2_t *ctx, loadcell2_data_t *cell_data );
498 
506 uint8_t loadcell2_calibration ( loadcell2_t *ctx, uint16_t cal_val, loadcell2_data_t *cell_data );
507 
516 
530 
531 
532 
533 #ifdef __cplusplus
534 }
535 #endif
536 #endif // _LOADCELL2_H_
537  // End public_function group
540 
541 // ------------------------------------------------------------------------- END
loadcell2_cfg_t
Click configuration structure definition.
Definition: loadcell2.h:254
loadcell2_t::i2c
i2c_master_t i2c
Definition: loadcell2.h:242
loadcell2_data_t
Click data structure definition.
Definition: loadcell2.h:275
loadcell2_data_t::tare_ok
uint8_t tare_ok
Definition: loadcell2.h:277
loadcell2_generic_read
void loadcell2_generic_read(loadcell2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
loadcell2_default_cfg
void loadcell2_default_cfg(loadcell2_t *ctx)
Click Default Configuration function.
loadcell2_data_t::weight_coeff_100g
float weight_coeff_100g
Definition: loadcell2.h:278
loadcell2_set_ldo_voltage
void loadcell2_set_ldo_voltage(loadcell2_t *ctx)
Set LDO Voltage function.
loadcell2_get_result
uint32_t loadcell2_get_result(loadcell2_t *ctx)
Get results function.
loadcell2_reset
void loadcell2_reset(loadcell2_t *ctx)
Reset function.
loadcell2_cfg_t::scl
pin_name_t scl
Definition: loadcell2.h:257
LOADCELL2_RETVAL
#define LOADCELL2_RETVAL
Definition: loadcell2.h:75
loadcell2_generic_write
void loadcell2_generic_write(loadcell2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
loadcell2_data_t::weight_coeff_500g
float weight_coeff_500g
Definition: loadcell2.h:280
loadcell2_calibration
uint8_t loadcell2_calibration(loadcell2_t *ctx, uint16_t cal_val, loadcell2_data_t *cell_data)
Calibration function.
loadcell2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: loadcell2.h:266
loadcell2_data_t::weight_data_1000g_ok
uint8_t weight_data_1000g_ok
Definition: loadcell2.h:283
loadcell2_data_t::weight_data_5000g_ok
uint8_t weight_data_5000g_ok
Definition: loadcell2.h:285
loadcell2_cfg_t::i2c_address
uint8_t i2c_address
Definition: loadcell2.h:267
loadcell2_data_t::weight_data_100g_ok
uint8_t weight_data_100g_ok
Definition: loadcell2.h:279
loadcell2_data_t::weight_coeff_5000g
float weight_coeff_5000g
Definition: loadcell2.h:284
loadcell2_tare
void loadcell2_tare(loadcell2_t *ctx, loadcell2_data_t *cell_data)
Tare function.
loadcell2_cfg_t::sda
pin_name_t sda
Definition: loadcell2.h:258
loadcell2_cfg_t::rdy
pin_name_t rdy
Definition: loadcell2.h:262
loadcell2_set_gain
void loadcell2_set_gain(loadcell2_t *ctx, uint8_t gain_val)
Set gain function.
loadcell2_power_on
LOADCELL2_RETVAL loadcell2_power_on(loadcell2_t *ctx)
Power On function.
loadcell2_data_t::tare
float tare
Definition: loadcell2.h:276
loadcell2_t::rdy
digital_in_t rdy
Definition: loadcell2.h:238
loadcell2_data_t::weight_data_10000g_ok
uint8_t weight_data_10000g_ok
Definition: loadcell2.h:287
loadcell2_data_t::weight_coeff_1000g
float weight_coeff_1000g
Definition: loadcell2.h:282
loadcell2_turn_off_clk_chp
void loadcell2_turn_off_clk_chp(loadcell2_t *ctx)
Turn Off clk chp function.
loadcell2_init
LOADCELL2_RETVAL loadcell2_init(loadcell2_t *ctx, loadcell2_cfg_t *cfg)
Initialization function.
loadcell2_data_t::weight_data_500g_ok
uint8_t weight_data_500g_ok
Definition: loadcell2.h:281
loadcell2_cfg_setup
void loadcell2_cfg_setup(loadcell2_cfg_t *cfg)
Config Object Initialization function.
loadcell2_check_drdy
uint8_t loadcell2_check_drdy(loadcell2_t *ctx)
Check data ready function.
loadcell2_t::slave_address
uint8_t slave_address
Definition: loadcell2.h:246
loadcell2_set_sample_rate
void loadcell2_set_sample_rate(loadcell2_t *ctx, uint8_t rate_sps)
Set sample rate function.
loadcell2_calibrate_afe
void loadcell2_calibrate_afe(loadcell2_t *ctx)
Calibrate analog front end of system function.
loadcell2_data_t::weight_coeff_10000g
float weight_coeff_10000g
Definition: loadcell2.h:286
loadcell2_t
Click ctx object definition.
Definition: loadcell2.h:233
loadcell2_check_data_ready
uint8_t loadcell2_check_data_ready(loadcell2_t *ctx)
Check data ready function.
loadcell2_get_weight
float loadcell2_get_weight(loadcell2_t *ctx, loadcell2_data_t *cell_data)
Get weight function.
loadcell2_enable_dec_cap
void loadcell2_enable_dec_cap(loadcell2_t *ctx)
Enables PGA output function.