amg88xx.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 Bas Stottelaar <basstottelaar@gmail.com>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdbool.h>
#include <stdint.h>
#include <errno.h>
 
#include "periph/i2c.h"
#include "periph/gpio.h"
 
#include "saul.h"
 
#include "amg88xx_constants.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define AMG88XX_PIXELS_HORIZONTAL   (8)     
#define AMG88XX_PIXELS_VERTICAL     (8)     
#define AMG88XX_PIXELS_COUNT        (64)    

#define AMG88XX_BYTES_PER_PIXEL     (2)     
#define AMG88XX_BYTES_PER_FRAME     (128)   

typedef enum {
    AMG88XX_FPS_10  = 0x00,     
    AMG88XX_FPS_1   = 0x01,     
} amg88xx_fps_t;

typedef enum {
    AMG88XX_MODE_NORMAL         = 0x00,     
    AMG88XX_MODE_SLEEP          = 0x10,     
    AMG88XX_MODE_STANDBY_60S    = 0x20,     
    AMG88XX_MODE_STANDBY_10S    = 0x21,     
} amg88xx_mode_t;

typedef enum {
    AMG88XX_INT_DIFFERENCE  = 0x00,     
    AMG88XX_INT_ABSOLUTE    = 0x01,     
} amg88xx_interrupt_mode_t;
 
#if IS_USED(MODULE_PERIPH_GPIO_IRQ) || defined(DOXYGEN)
typedef void (*amg88xx_int_cb_t)(void *);
#endif

typedef struct {
    i2c_t i2c_dev;              
    uint8_t address;            
#if IS_USED(MODULE_PERIPH_GPIO_IRQ) || defined(DOXYGEN)
    gpio_t int_pin;             
#endif
} amg88xx_params_t;

typedef struct {
    amg88xx_params_t params;    
    amg88xx_mode_t mode;        
} amg88xx_t;

extern const saul_driver_t amg88xx_temperature_saul_driver;

int amg88xx_set_fps(const amg88xx_t *dev, amg88xx_fps_t fps);

int amg88xx_get_fps(const amg88xx_t *dev, amg88xx_fps_t *fps);

int amg88xx_set_mode(amg88xx_t *dev, amg88xx_mode_t mode);

int amg88xx_get_mode(const amg88xx_t *dev, amg88xx_mode_t *mode);

int amg88xx_set_averaging(const amg88xx_t *dev, bool enabled);

int amg88xx_get_averaging(const amg88xx_t *dev, bool *enabled);

int amg88xx_get_temperature(const amg88xx_t *dev, int16_t *temperature);

int amg88xx_get_frame(const amg88xx_t *dev, int16_t pixels[AMG88XX_PIXELS_COUNT]);
 
#if IS_USED(MODULE_PERIPH_GPIO_IRQ) || defined(DOXYGEN)
int amg88xx_init_int(amg88xx_t *dev, amg88xx_int_cb_t cb, void *arg);
#endif

int amg88xx_set_interrupt(const amg88xx_t *dev, amg88xx_interrupt_mode_t mode,
                          bool enabled);

int amg88xx_get_interrupt(const amg88xx_t *dev, amg88xx_interrupt_mode_t *mode,
                          bool *enabled);

int amg88xx_set_interrupt_levels(const amg88xx_t *dev, int16_t upper,
                                 int16_t lower, int16_t hysteresis);

int amg88xx_get_interrupt_levels(const amg88xx_t *dev, int16_t *upper,
                                 int16_t *lower, int16_t *hysteresis);

int amg88xx_get_interrupt_table(const amg88xx_t *dev, uint8_t table[8]);

int amg88xx_get_status(const amg88xx_t *dev, uint8_t *status);

int amg88xx_clear_status(const amg88xx_t *dev);

int amg88xx_init(amg88xx_t *dev, const amg88xx_params_t *params);

static inline int16_t amg88xx_raw_to_temperature(int16_t raw)
{
    return (int16_t)raw * 25;
}

static inline int16_t amg88xx_temperature_to_raw(int16_t temperature)
{
    return (int16_t)(temperature / 25);
}
 
#ifdef __cplusplus
}
#endif