peltier  2.0.0.0
peltier.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  */
32 // ----------------------------------------------------------------------------
33 
34 #ifndef PELTIER_H
35 #define PELTIER_H
36 
37 #include "drv_digital_out.h"
38 #include "drv_digital_in.h"
39 
40 // -------------------------------------------------------------- PUBLIC MACROS
50 #define PELTIER_MAP_MIKROBUS( cfg, mikrobus ) \
51  cfg.en2= MIKROBUS( mikrobus, MIKROBUS_RST ); \
52  cfg.en1= MIKROBUS( mikrobus, MIKROBUS_CS ); \
53  cfg.chg= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
54  cfg.con= MIKROBUS( mikrobus, MIKROBUS_INT )
55 
61 #define PELTIER_RETVAL uint8_t
62 
63 #define PELTIER_OK 0x00
64 #define PELTIER_INIT_ERROR 0xFF
65  // End group macro
68 // --------------------------------------------------------------- PUBLIC TYPES
77 typedef struct
78 {
79  // Output pins
80 
81  digital_out_t en2;
82  digital_out_t en1;
83 
84  // Input pins
85 
86  digital_in_t chg;
87  digital_in_t con;
88 
89 } peltier_t;
90 
94 typedef struct
95 {
96  // Additional gpio pins
97 
98  pin_name_t en2;
99  pin_name_t en1;
100  pin_name_t chg;
101  pin_name_t con;
102 
103 } peltier_cfg_t;
104  // End types group
106 
107 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
108 
114 #ifdef __cplusplus
115 extern "C"{
116 #endif
117 
126 void peltier_cfg_setup ( peltier_cfg_t *cfg );
127 
136 
144 void peltier_enable_ldo2 ( peltier_t *ctx );
145 
153 void peltier_disable_ldo2 ( peltier_t *ctx );
154 
162 void peltier_enable_ldo1 ( peltier_t *ctx );
163 
171 void peltier_disable_ldo1 ( peltier_t *ctx );
172 
180 uint8_t peltier_battery_charge ( peltier_t *ctx );
181 
189 uint8_t peltier_vin_good_flag ( peltier_t *ctx );
190 
191 #ifdef __cplusplus
192 }
193 #endif
194 #endif // _PELTIER_H_
195  // End public_function group
198 
199 // ------------------------------------------------------------------------- END
peltier_cfg_t
Click configuration structure definition.
Definition: peltier.h:94
peltier_t::en1
digital_out_t en1
Definition: peltier.h:82
peltier_t
Click ctx object definition.
Definition: peltier.h:77
peltier_cfg_t::chg
pin_name_t chg
Definition: peltier.h:100
peltier_enable_ldo1
void peltier_enable_ldo1(peltier_t *ctx)
Enables LDO1 function.
peltier_cfg_setup
void peltier_cfg_setup(peltier_cfg_t *cfg)
Config Object Initialization function.
peltier_t::con
digital_in_t con
Definition: peltier.h:87
peltier_cfg_t::en2
pin_name_t en2
Definition: peltier.h:98
peltier_vin_good_flag
uint8_t peltier_vin_good_flag(peltier_t *ctx)
Check input voltage good flag pin function.
peltier_t::chg
digital_in_t chg
Definition: peltier.h:86
peltier_cfg_t::con
pin_name_t con
Definition: peltier.h:101
peltier_t::en2
digital_out_t en2
Definition: peltier.h:81
peltier_disable_ldo2
void peltier_disable_ldo2(peltier_t *ctx)
Disables LDO2 function.
peltier_init
PELTIER_RETVAL peltier_init(peltier_t *ctx, peltier_cfg_t *cfg)
Initialization function.
peltier_enable_ldo2
void peltier_enable_ldo2(peltier_t *ctx)
Enables LDO2 function.
peltier_battery_charge
uint8_t peltier_battery_charge(peltier_t *ctx)
Check ongoing battery charge flag pin function.
peltier_disable_ldo1
void peltier_disable_ldo1(peltier_t *ctx)
Disables LDO1 function.
peltier_cfg_t::en1
pin_name_t en1
Definition: peltier.h:99
PELTIER_RETVAL
#define PELTIER_RETVAL
Definition: peltier.h:61