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 "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define HALLCURRENT6_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
55 
61 #define HALLCURRENT6_RETVAL uint8_t
62 
63 #define HALLCURRENT6_OK 0x00
64 #define HALLCURRENT6_INIT_ERROR 0xFF
65  // End group macro
69 // --------------------------------------------------------------- PUBLIC TYPES
70 
74 typedef struct
75 {
76 
77  // Modules
78 
79  i2c_master_t i2c;
80 
81  // ctx variable
82 
83  uint8_t slave_address;
84 
86 
90 typedef struct
91 {
92  // Communication gpio pins
93 
94  pin_name_t scl;
95  pin_name_t sda;
96 
97 
98  // static variable
99 
100  uint32_t i2c_speed;
101  uint8_t i2c_address;
102 
104  // End types group
106 
107 
108 #ifdef __cplusplus
109 extern "C"{
110 #endif
111 
121 
131 
142 void hallcurrent6_generic_write ( hallcurrent6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
143 
155 void hallcurrent6_generic_read ( hallcurrent6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
156 
167 void hallcurrent6_generic_write ( hallcurrent6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
168 
178 
188 
189 
190 #ifdef __cplusplus
191 }
192 #endif
193 #endif // _HALLCURRENT6_H_
194  // End public_function group
197 
198 // ------------------------------------------------------------------------- END
hallcurrent6_t
Click ctx object definition.
Definition: hallcurrent6.h:75
hallcurrent6_t::i2c
i2c_master_t i2c
Definition: hallcurrent6.h:79
hallcurrent6_cfg_t::sda
pin_name_t sda
Definition: hallcurrent6.h:95
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:61
hallcurrent6_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: hallcurrent6.h:100
hallcurrent6_t::slave_address
uint8_t slave_address
Definition: hallcurrent6.h:83
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:101
hallcurrent6_cfg_t
Click configuration structure definition.
Definition: hallcurrent6.h:91
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:94
hallcurrent6_read_data
uint16_t hallcurrent6_read_data(hallcurrent6_t *ctx)
Reads ADC current data.