rotaryr  2.0.0.0
Modules | Functions
ROTARY R Click Driver

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

Modules

 ROTARY R MikroBUS Map
 MikroBUS pin mapping of ROTARY R Click driver.
 
 Rotaryr_led
 

Functions

void rotaryr_cfg_setup (rotaryr_cfg_t *cfg)
 ROTARY R configuration object setup function. More...
 
err_t rotaryr_init (rotaryr_t *ctx, rotaryr_cfg_t *cfg)
 ROTARY R initialization function. More...
 
void rotaryr_generic_transfer (rotaryr_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 ROTARY R data transfer function. More...
 
void rotaryr_turn_on_led_by_data (rotaryr_t *ctx, uint16_t write_data)
 ROTARY R generic data write function. More...
 
void rotaryr_turn_on_led_by_position (rotaryr_t *ctx, uint8_t led_position)
 ROTARY R turn on led by position function. More...
 
uint8_t rotaryr_button_push (rotaryr_t *ctx)
 Button push state. More...
 
uint16_t rotaryr_get_led_data (uint8_t current_led_state)
 Get led data state. More...
 
void rotaryr_reset_led (rotaryr_t *ctx)
 Reset led. More...
 
uint8_t rotaryr_get_ecb_state (rotaryr_t *ctx)
 State ecb pin. More...
 
uint8_t rotaryr_get_eca_state (rotaryr_t *ctx)
 State eca pin. More...
 

Detailed Description

API for configuring and manipulating ROTARY R 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

◆ rotaryr_button_push()

uint8_t rotaryr_button_push ( rotaryr_t ctx)

Button push state.

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

Parameters
[in]ctx: Click context object. See rotaryr_t object definition for detailed explanation.
Returns
  • 1 - Button is pushed,
  • 0 - Button isn't pushed.
Note
None.

◆ rotaryr_cfg_setup()

void rotaryr_cfg_setup ( rotaryr_cfg_t cfg)

ROTARY R configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See rotaryr_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ rotaryr_generic_transfer()

void rotaryr_generic_transfer ( rotaryr_t ctx,
uint8_t *  wr_buf,
uint16_t  wr_len,
uint8_t *  rd_buf,
uint16_t  rd_len 
)

ROTARY R 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 rotaryr_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.

◆ rotaryr_get_eca_state()

uint8_t rotaryr_get_eca_state ( rotaryr_t ctx)

State eca pin.

Function return eca state.

Parameters
[in]ctx: Click context object. See rotaryr_t object definition for detailed explanation.
Returns
eca pin state
Note
None.

◆ rotaryr_get_ecb_state()

uint8_t rotaryr_get_ecb_state ( rotaryr_t ctx)

State ecb pin.

Function return ecb state.

Parameters
[in]ctx: Click context object. See rotaryr_t object definition for detailed explanation.
Returns
ecb pin state
Note
None.

◆ rotaryr_get_led_data()

uint16_t rotaryr_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.

◆ rotaryr_init()

err_t rotaryr_init ( rotaryr_t ctx,
rotaryr_cfg_t cfg 
)

ROTARY R initialization function.

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

Parameters
[out]ctx: Click context object. See rotaryr_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See rotaryr_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ rotaryr_reset_led()

void rotaryr_reset_led ( rotaryr_t ctx)

Reset led.

Function turn off all led.

Parameters
[in]ctx: Click context object. See rotaryr_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ rotaryr_turn_on_led_by_data()

void rotaryr_turn_on_led_by_data ( rotaryr_t ctx,
uint16_t  write_data 
)

ROTARY R generic data write function.

Function turn on led by data.

Parameters
[in]ctx: Click context object. See rotaryr_t object definition for detailed explanation.
[in]write_data: Data to write.
Returns
Nothing.
Note
None.

◆ rotaryr_turn_on_led_by_position()

void rotaryr_turn_on_led_by_position ( rotaryr_t ctx,
uint8_t  led_position 
)

ROTARY R turn on led by position function.

Function turn on led by position

Parameters
[in]ctx: Click context object. See rotaryr_t object definition for detailed explanation.
[in]led_position: Led position.
Returns
Nothing.
Note
None.