loadcell 2.0.0.0
loadcell.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 */
24
33// ----------------------------------------------------------------------------
34
35#ifndef LOADCELL_H
36#define LOADCELL_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40
41// -------------------------------------------------------------- PUBLIC MACROS
51#define LOADCELL_MAP_MIKROBUS( cfg, mikrobus ) \
52 cfg.rte= MIKROBUS( mikrobus, MIKROBUS_CS ); \
53 cfg.clk= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
54 cfg.int_pin= MIKROBUS( mikrobus, MIKROBUS_INT );
61#define LOADCELL_RETVAL uint8_t
62
63#define LOADCELL_OK 0x00
64#define LOADCELL_INIT_ERROR 0xFF
71#define LOADCELL_CHANN_A_GATE_128_NEXT 0
72#define LOADCELL_CHANN_B_GATE_32_NEXT 1
73#define LOADCELL_CHANN_A_GATE_64_NEXT 2
80#define LOADCELL_10HZ_INTERNAL_OSC 0
81#define LOADCELL_80HZ_INTERNAL_OSC 1
88#define LOADCELL_POWER_UP 0
89#define LOADCELL_POWER_DOWN 1
96#define LOADCELL_GET_RESULT_ERROR 0
97#define LOADCELL_GET_RESULT_OK 1
104#define LOADCELL_WEIGHT_100G 100
105#define LOADCELL_WEIGHT_500G 500
106#define LOADCELL_WEIGHT_1000G 1000
107#define LOADCELL_WEIGHT_5000G 5000
108#define LOADCELL_WEIGHT_10000G 10000
115#define LOADCELL_DEFAULT_WEIGHT_SCALE_COEFFICIENT 0.088495575221
122#define LOADCELL_DATA_NO_DATA 0
123#define LOADCELL_DATA_OK 1 // End group macro
127// --------------------------------------------------------------- PUBLIC TYPES
136typedef struct
137{
138 // Output pins
139
140 digital_out_t rte;
141 digital_out_t clk;
142
143 // Input pins
144
145 digital_in_t int_pin;
146
147} loadcell_t;
148
152typedef struct
153{
154 // Additional gpio pins
155
156 pin_name_t rte;
157 pin_name_t clk;
158 pin_name_t int_pin;
159
161
165typedef struct
166{
167 float tare;
168 uint8_t tare_ok;
179}
181 // End types group
183// ------------------------------------------------------------------ CONSTANTS // End constants group
192// ------------------------------------------------------------------ VARIABLES // End variable group
200// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
201
207#ifdef __cplusplus
208extern "C"{
209#endif
210
220
229
238
247
255uint8_t loadcell_read_results ( loadcell_t *ctx, uint8_t input_sel, uint32_t *data_out );
256
264void loadcell_set_rate ( loadcell_t *ctx, uint8_t rate_sel );
265
274
282void loadcell_set_mode ( loadcell_t *ctx, uint8_t pwr_mode );
283
291void loadcell_tare ( loadcell_t *ctx, uint8_t input_sel, loadcell_data_t *cell_data );
292
300uint8_t loadcell_calibration ( loadcell_t *ctx, uint8_t input_sel, uint16_t cal_val, loadcell_data_t *cell_data );
301
309float loadcell_get_weight ( loadcell_t *ctx, uint8_t input_sel, loadcell_data_t *cell_data );
310
311
312#ifdef __cplusplus
313}
314#endif
315#endif // _LOADCELL_H_
316 // End public_function group
319
320// ------------------------------------------------------------------------- END
#define LOADCELL_RETVAL
Definition: loadcell.h:61
float loadcell_get_weight(loadcell_t *ctx, uint8_t input_sel, loadcell_data_t *cell_data)
Get weight function.
uint8_t loadcell_calibration(loadcell_t *ctx, uint8_t input_sel, uint16_t cal_val, loadcell_data_t *cell_data)
Calibration function.
void loadcell_tare(loadcell_t *ctx, uint8_t input_sel, loadcell_data_t *cell_data)
Function of messure and read results.
void loadcell_set_rate(loadcell_t *ctx, uint8_t rate_sel)
Set rate function.
void loadcell_cfg_setup(loadcell_cfg_t *cfg)
Config Object Initialization function.
uint8_t loadcell_read_results(loadcell_t *ctx, uint8_t input_sel, uint32_t *data_out)
Read results of function.
void loadcell_reset(loadcell_t *ctx)
Reset clock function.
void loadcell_default_cfg(loadcell_t *ctx)
Click Default Configuration function.
uint8_t loadcell_check_out(loadcell_t *ctx)
Check status of pin DO (do_pin).
LOADCELL_RETVAL loadcell_init(loadcell_t *ctx, loadcell_cfg_t *cfg)
Initialization function.
void loadcell_set_mode(loadcell_t *ctx, uint8_t pwr_mode)
Set clock mode function.
loadcell_data_t cell_data
Definition: main.c:39
Click configuration structure definition.
Definition: loadcell.h:153
pin_name_t rte
Definition: loadcell.h:156
pin_name_t clk
Definition: loadcell.h:157
pin_name_t int_pin
Definition: loadcell.h:158
Load cell data structure definition.
Definition: loadcell.h:166
float tare
Definition: loadcell.h:167
float weight_coeff_10000g
Definition: loadcell.h:177
uint8_t weight_data_1000g_ok
Definition: loadcell.h:174
uint8_t weight_data_500g_ok
Definition: loadcell.h:172
float weight_coeff_100g
Definition: loadcell.h:169
float weight_coeff_5000g
Definition: loadcell.h:175
uint8_t weight_data_10000g_ok
Definition: loadcell.h:178
float weight_coeff_500g
Definition: loadcell.h:171
uint8_t weight_data_5000g_ok
Definition: loadcell.h:176
uint8_t tare_ok
Definition: loadcell.h:168
uint8_t weight_data_100g_ok
Definition: loadcell.h:170
float weight_coeff_1000g
Definition: loadcell.h:173
Click ctx object definition.
Definition: loadcell.h:137
digital_out_t rte
Definition: loadcell.h:140
digital_in_t int_pin
Definition: loadcell.h:145
digital_out_t clk
Definition: loadcell.h:141