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 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_i2c_master.h"
50 
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define HALLCURRENT3_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
65 
71 #define HALLCURRENT3_RETVAL uint8_t
72 
73 #define HALLCURRENT3_OK 0x00
74 #define HALLCURRENT3_INIT_ERROR 0xFF
75  // End group macro
78 // --------------------------------------------------------------- PUBLIC TYPES
87 typedef struct
88 {
89  // Modules
90 
91  i2c_master_t i2c;
92 
93  // ctx variable
94 
95  uint8_t slave_address;
96 
98 
102 typedef struct
103 {
104  // Communication gpio pins
105 
106  pin_name_t scl;
107  pin_name_t sda;
108 
109  // static variable
110 
111  uint32_t i2c_speed;
112  uint8_t i2c_address;
113 
115  // End variable group
117 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
118 
124 #ifdef __cplusplus
125 extern "C"{
126 #endif
127 
137 
147 
158 void hallcurrent3_generic_read ( hallcurrent3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
159 
168 uint16_t hallcurrent3_read_data ( hallcurrent3_t *ctx, uint8_t reg );
169 
178 
179 #ifdef __cplusplus
180 }
181 #endif
182 #endif // _HALLCURRENT3_H_
183  // End public_function group
186 
187 // ------------------------------------------------------------------------- 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:111
HALLCURRENT3_RETVAL
#define HALLCURRENT3_RETVAL
Definition: hallcurrent3.h:71
hallcurrent3_t::slave_address
uint8_t slave_address
Definition: hallcurrent3.h:95
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:88
hallcurrent3_cfg_t::sda
pin_name_t sda
Definition: hallcurrent3.h:107
hallcurrent3_cfg_t::scl
pin_name_t scl
Definition: hallcurrent3.h:106
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:91
hallcurrent3_cfg_t::i2c_address
uint8_t i2c_address
Definition: hallcurrent3.h:112
hallcurrent3_cfg_t
Click configuration structure definition.
Definition: hallcurrent3.h:103
hallcurrent3_get_current
float hallcurrent3_get_current(hallcurrent3_t *ctx)
Get current function.