pir2 2.1.0.0
Data Structures | Macros | Enumerations | Functions
pir2.h File Reference

This file contains API for PIR 2 Click Driver. More...

#include "mikrosdk_version.h"
#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  pir2_t
 PIR 2 Click context object. More...
 
struct  pir2_cfg_t
 PIR 2 Click configuration object. More...
 

Macros

#define PIR2_ADC_RESOLUTION   0x0FFF
 PIR 2 ADC setting. More...
 
#define PIR2_VREF_3V3   3.3
 
#define PIR2_VREF_5V   5.0
 
#define PIR2_SET_DEV_ADDR   0x4D
 PIR 2 device address setting. More...
 
#define PIR2_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  pir2_drv_t { PIR2_DRV_SEL_ADC , PIR2_DRV_SEL_I2C }
 PIR 2 Click driver selector. More...
 
enum  pir2_return_value_t { PIR2_OK = 0 , PIR2_ERROR = -1 }
 PIR 2 Click return value data. More...
 

Functions

void pir2_cfg_setup (pir2_cfg_t *cfg)
 PIR 2 configuration object setup function. More...
 
void pir2_drv_interface_sel (pir2_cfg_t *cfg, pir2_drv_t drv_sel)
 PIR 2 driver interface setup function. More...
 
err_t pir2_init (pir2_t *ctx, pir2_cfg_t *cfg)
 PIR 2 initialization function. More...
 
err_t pir2_read_raw_adc (pir2_t *ctx, uint16_t *raw_adc)
 PIR 2 read raw ADC value function. More...
 
err_t pir2_read_voltage (pir2_t *ctx, float *voltage)
 PIR 2 read voltage level function. More...
 
err_t pir2_set_vref (pir2_t *ctx, float vref)
 PIR 2 set vref function. More...
 

Detailed Description

This file contains API for PIR 2 Click Driver.

Enumeration Type Documentation

◆ pir2_drv_t

enum pir2_drv_t

PIR 2 Click driver selector.

Selects target driver interface of PIR 2 Click driver.

Enumerator
PIR2_DRV_SEL_ADC 

ADC driver descriptor.

PIR2_DRV_SEL_I2C 

I2C driver descriptor.

◆ pir2_return_value_t

PIR 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
PIR2_OK 
PIR2_ERROR