driver_amg8833_basic.h

/**
 * Copyright (c) 2015 - present LibDriver All rights reserved
 * 
 * The MIT License (MIT)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE. 
 *
 * @file      driver_amg8833_basic.h
 * @brief     driver amg8833 basic header file
 * @version   1.0.0
 * @author    Shifeng Li
 * @date      2022-01-01
 *
 * <h3>history</h3>
 * <table>
 * <tr><th>Date        <th>Version  <th>Author      <th>Description
 * <tr><td>2022/01/01  <td>1.0      <td>Shifeng Li  <td>first upload
 * </table>
 */

#ifndef _DRIVER_AMG8833_BASIC_H_
#define _DRIVER_AMG8833_BASIC_H_

#include "driver_amg8833_interface.h"

#ifdef __cplusplus
extern "C"{
#endif

/**
 * @defgroup amg8833_example_driver amg8833 example driver function
 * @brief    amg8833 example driver modules
 * @ingroup  amg8833_driver
 * @{
 */

/**
 * @brief amg8833 basic example default definition
 */
#define AMG8833_BASIC_DEFAULT_FRAME_RATE          AMG8833_FRAME_RATE_10_FPS        /**< 10 fps */
#define AMG8833_BASIC_DEFAULT_AVERAGE_MODE        AMG8833_AVERAGE_MODE_TWICE       /**< twice */

/**
 * @brief     basic example init
 * @param[in] addr_pin is the iic device address
 * @return    status code
 *            - 0 success
 *            - 1 init failed
 * @note      none
 */
uint8_t amg8833_basic_init(amg8833_address_t addr_pin);

/**
 * @brief  basic example deinit
 * @return status code
 *         - 0 success
 *         - 1 deinit failed
 * @note   none
 */
uint8_t amg8833_basic_deinit(void);

/**
 * @brief      basic example read temperature array
 * @param[out] **temp points to a temperature array
 * @return     status code
 *             - 0 success
 *             - 1 read temperature array failed
 * @note       none
 */
uint8_t amg8833_basic_read_temperature_array(float temp[8][8]);

/**
 * @brief      basic example read temperature
 * @param[out] *temp points to a temperature buffer
 * @return     status code
 *             - 0 success
 *             - 1 read temperature failed
 * @note       none
 */
uint8_t amg8833_basic_read_temperature(float *temp);

/**
 * @}
 */

#ifdef __cplusplus
}
#endif

#endif