rmeter  2.0.0.0
rmeter.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 RMETER_H
35 #define RMETER_H
36 
37 #include "drv_digital_out.h"
38 #include "drv_digital_in.h"
39 #include "drv_spi_master.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
52 #define RMETER_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
54  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
55  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
56  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
57  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
58  cfg.s3 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
59  cfg.s1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
60  cfg.s2 = MIKROBUS( mikrobus, MIKROBUS_INT );
61 
67 #define RMETER_RETVAL uint8_t
68 
69 #define RMETER_OK 0x00
70 #define RMETER_INIT_ERROR 0xFF
71 
77 #define RMETER_SELECT 1
78 #define RMETER_DESELECT 0
79 #define RMETER_OVER_RANGE -1
80 #define RMETER_FILTER_USEFULL_DATA 0x1FFE
81 #define RMETER_DATA_SAMPLE_NUM 10
82 #define RMETER_RANGE_BASE_VALUE_0 88000
83 #define RMETER_RANGE_BASE_VALUE_1 236
84 #define RMETER_RANGE_BASE_VALUE_2 1100
85 #define RMETER_RANGE_BASE_VALUE_3 95000
86 #define RMETER_RANGE_VALUE 2000
87 #define RMETER_RANGE_VALUE_MAX 300000
88 #define RMETER_GAIN_CALC_CONST 100
89  // End group macro
92 // --------------------------------------------------------------- PUBLIC TYPES
101 typedef struct
102 {
103  // Output pins
104 
105  digital_out_t s3;
106  digital_out_t s1;
107  digital_out_t s2;
108  digital_out_t cs;
109 
110  // Input pins
111 
112  digital_in_t an;
113 
114  // Modules
115 
116  spi_master_t spi;
117  pin_name_t chip_select;
118 
119 } rmeter_t;
120 
124 typedef struct
125 {
126  // Communication gpio pins
127 
128  pin_name_t miso;
129  pin_name_t mosi;
130  pin_name_t sck;
131  pin_name_t cs;
132 
133  // Additional gpio pins
134 
135  pin_name_t an;
136  pin_name_t s3;
137  pin_name_t s1;
138  pin_name_t s2;
139 
140  // static variable
141 
142  uint32_t spi_speed;
143  spi_master_mode_t spi_mode;
144  spi_master_chip_select_polarity_t cs_polarity;
145 
146 } rmeter_cfg_t;
147  // End types group
149 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
150 
155 #ifdef __cplusplus
156 extern "C"{
157 #endif
158 
167 void rmeter_cfg_setup ( rmeter_cfg_t *cfg );
168 
177 
188 void rmeter_range_s1 ( rmeter_t *ctx, uint8_t state );
189 
200 void rmeter_range_s2 ( rmeter_t *ctx, uint8_t state );
201 
212 void rmeter_range_s3 ( rmeter_t *ctx, uint8_t state );
213 
223 uint16_t rmeter_read_data ( rmeter_t *ctx );
224 
234 uint16_t rmeter_get_volage ( rmeter_t *ctx );
235 
247 float rmeter_avg_volt ( rmeter_t *ctx );
248 
260 float rmeter_calc ( rmeter_t *ctx, uint32_t resFilt );
261 
272 float rmeter_get_ohms ( rmeter_t *ctx );
273 
274 #ifdef __cplusplus
275 }
276 #endif
277 #endif // _RMETER_H_
278  // End public_function group
281 
282 // ------------------------------------------------------------------------- END
digital_out_t s2
Definition: rmeter.h:107
pin_name_t chip_select
Definition: rmeter.h:117
digital_out_t s3
Definition: rmeter.h:105
spi_master_chip_select_polarity_t cs_polarity
Definition: rmeter.h:144
pin_name_t mosi
Definition: rmeter.h:129
digital_out_t s1
Definition: rmeter.h:106
void rmeter_cfg_setup(rmeter_cfg_t *cfg)
Config Object Initialization function.
pin_name_t s3
Definition: rmeter.h:136
float rmeter_avg_volt(rmeter_t *ctx)
Get average voltage function.
float rmeter_calc(rmeter_t *ctx, uint32_t resFilt)
Calculations function.
uint16_t rmeter_get_volage(rmeter_t *ctx)
Get voltage function.
RMETER_RETVAL rmeter_init(rmeter_t *ctx, rmeter_cfg_t *cfg)
Initialization function.
pin_name_t s1
Definition: rmeter.h:137
digital_in_t an
Definition: rmeter.h:112
Click configuration structure definition.
Definition: rmeter.h:124
float rmeter_get_ohms(rmeter_t *ctx)
Get resistance in OHMs function.
pin_name_t sck
Definition: rmeter.h:130
uint16_t rmeter_read_data(rmeter_t *ctx)
Data read function.
pin_name_t s2
Definition: rmeter.h:138
#define RMETER_RETVAL
Definition: rmeter.h:67
void rmeter_range_s2(rmeter_t *ctx, uint8_t state)
S2 defined range function.
pin_name_t cs
Definition: rmeter.h:131
void rmeter_range_s3(rmeter_t *ctx, uint8_t state)
S3 defined range function.
pin_name_t miso
Definition: rmeter.h:128
spi_master_mode_t spi_mode
Definition: rmeter.h:143
digital_out_t cs
Definition: rmeter.h:108
pin_name_t an
Definition: rmeter.h:135
spi_master_t spi
Definition: rmeter.h:116
Click ctx object definition.
Definition: rmeter.h:101
uint32_t spi_speed
Definition: rmeter.h:142
void rmeter_range_s1(rmeter_t *ctx, uint8_t state)
S1 defined range function.