currentsens2 2.1.0.0
currentsens2.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 CURRENTSENS2_H
29#define CURRENTSENS2_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_analog_in.h"
38
59#define CURRENTSENS2_CONV_FACTOR 12.5f
60#define CURRENTSENS2_NUM_CONVERSIONS 10
61#define CURRENTSENS2_NUM_OF_PASSES_1 1
62#define CURRENTSENS2_NUM_OF_PASSES_2 2
63#define CURRENTSENS2_NUM_OF_PASSES_3 3
64 // currentsens2_set
66
81#define CURRENTSENS2_MAP_MIKROBUS( cfg, mikrobus ) \
82 cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
83 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
84 // currentsens2_map // currentsens2
87
92typedef struct
93{
94 digital_in_t int_pin;
96 analog_in_t adc;
98 float zero_val;
99 uint8_t no_of_turns;
102
107typedef struct
108{
109 pin_name_t an;
110 pin_name_t int_pin;
112 analog_in_resolution_t resolution;
113 float vref;
116
121typedef enum
122{
125
127
144
159
171err_t currentsens2_read_an_pin_value ( currentsens2_t *ctx, uint16_t *data_out );
172
186err_t currentsens2_read_an_pin_vol ( currentsens2_t *ctx, float *data_out );
187
198
209
221
233err_t currentsens2_get_current ( currentsens2_t *ctx, float *current );
234
235#ifdef __cplusplus
236}
237#endif
238#endif // CURRENTSENS2_H
239 // currentsens2
241
242// ------------------------------------------------------------------------ END
currentsens2_return_value_t
Current Sens 2 Click return value data.
Definition: currentsens2.h:122
@ CURRENTSENS2_ERROR
Definition: currentsens2.h:124
@ CURRENTSENS2_OK
Definition: currentsens2.h:123
void currentsens2_cfg_setup(currentsens2_cfg_t *cfg)
Current Sens 2 configuration object setup function.
err_t currentsens2_tare(currentsens2_t *ctx)
Current Sens 2 tare function.
err_t currentsens2_read_an_pin_value(currentsens2_t *ctx, uint16_t *data_out)
Current Sens 2 read AN pin value function.
err_t currentsens2_get_current(currentsens2_t *ctx, float *current)
Current Sens 2 read current function.
void currentsens2_set_prim_turn_no(currentsens2_t *ctx, uint8_t turns)
Current Sens 2 set number of primary coil turns function.
err_t currentsens2_read_an_pin_vol(currentsens2_t *ctx, float *data_out)
Current Sens 2 read AN pin voltage level function.
uint8_t currentsens2_get_int_pin(currentsens2_t *ctx)
Current Sens 2 get int pin state function.
err_t currentsens2_init(currentsens2_t *ctx, currentsens2_cfg_t *cfg)
Current Sens 2 initialization function.
Current Sens 2 Click configuration object.
Definition: currentsens2.h:108
analog_in_resolution_t resolution
Definition: currentsens2.h:112
float vref
Definition: currentsens2.h:113
pin_name_t int_pin
Definition: currentsens2.h:110
pin_name_t an
Definition: currentsens2.h:109
Current Sens 2 Click context object.
Definition: currentsens2.h:93
uint8_t no_of_turns
Definition: currentsens2.h:99
digital_in_t int_pin
Definition: currentsens2.h:94
analog_in_t adc
Definition: currentsens2.h:96
float zero_val
Definition: currentsens2.h:98