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
37#include "drv_digital_in.h"
38#include "drv_i2c_master.h"
39
40
41// -------------------------------------------------------------- PUBLIC MACROS
51#define LOADCELL2_MAP_MIKROBUS( cfg, mikrobus ) \
52 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
53 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
54 cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
61#define LOADCELL2_RETVAL uint8_t
62
63#define LOADCELL2_OK 0x00
64#define LOADCELL2_INIT_ERROR 0xFF
71#define LOADCELL2_SLAVE_ADDRESS 0x2A
78#define LOADCELL2_REG_PU_CTRL 0x00
79#define LOADCELL2_REG_CTRL1 0x01
80#define LOADCELL2_REG_CTRL2 0x02
81#define LOADCELL2_REG_OCAL1_B2 0x03
82#define LOADCELL2_REG_OCAL1_B1 0x04
83#define LOADCELL2_REG_OCAL1_B0 0x05
84#define LOADCELL2_REG_GCAL1_B3 0x06
85#define LOADCELL2_REG_GCAL1_B2 0x07
86#define LOADCELL2_REG_GCAL1_B1 0x08
87#define LOADCELL2_REG_GCAL1_B0 0x09
88#define LOADCELL2_REG_OCAL2_B2 0x0A
89#define LOADCELL2_REG_OCAL2_B1 0x0B
90#define LOADCELL2_REG_OCAL2_B0 0x0C
91#define LOADCELL2_REG_GCAL2_B3 0x0D
92#define LOADCELL2_REG_GCAL2_B2 0x0E
93#define LOADCELL2_REG_GCAL2_B0 0x0F
94#define LOADCELL2_REG_GCAL2_B1 0x10
95#define LOADCELL2_REG_I2C_CTRL 0x11
96#define LOADCELL2_REG_ADC_B2 0x12
97#define LOADCELL2_REG_ADC_B1 0x13
98#define LOADCELL2_REG_ADC_B0 0x14
99#define LOADCELL2_REG_ADC_REG 0x15
100#define LOADCELL2_REG_OTP_B1 0x16
101#define LOADCELL2_REG_OTP_B0 0x17
102#define LOADCELL2_REG_RES_00 0x18
103#define LOADCELL2_REG_RES_01 0x19
104#define LOADCELL2_REG_RES_02 0x1A
105#define LOADCELL2_REG_PGA_REG 0x1B
106#define LOADCELL2_REG_POW_CTRL 0x1C
107#define LOADCELL2_REG_RES_03 0x1D
108#define LOADCELL2_REG_RES_04 0x1E
109#define LOADCELL2_REG_REV_ID 0x1F
116#define LOADCELL2_ERROR 0x00
117#define LOADCELL2_SUCCESS 0x01
124#define LOADCELL2_AVDDS 0x80
125#define LOADCELL2_OSCS 0x40
126#define LOADCELL2_CR 0x20
127#define LOADCELL2_CS 0x10
128#define LOADCELL2_PUR 0x08
129#define LOADCELL2_PUA 0x04
130#define LOADCELL2_PUD 0x02
131#define LOADCELL2_RR 0x01
143#define LOADCELL2_GAIN_VAL_x128 128
144#define LOADCELL2_GAIN_VAL_x64 64
145#define LOADCELL2_GAIN_VAL_x32 32
146#define LOADCELL2_GAIN_VAL_x16 16
147#define LOADCELL2_GAIN_VAL_x8 8
148#define LOADCELL2_GAIN_VAL_x4 4
149#define LOADCELL2_GAIN_VAL_x2 2
150#define LOADCELL2_GAIN_VAL_x1 1
165#define LOADCELL2_CONV_RATE_SPS_320 320
166#define LOADCELL2_CONV_RATE_SPS_80 80
167#define LOADCELL2_CONV_RATE_SPS_40 40
168#define LOADCELL2_CONV_RATE_SPS_20 20
169#define LOADCELL2_CONV_RATE_SPS_10 10
178#define LOADCELL2_DATA_NO_DATA 0
179#define LOADCELL2_DATA_OK 1
186#define LOADCELL2_GET_RESULT_ERROR 0
187#define LOADCELL2_GET_RESULT_OK 1
194#define LOADCELL2_WEIGHT_100G 100
195#define LOADCELL2_WEIGHT_500G 500
196#define LOADCELL2_WEIGHT_1000G 1000
197#define LOADCELL2_WEIGHT_5000G 5000
198#define LOADCELL2_WEIGHT_10000G 10000
205#define LOADCELL2_DEFAULT_WEIGHT_SCALE_COEFFICIENT 0.088495575221 // End group macro
209// --------------------------------------------------------------- PUBLIC TYPES
218typedef struct
219{
220 //digital_out_t rdy;
221
222 // Input pins
223
224 digital_in_t rdy;
225
226 // Modules
227
228 i2c_master_t i2c;
229
230 // ctx variable
231
233
235
239typedef struct
240{
241 // Communication gpio pins
242
243 pin_name_t scl;
244 pin_name_t sda;
245
246 // Additional gpio pins
247
248 pin_name_t rdy;
249
250 // static variable
251
252 uint32_t i2c_speed;
253 uint8_t i2c_address;
254
256
260typedef struct
261{
262 float tare;
263 uint8_t tare_ok;
274}
276 // End types group
278// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
279
285#ifdef __cplusplus
286extern "C"{
287#endif
288
298
308
324
335void loadcell2_generic_write ( loadcell2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
336
347void loadcell2_generic_read ( loadcell2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
348
362
372
386
396
414void loadcell2_set_gain ( loadcell2_t *ctx, uint8_t gain_val );
415
430void loadcell2_set_sample_rate ( loadcell2_t *ctx, uint8_t rate_sps );
431
441
451
465
475
484
492uint8_t loadcell2_calibration ( loadcell2_t *ctx, uint16_t cal_val, loadcell2_data_t *cell_data );
493
502
516
517
518
519#ifdef __cplusplus
520}
521#endif
522#endif // _LOADCELL2_H_
523 // End public_function group
526
527// ------------------------------------------------------------------------- END
#define LOADCELL2_RETVAL
Definition: loadcell2.h:61
void loadcell2_cfg_setup(loadcell2_cfg_t *cfg)
Config Object Initialization function.
LOADCELL2_RETVAL loadcell2_init(loadcell2_t *ctx, loadcell2_cfg_t *cfg)
Initialization function.
uint8_t loadcell2_calibration(loadcell2_t *ctx, uint16_t cal_val, loadcell2_data_t *cell_data)
Calibration function.
void loadcell2_default_cfg(loadcell2_t *ctx)
Click Default Configuration function.
void loadcell2_set_gain(loadcell2_t *ctx, uint8_t gain_val)
Set gain function.
void loadcell2_tare(loadcell2_t *ctx, loadcell2_data_t *cell_data)
Tare function.
void loadcell2_turn_off_clk_chp(loadcell2_t *ctx)
Turn Off clk chp function.
void loadcell2_generic_write(loadcell2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
void loadcell2_calibrate_afe(loadcell2_t *ctx)
Calibrate analog front end of system function.
void loadcell2_generic_read(loadcell2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
void loadcell2_enable_dec_cap(loadcell2_t *ctx)
Enables PGA output function.
void loadcell2_set_sample_rate(loadcell2_t *ctx, uint8_t rate_sps)
Set sample rate function.
float loadcell2_get_weight(loadcell2_t *ctx, loadcell2_data_t *cell_data)
Get weight function.
uint8_t loadcell2_check_data_ready(loadcell2_t *ctx)
Check data ready function.
void loadcell2_set_ldo_voltage(loadcell2_t *ctx)
Set LDO Voltage function.
LOADCELL2_RETVAL loadcell2_power_on(loadcell2_t *ctx)
Power On function.
void loadcell2_reset(loadcell2_t *ctx)
Reset function.
uint8_t loadcell2_check_drdy(loadcell2_t *ctx)
Check data ready function.
uint32_t loadcell2_get_result(loadcell2_t *ctx)
Get results function.
Click configuration structure definition.
Definition: loadcell2.h:240
uint32_t i2c_speed
Definition: loadcell2.h:252
pin_name_t scl
Definition: loadcell2.h:243
pin_name_t rdy
Definition: loadcell2.h:248
pin_name_t sda
Definition: loadcell2.h:244
uint8_t i2c_address
Definition: loadcell2.h:253
Click data structure definition.
Definition: loadcell2.h:261
float tare
Definition: loadcell2.h:262
float weight_coeff_10000g
Definition: loadcell2.h:272
uint8_t weight_data_1000g_ok
Definition: loadcell2.h:269
uint8_t weight_data_500g_ok
Definition: loadcell2.h:267
float weight_coeff_100g
Definition: loadcell2.h:264
float weight_coeff_5000g
Definition: loadcell2.h:270
uint8_t weight_data_10000g_ok
Definition: loadcell2.h:273
float weight_coeff_500g
Definition: loadcell2.h:266
uint8_t weight_data_5000g_ok
Definition: loadcell2.h:271
uint8_t tare_ok
Definition: loadcell2.h:263
uint8_t weight_data_100g_ok
Definition: loadcell2.h:265
float weight_coeff_1000g
Definition: loadcell2.h:268
Click ctx object definition.
Definition: loadcell2.h:219
i2c_master_t i2c
Definition: loadcell2.h:228
uint8_t slave_address
Definition: loadcell2.h:232
digital_in_t rdy
Definition: loadcell2.h:224