LibDriver AMG8833
Loading...
Searching...
No Matches
driver_amg8833.h File Reference

driver amg8833 header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>
Include dependency graph for driver_amg8833.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  amg8833_handle_s
 amg8833 handle structure definition More...
struct  amg8833_info_s
 amg8833 information structure definition More...

Macros

#define DRIVER_AMG8833_LINK_INIT(HANDLE, STRUCTURE)
 initialize amg8833_handle_t structure
#define DRIVER_AMG8833_LINK_IIC_INIT(HANDLE, FUC)
 link iic_init function
#define DRIVER_AMG8833_LINK_IIC_DEINIT(HANDLE, FUC)
 link iic_deinit function
#define DRIVER_AMG8833_LINK_IIC_READ(HANDLE, FUC)
 link iic_read function
#define DRIVER_AMG8833_LINK_IIC_WRITE(HANDLE, FUC)
 link iic_write function
#define DRIVER_AMG8833_LINK_DELAY_MS(HANDLE, FUC)
 link delay_ms function
#define DRIVER_AMG8833_LINK_DEBUG_PRINT(HANDLE, FUC)
 link debug_print function
#define DRIVER_AMG8833_LINK_RECEIVE_CALLBACK(HANDLE, FUC)
 link receive_callback function

Typedefs

typedef struct amg8833_handle_s amg8833_handle_t
 amg8833 handle structure definition
typedef struct amg8833_info_s amg8833_info_t
 amg8833 information structure definition

Enumerations

enum  amg8833_address_t { AMG8833_ADDRESS_0 = 0xD0 , AMG8833_ADDRESS_1 = 0xD2 }
 amg8833 address enumeration definition More...
enum  amg8833_bool_t { AMG8833_BOOL_FALSE = 0x00 , AMG8833_BOOL_TRUE = 0x01 }
 amg8833 bool enumeration definition More...
enum  amg8833_mode_t { AMG8833_MODE_NORMAL = 0x00 , AMG8833_MODE_SLEEP = 0x10 , AMG8833_MODE_STAND_BY_60S = 0x20 , AMG8833_MODE_STAND_BY_10S = 0x21 }
 amg8833 mode enumeration definition More...
enum  amg8833_reset_type_t { AMG8833_RESET_TYPE_FLAG = 0x30 , AMG8833_RESET_TYPE_INIT = 0x3F }
 amg8833 reset type enumeration definition More...
enum  amg8833_frame_rate_t { AMG8833_FRAME_RATE_10_FPS = 0x00 , AMG8833_FRAME_RATE_1_FPS = 0x01 }
 amg8833 frame rate enumeration definition More...
enum  amg8833_interrupt_mode_t { AMG8833_INTERRUPT_MODE_DIFFERENCE = 0x00 , AMG8833_INTERRUPT_MODE_ABSOLUTE = 0x01 }
 amg8833 interrupt mode enumeration definition More...
enum  amg8833_status_t { AMG8833_STATUS_OVF_THS = 0x03 , AMG8833_STATUS_OVF_IRS = 0x02 , AMG8833_STATUS_INTF = 0x01 }
 amg8833 status enumeration definition More...
enum  amg8833_average_mode_t { AMG8833_AVERAGE_MODE_ONCE = 0x00 , AMG8833_AVERAGE_MODE_TWICE = 0x01 }
 amg8833 average mode enumeration definition More...

Functions

uint8_t amg8833_info (amg8833_info_t *info)
 get chip's information
uint8_t amg8833_irq_handler (amg8833_handle_t *handle)
 irq handler
uint8_t amg8833_set_addr_pin (amg8833_handle_t *handle, amg8833_address_t addr_pin)
 set the iic address pin
uint8_t amg8833_get_addr_pin (amg8833_handle_t *handle, amg8833_address_t *addr_pin)
 get the iic address pin
uint8_t amg8833_init (amg8833_handle_t *handle)
 initialize the chip
uint8_t amg8833_deinit (amg8833_handle_t *handle)
 close the chip
uint8_t amg8833_read_temperature (amg8833_handle_t *handle, int16_t *raw, float *temp)
 read the temperature
uint8_t amg8833_read_temperature_array (amg8833_handle_t *handle, int16_t raw[8][8], float temp[8][8])
 read the temperature array
uint8_t amg8833_get_interrupt_table (amg8833_handle_t *handle, uint8_t table[8][1])
 get the interrupt table
uint8_t amg8833_set_mode (amg8833_handle_t *handle, amg8833_mode_t mode)
 set the mode
uint8_t amg8833_get_mode (amg8833_handle_t *handle, amg8833_mode_t *mode)
 get the mode
uint8_t amg8833_reset (amg8833_handle_t *handle, amg8833_reset_type_t type)
 reset the chip
uint8_t amg8833_set_frame_rate (amg8833_handle_t *handle, amg8833_frame_rate_t rate)
 set the frame rate
uint8_t amg8833_get_frame_rate (amg8833_handle_t *handle, amg8833_frame_rate_t *rate)
 get the frame rate
uint8_t amg8833_set_interrupt_mode (amg8833_handle_t *handle, amg8833_interrupt_mode_t mode)
 set the interrupt mode
uint8_t amg8833_get_interrupt_mode (amg8833_handle_t *handle, amg8833_interrupt_mode_t *mode)
 get the interrupt mode
uint8_t amg8833_set_interrupt (amg8833_handle_t *handle, amg8833_bool_t enable)
 enable or disable the interrupt
uint8_t amg8833_get_interrupt (amg8833_handle_t *handle, amg8833_bool_t *enable)
 get the interrupt status
uint8_t amg8833_get_status (amg8833_handle_t *handle, uint8_t *status)
 get the status
uint8_t amg8833_clear_status (amg8833_handle_t *handle, amg8833_status_t status)
 clear the interrupt status
uint8_t amg8833_set_average_mode (amg8833_handle_t *handle, amg8833_average_mode_t mode)
 set the average_mode
uint8_t amg8833_get_average_mode (amg8833_handle_t *handle, amg8833_average_mode_t *mode)
 get the average_mode
uint8_t amg8833_set_interrupt_high_level (amg8833_handle_t *handle, int16_t level)
 set the interrupt high level
uint8_t amg8833_get_interrupt_high_level (amg8833_handle_t *handle, int16_t *level)
 get the interrupt high level
uint8_t amg8833_set_interrupt_low_level (amg8833_handle_t *handle, int16_t level)
 set the interrupt low level
uint8_t amg8833_get_interrupt_low_level (amg8833_handle_t *handle, int16_t *level)
 get the interrupt low level
uint8_t amg8833_set_interrupt_hysteresis_level (amg8833_handle_t *handle, int16_t level)
 set the interrupt hysteresis level
uint8_t amg8833_get_interrupt_hysteresis_level (amg8833_handle_t *handle, int16_t *level)
 get the interrupt hysteresis level
uint8_t amg8833_interrupt_level_convert_to_register (amg8833_handle_t *handle, float temp, int16_t *reg)
 convert the interrupt level to the register raw data
uint8_t amg8833_interrupt_level_convert_to_data (amg8833_handle_t *handle, int16_t reg, float *temp)
 convert the register raw data to the interrupt level
uint8_t amg8833_set_reg (amg8833_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len)
 set the chip register
uint8_t amg8833_get_reg (amg8833_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len)
 get the chip register

Detailed Description

driver amg8833 header file

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.

Version
1.0.0
Author
Shifeng Li
Date
2022-01-01

history

Date Version Author Description
2022/01/01 1.0 Shifeng Li first upload

Definition in file driver_amg8833.h.