pir3 2.2.0
Loading...
Searching...
No Matches
pir3.h File Reference

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

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

Go to the source code of this file.

Data Structures

struct  pir3_config_t
 PIR 3 Click config object. More...
struct  pir3_t
 PIR 3 Click context object. More...
struct  pir3_cfg_t
 PIR 3 Click configuration object. More...

Macros

#define PIR3_CONFIG_DETLVL_MASK_MSB   0x7F
 PIR 3 control register setting.
#define PIR3_CONFIG_DETLVL_MASK_LSB   0x01
#define PIR3_CONFIG_DETLVL_DEFAULT   0x1C
#define PIR3_CONFIG_TRIGOM_DISABLED   0x00
#define PIR3_CONFIG_TRIGOM_ENABLED   0x01
#define PIR3_CONFIG_TRIGOM_MASK   0x01
#define PIR3_CONFIG_TRIGOM_DEFAULT   PIR3_CONFIG_TRIGOM_DISABLED
#define PIR3_CONFIG_FSTEP_1   0x01
#define PIR3_CONFIG_FSTEP_2   0x03
#define PIR3_CONFIG_FSTEP_3   0x00
#define PIR3_CONFIG_FSTEP_MASK   0x03
#define PIR3_CONFIG_FSTEP_DEFAULT   PIR3_CONFIG_FSTEP_2
#define PIR3_CONFIG_FILSEL_TYPE_A   0x07
#define PIR3_CONFIG_FILSEL_TYPE_B   0x00
#define PIR3_CONFIG_FILSEL_TYPE_C   0x01
#define PIR3_CONFIG_FILSEL_TYPE_D   0x02
#define PIR3_CONFIG_FILSEL_DIRECT   0x03
#define PIR3_CONFIG_FILSEL_MASK   0x07
#define PIR3_CONFIG_FILSEL_DEFAULT   PIR3_CONFIG_FILSEL_TYPE_B
#define PIR3_DEVICE_ADDRESS   0x00
 PIR 3 device address setting.
#define PIR3_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  pir3_return_value_t { PIR3_OK = 0 , PIR3_ERROR = -1 }
 PIR 3 Click return value data. More...

Functions

void pir3_cfg_setup (pir3_cfg_t *cfg)
 PIR 3 configuration object setup function.
err_t pir3_init (pir3_t *ctx, pir3_cfg_t *cfg)
 PIR 3 initialization function.
err_t pir3_default_cfg (pir3_t *ctx)
 PIR 3 default configuration function.
err_t pir3_write_config (pir3_t *ctx)
 PIR 3 write config function.
err_t pir3_read_peak_hold (pir3_t *ctx, int16_t *peak_hold)
 PIR 3 read peak hold function.
void pir3_enable_device (pir3_t *ctx)
 PIR 3 enable device function.
void pir3_disable_device (pir3_t *ctx)
 PIR 3 disable device function.
void pir3_set_detection_level (pir3_t *ctx, uint8_t detlvl)
 PIR 3 set detection level function.
void pir3_set_trigger_out (pir3_t *ctx, uint8_t trigom)
 PIR 3 set trigger out function.
void pir3_set_filter_step (pir3_t *ctx, uint8_t fstep)
 PIR 3 set filter step function.
void pir3_set_filter_type (pir3_t *ctx, uint8_t filsel)
 PIR 3 set filter type function.

Detailed Description

This file contains API for PIR 3 Click Driver.

Enumeration Type Documentation

◆ pir3_return_value_t

PIR 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
PIR3_OK 
PIR3_ERROR