hallcurrent2  2.0.0.0
hallcurrent2.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 HALLCURRENT2_H
36 #define HALLCURRENT2_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 HALLCURRENT2_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
70  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
71 
77 #define HALLCURRENT2_RETVAL uint8_t
78 
79 #define HALLCURRENT2_OK 0x00
80 #define HALLCURRENT2_INIT_ERROR 0xFF
81  // End group macro
84 // --------------------------------------------------------------- PUBLIC TYPES
93 typedef struct
94 {
95  // Output pins
96 
97  digital_out_t rst;
98 
99  // Input pins
100 
101  digital_in_t int_pin;
102 
103  // Modules
104 
105  i2c_master_t i2c;
106 
107  // ctx variable
108 
109  uint8_t slave_address;
110 
112 
116 typedef struct
117 {
118  // Communication gpio pins
119 
120  pin_name_t scl;
121  pin_name_t sda;
122 
123  // Additional gpio pins
124 
125  pin_name_t rst;
126  pin_name_t int_pin;
127 
128  // static variable
129 
130  uint32_t i2c_speed;
131  uint8_t i2c_address;
132 
134  // End types group
136 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
137 
143 #ifdef __cplusplus
144 extern "C"{
145 #endif
146 
156 
166 
178 
189 
201 
202 #ifdef __cplusplus
203 }
204 #endif
205 #endif // _HALLCURRENT2_H_
206  // End public_function group
209 
210 // ------------------------------------------------------------------------- END
hallcurrent2_generic_read
uint16_t hallcurrent2_generic_read(hallcurrent2_t *ctx)
Generic read function.
hallcurrent2_cfg_setup
void hallcurrent2_cfg_setup(hallcurrent2_cfg_t *cfg)
Config Object Initialization function.
hallcurrent2_cfg_t::int_pin
pin_name_t int_pin
Definition: hallcurrent2.h:126
hallcurrent2_cfg_t::i2c_address
uint8_t i2c_address
Definition: hallcurrent2.h:131
hallcurrent2_t::slave_address
uint8_t slave_address
Definition: hallcurrent2.h:109
hallcurrent2_cfg_t::sda
pin_name_t sda
Definition: hallcurrent2.h:121
hallcurrent2_t::rst
digital_out_t rst
Definition: hallcurrent2.h:97
HALLCURRENT2_RETVAL
#define HALLCURRENT2_RETVAL
Definition: hallcurrent2.h:77
hallcurrent2_get_current
int16_t hallcurrent2_get_current(hallcurrent2_t *ctx)
Reads current in mV.
hallcurrent2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: hallcurrent2.h:130
hallcurrent2_t::int_pin
digital_in_t int_pin
Definition: hallcurrent2.h:101
hallcurrent2_reset
void hallcurrent2_reset(hallcurrent2_t *ctx)
Functions for reset chip.
hallcurrent2_cfg_t::scl
pin_name_t scl
Definition: hallcurrent2.h:120
hallcurrent2_init
HALLCURRENT2_RETVAL hallcurrent2_init(hallcurrent2_t *ctx, hallcurrent2_cfg_t *cfg)
Initialization function.
hallcurrent2_t::i2c
i2c_master_t i2c
Definition: hallcurrent2.h:105
hallcurrent2_cfg_t
Click configuration structure definition.
Definition: hallcurrent2.h:117
hallcurrent2_t
Click ctx object definition.
Definition: hallcurrent2.h:94
hallcurrent2_cfg_t::rst
pin_name_t rst
Definition: hallcurrent2.h:125