force2  2.0.0.0
force2.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 FORCE2_H
29 #define FORCE2_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_analog_in.h"
38 
59 #define FORCE2_FORCE_MIN 0.0f
60 #define FORCE2_FORCE_MAX 15.0f
61 #define FORCE2_VREF 3.3f
62  // force2_set
64 
79 #define FORCE2_MAP_MIKROBUS( cfg, mikrobus ) \
80  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN );
81  // force2_map // force2
84 
89 typedef struct
90 {
91  analog_in_t adc;
93 } force2_t;
94 
99 typedef struct
100 {
101  pin_name_t an;
103  analog_in_resolution_t resolution;
104  float vref;
106 } force2_cfg_t;
107 
112 typedef enum
113 {
115  FORCE2_ERROR = -1
116 
118 
135 
149 err_t force2_init ( force2_t *ctx, force2_cfg_t *cfg );
150 
162 err_t force2_read_an_pin_value ( force2_t *ctx, uint16_t *data_out );
163 
177 err_t force2_read_an_pin_voltage ( force2_t *ctx, float *data_out );
178 
179 #ifdef __cplusplus
180 }
181 #endif
182 #endif // FORCE2_H
183  // force2
185 
186 // ------------------------------------------------------------------------ END
force2_init
err_t force2_init(force2_t *ctx, force2_cfg_t *cfg)
Force 2 initialization function.
force2_cfg_t::an
pin_name_t an
Definition: force2.h:101
FORCE2_ERROR
@ FORCE2_ERROR
Definition: force2.h:115
force2_cfg_setup
void force2_cfg_setup(force2_cfg_t *cfg)
Force 2 configuration object setup function.
FORCE2_OK
@ FORCE2_OK
Definition: force2.h:114
force2_cfg_t
Force 2 Click configuration object.
Definition: force2.h:100
force2_return_value_t
force2_return_value_t
Force 2 Click return value data.
Definition: force2.h:113
force2_read_an_pin_voltage
err_t force2_read_an_pin_voltage(force2_t *ctx, float *data_out)
Force 2 read AN pin voltage level function.
force2_t::adc
analog_in_t adc
Definition: force2.h:91
force2_read_an_pin_value
err_t force2_read_an_pin_value(force2_t *ctx, uint16_t *data_out)
Force 2 read AN pin value function.
force2_t
Force 2 Click context object.
Definition: force2.h:90
force2_cfg_t::resolution
analog_in_resolution_t resolution
Definition: force2.h:103
force2_cfg_t::vref
float vref
Definition: force2.h:104