powerbank2 2.0.0.0
powerbank2.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 POWERBANK2_H
36#define POWERBANK2_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 POWERBANK2_MAP_MIKROBUS( cfg, mikrobus ) \
54 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
62#define POWERBANK2_RETVAL uint8_t
63
64#define POWERBANK2_OK 0x00
65#define POWERBANK2_INIT_ERROR 0xFF
72#define POWERBANK2_SLAVE_ADR 0x4D
79#define POWERBANK2_RESOLUTION 4096
80#define POWERBANK2_12_BIT_DATA 0x0FFF // End group macro
84// --------------------------------------------------------------- PUBLIC TYPES
93typedef struct
94{
95 // Modules
96
97 i2c_master_t i2c;
98
99 // ctx variable
100
102
104
108typedef struct
109{
110 // Communication gpio pins
111
112 pin_name_t scl;
113 pin_name_t sda;
114
115
116 // static variable
117
118 uint32_t i2c_speed;
119 uint8_t i2c_address;
120
122 // End types group
124// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
125
131#ifdef __cplusplus
132extern "C"{
133#endif
134
144
153
164void powerbank2_generic_write ( powerbank2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
165
175void powerbank2_read ( powerbank2_t *ctx, uint16_t *result );
176
187uint16_t powerbank2_read_voltage ( powerbank2_t *ctx, uint16_t v_ref );
188
189#ifdef __cplusplus
190}
191#endif
192#endif // _POWERBANK2_H_
193 // End public_function group
196
197// ------------------------------------------------------------------------- END
#define POWERBANK2_RETVAL
Definition: powerbank2.h:62
void powerbank2_cfg_setup(powerbank2_cfg_t *cfg)
Config Object Initialization function.
void powerbank2_generic_write(powerbank2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
uint16_t powerbank2_read_voltage(powerbank2_t *ctx, uint16_t v_ref)
Read voltage function.
POWERBANK2_RETVAL powerbank2_init(powerbank2_t *ctx, powerbank2_cfg_t *cfg)
Initialization function.
void powerbank2_read(powerbank2_t *ctx, uint16_t *result)
Read function.
Click configuration structure definition.
Definition: powerbank2.h:109
uint32_t i2c_speed
Definition: powerbank2.h:118
pin_name_t scl
Definition: powerbank2.h:112
pin_name_t sda
Definition: powerbank2.h:113
uint8_t i2c_address
Definition: powerbank2.h:119
Click ctx object definition.
Definition: powerbank2.h:94
i2c_master_t i2c
Definition: powerbank2.h:97
uint8_t slave_address
Definition: powerbank2.h:101