powerbank  2.0.0.0
powerbank.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 POWERBANK_H
36 #define POWERBANK_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 
57 // -------------------------------------------------------------- PUBLIC MACROS
67 #define POWERBANK_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
69  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
70 
76 #define POWERBANK_RETVAL uint8_t
77 
78 #define POWERBANK_OK 0x00
79 #define POWERBANK_INIT_ERROR 0xFF
80 
86 #define POWERBANK_SLAVE_ADR 0x4D
87 
93 #define POWERBANK_RESOLUTION 4096
94 #define POWERBANK_12_BIT_DATA 0x0FFF
95  // End group macro
98 // --------------------------------------------------------------- PUBLIC TYPES
107 typedef struct
108 {
109  // Output pins
110 
111 
112  // Input pins
113 
114 
115  // Modules
116 
117  i2c_master_t i2c;
118 
119  // ctx variable
120 
121  uint8_t slave_address;
122 
123 } powerbank_t;
124 
128 typedef struct
129 {
130  // Communication gpio pins
131 
132  pin_name_t scl;
133  pin_name_t sda;
134 
135  // Additional gpio pins
136 
137 
138  // static variable
139 
140  uint32_t i2c_speed;
141  uint8_t i2c_address;
142 
144  // End types group
146 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
147 
153 #ifdef __cplusplus
154 extern "C"{
155 #endif
156 
166 
175 
186 void powerbank_generic_write ( powerbank_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
187 
199 void powerbank_generic_read ( powerbank_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
200 
211 
222 uint16_t powerbank_read_voltage ( powerbank_t *ctx, uint16_t v_ref );
223 
224 #ifdef __cplusplus
225 }
226 #endif
227 #endif // _POWERBANK_H_
228  // End public_function group
231 
232 // ------------------------------------------------------------------------- END
POWERBANK_RETVAL
#define POWERBANK_RETVAL
Definition: powerbank.h:76
powerbank_cfg_t::sda
pin_name_t sda
Definition: powerbank.h:133
powerbank_t::slave_address
uint8_t slave_address
Definition: powerbank.h:121
powerbank_read_voltage
uint16_t powerbank_read_voltage(powerbank_t *ctx, uint16_t v_ref)
Read voltage function.
powerbank_cfg_setup
void powerbank_cfg_setup(powerbank_cfg_t *cfg)
Config Object Initialization function.
powerbank_generic_read
void powerbank_generic_read(powerbank_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
powerbank_t
Click ctx object definition.
Definition: powerbank.h:108
powerbank_cfg_t
Click configuration structure definition.
Definition: powerbank.h:129
powerbank_cfg_t::scl
pin_name_t scl
Definition: powerbank.h:132
powerbank_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: powerbank.h:140
powerbank_t::i2c
i2c_master_t i2c
Definition: powerbank.h:117
powerbank_cfg_t::i2c_address
uint8_t i2c_address
Definition: powerbank.h:141
powerbank_read_data
uint16_t powerbank_read_data(powerbank_t *ctx)
Read data function.
powerbank_generic_write
void powerbank_generic_write(powerbank_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
powerbank_init
POWERBANK_RETVAL powerbank_init(powerbank_t *ctx, powerbank_cfg_t *cfg)
Initialization function.