AMG88 Driver extensions. More...

#include "sarmfsw.h"
#include "AMG88.h"

Include dependency graph for AMG88_ex.h:

This graph shows which files directly or indirectly include this file:

Data Structures
union	uAMG88_REG_MAP
	Union of AMG88 registry map. More...

Functions
float	AMG88_Convert_Thermistor_Raw (const uint16_t therm)
	Convert raw thermistor temperature to celsius degrees.

float	AMG88_Convert_Pixel_Raw (const uint16_t pixel)
	Convert raw pixel temperature to celsius degrees.

uint16_t	AMG88_Convert_Temp_To_Int (const float temp)
	Convert temperature to AMG88 temperature coded integer.

FctERR	AMG88_Get_thermistor_temp (AMG88_t const pCpnt, float temp)
	Get thermistor temperature.

FctERR	AMG88_Get_pixel_temp (AMG88_t const pCpnt, float temp, const uint8_t pixel)
	Get pixel temperature.

FctERR	AMG88_Get_pixels_temp (AMG88_t *const pCpnt, float temp[64])
	Get all pixels temperature.

FctERR	AMG88_Reset (AMG88_t *const pCpnt, const AMG88_reset rst)
	AMG88 reset.

FctERR	AMG88_Set_Mode (AMG88_t *const pCpnt, const AMG88_mode mode)
	AMG88 Set mode.

FctERR	AMG88_Set_FPS (AMG88_t *const pCpnt, const bool ten)
	Set AMG88 Frame Per Seconds multiplier.

FctERR	AMG88_Set_MA (AMG88_t *const pCpnt, const bool twice)
	Set AMG88 Moving Average.

FctERR	AMG88_Set_Interrupt_LVLH (AMG88_t *const pCpnt, const float temp)
	Set AMG88 Interrupt Level upper limit.

FctERR	AMG88_Set_Interrupt_LVLL (AMG88_t *const pCpnt, const float temp)
	Set AMG88 Interrupt Level lower limit.

FctERR	AMG88_Set_Interrupt_HYS (AMG88_t *const pCpnt, const float temp)
	Set AMG88 Interrupt Hysteresis level.

FctERR	AMG88_Set_Interrupt_Levels (AMG88_t *const pCpnt, const float temp_LVLH, const float temp_LVLL, const float temp_HYS)
	Set AMG88 Interrupt levels.

FctERR	AMG88_Get_interrupts (AMG88_t const pCpnt, uAMG88_REG__INT interrupts)
	Get interrupts registers.

FctERR	AMG88_Get_Thermistor_Raw (AMG88_t const pCpnt, uint16_t raw)
	Get thermistor raw value.

FctERR	AMG88_Get_Pixel_Raw (AMG88_t const pCpnt, uint16_t raw, const uint8_t pixel)
	Get pixel raw value.

void	AMG88_INT_GPIO_Init (AMG88_t const pCpnt, GPIO_TypeDef const GPIOx, const uint16_t GPIO_Pin, const GPIO_PinState GPIO_Active)
	Interrupt GPIO pin init for AMG88.

bool	AMG88_INT_GPIO_Get (const AMG88_t *const pCpnt)
	Interrupt GPIO pin getter for AMG88.

Detailed Description

AMG88 Driver extensions.

Author: SMFSW

Copyright: MIT (c) 2017-2026, SMFSW

AMG88: Infrared Array Sensor (Grid-EYE)

Function Documentation

◆ AMG88_Convert_Pixel_Raw()

float AMG88_Convert_Pixel_Raw ( const uint16_t pixel )

Convert raw pixel temperature to celsius degrees.

Parameters

[in] pixel - Raw pixel value

Returns: Pixel temperature (in �C)

Here is the caller graph for this function:

◆ AMG88_Convert_Temp_To_Int()

uint16_t AMG88_Convert_Temp_To_Int ( const float temp )

Convert temperature to AMG88 temperature coded integer.

Parameters

[in] temp - Temperature value

Returns: AMG88 temperature coded integer

