ROTARY Y Click Driver

API for configuring and manipulating ROTARY Y Click driver. More...

Topics
	ROTARY Y MikroBUS Map
	MikroBUS pin mapping of ROTARY Y Click driver.
	Rotaryy_led

Functions
void	rotaryy_cfg_setup (rotaryy_cfg_t *cfg)
	ROTARY Y configuration object setup function.
err_t	rotaryy_init (rotaryy_t *ctx, rotaryy_cfg_t *cfg)
	ROTARY Y initialization function.
void	rotaryy_generic_transfer (rotaryy_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
	ROTARY Y data transfer function.
void	rotaryy_turn_on_led_by_data (rotaryy_t *ctx, uint16_t write_data)
	ROTARY Y generic data write function.
void	rotaryy_turn_on_led_by_position (rotaryy_t *ctx, uint8_t led_position)
	ROTARY Y turn on led by position function.
uint8_t	rotaryy_button_push (rotaryy_t *ctx)
	Button push state.
uint16_t	rotaryy_get_led_data (uint8_t current_led_state)
	Get led data state.
void	rotaryy_reset_led (rotaryy_t *ctx)
	Reset led.
uint8_t	rotaryy_get_ecb_state (rotaryy_t *ctx)
	State ecb pin.
uint8_t	rotaryy_get_eca_state (rotaryy_t *ctx)
	State eca pin.

Detailed Description

API for configuring and manipulating ROTARY Y Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

rotaryy_button_push()

uint8_t rotaryy_button_push

(

rotaryy_t *

ctx

)

Button push state.

Function return 1 if button is pushed and return 0 if not

Parameters

[in]

ctx

: Click context object. See rotaryy_t object definition for detailed explanation.

Returns

• 1 - Button is pushed,
• 0 - Button isn't pushed.

Note

None.

rotaryy_cfg_setup()

void rotaryy_cfg_setup

(

rotaryy_cfg_t *

cfg

)

ROTARY Y configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See rotaryy_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

rotaryy_generic_transfer()

void rotaryy_generic_transfer	(	rotaryy_t *	ctx,
		uint8_t *	wr_buf,
		uint16_t	wr_len,
		uint8_t *	rd_buf,
		uint16_t	rd_len )

ROTARY Y data transfer function.

This function reads and writes a desired number of data bytes starting from the selected register by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See rotaryy_t object definition for detailed explanation.
[in]	wr_buf	: Write data buffer.
[in]	wr_len	: Number of byte in write data buffer.
[in]	rd_buf	: Read data buffer.
[in]	rd_len	: Number of byte in read data buffer.

Returns

Nothing.

Note

None.

rotaryy_get_eca_state()

uint8_t rotaryy_get_eca_state

(

rotaryy_t *

ctx

)

State eca pin.

Function return eca state.

Parameters

[in]

ctx

: Click context object. See rotaryy_t object definition for detailed explanation.

Returns

eca pin state

Note

None.

rotaryy_get_ecb_state()

uint8_t rotaryy_get_ecb_state

(

rotaryy_t *

ctx

)

State ecb pin.

Function return ecb state.

Parameters

[in]

ctx

: Click context object. See rotaryy_t object definition for detailed explanation.

Returns

ecb pin state

Note

None.

rotaryy_get_led_data()

uint16_t rotaryy_get_led_data

(

uint8_t

current_led_state

)

Get led data state.

Function return 16-bit data by current led state.

Parameters

[in]

current_led_state

: Current state of led.

Returns

Led state.

Note

None.

rotaryy_init()

err_t rotaryy_init	(	rotaryy_t *	ctx,
		rotaryy_cfg_t *	cfg )

ROTARY Y initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters

[out]	ctx	: Click context object. See rotaryy_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See rotaryy_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

rotaryy_reset_led()

void rotaryy_reset_led

(

rotaryy_t *

ctx

)

Reset led.

Function turn off all led.

Parameters

[in]

ctx

: Click context object. See rotaryy_t object definition for detailed explanation.

Returns

Nothing.

Note

None.

rotaryy_turn_on_led_by_data()

void rotaryy_turn_on_led_by_data	(	rotaryy_t *	ctx,
		uint16_t	write_data )

ROTARY Y generic data write function.

Function turn on led by data.

Parameters

[in]	ctx	: Click context object. See rotaryy_t object definition for detailed explanation.
[in]	write_data	: Data to write.

Returns

Nothing.

Note

None.

rotaryy_turn_on_led_by_position()

void rotaryy_turn_on_led_by_position	(	rotaryy_t *	ctx,
		uint8_t	led_position )

ROTARY Y turn on led by position function.

Function turn on led by position

Parameters

[in]	ctx	: Click context object. See rotaryy_t object definition for detailed explanation.
[in]	led_position	: Led position.

Returns

Nothing.

Note

None.