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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_analog_in.h"
38 
59 #define RFMETER3_NO_SIGNAL_VOLTAGE 0.180
60 #define RFMETER3_OUTPUT_SLOPE 0.031
61 #define RFMETER3_DBM_OFFSET 40
62  // rfmeter3_set
64 
79 #define RFMETER3_MAP_MIKROBUS( cfg, mikrobus ) \
80  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
81  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS )
82  // rfmeter3_map // rfmeter3
85 
90 typedef struct
91 {
92  digital_out_t en;
94  analog_in_t adc;
96 } rfmeter3_t;
97 
102 typedef struct
103 {
104  pin_name_t an;
105  pin_name_t en;
107  analog_in_resolution_t resolution;
108  float vref;
111 
116 typedef enum
117 {
119  RFMETER3_ERROR = -1
120 
122 
139 
155 
168 err_t rfmeter3_read_an_pin_value ( rfmeter3_t *ctx, uint16_t *data_out );
169 
184 err_t rfmeter3_read_an_pin_voltage ( rfmeter3_t *ctx, float *data_out );
185 
195 
205 
220 err_t rfmeter3_get_rf_input_power ( rfmeter3_t *ctx, float *data_out );
221 
222 #ifdef __cplusplus
223 }
224 #endif
225 #endif // RFMETER3_H
226  // rfmeter3
228 
229 // ------------------------------------------------------------------------ END
RFMETER3_OK
@ RFMETER3_OK
Definition: rfmeter3.h:118
rfmeter3_cfg_t::en
pin_name_t en
Definition: rfmeter3.h:105
rfmeter3_t::en
digital_out_t en
Definition: rfmeter3.h:92
rfmeter3_t
RF Meter 3 Click context object.
Definition: rfmeter3.h:91
rfmeter3_cfg_t::an
pin_name_t an
Definition: rfmeter3.h:104
RFMETER3_ERROR
@ RFMETER3_ERROR
Definition: rfmeter3.h:119
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:117
rfmeter3_cfg_t::vref
float vref
Definition: rfmeter3.h:108
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:107
rfmeter3_t::adc
analog_in_t adc
Definition: rfmeter3.h:94
rfmeter3_cfg_t
RF Meter 3 Click configuration object.
Definition: rfmeter3.h:103
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.