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 
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_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define HALLCURRENT6_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
65 
71 #define HALLCURRENT6_RETVAL uint8_t
72 
73 #define HALLCURRENT6_OK 0x00
74 #define HALLCURRENT6_INIT_ERROR 0xFF
75  // End group macro
79 // --------------------------------------------------------------- PUBLIC TYPES
80 
84 typedef struct
85 {
86 
87  // Modules
88 
89  i2c_master_t i2c;
90 
91  // ctx variable
92 
93  uint8_t slave_address;
94 
96 
100 typedef struct
101 {
102  // Communication gpio pins
103 
104  pin_name_t scl;
105  pin_name_t sda;
106 
107 
108  // static variable
109 
110  uint32_t i2c_speed;
111  uint8_t i2c_address;
112 
114  // End types group
116 
117 
118 #ifdef __cplusplus
119 extern "C"{
120 #endif
121 
131 
141 
152 void hallcurrent6_generic_write ( hallcurrent6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
153 
165 void hallcurrent6_generic_read ( hallcurrent6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
166 
177 void hallcurrent6_generic_write ( hallcurrent6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
178 
188 
198 
199 
200 #ifdef __cplusplus
201 }
202 #endif
203 #endif // _HALLCURRENT6_H_
204  // End public_function group
207 
208 // ------------------------------------------------------------------------- END
hallcurrent6_t
Click ctx object definition.
Definition: hallcurrent6.h:85
hallcurrent6_t::i2c
i2c_master_t i2c
Definition: hallcurrent6.h:89
hallcurrent6_cfg_t::sda
pin_name_t sda
Definition: hallcurrent6.h:105
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:71
hallcurrent6_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: hallcurrent6.h:110
hallcurrent6_t::slave_address
uint8_t slave_address
Definition: hallcurrent6.h:93
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:111
hallcurrent6_cfg_t
Click configuration structure definition.
Definition: hallcurrent6.h:101
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:104
hallcurrent6_read_data
uint16_t hallcurrent6_read_data(hallcurrent6_t *ctx)
Reads ADC current data.