LibDriver MAX31856
Loading...
Searching...
No Matches
max31856 example driver function
max31856 driver function

max31856 example driver modules More...

Collaboration diagram for max31856 example driver function:

Macros

#define MAX31856_BASIC_DEFAULT_OPEN_CIRCUIT_DETECTION   MAX31856_OPEN_CIRCUIT_DETECTION_MODE3
 max31856 basic example default definition
#define MAX31856_BASIC_DEFAULT_FAULT_MODE   MAX31856_FAULT_MODE_INTERRUPT
#define MAX31856_BASIC_DEFAULT_NOISE_REJECTION_FILTER   MAX31856_NOISE_REJECTION_FILTER_50HZ
#define MAX31856_BASIC_DEFAULT_SAMPLE_AVERAGE   MAX31856_SAMPLE_AVERAGE_16
#define MAX31856_BASIC_DEFAULT_COLD_JUNCTION_TEMPERATURE_OFFSET   0.0f
#define MAX31856_INTERRUPT_DEFAULT_OPEN_CIRCUIT_DETECTION   MAX31856_OPEN_CIRCUIT_DETECTION_MODE3
 max31856 interrupt example default definition
#define MAX31856_INTERRUPT_DEFAULT_FAULT_MODE   MAX31856_FAULT_MODE_INTERRUPT
#define MAX31856_INTERRUPT_DEFAULT_NOISE_REJECTION_FILTER   MAX31856_NOISE_REJECTION_FILTER_50HZ
#define MAX31856_INTERRUPT_DEFAULT_SAMPLE_AVERAGE   MAX31856_SAMPLE_AVERAGE_16
#define MAX31856_INTERRUPT_DEFAULT_COLD_JUNCTION_TEMPERATURE_OFFSET   0.0f
#define MAX31856_SHOT_DEFAULT_OPEN_CIRCUIT_DETECTION   MAX31856_OPEN_CIRCUIT_DETECTION_MODE3
 max31856 shot example default definition
#define MAX31856_SHOT_DEFAULT_FAULT_MODE   MAX31856_FAULT_MODE_INTERRUPT
#define MAX31856_SHOT_DEFAULT_NOISE_REJECTION_FILTER   MAX31856_NOISE_REJECTION_FILTER_50HZ
#define MAX31856_SHOT_DEFAULT_SAMPLE_AVERAGE   MAX31856_SAMPLE_AVERAGE_16
#define MAX31856_SHOT_DEFAULT_COLD_JUNCTION_TEMPERATURE_OFFSET   0.0f

Functions

uint8_t max31856_basic_init (max31856_thermocouple_type_t type)
 basic example init
uint8_t max31856_basic_deinit (void)
 basic example deinit
uint8_t max31856_basic_read (double *temp_deg, uint8_t *fault)
 basic example read the temperature
uint8_t max31856_basic_read_cold_junction_temperature (double *temp_deg)
 basic example read the cold junction temperature
uint8_t max31856_interrupt_irq_handler (void)
 interrupt irq callback
uint8_t max31856_interrupt_init (max31856_thermocouple_type_t type, float cold_junction_low_fault_threshold_deg, float cold_junction_high_fault_threshold_deg, float temperature_low_fault_threshold_deg, float temperature_high_fault_threshold_deg, void(*callback)(uint8_t type))
 interrupt example init
uint8_t max31856_interrupt_deinit (void)
 interrupt example deinit
uint8_t max31856_interrupt_read (double *temp_deg, uint8_t *fault)
 interrupt example read the temperature
uint8_t max31856_interrupt_read_cold_junction_temperature (double *temp_deg)
 interrupt example read the cold junction temperature
uint8_t max31856_shot_init (max31856_thermocouple_type_t type)
 shot example init
uint8_t max31856_shot_deinit (void)
 shot example deinit
uint8_t max31856_shot_read (double *temp_deg, uint8_t *fault)
 shot example read the temperature
uint8_t max31856_shot_read_cold_junction_temperature (double *temp_deg)
 shot example read the cold junction temperature

Detailed Description

max31856 example driver modules

Macro Definition Documentation

◆ MAX31856_BASIC_DEFAULT_COLD_JUNCTION_TEMPERATURE_OFFSET

#define MAX31856_BASIC_DEFAULT_COLD_JUNCTION_TEMPERATURE_OFFSET   0.0f

Definition at line 60 of file driver_max31856_basic.h.

◆ MAX31856_BASIC_DEFAULT_FAULT_MODE

