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 "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define POWERBANK_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
56 
62 #define POWERBANK_RETVAL uint8_t
63 
64 #define POWERBANK_OK 0x00
65 #define POWERBANK_INIT_ERROR 0xFF
66 
72 #define POWERBANK_SLAVE_ADR 0x4D
73 
79 #define POWERBANK_RESOLUTION 4096
80 #define POWERBANK_12_BIT_DATA 0x0FFF
81  // End group macro
84 // --------------------------------------------------------------- PUBLIC TYPES
93 typedef struct
94 {
95  // Output pins
96 
97 
98  // Input pins
99 
100 
101  // Modules
102 
103  i2c_master_t i2c;
104 
105  // ctx variable
106 
107  uint8_t slave_address;
108 
109 } powerbank_t;
110 
114 typedef struct
115 {
116  // Communication gpio pins
117 
118  pin_name_t scl;
119  pin_name_t sda;
120 
121  // Additional gpio pins
122 
123 
124  // static variable
125 
126  uint32_t i2c_speed;
127  uint8_t i2c_address;
128 
130  // End types group
132 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
133 
139 #ifdef __cplusplus
140 extern "C"{
141 #endif
142 
152 
161 
172 void powerbank_generic_write ( powerbank_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
173 
185 void powerbank_generic_read ( powerbank_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
186 
197 
208 uint16_t powerbank_read_voltage ( powerbank_t *ctx, uint16_t v_ref );
209 
210 #ifdef __cplusplus
211 }
212 #endif
213 #endif // _POWERBANK_H_
214  // End public_function group
217 
218 // ------------------------------------------------------------------------- END
POWERBANK_RETVAL
#define POWERBANK_RETVAL
Definition: powerbank.h:62
powerbank_cfg_t::sda
pin_name_t sda
Definition: powerbank.h:119
powerbank_t::slave_address
uint8_t slave_address
Definition: powerbank.h:107
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:94
powerbank_cfg_t
Click configuration structure definition.
Definition: powerbank.h:115
powerbank_cfg_t::scl
pin_name_t scl
Definition: powerbank.h:118
powerbank_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: powerbank.h:126
powerbank_t::i2c
i2c_master_t i2c
Definition: powerbank.h:103
powerbank_cfg_t::i2c_address
uint8_t i2c_address
Definition: powerbank.h:127
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.