nanopower3 2.1.0.0
nanopower3.h
Go to the documentation of this file.
1/****************************************************************************
2** Copyright (C) 2020 MikroElektronika d.o.o.
3** Contact: https://www.mikroe.com/contact
4**
5** Permission is hereby granted, free of charge, to any person obtaining a copy
6** of this software and associated documentation files (the "Software"), to deal
7** in the Software without restriction, including without limitation the rights
8** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9** copies of the Software, and to permit persons to whom the Software is
10** furnished to do so, subject to the following conditions:
11** The above copyright notice and this permission notice shall be
12** included in all copies or substantial portions of the Software.
13**
14** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20** USE OR OTHER DEALINGS IN THE SOFTWARE.
21****************************************************************************/
22
28#ifndef NANOPOWER3_H
29#define NANOPOWER3_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38
59#define NANOPOWER3_CMD_VREG 0x11
60#define NANOPOWER3_CMD_NVREG 0x21
61#define NANOPOWER3_CMD_VREGxNVREG 0x51
62#define NANOPOWER3_CMD_NVREGxVREG 0x61
63
68#define NANOPOWER3_1V_OUT_VOLTAGE 0x00
69#define NANOPOWER3_1V2_OUT_VOLTAGE 0x01
70#define NANOPOWER3_1V5_OUT_VOLTAGE 0x02
71#define NANOPOWER3_1V8_OUT_VOLTAGE 0x03
72#define NANOPOWER3_2V_OUT_VOLTAGE 0x04
73#define NANOPOWER3_2V5_OUT_VOLTAGE 0x05
74#define NANOPOWER3_3V_OUT_VOLTAGE 0x06
75#define NANOPOWER3_3V3_OUT_VOLTAGE 0x07
76#define NANOPOWER3_3V5_OUT_VOLTAGE 0x08
77#define NANOPOWER3_4V_OUT_VOLTAGE 0x09
78#define NANOPOWER3_4V5_OUT_VOLTAGE 0x0A
79
84#define NANOPOWER3_1V_RESISTANCE 187000
85#define NANOPOWER3_1V2_RESISTANCE 93100
86#define NANOPOWER3_1V5_RESISTANCE 53600
87#define NANOPOWER3_1V8_RESISTANCE 37400
88#define NANOPOWER3_2V_RESISTANCE 29000
89#define NANOPOWER3_2V5_RESISTANCE 20000
90#define NANOPOWER3_3V_RESISTANCE 15000
91#define NANOPOWER3_3V3_RESISTANCE 13100
92#define NANOPOWER3_3V5_RESISTANCE 12200
93#define NANOPOWER3_4V_RESISTANCE 10000
94#define NANOPOWER3_4V5_RESISTANCE 9000
95
100#define NANOPOWER3_R11_RESISTANCE 7200
101#define NANOPOWER3_DIGIPOT_MAX_RESISTANCE 200000
102#define NANOPOWER3_DIGIPOT_MAX_VAL 255
103#define NANOPOWER3_MAX_RESISTANCE 207200
104#define NANOPOWER3_ROUND_TO_NEAREST_INT 0.5
105
110#define NANOPOWER3_PIN_STATE_HIGH 0x01
111#define NANOPOWER3_PIN_STATE_LOW 0x00
112
118#define NANOPOWER3_DEVICE_ADDRESS_GND 0x28
119#define NANOPOWER3_DEVICE_ADDRESS_VCC 0x29
120 // nanopower3_set
122
137#define NANOPOWER3_MAP_MIKROBUS( cfg, mikrobus ) \
138 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
139 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
140 cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
141 cfg.ctr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
142 cfg.pg = MIKROBUS( mikrobus, MIKROBUS_INT )
143 // nanopower3_map // nanopower3
146
151typedef struct
152{
153 // Output pins
154 digital_out_t ctr;
156 // Input pins
157 digital_in_t an;
158 digital_in_t pg;
160 // Modules
161 i2c_master_t i2c;
163 // I2C slave address
167
172typedef struct
173{
174 pin_name_t scl;
175 pin_name_t sda;
177 pin_name_t an;
178 pin_name_t ctr;
179 pin_name_t pg;
181 uint32_t i2c_speed;
182 uint8_t i2c_address;
185
190typedef enum
191{
194
196
213
228
242
257err_t nanopower3_generic_write ( nanopower3_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
258
273err_t nanopower3_generic_read ( nanopower3_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
274
285
296
306void nanopower3_set_ctr_pin ( nanopower3_t *ctx, uint8_t pin_state );
307
320err_t nanopower3_write_data ( nanopower3_t *ctx, uint8_t cmd, uint8_t data_in );
321
333err_t nanopower3_set_wiper_pos ( nanopower3_t *ctx, uint8_t wiper_pos );
334
346err_t nanopower3_set_resistance ( nanopower3_t *ctx, uint32_t resistance );
347
359err_t nanopower3_set_voltage ( nanopower3_t *ctx, uint8_t out_vol );
360
361#ifdef __cplusplus
362}
363#endif
364#endif // NANOPOWER3_H
365 // nanopower3
367
368// ------------------------------------------------------------------------ END
void nanopower3_cfg_setup(nanopower3_cfg_t *cfg)
Nano Power 3 configuration object setup function.
err_t nanopower3_default_cfg(nanopower3_t *ctx)
Nano Power 3 default configuration function.
void nanopower3_set_ctr_pin(nanopower3_t *ctx, uint8_t pin_state)
Nano Power 3 set CTRL pin state function.
err_t nanopower3_set_voltage(nanopower3_t *ctx, uint8_t out_vol)
Nano Power 3 set output voltage function.
err_t nanopower3_set_resistance(nanopower3_t *ctx, uint32_t resistance)
Nano Power 3 set resistance function.
err_t nanopower3_write_data(nanopower3_t *ctx, uint8_t cmd, uint8_t data_in)
Nano Power 3 command writing function.
uint8_t nanopower3_get_an_pin_state(nanopower3_t *ctx)
Nano Power 3 get AN pin state function.
err_t nanopower3_set_wiper_pos(nanopower3_t *ctx, uint8_t wiper_pos)
Nano Power 3 set wiper position function.
uint8_t nanopower3_get_pg_pin_state(nanopower3_t *ctx)
Nano Power 3 get PG pin state function.
err_t nanopower3_init(nanopower3_t *ctx, nanopower3_cfg_t *cfg)
Nano Power 3 initialization function.
err_t nanopower3_generic_read(nanopower3_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Nano Power 3 I2C reading function.
err_t nanopower3_generic_write(nanopower3_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Nano Power 3 I2C writing function.
nanopower3_return_value_t
Nano Power 3 Click return value data.
Definition: nanopower3.h:191
@ NANOPOWER3_OK
Definition: nanopower3.h:192
@ NANOPOWER3_ERROR
Definition: nanopower3.h:193
Nano Power 3 Click configuration object.
Definition: nanopower3.h:173
pin_name_t ctr
Definition: nanopower3.h:178
uint32_t i2c_speed
Definition: nanopower3.h:181
pin_name_t scl
Definition: nanopower3.h:174
pin_name_t sda
Definition: nanopower3.h:175
pin_name_t pg
Definition: nanopower3.h:179
pin_name_t an
Definition: nanopower3.h:177
uint8_t i2c_address
Definition: nanopower3.h:182
Nano Power 3 Click context object.
Definition: nanopower3.h:152
i2c_master_t i2c
Definition: nanopower3.h:161
digital_in_t an
Definition: nanopower3.h:157
digital_out_t ctr
Definition: nanopower3.h:154
uint8_t slave_address
Definition: nanopower3.h:164
digital_in_t pg
Definition: nanopower3.h:158