buck11  2.0.0.0
buck11.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 BUCK11_H
36 #define BUCK11_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_i2c_master.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define BUCK11_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
53  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
54 
60 #define BUCK11_RETVAL uint8_t
61 
62 #define BUCK11_OK 0x00
63 #define BUCK11_INIT_ERROR 0xFF
64 
70 #define BUCK11_MCP3221A5T_DEV_ADDR 0x4D
71 
77 #define BUCK11_VOUT_VOLTS 0x00
78 #define BUCK11_VOUT_MILLIVOLTS 0x01
79  // End group macro
82 // --------------------------------------------------------------- PUBLIC TYPES
91 typedef struct
92 {
93  // Modules
94 
95  i2c_master_t i2c;
96 
97  // ctx variable
98 
99  uint8_t slave_address;
100 
101 } buck11_t;
102 
106 typedef struct
107 {
108  // Communication gpio pins
109 
110  pin_name_t scl;
111  pin_name_t sda;
112 
113  // static variable
114 
115  uint32_t i2c_speed;
116  uint8_t i2c_address;
117 
118 } buck11_cfg_t;
119  // End types group
121 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
122 
128 #ifdef __cplusplus
129 extern "C"{
130 #endif
131 
141 
150 
161 void buck11_generic_write ( buck11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
162 
174 void buck11_generic_read ( buck11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
175 
185 void buck11_set_vdd_value ( float vdd_volts );
186 
195 uint16_t buck11_read_adc ( buck11_t *ctx );
196 
208 float buck11_get_vout ( buck11_t *ctx, uint8_t vout_resolution );
209 
222 float buck11_get_averaged_vout ( buck11_t *ctx, uint8_t vout_resolution, uint8_t n_samples );
223 
224 
225 #ifdef __cplusplus
226 }
227 #endif
228 #endif // _BUCK11_H_
229  // End public_function group
232 
233 // ------------------------------------------------------------------------- END
buck11_cfg_setup
void buck11_cfg_setup(buck11_cfg_t *cfg)
Config Object Initialization function.
buck11_t::i2c
i2c_master_t i2c
Definition: buck11.h:95
buck11_get_vout
float buck11_get_vout(buck11_t *ctx, uint8_t vout_resolution)
Get VOUT function.
buck11_cfg_t::sda
pin_name_t sda
Definition: buck11.h:111
buck11_generic_read
void buck11_generic_read(buck11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
buck11_read_adc
uint16_t buck11_read_adc(buck11_t *ctx)
ADC Read function.
buck11_cfg_t
Click configuration structure definition.
Definition: buck11.h:107
buck11_generic_write
void buck11_generic_write(buck11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
buck11_get_averaged_vout
float buck11_get_averaged_vout(buck11_t *ctx, uint8_t vout_resolution, uint8_t n_samples)
Get Averaged VOUT function.
buck11_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: buck11.h:115
buck11_t
Click ctx object definition.
Definition: buck11.h:92
buck11_set_vdd_value
void buck11_set_vdd_value(float vdd_volts)
Set VDD Value function.
buck11_t::slave_address
uint8_t slave_address
Definition: buck11.h:99
buck11_cfg_t::i2c_address
uint8_t i2c_address
Definition: buck11.h:116
BUCK11_RETVAL
#define BUCK11_RETVAL
Definition: buck11.h:60
buck11_cfg_t::scl
pin_name_t scl
Definition: buck11.h:110
buck11_init
BUCK11_RETVAL buck11_init(buck11_t *ctx, buck11_cfg_t *cfg)
Initialization function.