battmon2  2.0.0.0
battmon2.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 BATTMON2_H
29 #define BATTMON2_H
30 
31 #ifdef __cplusplus
32 extern "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 BATTMON2_REG_STATUS 0x00
60 #define BATTMON2_REG_V_ALRT_TH 0x01
61 #define BATTMON2_REG_T_ALRT_TH 0x02
62 #define BATTMON2_REG_S_ALRT_TH 0x03
63 #define BATTMON2_REG_AT_RATE 0x04
64 #define BATTMON2_REG_REP_CAP 0x05
65 #define BATTMON2_REG_REP_SOC 0x06
66 #define BATTMON2_REG_AGE 0x07
67 #define BATTMON2_REG_TEMP 0x08
68 #define BATTMON2_REG_V_CELL 0x09
69 #define BATTMON2_REG_CURRENT 0x0A
70 #define BATTMON2_REG_AVG_CURRENT 0x0B
71 #define BATTMON2_REG_Q_RESIDUAL 0x0C
72 #define BATTMON2_REG_MIX_SOC 0x0D
73 #define BATTMON2_REG_AV_SOC 0x0E
74 #define BATTMON2_REG_MIX_CAP 0x0F
75 #define BATTMON2_REG_FULL_CAP_REP 0x10
76 #define BATTMON2_REG_TTE 0x11
77 #define BATTMON2_REG_QR_TABLE_00 0x12
78 #define BATTMON2_REG_FULL_SOC_THR 0x13
79 #define BATTMON2_REG_R_CELL 0x14
80 #define BATTMON2_REG_AVG_TA 0x16
81 #define BATTMON2_REG_CYCLES 0x17
82 #define BATTMON2_REG_DESIGN_CAP 0x18
83 #define BATTMON2_REG_AVG_V_CELL 0x19
84 #define BATTMON2_REG_MAX_MIN_TEMP 0x1A
85 #define BATTMON2_REG_MAX_MIN_VOLT 0x1B
86 #define BATTMON2_REG_MAX_MIN_CURR 0x1C
87 #define BATTMON2_REG_CONFIG 0x1D
88 #define BATTMON2_REG_I_CHG_TERM 0x1E
89 #define BATTMON2_REG_AV_CAP 0x1F
90 #define BATTMON2_REG_TTF 0x20
91 #define BATTMON2_REG_DEV_NAME 0x21
92 #define BATTMON2_REG_QR_TABLE_10 0x22
93 #define BATTMON2_REG_FULL_CAP_NOM 0x23
94 #define BATTMON2_REG_AIN 0x27
95 #define BATTMON2_REG_LEARN_CFG 0x28
96 #define BATTMON2_REG_FILTER_CFG 0x29
97 #define BATTMON2_REG_RELAX_CFG 0x2A
98 #define BATTMON2_REG_MISC_CFG 0x2B
99 #define BATTMON2_REG_T_GAIN 0x2C
100 #define BATTMON2_REG_T_OFF 0x2D
101 #define BATTMON2_REG_C_GAIN 0x2E
102 #define BATTMON2_REG_C_OFF 0x2F
103 #define BATTMON2_REG_QR_TABLE_20 0x32
104 #define BATTMON2_REG_DIE_TEMP 0x34
105 #define BATTMON2_REG_FULL_CAP 0x35
106 #define BATTMON2_REG_R_COMP_0 0x38
107 #define BATTMON2_REG_TEMP_CO 0x39
108 #define BATTMON2_REG_V_EMPTY 0x3A
109 #define BATTMON2_REG_F_STAT 0x3D
110 #define BATTMON2_REG_TIMER 0x3E
111 #define BATTMON2_REG_SHDN_TIMER 0x3F
112 #define BATTMON2_REG_QR_TABLE_30 0x42
113 #define BATTMON2_REG_R_GAIN 0x43
114 #define BATTMON2_REG_DQ_ACC 0x45
115 #define BATTMON2_REG_DP_ACC 0x46
116 #define BATTMON2_REG_CONVG_CFG 0x49
117 #define BATTMON2_REG_V_F_REM_CAP 0x4A
118 #define BATTMON2_REG_QH 0x4D
119 #define BATTMON2_REG_SOFT_WAKEUP 0x60
120 #define BATTMON2_REG_STATUS_2 0xB0
121 #define BATTMON2_REG_POWER 0xB1
122 #define BATTMON2_REG_ID_USER_MEM_2 0xB2
123 #define BATTMON2_REG_AVG_POWER 0xB3
124 #define BATTMON2_REG_I_ALRT_TH 0xB4
125 #define BATTMON2_REG_TTF_CFG 0xB5
126 #define BATTMON2_REG_C_V_MIX_CAP 0xB6
127 #define BATTMON2_REG_C_V_HALF_TIME 0xB7
128 #define BATTMON2_REG_C_G_TEMP_CO 0xB8
129 #define BATTMON2_REG_CURVE 0xB9
130 #define BATTMON2_REG_HIB_CFG 0xBA
131 #define BATTMON2_REG_CONFIG_2 0xBB
132 #define BATTMON2_REG_V_RIPPLE 0xBC
133 #define BATTMON2_REG_RIPPLE_CFG 0xBD
134 #define BATTMON2_REG_TIMER_H 0xBE
135 #define BATTMON2_REG_R_SENSE_USER_MEM_3 0xD0
136 #define BATTMON2_REG_SC_OCV_LIM 0xD1
137 #define BATTMON2_REG_V_GAIN 0xD2
138 #define BATTMON2_REG_SOC_HOLD 0xD3
139 #define BATTMON2_REG_MAX_PEAK_POWER 0xD4
140 #define BATTMON2_REG_SUS_PEAK_POWER 0xD5
141 #define BATTMON2_REG_PACK_RESISTANCE 0xD6
142 #define BATTMON2_REG_SYS_RESISTANCE 0xD7
143 #define BATTMON2_REG_MIN_SYS_VOLTAGE 0xD8
144 #define BATTMON2_REG_MPP_CURRENT 0xD9
145 #define BATTMON2_REG_SPP_CURRENT 0xDA
146 #define BATTMON2_REG_MODEL_CFG 0xDB
147 #define BATTMON2_REG_AT_Q_RESIDUAL 0xDC
148 #define BATTMON2_REG_AT_TTE 0xDD
149 #define BATTMON2_REG_AT_AV_SOC 0xDE
150 #define BATTMON2_REG_AT_AV_CAP 0xDF
151  // battmon2_reg
153 
168 #define BATTMON2_CAPACITY_RESOLUTION 0.5
169 #define BATTMON2_PERCENTAGE_RESOLUTION ( 1.0 / 256.0 )
170 #define BATTMON2_VOLTAGE_RESOLUTION ( 1.25 / 16.0 )
171 #define BATTMON2_CURRENT_RESOLUTION 0.15625
172 #define BATTMON2_TEMPERATURE_RESOLUTION ( 1.0 / 256.0 )
173 #define BATTMON2_TIME_RESOLUTION 5.625
174 
179 #define BATTMON2_DEVICE_ID 0x4039
180 
186 #define BATTMON2_SET_DEV_ADDR 0x36
187  // battmon2_set
189 
204 #define BATTMON2_MAP_MIKROBUS( cfg, mikrobus ) \
205  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
206  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
207  cfg.alert = MIKROBUS( mikrobus, MIKROBUS_INT )
208  // battmon2_map // battmon2
211 
216 typedef struct
217 {
218  // Input pins
219  digital_in_t alert;
221  // Modules
222  i2c_master_t i2c;
224  // I2C slave address
225  uint8_t slave_address;
227 } battmon2_t;
228 
233 typedef struct
234 {
235  pin_name_t scl;
236  pin_name_t sda;
238  pin_name_t alert;
240  uint32_t i2c_speed;
241  uint8_t i2c_address;
244 
249 typedef enum
250 {
252  BATTMON2_ERROR = -1
253 
255 
272 
287 
302 err_t battmon2_generic_write ( battmon2_t *ctx, uint8_t reg, uint16_t *tx_buf, uint8_t tx_len );
303 
318 err_t battmon2_generic_read ( battmon2_t *ctx, uint8_t reg, uint16_t *rx_buf, uint8_t rx_len );
319 
333 err_t battmon2_write_register ( battmon2_t *ctx, uint8_t reg, uint16_t data_in );
334 
348 err_t battmon2_read_register ( battmon2_t *ctx, uint8_t reg, uint16_t *data_out );
349 
361 
371 
383 err_t battmon2_get_die_temperature ( battmon2_t *ctx, float *temperature );
384 
396 err_t battmon2_get_battery_capacity ( battmon2_t *ctx, float *capacity );
397 
409 err_t battmon2_get_battery_percentage ( battmon2_t *ctx, float *percentage );
410 
422 err_t battmon2_get_battery_voltage ( battmon2_t *ctx, float *voltage );
423 
435 err_t battmon2_get_battery_current ( battmon2_t *ctx, float *current );
436 
448 err_t battmon2_get_battery_tte ( battmon2_t *ctx, uint32_t *time_to_empty );
449 
461 err_t battmon2_get_battery_ttf ( battmon2_t *ctx, uint32_t *time_to_full );
462 
463 #ifdef __cplusplus
464 }
465 #endif
466 #endif // BATTMON2_H
467  // battmon2
469 
470 // ------------------------------------------------------------------------ END
battmon2_cfg_t::alert
pin_name_t alert
Definition: battmon2.h:238
battmon2_get_battery_tte
err_t battmon2_get_battery_tte(battmon2_t *ctx, uint32_t *time_to_empty)
BATT-MON 2 get battery tte function.
battmon2_generic_read
err_t battmon2_generic_read(battmon2_t *ctx, uint8_t reg, uint16_t *rx_buf, uint8_t rx_len)
BATT-MON 2 I2C reading function.
battmon2_t
BATT-MON 2 Click context object.
Definition: battmon2.h:217
battmon2_cfg_t
BATT-MON 2 Click configuration object.
Definition: battmon2.h:234
BATTMON2_OK
@ BATTMON2_OK
Definition: battmon2.h:251
battmon2_generic_write
err_t battmon2_generic_write(battmon2_t *ctx, uint8_t reg, uint16_t *tx_buf, uint8_t tx_len)
BATT-MON 2 I2C writing function.
battmon2_check_communication
err_t battmon2_check_communication(battmon2_t *ctx)
BATT-MON 2 check communication function.
battmon2_t::i2c
i2c_master_t i2c
Definition: battmon2.h:222
battmon2_t::slave_address
uint8_t slave_address
Definition: battmon2.h:225
battmon2_cfg_t::scl
pin_name_t scl
Definition: battmon2.h:235
battmon2_return_value_t
battmon2_return_value_t
BATT-MON 2 Click return value data.
Definition: battmon2.h:250
battmon2_get_battery_capacity
err_t battmon2_get_battery_capacity(battmon2_t *ctx, float *capacity)
BATT-MON 2 get battery capacity function.
battmon2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: battmon2.h:240
battmon2_get_battery_voltage
err_t battmon2_get_battery_voltage(battmon2_t *ctx, float *voltage)
BATT-MON 2 get battery voltage function.
battmon2_get_battery_ttf
err_t battmon2_get_battery_ttf(battmon2_t *ctx, uint32_t *time_to_full)
BATT-MON 2 get battery ttf function.
battmon2_read_register
err_t battmon2_read_register(battmon2_t *ctx, uint8_t reg, uint16_t *data_out)
BATT-MON 2 read register function.
battmon2_cfg_setup
void battmon2_cfg_setup(battmon2_cfg_t *cfg)
BATT-MON 2 configuration object setup function.
battmon2_get_battery_percentage
err_t battmon2_get_battery_percentage(battmon2_t *ctx, float *percentage)
BATT-MON 2 get battery percentage function.
BATTMON2_ERROR
@ BATTMON2_ERROR
Definition: battmon2.h:252
battmon2_write_register
err_t battmon2_write_register(battmon2_t *ctx, uint8_t reg, uint16_t data_in)
BATT-MON 2 write register function.
battmon2_cfg_t::i2c_address
uint8_t i2c_address
Definition: battmon2.h:241
battmon2_init
err_t battmon2_init(battmon2_t *ctx, battmon2_cfg_t *cfg)
BATT-MON 2 initialization function.
battmon2_t::alert
digital_in_t alert
Definition: battmon2.h:219
battmon2_get_alert_pin
uint8_t battmon2_get_alert_pin(battmon2_t *ctx)
BATT-MON 2 get alert pin function.
battmon2_get_battery_current
err_t battmon2_get_battery_current(battmon2_t *ctx, float *current)
BATT-MON 2 get battery current function.
battmon2_get_die_temperature
err_t battmon2_get_die_temperature(battmon2_t *ctx, float *temperature)
BATT-MON 2 get die temperature function.
battmon2_cfg_t::sda
pin_name_t sda
Definition: battmon2.h:236