force5  2.0.0.0
force5.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 FORCE5_H
29 #define FORCE5_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 FORCE5_STATES_BIT_MASK 0x03
60 #define FORCE5_STATES_NORMAL_OPERATION 0x00
61 #define FORCE5_STATES_COMMAND_MODE 0x01
62 #define FORCE5_STATES_STALE_DATA 0x02
63 #define FORCE5_STATES_DIAGNOSTIC_CONDITION 0x03
64 
69 #define FORCE5_FORCE_SENSOR_10_N 10.0
70 #define FORCE5_FORCE_SENSOR_25_N 25.0
71 
72 #define FORCE5_FORCE_MAX_VALUE 14745.0
73 
79 #define FORCE5_SET_DEV_ADDR 0x28
80  // force5_set
82 
97 #define FORCE5_MAP_MIKROBUS( cfg, mikrobus ) \
98  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
99  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
100  // force5_map // force5
103 
108 typedef struct
109 {
110  // Modules
111  i2c_master_t i2c;
113  // I2C slave address
114  uint8_t slave_address;
116 } force5_t;
117 
122 typedef struct
123 {
124  pin_name_t scl;
125  pin_name_t sda;
127  uint32_t i2c_speed;
128  uint8_t i2c_address;
130 } force5_cfg_t;
131 
136 typedef struct
137 {
138  uint8_t status_data;
139  uint16_t force_data;
140  uint16_t temp_data;
142 
147 typedef struct
148 {
149  uint16_t force_claib_data;
151 
156 typedef enum
157 {
159  FORCE5_ERROR = -1
160 
162 
178 void force5_cfg_setup ( force5_cfg_t *cfg );
179 
193 err_t force5_init ( force5_t *ctx, force5_cfg_t *cfg );
194 
209 err_t force5_generic_write ( force5_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
210 
225 err_t force5_generic_read ( force5_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
226 
240 err_t force5_read_byte ( force5_t *ctx, uint8_t *rx_data, uint8_t n_bytes );
241 
250 void force5_read_all_data ( force5_t *ctx, force5_data_t *force_data );
251 
261 uint8_t force5_get_force_value ( force5_t *ctx, uint16_t *force );
262 
272 uint8_t force5_get_temperature_value ( force5_t *ctx, uint16_t *temp );
273 
284 
294 
302 float force5_get_temperature ( force5_t *ctx );
303 
304 #ifdef __cplusplus
305 }
306 #endif
307 #endif // FORCE5_H
308  // force5
310 
311 // ------------------------------------------------------------------------ END
force5_get_temperature
float force5_get_temperature(force5_t *ctx)
Get temperature function.
force5_generic_write
err_t force5_generic_write(force5_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Force 5 I2C writing function.
force5_get_force_value
uint8_t force5_get_force_value(force5_t *ctx, uint16_t *force)
Get force value function.
force5_read_byte
err_t force5_read_byte(force5_t *ctx, uint8_t *rx_data, uint8_t n_bytes)
Generic read data function.
force5_read_all_data
void force5_read_all_data(force5_t *ctx, force5_data_t *force_data)
Read all data function.
force5_cfg_t
Force 5 Click configuration object.
Definition: force5.h:121
force5_init
err_t force5_init(force5_t *ctx, force5_cfg_t *cfg)
Force 5 initialization function.
force5_return_value_t
force5_return_value_t
Force 5 Click return value data.
Definition: force5.h:155
FORCE5_OK
Definition: force5.h:157
force5_data_t
Force 5 Click data object.
Definition: force5.h:135
force5_t
Force 5 Click context object.
Definition: force5.h:107
force5_get_force
float force5_get_force(force5_t *ctx, force5_calibration_t calib_data)
Get force function.
force5_calibration
uint8_t force5_calibration(force5_t *ctx, force5_calibration_t *calib_data)
Calibration the sensor function.
FORCE5_ERROR
Definition: force5.h:158
force5_generic_read
err_t force5_generic_read(force5_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Force 5 I2C reading function.
calib_data
force5_calibration_t calib_data
Definition: main.c:29
force5_calibration_t
Force 5 Click calibration object.
Definition: force5.h:146
force5_get_temperature_value
uint8_t force5_get_temperature_value(force5_t *ctx, uint16_t *temp)
Get temperature value function.
force5_cfg_setup
void force5_cfg_setup(force5_cfg_t *cfg)
Force 5 configuration object setup function.