microwave4 2.1.0.0
microwave4.h File Reference

This file contains API for Microwave 4 Click Driver. More...

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

Go to the source code of this file.

Data Structures

struct  microwave4_t
 Microwave 4 Click context object. More...
 
struct  microwave4_cfg_t
 Microwave 4 Click configuration object. More...
 

Macros

#define MICROWAVE4_ADC_RESOLUTION   0x0FFF
 Microwave 4 description setting.
 
#define MICROWAVE4_VREF_3V3   3.3
 
#define MICROWAVE4_VREF_5V   5.0
 
#define MICROWAVE4_SET_DEV_ADDR   0x4D
 Microwave 4 device address setting.
 
#define MICROWAVE4_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  microwave4_drv_t { MICROWAVE4_DRV_SEL_ADC , MICROWAVE4_DRV_SEL_I2C }
 Microwave 4 Click driver selector. More...
 
enum  microwave4_return_value_t { MICROWAVE4_OK = 0 , MICROWAVE4_ERROR = -1 }
 Microwave 4 Click return value data. More...
 

Functions

void microwave4_cfg_setup (microwave4_cfg_t *cfg)
 Microwave 4 configuration object setup function.
 
void microwave4_drv_interface_sel (microwave4_cfg_t *cfg, microwave4_drv_t drv_sel)
 Microwave 4 driver interface setup function.
 
err_t microwave4_init (microwave4_t *ctx, microwave4_cfg_t *cfg)
 Microwave 4 initialization function.
 
err_t microwave4_read_raw_adc (microwave4_t *ctx, uint16_t *raw_adc)
 Microwave 4 read raw ADC value function.
 
err_t microwave4_read_voltage (microwave4_t *ctx, float *voltage)
 Microwave 4 read voltage level function.
 
err_t microwave4_set_vref (microwave4_t *ctx, float vref)
 Microwave 4 set vref function.
 

Detailed Description

This file contains API for Microwave 4 Click Driver.

Enumeration Type Documentation

◆ microwave4_drv_t

Microwave 4 Click driver selector.

Selects target driver interface of Microwave 4 Click driver.

Enumerator
MICROWAVE4_DRV_SEL_ADC 

ADC driver descriptor.

MICROWAVE4_DRV_SEL_I2C 

I2C driver descriptor.

◆ microwave4_return_value_t

Microwave 4 Click return value data.

Predefined enum values for driver return values.

Enumerator
MICROWAVE4_OK 
MICROWAVE4_ERROR