Here is the caller graph for this function:

◆ AMG88_Convert_Thermistor_Raw()

float AMG88_Convert_Thermistor_Raw ( const uint16_t therm )

Convert raw thermistor temperature to celsius degrees.

Parameters

[in] therm - Raw thermistor value

Returns: Thermistor temperature (in �C)

Here is the caller graph for this function:

◆ AMG88_Get_interrupts()

FctERR AMG88_Get_interrupts	(	AMG88_t *const	pCpnt,
		uAMG88_REG__INT *	interrupts )

inline

Get interrupts registers.

Parameters

[in]	pCpnt	- Pointer to AMG88 component
[in,out]	interrupts	- Pointer to interrupts result

Returns: Error code

Here is the call graph for this function:

◆ AMG88_Get_Pixel_Raw()

FctERR AMG88_Get_Pixel_Raw	(	AMG88_t *const	pCpnt,
		uint16_t *	raw,
		const uint8_t	pixel )

Get pixel raw value.

Parameters

[in]	pCpnt	- Pointer to AMG88 component
[in,out]	raw	- Pointer to pixel raw result
[in]	pixel	- Pixel index to retrieve data

Returns: Error code

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AMG88_Get_pixel_temp()

FctERR AMG88_Get_pixel_temp	(	AMG88_t *const	pCpnt,
		float *	temp,
		const uint8_t	pixel )

Get pixel temperature.

Parameters

[in]	pCpnt	- Pointer to AMG88 component
[in,out]	temp	- Pointer to temperature result
[in]	pixel	- Pixel index to retrieve data

Returns: Error code

Here is the call graph for this function:

◆ AMG88_Get_pixels_temp()

FctERR AMG88_Get_pixels_temp	(	AMG88_t *const	pCpnt,
		float	temp[64] )

Get all pixels temperature.

Parameters

[in]	pCpnt	- Pointer to AMG88 component
[in,out]	temp	- Pointer to temperature result

Returns: Error code

Here is the call graph for this function:

◆ AMG88_Get_Thermistor_Raw()

FctERR AMG88_Get_Thermistor_Raw	(	AMG88_t *const	pCpnt,
		uint16_t *	raw )

inline

Get thermistor raw value.

Parameters

[in]	pCpnt	- Pointer to AMG88 component
[in,out]	raw	- Pointer to thermistor raw result

Returns: Error code

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AMG88_Get_thermistor_temp()

FctERR AMG88_Get_thermistor_temp	(	AMG88_t *const	pCpnt,
		float *	temp )

Get thermistor temperature.

Parameters

[in]	pCpnt	- Pointer to AMG88 component
[in,out]	temp	- Pointer to temperature result

Returns: Error code

Here is the call graph for this function:

◆ AMG88_INT_GPIO_Get()

bool AMG88_INT_GPIO_Get ( const AMG88_t *const pCpnt )

Interrupt GPIO pin getter for AMG88.

Weak Functions: AMG88 Interrupt GPIO pin getter may be user implemented if needed

Parameters

[in] pCpnt - Pointer to AMG88 component

Returns: INT pin state value (0: inactive, 1: active)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AMG88_INT_GPIO_Init()

void AMG88_INT_GPIO_Init	(	AMG88_t *const	pCpnt,
		GPIO_TypeDef *const	GPIOx,
		const uint16_t	GPIO_Pin,
		const GPIO_PinState	GPIO_Active )

Interrupt GPIO pin init for AMG88.

Weak Functions: AMG88 Interrupt GPIO pin init may be user implemented if needed

Parameters

[in]	pCpnt	- Pointer to AMG88 component
[in]	GPIOx	- INT port
[in]	GPIO_Pin	- INT pin
[in]	GPIO_Active	INT pin active state

Here is the call graph for this function:

◆ AMG88_Reset()

FctERR AMG88_Reset	(	AMG88_t *const	pCpnt,
		const AMG88_reset	rst )

inline

AMG88 reset.

Parameters

