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 "drv_digital_out.h"
38#include "drv_analog_in.h"
39#include "drv_spi_master.h"
40
50#define RMETER_MAP_MIKROBUS( cfg, mikrobus ) \
51 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
52 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
53 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ) ; \
54 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ) ; \
55 cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ) ; \
56 cfg.s3 = MIKROBUS( mikrobus, MIKROBUS_RST ) ; \
57 cfg.s2 = MIKROBUS( mikrobus, MIKROBUS_INT ) ; \
58 cfg.s1 = MIKROBUS( mikrobus, MIKROBUS_PWM )
65#define RMETER_OK 0
66#define RMETER_INIT_ERROR (-1) // End group macro
70
79typedef void ( *rmeter_callback_t )( char* );
80
84typedef struct
85{
86 // Auto scale control pins objects.
87
88 digital_out_t s3;
89 digital_out_t s2;
90 digital_out_t s1;
91
92 // Analog input pin object.
93
94 analog_in_t an;
95
96 // Communication module object.
97
98 spi_master_t spi;
99
100 pin_name_t chip_select;
101
102 // R Meter calculation operands.
103
104 float ifb;
106 // Callback handler.
107
109
110} rmeter_t;
111
115typedef struct
116{
117 // Communication pins descriptors.
118
119 pin_name_t miso;
120 pin_name_t mosi;
121 pin_name_t sck;
122 pin_name_t cs;
123
124 // Additional pins descriptors.
125
126 pin_name_t an;
127 pin_name_t s3;
128 pin_name_t s2;
129 pin_name_t s1;
130
131 // Module configuration settings.
132
133 uint32_t spi_speed;
134 spi_master_mode_t spi_mode;
135 spi_master_chip_select_polarity_t cs_polarity;
136
137 // ADC settings.
138
139 analog_in_resolution_t adc_resolution;
140 float adc_vref;
143 // End types group
145
151#ifdef __cplusplus
152extern "C"{
153#endif
154
164
175err_t rmeter_init ( rmeter_t *ctx, rmeter_cfg_t *cfg );
176
186
195
204
213
224err_t rmeter_read_measurement ( rmeter_t *ctx, uint16_t *data_out );
225
240err_t rmeter_calculate_resistance ( rmeter_t *ctx, float *data_out, uint16_t data_in );
241
252
263err_t rmeter_read_an ( rmeter_t *ctx, uint16_t *data_out );
264
276err_t rmeter_read_an_voltage ( rmeter_t *ctx, float *data_out );
277
278#ifdef __cplusplus
279}
280#endif
281#endif // RMETER_H
282 // End public_function group // End click Driver group
285
286// ------------------------------------------------------------------------ END
err_t rmeter_calculate_resistance(rmeter_t *ctx, float *data_out, uint16_t data_in)
Resistance Calculation function.
void rmeter_set_range_up_to_17k_ohms(rmeter_t *ctx)
Range Setup Up To 17k Ohms function.
uint16_t rmeter_auto_scale_range_execution(rmeter_t *ctx)
Auto Scale Range Execution function.
void rmeter_set_range_up_to_1k9_ohms(rmeter_t *ctx)
Range Setup Up To 1k9 Ohms function.
err_t rmeter_read_an_voltage(rmeter_t *ctx, float *data_out)
AN Voltage Level Reading function.
void rmeter_cfg_setup(rmeter_cfg_t *cfg)
Config Object Setup function.
void rmeter_set_range_up_to_1M9_ohms(rmeter_t *ctx)
Range Setup Up To 1M9 Ohms function.
void rmeter_set_callback_handler(rmeter_t *ctx, rmeter_callback_t handler)
Callback Handler Setup function.
err_t rmeter_init(rmeter_t *ctx, rmeter_cfg_t *cfg)
Initialization function.
err_t rmeter_read_measurement(rmeter_t *ctx, uint16_t *data_out)
Measurement Reading function.
err_t rmeter_read_an(rmeter_t *ctx, uint16_t *data_out)
AN Pin Reading function.
void(* rmeter_callback_t)(char *)
Click callback handler definition.
Definition: rmeter.h:79
Click configuration structure definition.
Definition: rmeter.h:116
pin_name_t s2
Definition: rmeter.h:128
pin_name_t s3
Definition: rmeter.h:127
spi_master_chip_select_polarity_t cs_polarity
Definition: rmeter.h:135
pin_name_t sck
Definition: rmeter.h:121
pin_name_t s1
Definition: rmeter.h:129
spi_master_mode_t spi_mode
Definition: rmeter.h:134
float adc_vref
Definition: rmeter.h:140
analog_in_resolution_t adc_resolution
Definition: rmeter.h:139
pin_name_t mosi
Definition: rmeter.h:120
uint32_t spi_speed
Definition: rmeter.h:133
pin_name_t miso
Definition: rmeter.h:119
pin_name_t an
Definition: rmeter.h:126
pin_name_t cs
Definition: rmeter.h:122
Click ctx object definition.
Definition: rmeter.h:85
spi_master_t spi
Definition: rmeter.h:98
digital_out_t s3
Definition: rmeter.h:88
float ifb
Definition: rmeter.h:104
digital_out_t s2
Definition: rmeter.h:89
digital_out_t s1
Definition: rmeter.h:90
rmeter_callback_t callback
Definition: rmeter.h:108
analog_in_t an
Definition: rmeter.h:94
pin_name_t chip_select
Definition: rmeter.h:100