battmon  2.0.0.0
battmon.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 BATTMON_H
35 #define BATTMON_H
36 
41 #ifdef PREINIT_SUPPORTED
42 #include "preinit.h"
43 #endif
44 
45 #ifdef MikroCCoreVersion
46  #if MikroCCoreVersion >= 1
47  #include "delays.h"
48  #endif
49 #endif
50 
51 #include "drv_digital_out.h"
52 #include "drv_digital_in.h"
53 #include "drv_i2c_master.h"
54 
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define BATTMON_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69  cfg.rio = MIKROBUS( mikrobus, MIKROBUS_RST ); \
70  cfg.alm = MIKROBUS( mikrobus, MIKROBUS_INT )
71 
77 #define BATTMON_RETVAL uint8_t
78 
79 #define BATTMON_OK 0x00
80 #define BATTMON_INIT_ERROR 0xFF
81 
87 #define DUMMY_BYTE 0x00
88 
94 #define BATTMON_DEV_ADDR 0x70
95 
101 #define BATTMON_REG_MODE 0
102 #define BATTMON_REG_CTRL 1
103 #define BATTMON_REG_SOC 2
104 #define BATTMON_REG_COUNTER 4
105 #define BATTMON_REG_CURRENT 6
106 #define BATTMON_REG_VOLTAGE 8
107 #define BATTMON_REG_TEMPERATURE 10
108 #define BATTMON_REG_CC_ADJ_HIGH 11
109 #define BATTMON_REG_VM_ADJ_HIGH 12
110 #define BATTMON_REG_OCV 13
111 #define BATTMON_REG_CC_CNF 15
112 #define BATTMON_REG_VM_CNF 17
113 #define BATTMON_REG_ALARM_SOC 19
114 #define BATTMON_REG_ALARM_VOLTAGE 20
115 #define BATTMON_REG_CURRENT_THRES 21
116 #define BATTMON_REG_RELAX_COUNT 22
117 #define BATTMON_REG_RELAX_MAX 23
118 #define BATTMON_REG_ID 24
119 #define BATTMON_REG_CC_ADJ_LOW 25
120 #define BATTMON_REG_VM_ADJ_LOW 26
121 #define BATTMON_ACC_CC_ADJ 27
122 #define BATTMON_ACC_VM_ADJ 29
123 
129 #define BATTMON_REG_RAM0 32
130 #define BATTMON_REG_RAM1 33
131 #define BATTMON_REG_RAM2 34
132 #define BATTMON_REG_RAM3 35
133 #define BATTMON_REG_RAM4 36
134 #define BATTMON_REG_RAM5 37
135 #define BATTMON_REG_RAM6 38
136 #define BATTMON_REG_RAM7 39
137 #define BATTMON_REG_RAM8 40
138 #define BATTMON_REG_RAM9 41
139 #define BATTMON_REG_RAM10 42
140 #define BATTMON_REG_RAM11 43
141 #define BATTMON_REG_RAM12 44
142 #define BATTMON_REG_RAM13 45
143 #define BATTMON_REG_RAM14 46
144 #define BATTMON_REG_RAM15 47
145 
151 #define BATTMON_REG_OCVTAB0 48
152 #define BATTMON_REG_OCVTAB1 49
153 #define BATTMON_REG_OCVTAB2 50
154 #define BATTMON_REG_OCVTAB3 51
155 #define BATTMON_REG_OCVTAB4 52
156 #define BATTMON_REG_OCVTAB5 53
157 #define BATTMON_REG_OCVTAB6 54
158 #define BATTMON_REG_OCVTAB7 55
159 #define BATTMON_REG_OCVTAB8 56
160 #define BATTMON_REG_OCVTAB9 57
161 #define BATTMON_REG_OCVTAB10 58
162 #define BATTMON_REG_OCVTAB11 59
163 #define BATTMON_REG_OCVTAB12 60
164 #define BATTMON_REG_OCVTAB13 61
165 #define BATTMON_REG_OCVTAB14 62
166 #define BATTMON_REG_OCVTAB15 63
167 
173 #define BATTMON_MIXED_MODE 0x00
174 #define BATTMON_PWR_SAVE_VOLT_MODE 0x01
175 #define BATTMON_CLR_VM_ADJ 0x02
176 #define BATTMON_CLR_CC_ADJ 0x04
177 #define BATTMON_ALM_EN 0x08
178 #define BATTMON_STNDBY_RUN_MODE 0x00
179 #define BATTMON_OP_RUN_MODE 0x10
180 #define BATTMON_FORCE_CC 0x20
181 #define BATTMON_FORCE_VM 0x40
182 
188 #define BATTMON_ALM_PIN_STAT_MASK 0x01
189 #define BATTMON_FORCE_ALM_PIN_LOW 0x00
190 #define BATTMON_DRIVE_ALM_PIN_COND 0x01
191 #define BATTMON_RST_CONV_CNT 0x02
192 #define BATTMON_SOC_STAT_MASK 0x04
193 #define BATTMON_SOC_CC_MODE 0x00
194 #define BATTMON_SOC_VM_MODE 0x04
195 #define BATTMON_BATFAIL_DET_MASK 0x08
196 #define BATTMON_POR_DET_MASK 0x10
197 #define BATTMON_POR_INACTIVE 0x00
198 #define BATTMON_POR_ACTIVE 0x10
199 #define BATTMON_SOFT_RST 0x10
200 #define BATTMON_ALM_SOC_DET_MASK 0x20
201 #define BATTMON_ALM_VOLT_DET_MASK 0x40
202 
208 #define BATTMON_INVALID_ADDR 0xFF
209 #define BATTMON_INVALID_NBYTES 0xFE
210 #define BATTMON_INVALID_ALM_VAL 0xFD
211 #define BATTMON_OK 0x00
212 #define BATTMON_LOG_LOW 0x00
213 #define BATTMON_LOG_HIGH 0x01
214  // End group macro
217 // --------------------------------------------------------------- PUBLIC TYPES
226 typedef struct
227 {
228  // Input pins
229 
230  digital_in_t rio;
231  digital_in_t alm;
232 
233  // Modules
234 
235  i2c_master_t i2c;
236 
237  // ctx variable
238 
239  uint8_t slave_address;
240 
241 } battmon_t;
242 
246 typedef struct
247 {
248  // Communication gpio pins
249 
250  pin_name_t scl;
251  pin_name_t sda;
252 
253  // Additional gpio pins
254 
255  pin_name_t rio;
256  pin_name_t alm;
257 
258  // static variable
259 
260  uint32_t i2c_speed;
261  uint8_t i2c_address;
262 
263 } battmon_cfg_t;
264  // End types group
266 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
267 
273 #ifdef __cplusplus
274 extern "C"{
275 #endif
276 
286 
295 
318 
329 void battmon_generic_write ( battmon_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
330 
342 void battmon_generic_read ( battmon_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
343 
356 uint8_t battmon_read_bytes ( battmon_t *ctx, uint8_t reg_addr, uint8_t *data_out, uint8_t n_bytes );
357 
369 uint8_t battmon_read_word ( battmon_t *ctx, uint8_t reg_addr, uint16_t *data_out );
370 
382 uint8_t battmon_write_byte ( battmon_t *ctx, uint8_t reg_addr, uint8_t data_in );
383 
395 uint8_t battmon_write_word ( battmon_t *ctx, uint8_t reg_addr, uint16_t data_in );
396 
416 float battmon_get_data ( battmon_t *ctx, uint8_t data_addr );
417 
432 uint8_t battmon_set_alarm ( battmon_t *ctx, uint8_t alarm_addr, float alarm_value );
433 
444 
457 
469 
478 
487 
488 #ifdef __cplusplus
489 }
490 #endif
491 #endif // _BATTMON_H_
492  // End public_function group
495 
496 // ------------------------------------------------------------------------- END
battmon_read_word
uint8_t battmon_read_word(battmon_t *ctx, uint8_t reg_addr, uint16_t *data_out)
Word Read function.
battmon_sw_reset
void battmon_sw_reset(battmon_t *ctx)
SW Reset function.
battmon_init
BATTMON_RETVAL battmon_init(battmon_t *ctx, battmon_cfg_t *cfg)
Initialization function.
battmon_get_data
float battmon_get_data(battmon_t *ctx, uint8_t data_addr)
Data Get function.
battmon_t::alm
digital_in_t alm
Definition: battmon.h:231
battmon_generic_write
void battmon_generic_write(battmon_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
battmon_reset_conv_cnt
void battmon_reset_conv_cnt(battmon_t *ctx)
Conversion Counter Reset function.
battmon_cfg_t::i2c_address
uint8_t i2c_address
Definition: battmon.h:261
BATTMON_RETVAL
#define BATTMON_RETVAL
Definition: battmon.h:77
battmon_cfg_t
Click configuration structure definition.
Definition: battmon.h:247
battmon_set_alarm
uint8_t battmon_set_alarm(battmon_t *ctx, uint8_t alarm_addr, float alarm_value)
Alarm Set function.
battmon_cfg_t::scl
pin_name_t scl
Definition: battmon.h:250
battmon_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: battmon.h:260
battmon_t::rio
digital_in_t rio
Definition: battmon.h:230
battmon_default_cfg
void battmon_default_cfg(battmon_t *ctx)
Click Default Configuration function.
battmon_write_byte
uint8_t battmon_write_byte(battmon_t *ctx, uint8_t reg_addr, uint8_t data_in)
Byte Write function.
battmon_cfg_t::sda
pin_name_t sda
Definition: battmon.h:251
battmon_write_word
uint8_t battmon_write_word(battmon_t *ctx, uint8_t reg_addr, uint16_t data_in)
Word Write function.
battmon_get_rio_pin
uint8_t battmon_get_rio_pin(battmon_t *ctx)
RIO Pin Get function.
battmon_check_clear_alarm
uint8_t battmon_check_clear_alarm(battmon_t *ctx)
Alarm Check And Clear function.
battmon_cfg_t::alm
pin_name_t alm
Definition: battmon.h:256
battmon_t::i2c
i2c_master_t i2c
Definition: battmon.h:235
battmon_t
Click ctx object definition.
Definition: battmon.h:227
battmon_read_bytes
uint8_t battmon_read_bytes(battmon_t *ctx, uint8_t reg_addr, uint8_t *data_out, uint8_t n_bytes)
Bytes Read function.
battmon_generic_read
void battmon_generic_read(battmon_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
battmon_cfg_setup
void battmon_cfg_setup(battmon_cfg_t *cfg)
Config Object Initialization function.
battmon_cfg_t::rio
pin_name_t rio
Definition: battmon.h:255
battmon_t::slave_address
uint8_t slave_address
Definition: battmon.h:239
battmon_get_alm_pin
uint8_t battmon_get_alm_pin(battmon_t *ctx)
ALM Pin Get function.