rfmeter3  2.0.0.0
Data Structures | Macros | Enumerations | Functions
rfmeter3.h File Reference

This file contains API for RF Meter 3 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"

Go to the source code of this file.

Data Structures

struct  rfmeter3_t
 RF Meter 3 Click context object. More...
 
struct  rfmeter3_cfg_t
 RF Meter 3 Click configuration object. More...
 

Macros

#define RFMETER3_NO_SIGNAL_VOLTAGE   0.180
 RF Meter 3 description setting. More...
 
#define RFMETER3_OUTPUT_SLOPE   0.031
 
#define RFMETER3_DBM_OFFSET   40
 
#define RFMETER3_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  rfmeter3_return_value_t { RFMETER3_OK = 0, RFMETER3_ERROR = -1 }
 RF Meter 3 Click return value data. More...
 

Functions

void rfmeter3_cfg_setup (rfmeter3_cfg_t *cfg)
 RF Meter 3 configuration object setup function. More...
 
err_t rfmeter3_init (rfmeter3_t *ctx, rfmeter3_cfg_t *cfg)
 RF Meter 3 initialization function. More...
 
err_t rfmeter3_read_an_pin_value (rfmeter3_t *ctx, uint16_t *data_out)
 RF Meter 3 read AN pin value function. More...
 
err_t rfmeter3_read_an_pin_voltage (rfmeter3_t *ctx, float *data_out)
 RF Meter 3 read AN pin voltage level function. More...
 
void rfmeter3_enable_device (rfmeter3_t *ctx)
 RF Meter 3 enable device function. More...
 
void rfmeter3_disable_device (rfmeter3_t *ctx)
 RF Meter 3 disable device function. More...
 
err_t rfmeter3_get_rf_input_power (rfmeter3_t *ctx, float *data_out)
 RF Meter 3 get rf input power function. More...
 

Detailed Description

This file contains API for RF Meter 3 Click Driver.

Enumeration Type Documentation

◆ rfmeter3_return_value_t

RF Meter 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
RFMETER3_OK 
RFMETER3_ERROR