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 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_analog_in.h"
52 
73 #define RFMETER3_NO_SIGNAL_VOLTAGE 0.180
74 #define RFMETER3_OUTPUT_SLOPE 0.031
75 #define RFMETER3_DBM_OFFSET 40
76  // rfmeter3_set
78 
93 #define RFMETER3_MAP_MIKROBUS( cfg, mikrobus ) \
94  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
95  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS )
96  // rfmeter3_map // rfmeter3
99 
104 typedef struct
105 {
106  digital_out_t en;
108  analog_in_t adc;
110 } rfmeter3_t;
111 
116 typedef struct
117 {
118  pin_name_t an;
119  pin_name_t en;
121  analog_in_resolution_t resolution;
122  float vref;
125 
130 typedef enum
131 {
133  RFMETER3_ERROR = -1
134 
136 
153 
169 
182 err_t rfmeter3_read_an_pin_value ( rfmeter3_t *ctx, uint16_t *data_out );
183 
198 err_t rfmeter3_read_an_pin_voltage ( rfmeter3_t *ctx, float *data_out );
199 
209 
219 
234 err_t rfmeter3_get_rf_input_power ( rfmeter3_t *ctx, float *data_out );
235 
236 #ifdef __cplusplus
237 }
238 #endif
239 #endif // RFMETER3_H
240  // rfmeter3
242 
243 // ------------------------------------------------------------------------ END
RFMETER3_OK
@ RFMETER3_OK
Definition: rfmeter3.h:132
rfmeter3_cfg_t::en
pin_name_t en
Definition: rfmeter3.h:119
rfmeter3_t::en
digital_out_t en
Definition: rfmeter3.h:106
rfmeter3_t
RF Meter 3 Click context object.
Definition: rfmeter3.h:105
rfmeter3_cfg_t::an
pin_name_t an
Definition: rfmeter3.h:118
RFMETER3_ERROR
@ RFMETER3_ERROR
Definition: rfmeter3.h:133
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:131
rfmeter3_cfg_t::vref
float vref
Definition: rfmeter3.h:122
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:121
rfmeter3_t::adc
analog_in_t adc
Definition: rfmeter3.h:108
rfmeter3_cfg_t
RF Meter 3 Click configuration object.
Definition: rfmeter3.h:117
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.