Herzog Library 00.00.01  rel_libdev.herzog.00.00.01.10606
Data Structures | Typedefs | Functions
pir_device.h File Reference

Go to the source code of this file.

Data Structures

struct  PIR_Device_t
 A structure to represent PIR device. More...
 

Typedefs

typedef void(* pir_cb_func_t) (PIR_Device_t *dev)
 

Functions

PIR_Device_tPIR_devRequest (void)
 Request A PIR Device. More...
 
int32_t PIR_devInit (PIR_Device_t *dev, uint8_t clkdiv, uint8_t etime, uint8_t itime, uint8_t atten)
 Initialize PIR settings. More...
 
int32_t PIR_devEnableWakeup (PIR_Device_t *dev, void *cb)
 Enable PIR Wakeup. More...
 
int32_t PIR_devDisableWakeup (PIR_Device_t *dev)
 Disable PIR Wakeup. More...
 
int32_t PIR_devDisable (PIR_Device_t *dev)
 Disable PIR. More...
 

Detailed Description

This file is proprietary to Indie Semiconductor. All rights reserved. Reproduction or distribution, in whole or in part, is forbidden except by express written permission of Indie Semiconductor.

Typedef Documentation

typedef void(* pir_cb_func_t) (PIR_Device_t *dev)

Function Documentation

int32_t PIR_devDisable ( PIR_Device_t dev)

Disable PIR.

Parameters
devThe pointer to PIR device.
Returns
0 or error code upon a failure.
int32_t PIR_devDisableWakeup ( PIR_Device_t dev)

Disable PIR Wakeup.

Parameters
devThe pointer to PIR device.
Returns
0 or error code upon a failure.
int32_t PIR_devEnableWakeup ( PIR_Device_t dev,
void *  cb 
)

Enable PIR Wakeup.

Parameters
devThe pointer to PIR device.
cbThe pointer to the call back function for the wakeup interrupt.
Returns
0 or error code upon a failure.
int32_t PIR_devInit ( PIR_Device_t dev,
uint8_t  clkdiv,
uint8_t  etime,
uint8_t  itime,
uint8_t  atten 
)

Initialize PIR settings.

Parameters
devThe pointer to PIR device.
clkdivThe setting for clock divider. The valid values: 8,16,24,32
etimeThe event time in decisecond.
itimeThe inhibit time in seconds.
attenThe attenuation in dB. The valid value 0 to 26 dB.
Returns
0 or error code upon a failure.
PIR_Device_t* PIR_devRequest ( void  )

Request A PIR Device.

Returns
The pointer to the RTC device instance.

Request A PIR Device.