[in]	pCpnt	- Pointer to AMG88 component
[in]	rst	- Reset type

Returns: Error code

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AMG88_Set_FPS()

FctERR AMG88_Set_FPS	(	AMG88_t *const	pCpnt,
		const bool	ten )

inline

Set AMG88 Frame Per Seconds multiplier.

Parameters

[in]	pCpnt	- Pointer to AMG88 component
[in]	ten	- multiply by 10FPS when set to true

Returns: Error code

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AMG88_Set_Interrupt_HYS()

FctERR AMG88_Set_Interrupt_HYS	(	AMG88_t *const	pCpnt,
		const float	temp )

Set AMG88 Interrupt Hysteresis level.

Parameters

[in]	pCpnt	- Pointer to AMG88 component
[in]	temp	- Temperature value

Returns: Error code

Here is the call graph for this function:

◆ AMG88_Set_Interrupt_Levels()

FctERR AMG88_Set_Interrupt_Levels	(	AMG88_t *const	pCpnt,
		const float	temp_LVLH,
		const float	temp_LVLL,
		const float	temp_HYS )

Set AMG88 Interrupt levels.

Parameters

[in]	pCpnt	- Pointer to AMG88 component
[in]	temp_LVLH	- Temperature Interrupt Level upper limit value
[in]	temp_LVLL	- Temperature Interrupt Level lower limit value
[in]	temp_HYS	- Temperature Interrupt Hysteresis level value

Returns: Error code

Here is the call graph for this function:

◆ AMG88_Set_Interrupt_LVLH()

FctERR AMG88_Set_Interrupt_LVLH	(	AMG88_t *const	pCpnt,
		const float	temp )

Set AMG88 Interrupt Level upper limit.

Parameters

[in]	pCpnt	- Pointer to AMG88 component
[in]	temp	- Temperature value

Returns: Error code

Here is the call graph for this function:

◆ AMG88_Set_Interrupt_LVLL()

FctERR AMG88_Set_Interrupt_LVLL	(	AMG88_t *const	pCpnt,
		const float	temp )

Set AMG88 Interrupt Level lower limit.

Parameters

[in]	pCpnt	- Pointer to AMG88 component
[in]	temp	- Temperature value

Returns: Error code

Here is the call graph for this function:

◆ AMG88_Set_MA()

FctERR AMG88_Set_MA	(	AMG88_t *const	pCpnt,
		const bool	twice )

inline

Set AMG88 Moving Average.

Parameters

[in]	pCpnt	- Pointer to AMG88 component
[in]	twice	- Twice moving average when set to true

Returns: Error code

Here is the call graph for this function:

◆ AMG88_Set_Mode()

FctERR AMG88_Set_Mode	(	AMG88_t *const	pCpnt,
		const AMG88_mode	mode )

inline

AMG88 Set mode.

Parameters

[in]	pCpnt	- Pointer to AMG88 component
[in]	mode	- AMG88 mode

Returns: Error code

Here is the call graph for this function:

Here is the caller graph for this function:

Data Structures

Functions

Detailed Description

Function Documentation

◆ AMG88_Convert_Pixel_Raw()

◆ AMG88_Convert_Temp_To_Int()

◆ AMG88_Convert_Thermistor_Raw()

◆ AMG88_Get_interrupts()

◆ AMG88_Get_Pixel_Raw()

◆ AMG88_Get_pixel_temp()

◆ AMG88_Get_pixels_temp()

◆ AMG88_Get_Thermistor_Raw()

◆ AMG88_Get_thermistor_temp()

◆ AMG88_INT_GPIO_Get()

◆ AMG88_INT_GPIO_Init()

◆ AMG88_Reset()

◆ AMG88_Set_FPS()

◆ AMG88_Set_Interrupt_HYS()

◆ AMG88_Set_Interrupt_Levels()

◆ AMG88_Set_Interrupt_LVLH()

◆ AMG88_Set_Interrupt_LVLL()

◆ AMG88_Set_MA()

◆ AMG88_Set_Mode()