#define MAX31856_BASIC_DEFAULT_FAULT_MODE   MAX31856_FAULT_MODE_INTERRUPT

interrupt mode

Definition at line 57 of file driver_max31856_basic.h.

◆ MAX31856_BASIC_DEFAULT_NOISE_REJECTION_FILTER

#define MAX31856_BASIC_DEFAULT_NOISE_REJECTION_FILTER   MAX31856_NOISE_REJECTION_FILTER_50HZ

50hz

Definition at line 58 of file driver_max31856_basic.h.

◆ MAX31856_BASIC_DEFAULT_OPEN_CIRCUIT_DETECTION

#define MAX31856_BASIC_DEFAULT_OPEN_CIRCUIT_DETECTION   MAX31856_OPEN_CIRCUIT_DETECTION_MODE3

max31856 basic example default definition

113.4ms / 140ms

Definition at line 56 of file driver_max31856_basic.h.

◆ MAX31856_BASIC_DEFAULT_SAMPLE_AVERAGE

#define MAX31856_BASIC_DEFAULT_SAMPLE_AVERAGE   MAX31856_SAMPLE_AVERAGE_16

16 samples

Definition at line 59 of file driver_max31856_basic.h.

◆ MAX31856_INTERRUPT_DEFAULT_COLD_JUNCTION_TEMPERATURE_OFFSET

#define MAX31856_INTERRUPT_DEFAULT_COLD_JUNCTION_TEMPERATURE_OFFSET   0.0f

Definition at line 58 of file driver_max31856_interrupt.h.

◆ MAX31856_INTERRUPT_DEFAULT_FAULT_MODE

#define MAX31856_INTERRUPT_DEFAULT_FAULT_MODE   MAX31856_FAULT_MODE_INTERRUPT

interrupt mode

Definition at line 55 of file driver_max31856_interrupt.h.

◆ MAX31856_INTERRUPT_DEFAULT_NOISE_REJECTION_FILTER

#define MAX31856_INTERRUPT_DEFAULT_NOISE_REJECTION_FILTER   MAX31856_NOISE_REJECTION_FILTER_50HZ

50hz

Definition at line 56 of file driver_max31856_interrupt.h.

◆ MAX31856_INTERRUPT_DEFAULT_OPEN_CIRCUIT_DETECTION

#define MAX31856_INTERRUPT_DEFAULT_OPEN_CIRCUIT_DETECTION   MAX31856_OPEN_CIRCUIT_DETECTION_MODE3

max31856 interrupt example default definition

113.4ms / 140ms

Definition at line 54 of file driver_max31856_interrupt.h.

◆ MAX31856_INTERRUPT_DEFAULT_SAMPLE_AVERAGE

#define MAX31856_INTERRUPT_DEFAULT_SAMPLE_AVERAGE   MAX31856_SAMPLE_AVERAGE_16

16 samples

Definition at line 57 of file driver_max31856_interrupt.h.

◆ MAX31856_SHOT_DEFAULT_COLD_JUNCTION_TEMPERATURE_OFFSET

#define MAX31856_SHOT_DEFAULT_COLD_JUNCTION_TEMPERATURE_OFFSET   0.0f

Definition at line 58 of file driver_max31856_shot.h.

◆ MAX31856_SHOT_DEFAULT_FAULT_MODE

#define MAX31856_SHOT_DEFAULT_FAULT_MODE   MAX31856_FAULT_MODE_INTERRUPT

interrupt mode

Definition at line 55 of file driver_max31856_shot.h.

◆ MAX31856_SHOT_DEFAULT_NOISE_REJECTION_FILTER

#define MAX31856_SHOT_DEFAULT_NOISE_REJECTION_FILTER   MAX31856_NOISE_REJECTION_FILTER_50HZ

50hz

Definition at line 56 of file driver_max31856_shot.h.

◆ MAX31856_SHOT_DEFAULT_OPEN_CIRCUIT_DETECTION

#define MAX31856_SHOT_DEFAULT_OPEN_CIRCUIT_DETECTION   MAX31856_OPEN_CIRCUIT_DETECTION_MODE3

max31856 shot example default definition

113.4ms / 140ms

Definition at line 54 of file driver_max31856_shot.h.

◆ MAX31856_SHOT_DEFAULT_SAMPLE_AVERAGE

#define MAX31856_SHOT_DEFAULT_SAMPLE_AVERAGE   MAX31856_SAMPLE_AVERAGE_16

16 samples

