ntc example driver modules More...

Collaboration diagram for ntc example driver function:

Functions
uint8_t	ntc_basic_init (ntc_circuit_t circuit, float r_fixed_ohm)
	basic example init
uint8_t	ntc_basic_deinit (void)
	basic example deinit
uint8_t	ntc_basic_read (float *degrees_celsius)
	basic example read
uint8_t	ntc_basic_calculate_temperature (float ohm, float *degrees_celsius)
	basic calculate temperature
uint8_t	ntc_basic_calculate_temperature_with_filter (float ohm, uint16_t len, float degrees_celsius)
	basic calculate temperature with filter
uint8_t	ntc_basic_set_algorithm_beta_formula (float beta, float r25_ohm)
	basic example set algorithm beta formula
uint8_t	ntc_basic_set_algorithm_steinhart_hart (double a, double b, double c)
	basic example set algorithm steinhart hart
uint8_t	ntc_basic_set_algorithm_lookup_table (const ntc_table_t *table, uint16_t table_len)
	basic example set algorithm lookup table
uint8_t	ntc_basic_set_filter_none (void)
	basic example set filter none
uint8_t	ntc_basic_set_filter_first_order_lag (float alpha)
	basic example set filter first order lag
uint8_t	ntc_basic_set_filter_median (uint16_t length)
	basic example set filter median
uint8_t	ntc_basic_set_filter_anti_spike_average (uint16_t length)
	basic example set filter anti spike average
uint8_t	ntc_basic_set_filter_moving_average (uint16_t length)
	basic example set filter moving average
uint8_t	ntc_basic_set_filter_weighted_moving_average (float *weight, uint16_t length)
	basic example set filter weighted moving average
uint8_t	ntc_basic_set_filter_limiting (float degrees_celsius)
	basic example set filter limiting
uint8_t	ntc_basic_set_filter_kalman (float q_process_noise_covariance, float r_measurement_noise_covariance, float p_estimation_error_covariance, float x_estimated_value)
	basic example set filter kalman
uint8_t	ntc_basic_reset_filter (void)
	basic example reset filter

Detailed Description

ntc example driver modules

Function Documentation

◆ ntc_basic_calculate_temperature()

uint8_t ntc_basic_calculate_temperature	(	float	ohm,
		float *	degrees_celsius )

basic calculate temperature

Parameters

[in]	ohm	resistor in ohm
[out]	*degrees_celsius	pointer to a degrees celsius buffer

Returns

status code

0 success
1 calculate failed

Note: none

Definition at line 497 of file driver_ntc_basic.c.

Here is the call graph for this function:

◆ ntc_basic_calculate_temperature_with_filter()

uint8_t ntc_basic_calculate_temperature_with_filter	(	float *	ohm,
		uint16_t	len,
		float *	degrees_celsius )

basic calculate temperature with filter

Parameters

[in]	*ohm	pointer to a resistor in ohm
[in]	len	resistor length
[out]	*degrees_celsius	pointer to a degrees celsius buffer

Returns

status code

0 success
1 calculate failed

Note: none

Definition at line 521 of file driver_ntc_basic.c.

Here is the call graph for this function:

◆ ntc_basic_deinit()

uint8_t ntc_basic_deinit ( void )

basic example deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 101 of file driver_ntc_basic.c.

Here is the call graph for this function:

◆ ntc_basic_init()

uint8_t ntc_basic_init	(	ntc_circuit_t	circuit,
		float	r_fixed_ohm )

basic example init

Parameters

[in]	circuit	ntc circuit
[in]	r_fixed_ohm	fixed resistor in ohm

Returns

status code

0 success
1 init failed

Note: none

Definition at line 50 of file driver_ntc_basic.c.

Here is the call graph for this function:

◆ ntc_basic_read()

uint8_t ntc_basic_read ( float * degrees_celsius )

basic example read

Parameters

[out] *degrees_celsius pointer to a degrees celsius buffer

Returns

status code

0 success
1 read failed

Note: none

Definition at line 473 of file driver_ntc_basic.c.

Here is the call graph for this function:

◆ ntc_basic_reset_filter()

uint8_t ntc_basic_reset_filter ( void )

basic example reset filter

Returns

status code

0 success
1 reset filter failed

Note: none

Definition at line 451 of file driver_ntc_basic.c.

Here is the call graph for this function:

◆ ntc_basic_set_algorithm_beta_formula()

uint8_t ntc_basic_set_algorithm_beta_formula	(	float	beta,
		float	r25_ohm )

basic example set algorithm beta formula

Parameters

[in]	beta	beta value
[in]	r25_ohm	r25 ohm

Returns

status code

0 success
1 set algorithm failed

Note: none

Definition at line 120 of file driver_ntc_basic.c.

Here is the call graph for this function:

◆ ntc_basic_set_algorithm_lookup_table()

