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
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 
73 #define NANOPOWER3_CMD_VREG 0x11
74 #define NANOPOWER3_CMD_NVREG 0x21
75 #define NANOPOWER3_CMD_VREGxNVREG 0x51
76 #define NANOPOWER3_CMD_NVREGxVREG 0x61
77 
82 #define NANOPOWER3_1V_OUT_VOLTAGE 0x00
83 #define NANOPOWER3_1V2_OUT_VOLTAGE 0x01
84 #define NANOPOWER3_1V5_OUT_VOLTAGE 0x02
85 #define NANOPOWER3_1V8_OUT_VOLTAGE 0x03
86 #define NANOPOWER3_2V_OUT_VOLTAGE 0x04
87 #define NANOPOWER3_2V5_OUT_VOLTAGE 0x05
88 #define NANOPOWER3_3V_OUT_VOLTAGE 0x06
89 #define NANOPOWER3_3V3_OUT_VOLTAGE 0x07
90 #define NANOPOWER3_3V5_OUT_VOLTAGE 0x08
91 #define NANOPOWER3_4V_OUT_VOLTAGE 0x09
92 #define NANOPOWER3_4V5_OUT_VOLTAGE 0x0A
93 
98 #define NANOPOWER3_1V_RESISTANCE 187000
99 #define NANOPOWER3_1V2_RESISTANCE 93100
100 #define NANOPOWER3_1V5_RESISTANCE 53600
101 #define NANOPOWER3_1V8_RESISTANCE 37400
102 #define NANOPOWER3_2V_RESISTANCE 29000
103 #define NANOPOWER3_2V5_RESISTANCE 20000
104 #define NANOPOWER3_3V_RESISTANCE 15000
105 #define NANOPOWER3_3V3_RESISTANCE 13100
106 #define NANOPOWER3_3V5_RESISTANCE 12200
107 #define NANOPOWER3_4V_RESISTANCE 10000
108 #define NANOPOWER3_4V5_RESISTANCE 9000
109 
114 #define NANOPOWER3_R11_RESISTANCE 7200
115 #define NANOPOWER3_DIGIPOT_MAX_RESISTANCE 200000
116 #define NANOPOWER3_DIGIPOT_MAX_VAL 255
117 #define NANOPOWER3_MAX_RESISTANCE 207200
118 #define NANOPOWER3_ROUND_TO_NEAREST_INT 0.5
119 
124 #define NANOPOWER3_PIN_STATE_HIGH 0x01
125 #define NANOPOWER3_PIN_STATE_LOW 0x00
126 
132 #define NANOPOWER3_DEVICE_ADDRESS_GND 0x28
133 #define NANOPOWER3_DEVICE_ADDRESS_VCC 0x29
134  // nanopower3_set
136 
151 #define NANOPOWER3_MAP_MIKROBUS( cfg, mikrobus ) \
152  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
153  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
154  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
155  cfg.ctr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
156  cfg.pg = MIKROBUS( mikrobus, MIKROBUS_INT )
157  // nanopower3_map // nanopower3
160 
165 typedef struct
166 {
167  // Output pins
168  digital_out_t ctr;
170  // Input pins
171  digital_in_t an;
172  digital_in_t pg;
174  // Modules
175  i2c_master_t i2c;
177  // I2C slave address
178  uint8_t slave_address;
180 } nanopower3_t;
181 
186 typedef struct
187 {
188  pin_name_t scl;
189  pin_name_t sda;
191  pin_name_t an;
192  pin_name_t ctr;
193  pin_name_t pg;
195  uint32_t i2c_speed;
196  uint8_t i2c_address;
199 
204 typedef enum
205 {
207  NANOPOWER3_ERROR = -1
208 
210 
227 
242 
256 
271 err_t nanopower3_generic_write ( nanopower3_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
272 
287 err_t nanopower3_generic_read ( nanopower3_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
288 
299 
310 
320 void nanopower3_set_ctr_pin ( nanopower3_t *ctx, uint8_t pin_state );
321 
334 err_t nanopower3_write_data ( nanopower3_t *ctx, uint8_t cmd, uint8_t data_in );
335 
347 err_t nanopower3_set_wiper_pos ( nanopower3_t *ctx, uint8_t wiper_pos );
348 
360 err_t nanopower3_set_resistance ( nanopower3_t *ctx, uint32_t resistance );
361 
373 err_t nanopower3_set_voltage ( nanopower3_t *ctx, uint8_t out_vol );
374 
375 #ifdef __cplusplus
376 }
377 #endif
378 #endif // NANOPOWER3_H
379  // nanopower3
381 
382 // ------------------------------------------------------------------------ END
nanopower3_get_an_pin_state
uint8_t nanopower3_get_an_pin_state(nanopower3_t *ctx)
Nano Power 3 get AN pin state function.
nanopower3_set_voltage
err_t nanopower3_set_voltage(nanopower3_t *ctx, uint8_t out_vol)
Nano Power 3 set output voltage function.
nanopower3_cfg_t::an
pin_name_t an
Definition: nanopower3.h:191
nanopower3_cfg_t::i2c_address
uint8_t i2c_address
Definition: nanopower3.h:196
nanopower3_cfg_t::pg
pin_name_t pg
Definition: nanopower3.h:193
nanopower3_write_data
err_t nanopower3_write_data(nanopower3_t *ctx, uint8_t cmd, uint8_t data_in)
Nano Power 3 command writing function.
nanopower3_set_wiper_pos
err_t nanopower3_set_wiper_pos(nanopower3_t *ctx, uint8_t wiper_pos)
Nano Power 3 set wiper position function.
nanopower3_cfg_t
Nano Power 3 Click configuration object.
Definition: nanopower3.h:187
nanopower3_cfg_t::scl
pin_name_t scl
Definition: nanopower3.h:188
nanopower3_t
Nano Power 3 Click context object.
Definition: nanopower3.h:166
nanopower3_set_ctr_pin
void nanopower3_set_ctr_pin(nanopower3_t *ctx, uint8_t pin_state)
Nano Power 3 set CTRL pin state function.
NANOPOWER3_ERROR
@ NANOPOWER3_ERROR
Definition: nanopower3.h:207
nanopower3_t::an
digital_in_t an
Definition: nanopower3.h:171
nanopower3_t::pg
digital_in_t pg
Definition: nanopower3.h:172
nanopower3_default_cfg
err_t nanopower3_default_cfg(nanopower3_t *ctx)
Nano Power 3 default configuration function.
nanopower3_t::i2c
i2c_master_t i2c
Definition: nanopower3.h:175
nanopower3_return_value_t
nanopower3_return_value_t
Nano Power 3 Click return value data.
Definition: nanopower3.h:205
nanopower3_generic_write
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_init
err_t nanopower3_init(nanopower3_t *ctx, nanopower3_cfg_t *cfg)
Nano Power 3 initialization function.
nanopower3_get_pg_pin_state
uint8_t nanopower3_get_pg_pin_state(nanopower3_t *ctx)
Nano Power 3 get PG pin state function.
nanopower3_cfg_t::sda
pin_name_t sda
Definition: nanopower3.h:189
nanopower3_cfg_t::ctr
pin_name_t ctr
Definition: nanopower3.h:192
NANOPOWER3_OK
@ NANOPOWER3_OK
Definition: nanopower3.h:206
nanopower3_cfg_setup
void nanopower3_cfg_setup(nanopower3_cfg_t *cfg)
Nano Power 3 configuration object setup function.
nanopower3_t::ctr
digital_out_t ctr
Definition: nanopower3.h:168
nanopower3_t::slave_address
uint8_t slave_address
Definition: nanopower3.h:178
nanopower3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: nanopower3.h:195
nanopower3_generic_read
err_t nanopower3_generic_read(nanopower3_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Nano Power 3 I2C reading function.
nanopower3_set_resistance
err_t nanopower3_set_resistance(nanopower3_t *ctx, uint32_t resistance)
Nano Power 3 set resistance function.