force4  2.0.0.0
force4.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 FORCE4_H
36 #define FORCE4_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_i2c_master.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define FORCE4_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
70 
76 #define FORCE4_RETVAL uint8_t
77 
78 #define FORCE4_OK 0x00
79 #define FORCE4_INIT_ERROR 0xFF
80 
86 #define FORCE4_SLAVE_ADDRES 0x4D
87  // End group macro
90 // --------------------------------------------------------------- PUBLIC TYPES
99 typedef struct
100 {
101  // Output pins
102 
103  digital_out_t an;
104 
105  // Modules
106 
107  i2c_master_t i2c;
108 
109  // ctx variable
110 
111  uint8_t slave_address;
112 
113 } force4_t;
114 
118 typedef struct
119 {
120  // Communication gpio pins
121 
122  pin_name_t scl;
123  pin_name_t sda;
124 
125  // Additional gpio pins
126 
127  pin_name_t an;
128 
129  // static variable
130 
131  uint32_t i2c_speed;
132  uint8_t i2c_address;
133 
134 } force4_cfg_t;
135  // End types group
137 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
138 
144 #ifdef __cplusplus
145 extern "C"{
146 #endif
147 
157 
167 
178 void force4_generic_write ( force4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
179 
190 void force4_generic_read ( force4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
191 
201 uint16_t force4_read_adc ( force4_t *ctx );
202 
203 #ifdef __cplusplus
204 }
205 #endif
206 #endif // _FORCE4_H_
207  // End public_function group
210 
211 // ------------------------------------------------------------------------- END
force4_t::an
digital_out_t an
Definition: force4.h:103
force4_generic_read
void force4_generic_read(force4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
force4_cfg_t::an
pin_name_t an
Definition: force4.h:127
force4_init
FORCE4_RETVAL force4_init(force4_t *ctx, force4_cfg_t *cfg)
Initialization function.
force4_cfg_t
Click configuration structure definition.
Definition: force4.h:119
force4_cfg_t::i2c_address
uint8_t i2c_address
Definition: force4.h:132
force4_cfg_t::scl
pin_name_t scl
Definition: force4.h:122
force4_t::i2c
i2c_master_t i2c
Definition: force4.h:107
force4_read_adc
uint16_t force4_read_adc(force4_t *ctx)
Function for reading 12bit ADC data from device.
force4_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: force4.h:131
force4_t
Click ctx object definition.
Definition: force4.h:100
force4_cfg_t::sda
pin_name_t sda
Definition: force4.h:123
force4_generic_write
void force4_generic_write(force4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
force4_cfg_setup
void force4_cfg_setup(force4_cfg_t *cfg)
Config Object Initialization function.
force4_t::slave_address
uint8_t slave_address
Definition: force4.h:111
FORCE4_RETVAL
#define FORCE4_RETVAL
Definition: force4.h:76