driver_max31855.h File Reference

driver max31855 header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>

Include dependency graph for driver_max31855.h:

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

Go to the source code of this file.

Data Structures
struct	max31855_handle_s
	max31855 handle structure definition More...
struct	max31855_info_s
	max31855 information structure definition More...

Macros
#define	DRIVER_MAX31855_LINK_INIT(HANDLE, STRUCTURE)
	initialize max31855_handle_t structure
#define	DRIVER_MAX31855_LINK_SPI_INIT(HANDLE, FUC)
	link spi_init function
#define	DRIVER_MAX31855_LINK_SPI_DEINIT(HANDLE, FUC)
	link spi_deinit function
#define	DRIVER_MAX31855_LINK_SPI_READ_COMMAND(HANDLE, FUC)
	link spi_read_cmd function
#define	DRIVER_MAX31855_LINK_DELAY_MS(HANDLE, FUC)
	link delay_ms function
#define	DRIVER_MAX31855_LINK_DEBUG_PRINT(HANDLE, FUC)
	link debug_print function

Typedefs
typedef struct max31855_handle_s	max31855_handle_t
	max31855 handle structure definition
typedef struct max31855_info_s	max31855_info_t
	max31855 information structure definition

Enumerations
enum	max31855_fault_t { MAX31855_FAULT_NONE = 0x00 , MAX31855_FAULT_OC = (1 << 0) , MAX31855_FAULT_SCG = (1 << 1) , MAX31855_FAULT_SCV = (1 << 2) }
	max31855 fault enumeration definition More...

Functions
uint8_t	max31855_info (max31855_info_t *info)
	get chip's information
uint8_t	max31855_init (max31855_handle_t *handle)
	initialize the chip
uint8_t	max31855_deinit (max31855_handle_t *handle)
	close the chip
uint8_t	max31855_read (max31855_handle_t *handle, int16_t *thermocouple_raw, float *thermocouple_temp, int16_t *reference_junction_raw, float *reference_junction_temp)
	read the temperature
uint8_t	max31855_get_last_fault (max31855_handle_t *handle, max31855_fault_t *fault)
	get the last fault
uint8_t	max31855_get_reg (max31855_handle_t *handle, uint32_t *data)
	get the chip register

Detailed Description

driver max31855 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

2025-01-08

history

Date	Version	Author	Description
2025/01/08	1.0	Shifeng Li	first upload

Definition in file driver_max31855.h.