uint8_t ntc_basic_set_algorithm_lookup_table	(	const ntc_table_t *	table,
		uint16_t	table_len )

basic example set algorithm lookup table

Parameters

[in]	*table	pointer to a ntc table buffer
[in]	table_len	table length

Returns

status code

0 success
1 set algorithm failed

Note: none

Definition at line 188 of file driver_ntc_basic.c.

Here is the call graph for this function:

◆ ntc_basic_set_algorithm_steinhart_hart()

uint8_t ntc_basic_set_algorithm_steinhart_hart	(	double	a,
		double	b,
		double	c )

basic example set algorithm steinhart hart

Parameters

[in]	a	param a
[in]	b	param b
[in]	c	param c

Returns

status code

0 success
1 set algorithm failed

Note: none

Definition at line 158 of file driver_ntc_basic.c.

Here is the call graph for this function:

◆ ntc_basic_set_filter_anti_spike_average()

uint8_t ntc_basic_set_filter_anti_spike_average ( uint16_t length )

basic example set filter anti spike average

Parameters

[in] length anti spike average length

Returns

status code

0 success
1 set filter failed

Note: none

Definition at line 296 of file driver_ntc_basic.c.

Here is the call graph for this function:

◆ ntc_basic_set_filter_first_order_lag()

uint8_t ntc_basic_set_filter_first_order_lag ( float alpha )

basic example set filter first order lag

Parameters

[in] alpha input alpha

Returns

status code

0 success
1 set filter failed

Note: none

Definition at line 238 of file driver_ntc_basic.c.

Here is the call graph for this function:

◆ ntc_basic_set_filter_kalman()

uint8_t ntc_basic_set_filter_kalman	(	float	q_process_noise_covariance,
		float	r_measurement_noise_covariance,
		float	p_estimation_error_covariance,
		float	x_estimated_value )

basic example set filter kalman

Parameters

[in]	q_process_noise_covariance	process noise covariance
[in]	r_measurement_noise_covariance	measurement noise covariance
[in]	p_estimation_error_covariance	estimation error covariance
[in]	x_estimated_value	x estimated value

Returns

status code

0 success
1 set filter failed

Note: none

Definition at line 416 of file driver_ntc_basic.c.

Here is the call graph for this function:

◆ ntc_basic_set_filter_limiting()

uint8_t ntc_basic_set_filter_limiting ( float degrees_celsius )

basic example set filter limiting

Parameters

[in] degrees_celsius degrees celsius

Returns

status code

0 success
1 set filter failed

Note: none

Definition at line 384 of file driver_ntc_basic.c.

Here is the call graph for this function:

◆ ntc_basic_set_filter_median()

uint8_t ntc_basic_set_filter_median ( uint16_t length )

basic example set filter median

Parameters

[in] length median length

Returns

status code

0 success
1 set filter failed

Note: none

Definition at line 267 of file driver_ntc_basic.c.

Here is the call graph for this function:

◆ ntc_basic_set_filter_moving_average()

uint8_t ntc_basic_set_filter_moving_average ( uint16_t length )

basic example set filter moving average

Parameters

[in] length moving average length

Returns

status code

0 success
1 set filter failed

Note: none

Definition at line 325 of file driver_ntc_basic.c.

Here is the call graph for this function:

◆ ntc_basic_set_filter_none()

uint8_t ntc_basic_set_filter_none ( void )

basic example set filter none

Returns

status code

0 success
1 set filter failed

Note: none

Definition at line 216 of file driver_ntc_basic.c.

Here is the call graph for this function:

◆ ntc_basic_set_filter_weighted_moving_average()

uint8_t ntc_basic_set_filter_weighted_moving_average	(	float *	weight,
		uint16_t	length )

basic example set filter weighted moving average

Parameters

[in]	*weight	pointer to a weight buffer
[in]	length	weighted moving average length

Returns

status code

0 success
1 set filter failed

Note: weight[0](older), ..., weight[n](newer)

Definition at line 355 of file driver_ntc_basic.c.

Here is the call graph for this function:

Functions

Detailed Description

Function Documentation

◆ ntc_basic_calculate_temperature()

◆ ntc_basic_calculate_temperature_with_filter()

◆ ntc_basic_deinit()

◆ ntc_basic_init()

◆ ntc_basic_read()

◆ ntc_basic_reset_filter()

◆ ntc_basic_set_algorithm_beta_formula()

◆ ntc_basic_set_algorithm_lookup_table()

◆ ntc_basic_set_algorithm_steinhart_hart()

◆ ntc_basic_set_filter_anti_spike_average()

◆ ntc_basic_set_filter_first_order_lag()

◆ ntc_basic_set_filter_kalman()

◆ ntc_basic_set_filter_limiting()

◆ ntc_basic_set_filter_median()

◆ ntc_basic_set_filter_moving_average()

◆ ntc_basic_set_filter_none()

◆ ntc_basic_set_filter_weighted_moving_average()