nanopower 2.0.0.0
nanopower.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 NANOPOWER_H
36#define NANOPOWER_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40
41// -------------------------------------------------------------- PUBLIC MACROS
47#define NANOPW_ENABLE_DEVICE 1
48#define NANOPW_DISABLE_DEVICE 0
49
54#define NANOPOWER_MAP_MIKROBUS( cfg, mikrobus ) \
55 cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS );
62#define NANOPOWER_RETVAL uint8_t
63
64#define NANOPOWER_OK 0x00
65#define NANOPOWER_INIT_ERROR 0xFF // End group macro
69// --------------------------------------------------------------- PUBLIC TYPES
78typedef struct
79{
80
81 digital_out_t en;
82
84
88typedef struct
89{
90
91 pin_name_t en;
92
94 // End types group
96
97// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
98
104#ifdef __cplusplus
105extern "C"{
106#endif
107
117
126
136void nanopw_enable_device ( nanopower_t *ctx, const uint8_t state );
137
138#ifdef __cplusplus
139}
140#endif
141#endif // _NANOPOWER_H_
142 // End public_function group
145
146// ------------------------------------------------------------------------- END
#define NANOPOWER_RETVAL
Definition: nanopower.h:62
NANOPOWER_RETVAL nanopower_init(nanopower_t *ctx, nanopower_cfg_t *cfg)
Initialization function.
void nanopw_enable_device(nanopower_t *ctx, const uint8_t state)
Click Enable function.
void nanopower_cfg_setup(nanopower_cfg_t *cfg)
Config Object Initialization function.
Click configuration structure definition.
Definition: nanopower.h:89
pin_name_t en
Definition: nanopower.h:91
Click ctx object definition.
Definition: nanopower.h:79
digital_out_t en
Definition: nanopower.h:81