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 
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 
53 // -------------------------------------------------------------- PUBLIC MACROS
63 #define POWERBANK_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
65  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
66 
72 #define POWERBANK_RETVAL uint8_t
73 
74 #define POWERBANK_OK 0x00
75 #define POWERBANK_INIT_ERROR 0xFF
76 
82 #define POWERBANK_SLAVE_ADR 0x4D
83 
89 #define POWERBANK_RESOLUTION 4096
90 #define POWERBANK_12_BIT_DATA 0x0FFF
91  // End group macro
94 // --------------------------------------------------------------- PUBLIC TYPES
103 typedef struct
104 {
105  // Output pins
106 
107 
108  // Input pins
109 
110 
111  // Modules
112 
113  i2c_master_t i2c;
114 
115  // ctx variable
116 
117  uint8_t slave_address;
118 
119 } powerbank_t;
120 
124 typedef struct
125 {
126  // Communication gpio pins
127 
128  pin_name_t scl;
129  pin_name_t sda;
130 
131  // Additional gpio pins
132 
133 
134  // static variable
135 
136  uint32_t i2c_speed;
137  uint8_t i2c_address;
138 
140  // End types group
142 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
143 
149 #ifdef __cplusplus
150 extern "C"{
151 #endif
152 
162 
171 
182 void powerbank_generic_write ( powerbank_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
183 
195 void powerbank_generic_read ( powerbank_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
196 
207 
218 uint16_t powerbank_read_voltage ( powerbank_t *ctx, uint16_t v_ref );
219 
220 #ifdef __cplusplus
221 }
222 #endif
223 #endif // _POWERBANK_H_
224  // End public_function group
227 
228 // ------------------------------------------------------------------------- END
POWERBANK_RETVAL
#define POWERBANK_RETVAL
Definition: powerbank.h:72
powerbank_cfg_t::sda
pin_name_t sda
Definition: powerbank.h:129
powerbank_t::slave_address
uint8_t slave_address
Definition: powerbank.h:117
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:104
powerbank_cfg_t
Click configuration structure definition.
Definition: powerbank.h:125
powerbank_cfg_t::scl
pin_name_t scl
Definition: powerbank.h:128
powerbank_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: powerbank.h:136
powerbank_t::i2c
i2c_master_t i2c
Definition: powerbank.h:113
powerbank_cfg_t::i2c_address
uint8_t i2c_address
Definition: powerbank.h:137
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.