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 
37 #include "mikrosdk_version.h"
38 
39 #ifdef __GNUC__
40 #if mikroSDK_GET_VERSION < 20800ul
41 #include "rcu_delays.h"
42 #else
43 #include "delays.h"
44 #endif
45 #endif
46 
47 #include "drv_digital_out.h"
48 #include "drv_digital_in.h"
49 #include "drv_i2c_master.h"
50 
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define BATTMON_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
65  cfg.rio = MIKROBUS( mikrobus, MIKROBUS_RST ); \
66  cfg.alm = MIKROBUS( mikrobus, MIKROBUS_INT )
67 
73 #define BATTMON_RETVAL uint8_t
74 
75 #define BATTMON_OK 0x00
76 #define BATTMON_INIT_ERROR 0xFF
77 
83 #define DUMMY_BYTE 0x00
84 
90 #define BATTMON_DEV_ADDR 0x70
91 
97 #define BATTMON_REG_MODE 0
98 #define BATTMON_REG_CTRL 1
99 #define BATTMON_REG_SOC 2
100 #define BATTMON_REG_COUNTER 4
101 #define BATTMON_REG_CURRENT 6
102 #define BATTMON_REG_VOLTAGE 8
103 #define BATTMON_REG_TEMPERATURE 10
104 #define BATTMON_REG_CC_ADJ_HIGH 11
105 #define BATTMON_REG_VM_ADJ_HIGH 12
106 #define BATTMON_REG_OCV 13
107 #define BATTMON_REG_CC_CNF 15
108 #define BATTMON_REG_VM_CNF 17
109 #define BATTMON_REG_ALARM_SOC 19
110 #define BATTMON_REG_ALARM_VOLTAGE 20
111 #define BATTMON_REG_CURRENT_THRES 21
112 #define BATTMON_REG_RELAX_COUNT 22
113 #define BATTMON_REG_RELAX_MAX 23
114 #define BATTMON_REG_ID 24
115 #define BATTMON_REG_CC_ADJ_LOW 25
116 #define BATTMON_REG_VM_ADJ_LOW 26
117 #define BATTMON_ACC_CC_ADJ 27
118 #define BATTMON_ACC_VM_ADJ 29
119 
125 #define BATTMON_REG_RAM0 32
126 #define BATTMON_REG_RAM1 33
127 #define BATTMON_REG_RAM2 34
128 #define BATTMON_REG_RAM3 35
129 #define BATTMON_REG_RAM4 36
130 #define BATTMON_REG_RAM5 37
131 #define BATTMON_REG_RAM6 38
132 #define BATTMON_REG_RAM7 39
133 #define BATTMON_REG_RAM8 40
134 #define BATTMON_REG_RAM9 41
135 #define BATTMON_REG_RAM10 42
136 #define BATTMON_REG_RAM11 43
137 #define BATTMON_REG_RAM12 44
138 #define BATTMON_REG_RAM13 45
139 #define BATTMON_REG_RAM14 46
140 #define BATTMON_REG_RAM15 47
141 
147 #define BATTMON_REG_OCVTAB0 48
148 #define BATTMON_REG_OCVTAB1 49
149 #define BATTMON_REG_OCVTAB2 50
150 #define BATTMON_REG_OCVTAB3 51
151 #define BATTMON_REG_OCVTAB4 52
152 #define BATTMON_REG_OCVTAB5 53
153 #define BATTMON_REG_OCVTAB6 54
154 #define BATTMON_REG_OCVTAB7 55
155 #define BATTMON_REG_OCVTAB8 56
156 #define BATTMON_REG_OCVTAB9 57
157 #define BATTMON_REG_OCVTAB10 58
158 #define BATTMON_REG_OCVTAB11 59
159 #define BATTMON_REG_OCVTAB12 60
160 #define BATTMON_REG_OCVTAB13 61
161 #define BATTMON_REG_OCVTAB14 62
162 #define BATTMON_REG_OCVTAB15 63
163 
169 #define BATTMON_MIXED_MODE 0x00
170 #define BATTMON_PWR_SAVE_VOLT_MODE 0x01
171 #define BATTMON_CLR_VM_ADJ 0x02
172 #define BATTMON_CLR_CC_ADJ 0x04
173 #define BATTMON_ALM_EN 0x08
174 #define BATTMON_STNDBY_RUN_MODE 0x00
175 #define BATTMON_OP_RUN_MODE 0x10
176 #define BATTMON_FORCE_CC 0x20
177 #define BATTMON_FORCE_VM 0x40
178 
184 #define BATTMON_ALM_PIN_STAT_MASK 0x01
185 #define BATTMON_FORCE_ALM_PIN_LOW 0x00
186 #define BATTMON_DRIVE_ALM_PIN_COND 0x01
187 #define BATTMON_RST_CONV_CNT 0x02
188 #define BATTMON_SOC_STAT_MASK 0x04
189 #define BATTMON_SOC_CC_MODE 0x00
190 #define BATTMON_SOC_VM_MODE 0x04
191 #define BATTMON_BATFAIL_DET_MASK 0x08
192 #define BATTMON_POR_DET_MASK 0x10
193 #define BATTMON_POR_INACTIVE 0x00
194 #define BATTMON_POR_ACTIVE 0x10
195 #define BATTMON_SOFT_RST 0x10
196 #define BATTMON_ALM_SOC_DET_MASK 0x20
197 #define BATTMON_ALM_VOLT_DET_MASK 0x40
198 
204 #define BATTMON_INVALID_ADDR 0xFF
205 #define BATTMON_INVALID_NBYTES 0xFE
206 #define BATTMON_INVALID_ALM_VAL 0xFD
207 #define BATTMON_OK 0x00
208 #define BATTMON_LOG_LOW 0x00
209 #define BATTMON_LOG_HIGH 0x01
210  // End group macro
213 // --------------------------------------------------------------- PUBLIC TYPES
222 typedef struct
223 {
224  // Input pins
225 
226  digital_in_t rio;
227  digital_in_t alm;
228 
229  // Modules
230 
231  i2c_master_t i2c;
232 
233  // ctx variable
234 
235  uint8_t slave_address;
236 
237 } battmon_t;
238 
242 typedef struct
243 {
244  // Communication gpio pins
245 
246  pin_name_t scl;
247  pin_name_t sda;
248 
249  // Additional gpio pins
250 
251  pin_name_t rio;
252  pin_name_t alm;
253 
254  // static variable
255 
256  uint32_t i2c_speed;
257  uint8_t i2c_address;
258 
259 } battmon_cfg_t;
260  // End types group
262 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
263 
269 #ifdef __cplusplus
270 extern "C"{
271 #endif
272 
282 
291 
314 
325 void battmon_generic_write ( battmon_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
326 
338 void battmon_generic_read ( battmon_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
339 
352 uint8_t battmon_read_bytes ( battmon_t *ctx, uint8_t reg_addr, uint8_t *data_out, uint8_t n_bytes );
353 
365 uint8_t battmon_read_word ( battmon_t *ctx, uint8_t reg_addr, uint16_t *data_out );
366 
378 uint8_t battmon_write_byte ( battmon_t *ctx, uint8_t reg_addr, uint8_t data_in );
379 
391 uint8_t battmon_write_word ( battmon_t *ctx, uint8_t reg_addr, uint16_t data_in );
392 
412 float battmon_get_data ( battmon_t *ctx, uint8_t data_addr );
413 
428 uint8_t battmon_set_alarm ( battmon_t *ctx, uint8_t alarm_addr, float alarm_value );
429 
440 
453 
465 
474 
483 
484 #ifdef __cplusplus
485 }
486 #endif
487 #endif // _BATTMON_H_
488  // End public_function group
491 
492 // ------------------------------------------------------------------------- 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:227
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:257
BATTMON_RETVAL
#define BATTMON_RETVAL
Definition: battmon.h:73
battmon_cfg_t
Click configuration structure definition.
Definition: battmon.h:243
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:246
battmon_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: battmon.h:256
battmon_t::rio
digital_in_t rio
Definition: battmon.h:226
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:247
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:252
battmon_t::i2c
i2c_master_t i2c
Definition: battmon.h:231
battmon_t
Click ctx object definition.
Definition: battmon.h:223
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:251
battmon_t::slave_address
uint8_t slave_address
Definition: battmon.h:235
battmon_get_alm_pin
uint8_t battmon_get_alm_pin(battmon_t *ctx)
ALM Pin Get function.