hallcurrent6  2.0.0.0
hallcurrent6.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 HALLCURRENT6_H
36 #define HALLCURRENT6_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 HALLCURRENT6_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
69 
75 #define HALLCURRENT6_RETVAL uint8_t
76 
77 #define HALLCURRENT6_OK 0x00
78 #define HALLCURRENT6_INIT_ERROR 0xFF
79  // End group macro
83 // --------------------------------------------------------------- PUBLIC TYPES
84 
88 typedef struct
89 {
90 
91  // Modules
92 
93  i2c_master_t i2c;
94 
95  // ctx variable
96 
97  uint8_t slave_address;
98 
100 
104 typedef struct
105 {
106  // Communication gpio pins
107 
108  pin_name_t scl;
109  pin_name_t sda;
110 
111 
112  // static variable
113 
114  uint32_t i2c_speed;
115  uint8_t i2c_address;
116 
118  // End types group
120 
121 
122 #ifdef __cplusplus
123 extern "C"{
124 #endif
125 
135 
145 
156 void hallcurrent6_generic_write ( hallcurrent6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
157 
169 void hallcurrent6_generic_read ( hallcurrent6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
170 
181 void hallcurrent6_generic_write ( hallcurrent6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
182 
192 
202 
203 
204 #ifdef __cplusplus
205 }
206 #endif
207 #endif // _HALLCURRENT6_H_
208  // End public_function group
211 
212 // ------------------------------------------------------------------------- END
hallcurrent6_t
Click ctx object definition.
Definition: hallcurrent6.h:89
hallcurrent6_t::i2c
i2c_master_t i2c
Definition: hallcurrent6.h:93
hallcurrent6_cfg_t::sda
pin_name_t sda
Definition: hallcurrent6.h:109
hallcurrent6_get_current
float hallcurrent6_get_current(hallcurrent6_t *ctx)
Reads current data.
hallcurrent6_cfg_setup
void hallcurrent6_cfg_setup(hallcurrent6_cfg_t *cfg)
Config Object Initialization function.
HALLCURRENT6_RETVAL
#define HALLCURRENT6_RETVAL
Definition: hallcurrent6.h:75
hallcurrent6_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: hallcurrent6.h:114
hallcurrent6_t::slave_address
uint8_t slave_address
Definition: hallcurrent6.h:97
hallcurrent6_generic_read
void hallcurrent6_generic_read(hallcurrent6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
hallcurrent6_generic_write
void hallcurrent6_generic_write(hallcurrent6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
hallcurrent6_cfg_t::i2c_address
uint8_t i2c_address
Definition: hallcurrent6.h:115
hallcurrent6_cfg_t
Click configuration structure definition.
Definition: hallcurrent6.h:105
hallcurrent6_init
HALLCURRENT6_RETVAL hallcurrent6_init(hallcurrent6_t *ctx, hallcurrent6_cfg_t *cfg)
Initialization function.
hallcurrent6_cfg_t::scl
pin_name_t scl
Definition: hallcurrent6.h:108
hallcurrent6_read_data
uint16_t hallcurrent6_read_data(hallcurrent6_t *ctx)
Reads ADC current data.