Definition at line 57 of file driver_max31856_shot.h.

Function Documentation

◆ max31856_basic_deinit()

uint8_t max31856_basic_deinit ( void )

basic example deinit

Returns
status code
  • 0 success
  • 1 deinit failed
Note
none

Definition at line 243 of file driver_max31856_basic.c.

Here is the call graph for this function:

◆ max31856_basic_init()

uint8_t max31856_basic_init ( max31856_thermocouple_type_t type)

basic example init

Parameters
[in]typethermocouple type
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 49 of file driver_max31856_basic.c.

Here is the call graph for this function:

◆ max31856_basic_read()

uint8_t max31856_basic_read ( double * temp_deg,
uint8_t * fault )

basic example read the temperature

Parameters
[out]*temp_degpointer to a converted temperature buffer
[out]*faultpointer to a fault buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 269 of file driver_max31856_basic.c.

Here is the call graph for this function:

◆ max31856_basic_read_cold_junction_temperature()

uint8_t max31856_basic_read_cold_junction_temperature ( double * temp_deg)

basic example read the cold junction temperature

Parameters
[out]*temp_degpointer to a converted temperature buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 299 of file driver_max31856_basic.c.

Here is the call graph for this function:

◆ max31856_interrupt_deinit()

uint8_t max31856_interrupt_deinit ( void )

interrupt example deinit

Returns
status code
  • 0 success
  • 1 deinit failed
Note
none

Definition at line 352 of file driver_max31856_interrupt.c.

Here is the call graph for this function:

◆ max31856_interrupt_init()

uint8_t max31856_interrupt_init ( max31856_thermocouple_type_t type,
float cold_junction_low_fault_threshold_deg,
float cold_junction_high_fault_threshold_deg,
float temperature_low_fault_threshold_deg,
float temperature_high_fault_threshold_deg,
void(* callback )(uint8_t type) )

interrupt example init

Parameters
[in]typethermocouple type
[in]cold_junction_low_fault_threshold_degcold junction low fault threshold
[in]cold_junction_high_fault_threshold_degcold junction high fault threshold
[in]temperature_low_fault_threshold_degtemperature low fault threshold
[in]temperature_high_fault_threshold_degtemperature high fault threshold
[in]*callbackpointer to a callback address
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 71 of file driver_max31856_interrupt.c.

Here is the call graph for this function:

◆ max31856_interrupt_irq_handler()

uint8_t max31856_interrupt_irq_handler ( void )

interrupt irq callback

Returns
status code
  • 0 success
  • 1 run failed
Note
none

Definition at line 48 of file driver_max31856_interrupt.c.

Here is the call graph for this function:

◆ max31856_interrupt_read()

uint8_t max31856_interrupt_read ( double * temp_deg,
uint8_t * fault )

interrupt example read the temperature

Parameters
[out]*temp_degpointer to a converted temperature buffer
[out]*faultpointer to a fault buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 378 of file driver_max31856_interrupt.c.

Here is the call graph for this function:

◆ max31856_interrupt_read_cold_junction_temperature()

uint8_t max31856_interrupt_read_cold_junction_temperature ( double * temp_deg)

interrupt example read the cold junction temperature

Parameters
[out]*temp_degpointer to a converted temperature buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 408 of file driver_max31856_interrupt.c.

Here is the call graph for this function:

◆ max31856_shot_deinit()

uint8_t max31856_shot_deinit ( void )

shot example deinit

Returns
status code
  • 0 success
  • 1 deinit failed
Note
none

Definition at line 233 of file driver_max31856_shot.c.

Here is the call graph for this function:

◆ max31856_shot_init()

uint8_t max31856_shot_init ( max31856_thermocouple_type_t type)

shot example init

Parameters
[in]typethermocouple type
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 49 of file driver_max31856_shot.c.

Here is the call graph for this function:

◆ max31856_shot_read()

uint8_t max31856_shot_read ( double * temp_deg,
uint8_t * fault )

shot example read the temperature

Parameters
[out]*temp_degpointer to a converted temperature buffer
[out]*faultpointer to a fault buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 253 of file driver_max31856_shot.c.

Here is the call graph for this function:

◆ max31856_shot_read_cold_junction_temperature()

uint8_t max31856_shot_read_cold_junction_temperature ( double * temp_deg)

shot example read the cold junction temperature

Parameters
[out]*temp_degpointer to a converted temperature buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 283 of file driver_max31856_shot.c.

Here is the call graph for this function: