hallcurrent3  2.0.0.0
hallcurrent3.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 HALLCURRENT3_H
36 #define HALLCURRENT3_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_i2c_master.h"
54 
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define HALLCURRENT3_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
69 
75 #define HALLCURRENT3_RETVAL uint8_t
76 
77 #define HALLCURRENT3_OK 0x00
78 #define HALLCURRENT3_INIT_ERROR 0xFF
79  // End group macro
82 // --------------------------------------------------------------- PUBLIC TYPES
91 typedef struct
92 {
93  // Modules
94 
95  i2c_master_t i2c;
96 
97  // ctx variable
98 
99  uint8_t slave_address;
100 
102 
106 typedef struct
107 {
108  // Communication gpio pins
109 
110  pin_name_t scl;
111  pin_name_t sda;
112 
113  // static variable
114 
115  uint32_t i2c_speed;
116  uint8_t i2c_address;
117 
119  // End variable group
121 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
122 
128 #ifdef __cplusplus
129 extern "C"{
130 #endif
131 
141 
151 
162 void hallcurrent3_generic_read ( hallcurrent3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
163 
172 uint16_t hallcurrent3_read_data ( hallcurrent3_t *ctx, uint8_t reg );
173 
182 
183 #ifdef __cplusplus
184 }
185 #endif
186 #endif // _HALLCURRENT3_H_
187  // End public_function group
190 
191 // ------------------------------------------------------------------------- END
hallcurrent3_cfg_setup
void hallcurrent3_cfg_setup(hallcurrent3_cfg_t *cfg)
Config Object Initialization function.
hallcurrent3_init
HALLCURRENT3_RETVAL hallcurrent3_init(hallcurrent3_t *ctx, hallcurrent3_cfg_t *cfg)
Initialization function.
hallcurrent3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: hallcurrent3.h:115
HALLCURRENT3_RETVAL
#define HALLCURRENT3_RETVAL
Definition: hallcurrent3.h:75
hallcurrent3_t::slave_address
uint8_t slave_address
Definition: hallcurrent3.h:99
hallcurrent3_generic_read
void hallcurrent3_generic_read(hallcurrent3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
hallcurrent3_t
Click ctx object definition.
Definition: hallcurrent3.h:92
hallcurrent3_cfg_t::sda
pin_name_t sda
Definition: hallcurrent3.h:111
hallcurrent3_cfg_t::scl
pin_name_t scl
Definition: hallcurrent3.h:110
hallcurrent3_read_data
uint16_t hallcurrent3_read_data(hallcurrent3_t *ctx, uint8_t reg)
Data read function.
hallcurrent3_t::i2c
i2c_master_t i2c
Definition: hallcurrent3.h:95
hallcurrent3_cfg_t::i2c_address
uint8_t i2c_address
Definition: hallcurrent3.h:116
hallcurrent3_cfg_t
Click configuration structure definition.
Definition: hallcurrent3.h:107
hallcurrent3_get_current
float hallcurrent3_get_current(hallcurrent3_t *ctx)
Get current function.