oledb  2.0.0.0
Functions
Public Function

Functions

void oledb_cfg_setup (oledb_cfg_t *cfg)
 Configuration Object Setup function. More...
 
err_t oledb_init (oledb_t *ctx, oledb_cfg_t *cfg)
 Click Initialization function. More...
 
err_t oledb_send (oledb_t *ctx, oledb_data_t tx_data, oledb_data_mode_t data_mode)
 Send function. More...
 
void oledb_default_cfg (oledb_t *ctx)
 Click Default Configuration function. More...
 
void oledb_set_page (oledb_t *ctx, oledb_data_t page_addr)
 Page Setting function. More...
 
void oledb_set_column (oledb_t *ctx, oledb_data_t col_addr)
 Column Setting function. More...
 
void oledb_display_picture (oledb_t *ctx, oledb_resources_t *pic)
 Display Picture function. More...
 
void oledb_set_contrast (oledb_t *ctx, oledb_data_t value)
 Contrast Setting function. More...
 
void oledb_scroll_right (oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr)
 Scroll Right function. More...
 
void oledb_scroll_left (oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr)
 Scroll Left function. More...
 
void oledb_scroll_diag_right (oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr)
 Scroll Diagonally Right function. More...
 
void oledb_scroll_diag_left (oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr)
 Scroll Diagonally Left function. More...
 
void oledb_stop_scroll (oledb_t *ctx)
 Stop Scrolling function. More...
 

Detailed Description

Function Documentation

◆ oledb_cfg_setup()

void oledb_cfg_setup ( oledb_cfg_t cfg)

Configuration Object Setup function.

This function initializes click configuration structure to initial state.

Parameters
[in]cfgClick configuration structure.
Returns
Nothing.
Note
All used pins will be initialized to unconnected state. SPI driver will be activated as default driver.

◆ oledb_default_cfg()

void oledb_default_cfg ( oledb_t ctx)

Click Default Configuration function.

This function configures OLED B click to default state.

Parameters
[in]ctxClick object.
Returns
Nothing.

◆ oledb_display_picture()

void oledb_display_picture ( oledb_t ctx,
oledb_resources_t pic 
)

Display Picture function.

This function allows user to display picture for page addressing mode.

Parameters
[in]ctxClick object.
[in]picResource code.
Returns
Nothing.

◆ oledb_init()

err_t oledb_init ( oledb_t ctx,
oledb_cfg_t cfg 
)

Click Initialization function.

Parameters
[in]ctxClick object.
[in]cfgClick configuration structure.
Returns
0x00 - Ok, 0xFF - Init error, 0xFD - Invalid driver selector.

This function initializes all necessary peripherals and pins.

◆ oledb_scroll_diag_left()

void oledb_scroll_diag_left ( oledb_t ctx,
oledb_data_t  start_page_addr,
oledb_data_t  end_page_addr 
)

Scroll Diagonally Left function.

This function scrolls the display diagonally to the left.

Parameters
[in]ctxClick object.
[in]start_page_addrStart page address.
[in]end_page_addrEnd page address.
Returns
Nothing.

◆ oledb_scroll_diag_right()

void oledb_scroll_diag_right ( oledb_t ctx,
oledb_data_t  start_page_addr,
oledb_data_t  end_page_addr 
)

Scroll Diagonally Right function.

This function scrolls the display diagonally to the right.

Parameters
[in]ctxClick object.
[in]start_page_addrStart page address.
[in]end_page_addrEnd page address.
Returns
Nothing.

◆ oledb_scroll_left()

void oledb_scroll_left ( oledb_t ctx,
oledb_data_t  start_page_addr,
oledb_data_t  end_page_addr 
)

Scroll Left function.

This function scrolls the display to the left.

Parameters
[in]ctxClick object.
[in]start_page_addrStart page address.
[in]end_page_addrEnd page address.
Returns
Nothing.

◆ oledb_scroll_right()

void oledb_scroll_right ( oledb_t ctx,
oledb_data_t  start_page_addr,
oledb_data_t  end_page_addr 
)

Scroll Right function.

This function scrolls the display to the right.

Parameters
[in]ctxClick object.
[in]start_page_addrStart page address.
[in]end_page_addrEnd page address.
Returns
Nothing.

◆ oledb_send()

err_t oledb_send ( oledb_t ctx,
oledb_data_t  tx_data,
oledb_data_mode_t  data_mode 
)

Send function.

This function sends commands or data to OLED B click.

Parameters
[in]ctxClick object.
[in]tx_dataData to be sent.
[in]data_mode0x3C - Command, 0x3D - Data.
Returns
0x00 - Ok, 0xFE - Invalid data mode.

◆ oledb_set_column()

void oledb_set_column ( oledb_t ctx,
oledb_data_t  col_addr 
)

Column Setting function.

This function sets column address for page addressing mode.

Parameters
[in]ctxClick object.
[in]col_addrColumn address.
Returns
Nothing.

◆ oledb_set_contrast()

void oledb_set_contrast ( oledb_t ctx,
oledb_data_t  value 
)

Contrast Setting function.

This function sets the display contrast level (0 to 255).

Parameters
[in]ctxClick object.
[in]valueContrast value to be set.
Returns
Nothing.

◆ oledb_set_page()

void oledb_set_page ( oledb_t ctx,
oledb_data_t  page_addr 
)

Page Setting function.

This function sets page address for page addressing mode.

Parameters
[in]ctxClick object.
[in]page_addrPage address.
Returns
Nothing.

◆ oledb_stop_scroll()

void oledb_stop_scroll ( oledb_t ctx)

Stop Scrolling function.

This function allows user to stop the scrolling motion.

Parameters
[in]ctxClick object.
Returns
Nothing.