ledringr  2.0.0.0
Functions

Functions

void ledringr_cfg_setup (ledringr_cfg_t *cfg)
 Config Object Initialization function. More...
 
LEDRINGR_RETVAL ledringr_init (ledringr_t *ctx, ledringr_cfg_t *cfg)
 Initialization function. More...
 
void ledringr_transfer_data (ledringr_t *ctx, uint8_t *write_buf, uint16_t wbuf_size, uint8_t *read_buf, uint16_t rbuf_size)
 Transfer data function. More...
 
void ledringr_write_data (ledringr_t *ctx, uint32_t data_to_write)
 Generic write function. More...
 
void ledringr_turn_on_led (ledringr_t *ctx, uint8_t led_position)
 Turn On LED by position. More...
 
void ledringr_led_ring_set (ledringr_t *ctx)
 Set led. More...
 
void ledringr_led_ring_reset (ledringr_t *ctx)
 Set led. More...
 

Detailed Description

Function Documentation

◆ ledringr_cfg_setup()

void ledringr_cfg_setup ( ledringr_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ ledringr_init()

LEDRINGR_RETVAL ledringr_init ( ledringr_t ctx,
ledringr_cfg_t cfg 
)

Initialization function.

Parameters
ledringrClick object.
cfgClick configuration structure.

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

◆ ledringr_led_ring_reset()

void ledringr_led_ring_reset ( ledringr_t ctx)

Set led.

Parameters
ctxClick object.

Function sets led's to standby

◆ ledringr_led_ring_set()

void ledringr_led_ring_set ( ledringr_t ctx)

Set led.

Parameters
ctxClick object.

Function sets led's to standby

◆ ledringr_transfer_data()

void ledringr_transfer_data ( ledringr_t ctx,
uint8_t *  write_buf,
uint16_t  wbuf_size,
uint8_t *  read_buf,
uint16_t  rbuf_size 
)

Transfer data function.

Parameters
ctxClick object.
write_bufWrite data.
wbuf_sizeBuffer size.
read_bufRead buffer.
rbuf_sizeBuffer size.

This function transfers data to/from the click module.

◆ ledringr_turn_on_led()

void ledringr_turn_on_led ( ledringr_t ctx,
uint8_t  led_position 
)

Turn On LED by position.

Parameters
ctxClick object.
led_positionLed position.

Function turn On LED by position.

◆ ledringr_write_data()

void ledringr_write_data ( ledringr_t ctx,
uint32_t  data_to_write 
)

Generic write function.

Parameters
ctxClick object.
data_to_writeData to write.

This function turn On led by data.