x9cxx example driver function

x9cxx example driver modules More...

Collaboration diagram for x9cxx example driver function:

Functions
uint8_t	x9cxx_basic_init (x9cxx_type_t type)
	basic example init
uint8_t	x9cxx_basic_deinit (void)
	basic example deinit
uint8_t	x9cxx_basic_reset_to_min (x9cxx_bool_t store_enable)
	basic example reset to min
uint8_t	x9cxx_basic_reset_to_max (x9cxx_bool_t store_enable)
	basic example reset to max
uint8_t	x9cxx_basic_increment (uint8_t step, x9cxx_bool_t store_enable)
	basic example increment
uint8_t	x9cxx_basic_decrement (uint8_t step, x9cxx_bool_t store_enable)
	basic example decrement
uint8_t	x9cxx_basic_set_absolute_step (uint8_t step, x9cxx_bool_t store_enable)
	basic example set absolute step
uint8_t	x9cxx_basic_set_absolute_resistor (float ohm, x9cxx_bool_t store_enable)
	basic example set absolute resistor
uint8_t	x9cxx_basic_get_resistor (uint8_t *step, float *ohm)
	basic example get resistor

Detailed Description

x9cxx example driver modules

Function Documentation

x9cxx_basic_decrement()

uint8_t x9cxx_basic_decrement	(	uint8_t	step,
		x9cxx_bool_t	store_enable )

basic example decrement

Parameters

[in]	step	step counter
[in]	store_enable	bool value

Returns

status code

• 0 success
• 1 decrement failed

Note

none

Definition at line 183 of file driver_x9cxx_basic.c.

Here is the call graph for this function:

x9cxx_basic_deinit()

uint8_t x9cxx_basic_deinit

(

void

)

basic example deinit

Returns

status code

• 0 success
• 1 deinit failed

Note

none

Definition at line 96 of file driver_x9cxx_basic.c.

Here is the call graph for this function:

x9cxx_basic_get_resistor()

uint8_t x9cxx_basic_get_resistor	(	uint8_t *	step,
		float *	ohm )

basic example get resistor

Parameters

[out]	*step	pointer to a step buffer
[out]	*ohm	pointer to an ohm buffer

Returns

status code

• 0 success
• 1 get resistor failed

Note

none

Definition at line 260 of file driver_x9cxx_basic.c.

Here is the call graph for this function:

x9cxx_basic_increment()

uint8_t x9cxx_basic_increment	(	uint8_t	step,
		x9cxx_bool_t	store_enable )

basic example increment

Parameters

[in]	step	step counter
[in]	store_enable	bool value

Returns

status code

• 0 success
• 1 increment failed

Note

none

Definition at line 160 of file driver_x9cxx_basic.c.

Here is the call graph for this function:

x9cxx_basic_init()

uint8_t x9cxx_basic_init

(

x9cxx_type_t

type

)

basic example init

Parameters

[in]

type

chip type

Returns

status code

• 0 success
• 1 init failed

Note

none

Definition at line 49 of file driver_x9cxx_basic.c.

Here is the call graph for this function:

x9cxx_basic_reset_to_max()

uint8_t x9cxx_basic_reset_to_max

(

x9cxx_bool_t

store_enable

)

basic example reset to max

Parameters

[in]

store_enable

bool value

Returns

status code

• 0 success
• 1 reset to max failed

Note

none

Definition at line 137 of file driver_x9cxx_basic.c.

Here is the call graph for this function:

x9cxx_basic_reset_to_min()

uint8_t x9cxx_basic_reset_to_min

(

x9cxx_bool_t

store_enable

)

basic example reset to min

Parameters

[in]

store_enable

bool value

Returns

status code

• 0 success
• 1 reset to min failed

Note

none

Definition at line 115 of file driver_x9cxx_basic.c.

Here is the call graph for this function:

x9cxx_basic_set_absolute_resistor()

uint8_t x9cxx_basic_set_absolute_resistor	(	float	ohm,
		x9cxx_bool_t	store_enable )

basic example set absolute resistor

Parameters

[in]	ohm	resistor ohm
[in]	store_enable	bool value

Returns

status code

• 0 success
• 1 set absolute resistor failed

Note

none

Definition at line 229 of file driver_x9cxx_basic.c.

Here is the call graph for this function:

x9cxx_basic_set_absolute_step()

uint8_t x9cxx_basic_set_absolute_step	(	uint8_t	step,
		x9cxx_bool_t	store_enable )

basic example set absolute step

Parameters

[in]	step	step counter
[in]	store_enable	bool value

Returns

status code

• 0 success
• 1 set absolute step failed

Note

none

Definition at line 206 of file driver_x9cxx_basic.c.

Here is the call graph for this function: