loadcell4  2.0.0.0
loadcell4.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 LOADCELL4_H
29 #define LOADCELL4_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_i2c_master.h"
38 
59 #define LOADCELL4_GET_RESULT_ERROR 0
60 #define LOADCELL4_GET_RESULT_OK 1
61 #define LOADCELL4_DATA_NO_DATA 0
62 #define LOADCELL4_DATA_OK 1
63 #define LOADCELL4_WEIGHT_100G 100
64 #define LOADCELL4_WEIGHT_500G 500
65 #define LOADCELL4_WEIGHT_1000G 1000
66 #define LOADCELL4_WEIGHT_5000G 5000
67 #define LOADCELL4_WEIGHT_10000G 10000
68 #define LOADCELL4_DEFAULT_WEIGHT_SCALE_COEFFICIENT 0.088495575221
69 
74 #define LOADCELL4_EEPROM_ID_0 0x00
75 #define LOADCELL4_EEPROM_CONFIG_1 0x01
76 #define LOADCELL4_EEPROM_CONFIG_2 0x02
77 #define LOADCELL4_EEPROM_OFFSET_BRIDGE 0x03
78 #define LOADCELL4_EEPROM_GAIN_BRIDGE 0x04
79 #define LOADCELL4_EEPROM_TEMP_COF_GAIN 0x05
80 #define LOADCELL4_EEPROM_TEMP_COF_OFFSET 0x06
81 #define LOADCELL4_EEPROM_2ND_ORDER_TEMP_COF_OFFSET 0x07
82 #define LOADCELL4_EEPROM_2ND_ORDER_TEMP_COF_GAIN 0x08
83 #define LOADCELL4_EEPROM_2ND_ORDER_BRIDGE 0x09
84 #define LOADCELL4_EEPROM_OFFSET_TEMP 0x0A
85 #define LOADCELL4_EEPROM_GAINT_TEMP 0x0B
86 #define LOADCELL4_EEPROM_2ND_ORDER_TEMP 0x0C
87 #define LOADCELL4_EEPROM_TEMP_SETL 0x0D
88 #define LOADCELL4_EEPROM_ID_1 0x0E
89 #define LOADCELL4_EEPROM_BRIDGE_CONFIG 0x0F
90 #define LOADCELL4_EEPROM_TEMP_CONFIG 0x10
91 #define LOADCELL4_EEPROM_OSC_TRIM 0x11
92 #define LOADCELL4_EEPROM_SIGNATURE 0x12
93 #define LOADCELL4_EEPROM_ID_2 0x13
94 #define LOADCELL4_EEPROM_WRITE_CMD 0x40
95 #define LOADCELL4_EEPROM_STATUS_READ_READY 0x5A
96 
101 #define LOADCELL4_STATUS_NORMAL 0x00
102 #define LOADCELL4_STATUS_CMD_MODE 0x01
103 #define LOADCELL4_STATUS_STALE_DATA 0x02
104 #define LOADCELL4_STATUS_ERROR 0x03
105 #define LOADCELL4_STATUS_BIT_MASK 0x03
106 #define LOADCELL4_BRIDGE_RES 0x3FFF
107 
112 #define LOADCELL4_DUMMY 0x0000
113 
118 #define LOADCELL4_PWR_OFF 0x00
119 #define LOADCELL4_PWR_ON 0x01
120 
125 #define LOADCELL4_WEIGHT_ZERO 0.000
126 
132 #define LOADCELL4_NUMB_OF_SUM_AVG_20 20.00
133 #define LOADCELL4_NUMB_OF_SUM_AVG_100 100.0
134 
139 #define LOADCELL4_CMD_MODE_START 0xA0
140 #define LOADCELL4_CMD_MODE_STOP 0x80
141 
147 #define LOADCELL4_SET_DEV_ADDR 0x28
148  // loadcell4_set
150 
165 #define LOADCELL4_MAP_MIKROBUS( cfg, mikrobus ) \
166  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
167  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
168  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
169  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
170  // loadcell4_map // loadcell4
173 
178 typedef struct
179 {
180  // Output pins
181  digital_out_t en;
183  // Input pins
184  digital_in_t int_pin;
186  // Modules
187  i2c_master_t i2c;
189  // I2C slave address
190  uint8_t slave_address;
192 } loadcell4_t;
193 
198 typedef struct
199 {
200  pin_name_t scl;
201  pin_name_t sda;
203  pin_name_t en;
204  pin_name_t int_pin;
206  uint32_t i2c_speed;
207  uint8_t i2c_address;
210 
215 typedef struct
216 {
217  float tare;
218  uint8_t tare_ok;
229 
231 
236 typedef enum
237 {
239  LOADCELL4_ERROR = -1
240 
242 
259 
274 
289 
305 err_t loadcell4_generic_write ( loadcell4_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
306 
322 err_t loadcell4_generic_read ( loadcell4_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
323 
334 void loadcell4_read_raw ( loadcell4_t *ctx, uint32_t *rx_data );
335 
347 uint8_t loadcell4_read_data ( loadcell4_t *ctx, uint16_t *bridge_data, int16_t *temperature_data );
348 
360 
371 
382 
393 void loadcell4_power_dev ( loadcell4_t *ctx, uint8_t power_state );
394 
406 void loadcell4_write_eeprom ( loadcell4_t *ctx, uint8_t cmd_byte, uint16_t data_word );
407 
418 uint16_t loadcell4_read_eeprom ( loadcell4_t *ctx, uint8_t cmd_byte );
419 
429 
441 void loadcell4_tare ( loadcell4_t *ctx, loadcell4_data_t *cell_data );
442 
460 err_t loadcell4_calibration ( loadcell4_t *ctx, uint16_t cal_val, loadcell4_data_t *cell_data );
475 
476 #ifdef __cplusplus
477 }
478 #endif
479 #endif // LOADCELL4_H
480  // loadcell4
482 
483 // ------------------------------------------------------------------------ END
loadcell4_data_t
Load Cell 4 Click data object.
Definition: loadcell4.h:216
loadcell4_data_t::weight_coeff_5000g
float weight_coeff_5000g
Definition: loadcell4.h:225
loadcell4_cfg_t
Load Cell 4 Click configuration object.
Definition: loadcell4.h:199
LOADCELL4_OK
@ LOADCELL4_OK
Definition: loadcell4.h:238
loadcell4_default_cfg
err_t loadcell4_default_cfg(loadcell4_t *ctx)
Load Cell 4 default configuration function.
loadcell4_data_t::weight_coeff_100g
float weight_coeff_100g
Definition: loadcell4.h:219
loadcell4_data_t::weight_data_500g_ok
uint8_t weight_data_500g_ok
Definition: loadcell4.h:222
loadcell4_start_cmd_mode
void loadcell4_start_cmd_mode(loadcell4_t *ctx)
Start command mode function.
loadcell4_data_t::weight_data_1000g_ok
uint8_t weight_data_1000g_ok
Definition: loadcell4.h:224
loadcell4_read_data
uint8_t loadcell4_read_data(loadcell4_t *ctx, uint16_t *bridge_data, int16_t *temperature_data)
Read data function.
loadcell4_init
err_t loadcell4_init(loadcell4_t *ctx, loadcell4_cfg_t *cfg)
Load Cell 4 initialization function.
loadcell4_t::int_pin
digital_in_t int_pin
Definition: loadcell4.h:184
loadcell4_t::en
digital_out_t en
Definition: loadcell4.h:181
loadcell4_cfg_setup
void loadcell4_cfg_setup(loadcell4_cfg_t *cfg)
Load Cell 4 configuration object setup function.
loadcell4_read_bridge_data
uint16_t loadcell4_read_bridge_data(loadcell4_t *ctx)
Read bridge data function.
loadcell4_data_t::tare
float tare
Definition: loadcell4.h:217
loadcell4_generic_read
err_t loadcell4_generic_read(loadcell4_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Load Cell 4 I2C reading function.
loadcell4_data_t::tare_ok
uint8_t tare_ok
Definition: loadcell4.h:218
loadcell4_data_t::weight_data_10000g_ok
uint8_t weight_data_10000g_ok
Definition: loadcell4.h:228
loadcell4_get_weight
float loadcell4_get_weight(loadcell4_t *ctx, loadcell4_data_t *cell_data)
Get weight function.
loadcell4_get_int
uint8_t loadcell4_get_int(loadcell4_t *ctx)
Get state of the INT pin function.
LOADCELL4_ERROR
@ LOADCELL4_ERROR
Definition: loadcell4.h:239
loadcell4_calibration
err_t loadcell4_calibration(loadcell4_t *ctx, uint16_t cal_val, loadcell4_data_t *cell_data)
Calibration function.
loadcell4_cfg_t::en
pin_name_t en
Definition: loadcell4.h:203
loadcell4_read_eeprom
uint16_t loadcell4_read_eeprom(loadcell4_t *ctx, uint8_t cmd_byte)
Write eeprom function.
loadcell4_t::slave_address
uint8_t slave_address
Definition: loadcell4.h:190
loadcell4_cfg_t::scl
pin_name_t scl
Definition: loadcell4.h:200
loadcell4_data_t::weight_coeff_10000g
float weight_coeff_10000g
Definition: loadcell4.h:227
loadcell4_power_dev
void loadcell4_power_dev(loadcell4_t *ctx, uint8_t power_state)
Enable power function.
loadcell4_return_value_t
loadcell4_return_value_t
Load Cell 4 Click return value data.
Definition: loadcell4.h:237
loadcell4_cfg_t::int_pin
pin_name_t int_pin
Definition: loadcell4.h:204
loadcell4_end_cmd_mode
void loadcell4_end_cmd_mode(loadcell4_t *ctx)
Start command mode function.
loadcell4_cfg_t::i2c_address
uint8_t i2c_address
Definition: loadcell4.h:207
loadcell4_tare
void loadcell4_tare(loadcell4_t *ctx, loadcell4_data_t *cell_data)
Tare the scales function.
loadcell4_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: loadcell4.h:206
loadcell4_data_t::weight_coeff_500g
float weight_coeff_500g
Definition: loadcell4.h:221
loadcell4_read_raw
void loadcell4_read_raw(loadcell4_t *ctx, uint32_t *rx_data)
Read raw data function.
loadcell4_generic_write
err_t loadcell4_generic_write(loadcell4_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Load Cell 4 I2C writing function.
loadcell4_t
Load Cell 4 Click context object.
Definition: loadcell4.h:179
loadcell4_cfg_t::sda
pin_name_t sda
Definition: loadcell4.h:201
loadcell4_write_eeprom
void loadcell4_write_eeprom(loadcell4_t *ctx, uint8_t cmd_byte, uint16_t data_word)
Write eeprom function.
loadcell4_t::i2c
i2c_master_t i2c
Definition: loadcell4.h:187
loadcell4_data_t::weight_data_100g_ok
uint8_t weight_data_100g_ok
Definition: loadcell4.h:220
loadcell4_data_t::weight_data_5000g_ok
uint8_t weight_data_5000g_ok
Definition: loadcell4.h:226
loadcell4_data_t::weight_coeff_1000g
float weight_coeff_1000g
Definition: loadcell4.h:223