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  */
24 
34 #ifndef RMETER_H
35 #define RMETER_H
36 
37 #include "mikrosdk_version.h"
38 
39 #ifdef __GNUC__
40 #if mikroSDK_GET_VERSION < 20800ul
41 #include "rcu_delays.h"
42 #else
43 #include "delays.h"
44 #endif
45 #endif
46 
47 #include "drv_digital_out.h"
48 #include "drv_analog_in.h"
49 #include "drv_spi_master.h"
50 
60 #define RMETER_MAP_MIKROBUS( cfg, mikrobus ) \
61  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
62  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
63  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ) ; \
64  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ) ; \
65  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ) ; \
66  cfg.s3 = MIKROBUS( mikrobus, MIKROBUS_RST ) ; \
67  cfg.s2 = MIKROBUS( mikrobus, MIKROBUS_INT ) ; \
68  cfg.s1 = MIKROBUS( mikrobus, MIKROBUS_PWM )
69 
75 #define RMETER_OK 0
76 #define RMETER_INIT_ERROR (-1)
77  // End group macro
80 
89 typedef void ( *rmeter_callback_t )( char* );
90 
94 typedef struct
95 {
96  // Auto scale control pins objects.
97 
98  digital_out_t s3;
99  digital_out_t s2;
100  digital_out_t s1;
101 
102  // Analog input pin object.
103 
104  analog_in_t an;
105 
106  // Communication module object.
107 
108  spi_master_t spi;
109 
110  pin_name_t chip_select;
111 
112  // R Meter calculation operands.
113 
114  float ifb;
116  // Callback handler.
117 
119 
120 } rmeter_t;
121 
125 typedef struct
126 {
127  // Communication pins descriptors.
128 
129  pin_name_t miso;
130  pin_name_t mosi;
131  pin_name_t sck;
132  pin_name_t cs;
133 
134  // Additional pins descriptors.
135 
136  pin_name_t an;
137  pin_name_t s3;
138  pin_name_t s2;
139  pin_name_t s1;
140 
141  // Module configuration settings.
142 
143  uint32_t spi_speed;
144  spi_master_mode_t spi_mode;
145  spi_master_chip_select_polarity_t cs_polarity;
146 
147  // ADC settings.
148 
149  analog_in_resolution_t adc_resolution;
150  float adc_vref;
152 } rmeter_cfg_t;
153  // End types group
155 
161 #ifdef __cplusplus
162 extern "C"{
163 #endif
164 
174 
185 err_t rmeter_init ( rmeter_t *ctx, rmeter_cfg_t *cfg );
186 
196 
205 
214 
223 
234 err_t rmeter_read_measurement ( rmeter_t *ctx, uint16_t *data_out );
235 
250 err_t rmeter_calculate_resistance ( rmeter_t *ctx, float *data_out, uint16_t data_in );
251 
262 
273 err_t rmeter_read_an ( rmeter_t *ctx, uint16_t *data_out );
274 
286 err_t rmeter_read_an_voltage ( rmeter_t *ctx, float *data_out );
287 
288 #ifdef __cplusplus
289 }
290 #endif
291 #endif // RMETER_H
292  // End public_function group // End click Driver group
295 
296 // ------------------------------------------------------------------------ END
rmeter_callback_t
void(* rmeter_callback_t)(char *)
Click callback handler definition.
Definition: rmeter.h:89
rmeter_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: rmeter.h:145
rmeter_cfg_t::an
pin_name_t an
Definition: rmeter.h:136
rmeter_calculate_resistance
err_t rmeter_calculate_resistance(rmeter_t *ctx, float *data_out, uint16_t data_in)
Resistance Calculation function.
rmeter_set_callback_handler
void rmeter_set_callback_handler(rmeter_t *ctx, rmeter_callback_t handler)
Callback Handler Setup function.
rmeter_cfg_t::sck
pin_name_t sck
Definition: rmeter.h:131
rmeter_cfg_t::s2
pin_name_t s2
Definition: rmeter.h:138
rmeter_cfg_t::s1
pin_name_t s1
Definition: rmeter.h:139
rmeter_set_range_up_to_1k9_ohms
void rmeter_set_range_up_to_1k9_ohms(rmeter_t *ctx)
Range Setup Up To 1k9 Ohms function.
rmeter_t::callback
rmeter_callback_t callback
Definition: rmeter.h:118
rmeter_t::ifb
float ifb
Definition: rmeter.h:114
rmeter_cfg_t::cs
pin_name_t cs
Definition: rmeter.h:132
rmeter_read_an_voltage
err_t rmeter_read_an_voltage(rmeter_t *ctx, float *data_out)
AN Voltage Level Reading function.
rmeter_t::s3
digital_out_t s3
Definition: rmeter.h:98
rmeter_cfg_setup
void rmeter_cfg_setup(rmeter_cfg_t *cfg)
Config Object Setup function.
rmeter_t::spi
spi_master_t spi
Definition: rmeter.h:108
rmeter_read_an
err_t rmeter_read_an(rmeter_t *ctx, uint16_t *data_out)
AN Pin Reading function.
rmeter_cfg_t::s3
pin_name_t s3
Definition: rmeter.h:137
rmeter_cfg_t::spi_speed
uint32_t spi_speed
Definition: rmeter.h:143
rmeter_t::an
analog_in_t an
Definition: rmeter.h:104
rmeter_t::chip_select
pin_name_t chip_select
Definition: rmeter.h:110
rmeter_cfg_t
Click configuration structure definition.
Definition: rmeter.h:126
rmeter_t::s2
digital_out_t s2
Definition: rmeter.h:99
rmeter_init
err_t rmeter_init(rmeter_t *ctx, rmeter_cfg_t *cfg)
Initialization function.
rmeter_read_measurement
err_t rmeter_read_measurement(rmeter_t *ctx, uint16_t *data_out)
Measurement Reading function.
rmeter_set_range_up_to_17k_ohms
void rmeter_set_range_up_to_17k_ohms(rmeter_t *ctx)
Range Setup Up To 17k Ohms function.
rmeter_t
Click ctx object definition.
Definition: rmeter.h:95
rmeter_cfg_t::miso
pin_name_t miso
Definition: rmeter.h:129
rmeter_cfg_t::adc_vref
float adc_vref
Definition: rmeter.h:150
rmeter_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: rmeter.h:144
rmeter_cfg_t::adc_resolution
analog_in_resolution_t adc_resolution
Definition: rmeter.h:149
rmeter_t::s1
digital_out_t s1
Definition: rmeter.h:100
rmeter_cfg_t::mosi
pin_name_t mosi
Definition: rmeter.h:130
rmeter_auto_scale_range_execution
uint16_t rmeter_auto_scale_range_execution(rmeter_t *ctx)
Auto Scale Range Execution function.
rmeter_set_range_up_to_1M9_ohms
void rmeter_set_range_up_to_1M9_ohms(rmeter_t *ctx)
Range Setup Up To 1M9 Ohms function.