I2C_Drivers (ARM) 1.1
SMFSW collection of HAL I2C Drivers for ARM
Loading...
Searching...
No Matches
AMG88_proc.h File Reference

AMG88 Driver procedures. More...

#include "sarmfsw.h"
#include "AMG88.h"
Include dependency graph for AMG88_proc.h:
This graph shows which files directly or indirectly include this file:

Data Structures

struct  AMG88_t
 AMG88 user interface struct. More...
 

Macros

#define AMG88_CHIP_ID   0x00
 AMG88 Chip ID to check against.
 

Functions

FctERR AMG88_Init_Sequence (AMG88_t *const pCpnt)
 Initialization Sequence for AMG88 peripheral.
 
FctERR AMG88_handler (AMG88_t *const pCpnt)
 Handler for AMG88 peripheral.
 
FctERR AMG88_handler_it (AMG88_t *const pCpnt)
 Handler for AMG88 peripheral GPIO interrupt.
 
FctERR AMG88_handler_all (void)
 Handler for all AMG88 peripherals.
 
FctERR AMG88_handler_it_all (void)
 Handler for all AMG88 peripherals GPIO interrupt.
 

Variables

AMG88_t AMG88 [I2C_AMG88_NB]
 AMG88 User structure.
 

Detailed Description

AMG88 Driver procedures.

Author
SMFSW

AMG88: Infrared Array Sensor (Grid-EYE)

Macro Definition Documentation

◆ AMG88_CHIP_ID

#define AMG88_CHIP_ID   0x00

AMG88 Chip ID to check against.

Function Documentation

◆ AMG88_handler()

FctERR AMG88_handler ( AMG88_t *const pCpnt)

Handler for AMG88 peripheral.

Weak Functions
AMG88 handler may be user implemented to suit custom needs
Note
May be called periodically to handle AMG88 tasks
Alternately may be called when event occurs on AMG88 pin (or by calling AMG88_handler_it instead)
Parameters
[in]pCpnt- Pointer to AMG88 component
Returns
FctERR - error code
Here is the call graph for this function:
Here is the caller graph for this function:

◆ AMG88_handler_all()

FctERR AMG88_handler_all ( void )

Handler for all AMG88 peripherals.

Note
May be called periodically to handle all AMG88 tasks
Returns
FctERR - error code
Here is the call graph for this function:

◆ AMG88_handler_it()

FctERR AMG88_handler_it ( AMG88_t *const pCpnt)

Handler for AMG88 peripheral GPIO interrupt.

Note
AMG88_INT_GPIO_Init has to be called at init before using interrupt handler function
Weak Functions
AMG88 GPIO interrupt handler may be user implemented to suit custom needs
Note
May be called periodically to handle AMG88 tasks through interrupts
Parameters
[in]pCpnt- Pointer to AMG88 component
Returns
FctERR - error code
Here is the call graph for this function:
Here is the caller graph for this function:

◆ AMG88_handler_it_all()

FctERR AMG88_handler_it_all ( void )

Handler for all AMG88 peripherals GPIO interrupt.

Note
AMG88_INT_GPIO_Init has to be called at init before using interrupt handler function
May be called periodically to handle all AMG88 tasks
Returns
FctERR - error code
Here is the call graph for this function:

◆ AMG88_Init_Sequence()

FctERR AMG88_Init_Sequence ( AMG88_t *const pCpnt)

Initialization Sequence for AMG88 peripheral.

Weak Functions
AMG88 Init sequence may be user implemented if custom initialization sequence needed
Parameters
[in]pCpnt- Pointer to AMG88 component
Returns
FctERR - error code
Here is the call graph for this function:
Here is the caller graph for this function:

Variable Documentation

◆ AMG88

AMG88_t AMG88[I2C_AMG88_NB]
extern

AMG88 User structure.