rfmeter3  2.0.0.0
rfmeter3.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 RFMETER3_H
29 #define RFMETER3_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_analog_in.h"
48 
69 #define RFMETER3_NO_SIGNAL_VOLTAGE 0.180
70 #define RFMETER3_OUTPUT_SLOPE 0.031
71 #define RFMETER3_DBM_OFFSET 40
72  // rfmeter3_set
74 
89 #define RFMETER3_MAP_MIKROBUS( cfg, mikrobus ) \
90  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
91  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS )
92  // rfmeter3_map // rfmeter3
95 
100 typedef struct
101 {
102  digital_out_t en;
104  analog_in_t adc;
106 } rfmeter3_t;
107 
112 typedef struct
113 {
114  pin_name_t an;
115  pin_name_t en;
117  analog_in_resolution_t resolution;
118  float vref;
121 
126 typedef enum
127 {
129  RFMETER3_ERROR = -1
130 
132 
149 
165 
178 err_t rfmeter3_read_an_pin_value ( rfmeter3_t *ctx, uint16_t *data_out );
179 
194 err_t rfmeter3_read_an_pin_voltage ( rfmeter3_t *ctx, float *data_out );
195 
205 
215 
230 err_t rfmeter3_get_rf_input_power ( rfmeter3_t *ctx, float *data_out );
231 
232 #ifdef __cplusplus
233 }
234 #endif
235 #endif // RFMETER3_H
236  // rfmeter3
238 
239 // ------------------------------------------------------------------------ END
RFMETER3_OK
@ RFMETER3_OK
Definition: rfmeter3.h:128
rfmeter3_cfg_t::en
pin_name_t en
Definition: rfmeter3.h:115
rfmeter3_t::en
digital_out_t en
Definition: rfmeter3.h:102
rfmeter3_t
RF Meter 3 Click context object.
Definition: rfmeter3.h:101
rfmeter3_cfg_t::an
pin_name_t an
Definition: rfmeter3.h:114
RFMETER3_ERROR
@ RFMETER3_ERROR
Definition: rfmeter3.h:129
rfmeter3_get_rf_input_power
err_t rfmeter3_get_rf_input_power(rfmeter3_t *ctx, float *data_out)
RF Meter 3 get rf input power function.
rfmeter3_enable_device
void rfmeter3_enable_device(rfmeter3_t *ctx)
RF Meter 3 enable device function.
rfmeter3_init
err_t rfmeter3_init(rfmeter3_t *ctx, rfmeter3_cfg_t *cfg)
RF Meter 3 initialization function.
rfmeter3_return_value_t
rfmeter3_return_value_t
RF Meter 3 Click return value data.
Definition: rfmeter3.h:127
rfmeter3_cfg_t::vref
float vref
Definition: rfmeter3.h:118
rfmeter3_cfg_setup
void rfmeter3_cfg_setup(rfmeter3_cfg_t *cfg)
RF Meter 3 configuration object setup function.
rfmeter3_cfg_t::resolution
analog_in_resolution_t resolution
Definition: rfmeter3.h:117
rfmeter3_t::adc
analog_in_t adc
Definition: rfmeter3.h:104
rfmeter3_cfg_t
RF Meter 3 Click configuration object.
Definition: rfmeter3.h:113
rfmeter3_read_an_pin_value
err_t rfmeter3_read_an_pin_value(rfmeter3_t *ctx, uint16_t *data_out)
RF Meter 3 read AN pin value function.
rfmeter3_read_an_pin_voltage
err_t rfmeter3_read_an_pin_voltage(rfmeter3_t *ctx, float *data_out)
RF Meter 3 read AN pin voltage level function.
rfmeter3_disable_device
void rfmeter3_disable_device(rfmeter3_t *ctx)
RF Meter 3 disable device function.