currentlimit5  2.0.0.0
currentlimit5.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 CURRENTLIMIT5_H
29 #define CURRENTLIMIT5_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
48 
69 #define CURRENTLIMIT5_DIGIPOT_MAX_VALUE 5000
70 #define CURRENTLIMIT5_DIGIPOT_OFFSET 80
71 #define CURRENTLIMIT5_DIGIPOT_RESOLUTION 257
72 #define CURRENTLIMIT5_ROUND_TO_NEAREST_INT 0.5
73 
79 #define CURRENTLIMIT5_SET_DEV_ADDR 0x2F
80  // currentlimit5_set
82 
97 #define CURRENTLIMIT5_MAP_MIKROBUS( cfg, mikrobus ) \
98  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
99  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
100  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
101  cfg.fault = MIKROBUS( mikrobus, MIKROBUS_INT )
102  // currentlimit5_map // currentlimit5
105 
110 typedef struct
111 {
112  // Output pins
113  digital_out_t en;
115  // Input pins
116  digital_in_t fault;
118  // Modules
119  i2c_master_t i2c;
121  // I2C slave address
122  uint8_t slave_address;
125 
130 typedef struct
131 {
132  pin_name_t scl;
133  pin_name_t sda;
135  pin_name_t en;
136  pin_name_t fault;
138  uint32_t i2c_speed;
139  uint8_t i2c_address;
142 
147 typedef enum
148 {
151 
153 
158 typedef enum
159 {
171 
173 
190 
206 
221 
236 
247 
257 
267 
268 #ifdef __cplusplus
269 }
270 #endif
271 #endif // CURRENTLIMIT5_H
272  // currentlimit5
274 
275 // ------------------------------------------------------------------------ END
currentlimit5_cfg_t::sda
pin_name_t sda
Definition: currentlimit5.h:133
CURRENTLIMIT5_ILIMIT_1000mA
@ CURRENTLIMIT5_ILIMIT_1000mA
Definition: currentlimit5.h:169
currentlimit5_cfg_setup
void currentlimit5_cfg_setup(currentlimit5_cfg_t *cfg)
Current Limit 5 configuration object setup function.
CURRENTLIMIT5_ILIMIT_300mA
@ CURRENTLIMIT5_ILIMIT_300mA
Definition: currentlimit5.h:162
CURRENTLIMIT5_ILIMIT_200mA
@ CURRENTLIMIT5_ILIMIT_200mA
Definition: currentlimit5.h:161
currentlimit5_cfg_t::en
pin_name_t en
Definition: currentlimit5.h:135
currentlimit5_t::slave_address
uint8_t slave_address
Definition: currentlimit5.h:122
CURRENTLIMIT5_ILIMIT_800mA
@ CURRENTLIMIT5_ILIMIT_800mA
Definition: currentlimit5.h:167
CURRENTLIMIT5_ILIMIT_1100mA
@ CURRENTLIMIT5_ILIMIT_1100mA
Definition: currentlimit5.h:170
CURRENTLIMIT5_ILIMIT_600mA
@ CURRENTLIMIT5_ILIMIT_600mA
Definition: currentlimit5.h:165
currentlimit5_cfg_t::scl
pin_name_t scl
Definition: currentlimit5.h:132
CURRENTLIMIT5_ILIMIT_900mA
@ CURRENTLIMIT5_ILIMIT_900mA
Definition: currentlimit5.h:168
currentlimit5_cfg_t::i2c_address
uint8_t i2c_address
Definition: currentlimit5.h:139
currentlimit5_set_ilimit
err_t currentlimit5_set_ilimit(currentlimit5_t *ctx, currentlimit5_ilimit_t ilimit)
Current Limit 5 set ilimit function.
currentlimit5_default_cfg
err_t currentlimit5_default_cfg(currentlimit5_t *ctx)
Current Limit 5 default configuration function.
CURRENTLIMIT5_ILIMIT_100mA
@ CURRENTLIMIT5_ILIMIT_100mA
Definition: currentlimit5.h:160
CURRENTLIMIT5_OK
@ CURRENTLIMIT5_OK
Definition: currentlimit5.h:149
currentlimit5_ilimit_t
currentlimit5_ilimit_t
Current Limit 5 Click Ilimit values.
Definition: currentlimit5.h:159
currentlimit5_t::i2c
i2c_master_t i2c
Definition: currentlimit5.h:119
currentlimit5_cfg_t::fault
pin_name_t fault
Definition: currentlimit5.h:136
CURRENTLIMIT5_ILIMIT_700mA
@ CURRENTLIMIT5_ILIMIT_700mA
Definition: currentlimit5.h:166
currentlimit5_return_value_t
currentlimit5_return_value_t
Current Limit 5 Click return value data.
Definition: currentlimit5.h:148
currentlimit5_enable_limit
void currentlimit5_enable_limit(currentlimit5_t *ctx)
Current Limit 5 enable limit function.
currentlimit5_get_fault_pin
uint8_t currentlimit5_get_fault_pin(currentlimit5_t *ctx)
Current Limit 5 get fault pin function.
currentlimit5_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: currentlimit5.h:138
currentlimit5_t::fault
digital_in_t fault
Definition: currentlimit5.h:116
currentlimit5_init
err_t currentlimit5_init(currentlimit5_t *ctx, currentlimit5_cfg_t *cfg)
Current Limit 5 initialization function.
CURRENTLIMIT5_ILIMIT_400mA
@ CURRENTLIMIT5_ILIMIT_400mA
Definition: currentlimit5.h:163
currentlimit5_cfg_t
Current Limit 5 Click configuration object.
Definition: currentlimit5.h:131
CURRENTLIMIT5_ILIMIT_500mA
@ CURRENTLIMIT5_ILIMIT_500mA
Definition: currentlimit5.h:164
currentlimit5_disable_limit
void currentlimit5_disable_limit(currentlimit5_t *ctx)
Current Limit 5 disable limit function.
currentlimit5_t
Current Limit 5 Click context object.
Definition: currentlimit5.h:111
currentlimit5_t::en
digital_out_t en
Definition: currentlimit5.h:113
CURRENTLIMIT5_ERROR
@ CURRENTLIMIT5_ERROR
Definition: currentlimit5.h:150