currentlimit10  2.1.0.0
currentlimit10.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 CURRENTLIMIT10_H
29 #define CURRENTLIMIT10_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 CURRENTLIMIT10_CMD_VREG 0x11
60 #define CURRENTLIMIT10_CMD_NVREG 0x21
61 #define CURRENTLIMIT10_CMD_VREGxNVREG 0x51
62 #define CURRENTLIMIT10_CMD_NVREGxVREG 0x61
63  // currentlimit10_reg
65 
80 #define CURRENTLIMIT10_WIPER_POS_MIN 0
81 #define CURRENTLIMIT10_WIPER_POS_MIDDLE 127
82 #define CURRENTLIMIT10_WIPER_POS_MAX 255
83 #define CURRENTLIMIT10_RES_200_KOHM 200.0f
84 
89 #define CURRENTLIMIT10_FAULT_FLAG 0
90 
95 #define CURRENTLIMIT10_COEFF_MULTI 0.37f
96 #define CURRENTLIMIT10_TYP_V_ILIM_MV 289.0f
97 #define CURRENTLIMIT10_RES_L_20_KOHM 20.0f
98 #define CURRENTLIMIT10_LIMIT_MIN 0.5f
99 #define CURRENTLIMIT10_LIMIT_MAX 5.5f
100 
106 #define CURRENTLIMIT10_DEVICE_ADDRESS 0x28
107  // currentlimit10_set
109 
124 #define CURRENTLIMIT10_MAP_MIKROBUS( cfg, mikrobus ) \
125  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
126  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
127  cfg.on = MIKROBUS( mikrobus, MIKROBUS_RST ); \
128  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
129  // currentlimit10_map // currentlimit10
132 
137 typedef struct
138 {
139  // Output pins
140  digital_out_t on;
142  // Input pins
143  digital_in_t flt;
145  float offset;
147  // Modules
148  i2c_master_t i2c;
150  // I2C slave address
151  uint8_t slave_address;
154 
159 typedef struct
160 {
161  pin_name_t scl;
162  pin_name_t sda;
164  pin_name_t on;
165  pin_name_t flt;
167  uint32_t i2c_speed;
168  uint8_t i2c_address;
171 
176 typedef enum
177 {
180 
182 
199 
214 
228 
240 
252 
266 err_t currentlimit10_write_data ( currentlimit10_t *ctx, uint8_t cmd, uint8_t data_in );
267 
281 err_t currentlimit10_set_wiper_pos ( currentlimit10_t *ctx, uint8_t wiper_pos );
282 
296 err_t currentlimit10_set_resistance ( currentlimit10_t *ctx, float res_kohm );
297 
310 err_t currentlimit10_set_limit ( currentlimit10_t *ctx, float current_limit );
311 
327 
328 #ifdef __cplusplus
329 }
330 #endif
331 #endif // CURRENTLIMIT10_H
332  // currentlimit10
334 
335 // ------------------------------------------------------------------------ END
currentlimit10_set_limit
err_t currentlimit10_set_limit(currentlimit10_t *ctx, float current_limit)
Current Limit 10 sets the current limit function.
currentlimit10_t::i2c
i2c_master_t i2c
Definition: currentlimit10.h:148
currentlimit10_enable
void currentlimit10_enable(currentlimit10_t *ctx)
Current Limit 10 enable the device function.
currentlimit10_t::on
digital_out_t on
Definition: currentlimit10.h:140
currentlimit10_cfg_t::on
pin_name_t on
Definition: currentlimit10.h:164
currentlimit10_cfg_t::sda
pin_name_t sda
Definition: currentlimit10.h:162
currentlimit10_cfg_t::scl
pin_name_t scl
Definition: currentlimit10.h:161
currentlimit10_return_value_t
currentlimit10_return_value_t
Current Limit 10 Click return value data.
Definition: currentlimit10.h:177
currentlimit10_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: currentlimit10.h:167
currentlimit10_get_fault
uint8_t currentlimit10_get_fault(currentlimit10_t *ctx)
Current Limit 10 get the fault flag function.
currentlimit10_cfg_t
Current Limit 10 Click configuration object.
Definition: currentlimit10.h:160
currentlimit10_t
Current Limit 10 Click context object.
Definition: currentlimit10.h:138
currentlimit10_set_wiper_pos
err_t currentlimit10_set_wiper_pos(currentlimit10_t *ctx, uint8_t wiper_pos)
Current Limit 10 sets the wiper position function.
currentlimit10_t::slave_address
uint8_t slave_address
Definition: currentlimit10.h:151
currentlimit10_set_resistance
err_t currentlimit10_set_resistance(currentlimit10_t *ctx, float res_kohm)
Current Limit 10 sets the resistance function.
currentlimit10_cfg_t::i2c_address
uint8_t i2c_address
Definition: currentlimit10.h:168
currentlimit10_t::flt
digital_in_t flt
Definition: currentlimit10.h:143
currentlimit10_disable
void currentlimit10_disable(currentlimit10_t *ctx)
Current Limit 10 disable the device function.
CURRENTLIMIT10_ERROR
@ CURRENTLIMIT10_ERROR
Definition: currentlimit10.h:179
currentlimit10_t::offset
float offset
Definition: currentlimit10.h:145
currentlimit10_cfg_t::flt
pin_name_t flt
Definition: currentlimit10.h:165
currentlimit10_init
err_t currentlimit10_init(currentlimit10_t *ctx, currentlimit10_cfg_t *cfg)
Current Limit 10 initialization function.
CURRENTLIMIT10_OK
@ CURRENTLIMIT10_OK
Definition: currentlimit10.h:178
currentlimit10_default_cfg
err_t currentlimit10_default_cfg(currentlimit10_t *ctx)
Current Limit 10 default configuration function.
currentlimit10_cfg_setup
void currentlimit10_cfg_setup(currentlimit10_cfg_t *cfg)
Current Limit 10 configuration object setup function.
currentlimit10_write_data
err_t currentlimit10_write_data(currentlimit10_t *ctx, uint8_t cmd, uint8_t data_in)
Current Limit 10 I2C writing function.