currentlimit  2.0.0.0
currentlimit.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2021 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 CURRENTLIMIT_H
29 #define CURRENTLIMIT_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_spi_master.h"
48 #include "spi_specifics.h"
49 
70 #define CURRENTLIMIT_ENABLE 1
71 #define CURRENTLIMIT_DISABLE 0
72 
73 #define CURRENTLIMIT_LSB_VAL 392.2
74 #define CURRENTLIMIT_R_BASE 1200.0
75 #define CURRENTLIMIT_I_MAX 1.2
76 #define CURRENTLIMIT_CALC_COEF 1380.0
77 
78 #define CURRENTLIMIT_CUR_LIM_VAL_0_1 224
79 #define CURRENTLIMIT_CUR_LIM_VAL_0_2 241
80 #define CURRENTLIMIT_CUR_LIM_VAL_0_3 247
81 #define CURRENTLIMIT_CUR_LIM_VAL_0_4 250
82 #define CURRENTLIMIT_CUR_LIM_VAL_0_5 252
83 #define CURRENTLIMIT_CUR_LIM_VAL_0_6 253
84 #define CURRENTLIMIT_CUR_LIM_VAL_0_7 254
85 #define CURRENTLIMIT_CUR_LIM_VAL_0_867 255
86 
95 #define CURRENTLIMIT_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
96 #define CURRENTLIMIT_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
97  // currentlimit_set
99 
114 #define CURRENTLIMIT_MAP_MIKROBUS( cfg, mikrobus ) \
115  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
116  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
117  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
118  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
119  cfg.en = MIKROBUS( mikrobus, MIKROBUS_AN )
120  // currentlimit_map // currentlimit
123 
128 typedef struct
129 {
130  // Output pins
131  digital_out_t en;
133  // Modules
134  spi_master_t spi;
136  pin_name_t chip_select;
139 
144 typedef struct
145 {
146  // Communication gpio pins
147  pin_name_t miso;
148  pin_name_t mosi;
149  pin_name_t sck;
150  pin_name_t cs;
152  // Additional gpio pins
153  pin_name_t en;
155  // static variable
156  uint32_t spi_speed;
157  spi_master_mode_t spi_mode;
158  spi_master_chip_select_polarity_t cs_polarity;
161 
166 typedef enum
167 {
169  CURRENTLIMIT_ERROR = -1
170 
172 
189 
204 
219 err_t currentlimit_generic_write ( currentlimit_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
220 
235 err_t currentlimit_generic_read ( currentlimit_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
236 
245 void currentlimit_dev_enable ( currentlimit_t *ctx, uint8_t state );
246 
260 
274 
275 #ifdef __cplusplus
276 }
277 #endif
278 #endif // CURRENTLIMIT_H
279  // currentlimit
281 
282 // ------------------------------------------------------------------------ END
currentlimit_dev_enable
void currentlimit_dev_enable(currentlimit_t *ctx, uint8_t state)
Device enable function.
currentlimit_generic_write
err_t currentlimit_generic_write(currentlimit_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Current Limit data writing function.
currentlimit_t::spi
spi_master_t spi
Definition: currentlimit.h:134
spi_specifics.h
This file contains SPI specific macros, functions, etc.
currentlimit_cfg_setup
void currentlimit_cfg_setup(currentlimit_cfg_t *cfg)
Current Limit configuration object setup function.
currentlimit_return_value_t
currentlimit_return_value_t
Current Limit Click return value data.
Definition: currentlimit.h:167
currentlimit_t::chip_select
pin_name_t chip_select
Definition: currentlimit.h:136
currentlimit_init
err_t currentlimit_init(currentlimit_t *ctx, currentlimit_cfg_t *cfg)
Current Limit initialization function.
currentlimit_cfg_t::miso
pin_name_t miso
Definition: currentlimit.h:147
lim_val
const uint8_t lim_val[8]
Definition: main.c:29
currentlimit_cfg_t::sck
pin_name_t sck
Definition: currentlimit.h:149
currentlimit_cfg_t::en
pin_name_t en
Definition: currentlimit.h:153
CURRENTLIMIT_OK
@ CURRENTLIMIT_OK
Definition: currentlimit.h:168
currentlimit_set_limit
void currentlimit_set_limit(currentlimit_t *ctx, uint8_t lim_val)
Set Current With Predefined Values Limit function.
currentlimit_cfg_t::cs
pin_name_t cs
Definition: currentlimit.h:150
currentlimit_cfg_t::spi_speed
uint32_t spi_speed
Definition: currentlimit.h:156
currentlimit_t::en
digital_out_t en
Definition: currentlimit.h:131
currentlimit_cfg_t::mosi
pin_name_t mosi
Definition: currentlimit.h:148
currentlimit_cfg_t
Current Limit Click configuration object.
Definition: currentlimit.h:145
currentlimit_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: currentlimit.h:158
currentlimit_t
Current Limit Click context object.
Definition: currentlimit.h:129
currentlimit_set_limit_calc
void currentlimit_set_limit_calc(currentlimit_t *ctx, float lim_val)
Set Calculated Current Limit function.
currentlimit_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: currentlimit.h:157
CURRENTLIMIT_ERROR
@ CURRENTLIMIT_ERROR
Definition: currentlimit.h:169
currentlimit_generic_read
err_t currentlimit_generic_read(currentlimit_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Current Limit data reading function.