Public Function

Functions
void	oledw_cfg_setup (oledw_cfg_t *cfg)
	Configuration Object Setup function.
err_t	oledw_init (oledw_t *ctx, oledw_cfg_t *cfg)
	Click Initialization function.
err_t	oledw_send (oledw_t *ctx, oledw_data_t tx_data, oledw_data_mode_t data_mode)
	Send function.
void	oledw_default_cfg (oledw_t *ctx)
	Click Default Configuration function.
void	oledw_set_page (oledw_t *ctx, oledw_data_t page_addr)
	Page Setting function.
void	oledw_set_column (oledw_t *ctx, oledw_data_t col_addr)
	Column Setting function.
void	oledw_display_picture (oledw_t *ctx, oledw_resources_t *pic)
	Display Picture function.
void	oledw_set_contrast (oledw_t *ctx, oledw_data_t value)
	Contrast Setting function.
void	oledw_scroll_right (oledw_t *ctx, oledw_data_t start_page_addr, oledw_data_t end_page_addr)
	Scroll Right function.
void	oledw_scroll_left (oledw_t *ctx, oledw_data_t start_page_addr, oledw_data_t end_page_addr)
	Scroll Left function.
void	oledw_scroll_diag_right (oledw_t *ctx, oledw_data_t start_page_addr, oledw_data_t end_page_addr)
	Scroll Diagonally Right function.
void	oledw_scroll_diag_left (oledw_t *ctx, oledw_data_t start_page_addr, oledw_data_t end_page_addr)
	Scroll Diagonally Left function.
void	oledw_stop_scroll (oledw_t *ctx)
	Stop Scrolling function.

Detailed Description

Function Documentation

oledw_cfg_setup()

void oledw_cfg_setup

(

oledw_cfg_t *

cfg

)

Configuration Object Setup function.

This function initializes click configuration structure to initial state.

Parameters

[in]

cfg

Click configuration structure.

Returns

Nothing.

Note

All used pins will be initialized to unconnected state. SPI driver will be activated as default driver.

oledw_default_cfg()

void oledw_default_cfg

(

oledw_t *

ctx

)

Click Default Configuration function.

This function configures OLED W click to default state.

Parameters

[in]

ctx

Click object.

Returns

Nothing.

oledw_display_picture()

void oledw_display_picture	(	oledw_t *	ctx,
		oledw_resources_t *	pic )

Display Picture function.

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

Parameters

[in]	ctx	Click object.
[in]	pic	Resource code.

Returns

Nothing.

oledw_init()

err_t oledw_init	(	oledw_t *	ctx,
		oledw_cfg_t *	cfg )

Click Initialization function.

Parameters

[in]	ctx	Click object.
[in]	cfg	Click configuration structure.

Returns

0x00 - Ok, 0xFF - Init error, 0xFD - Invalid driver selector.

This function initializes all necessary peripherals and pins.

oledw_scroll_diag_left()

void oledw_scroll_diag_left	(	oledw_t *	ctx,
		oledw_data_t	start_page_addr,
		oledw_data_t	end_page_addr )

Scroll Diagonally Left function.

This function scrolls the display diagonally to the left.

Parameters

[in]	ctx	Click object.
[in]	start_page_addr	Start page address.
[in]	end_page_addr	End page address.

Returns

Nothing.

oledw_scroll_diag_right()

void oledw_scroll_diag_right	(	oledw_t *	ctx,
		oledw_data_t	start_page_addr,
		oledw_data_t	end_page_addr )

Scroll Diagonally Right function.

This function scrolls the display diagonally to the right.

Parameters

[in]	ctx	Click object.
[in]	start_page_addr	Start page address.
[in]	end_page_addr	End page address.

Returns

Nothing.

oledw_scroll_left()

void oledw_scroll_left	(	oledw_t *	ctx,
		oledw_data_t	start_page_addr,
		oledw_data_t	end_page_addr )

Scroll Left function.

This function scrolls the display to the left.

Parameters

[in]	ctx	Click object.
[in]	start_page_addr	Start page address.
[in]	end_page_addr	End page address.

Returns

Nothing.

oledw_scroll_right()

void oledw_scroll_right	(	oledw_t *	ctx,
		oledw_data_t	start_page_addr,
		oledw_data_t	end_page_addr )

Scroll Right function.

This function scrolls the display to the right.

Parameters

[in]	ctx	Click object.
[in]	start_page_addr	Start page address.
[in]	end_page_addr	End page address.

Returns

Nothing.

oledw_send()

err_t oledw_send	(	oledw_t *	ctx,
		oledw_data_t	tx_data,
		oledw_data_mode_t	data_mode )

Send function.

This function sends commands or data to OLED W click.

Parameters

[in]	ctx	Click object.
[in]	tx_data	Data to be sent.
[in]	data_mode	0x3C - Command, 0x3D - Data.

Returns

0x00 - Ok, 0xFE - Invalid data mode.

oledw_set_column()

void oledw_set_column	(	oledw_t *	ctx,
		oledw_data_t	col_addr )

Column Setting function.

This function sets column address for page addressing mode.

Parameters

[in]	ctx	Click object.
[in]	col_addr	Column address.

Returns

Nothing.

oledw_set_contrast()

void oledw_set_contrast	(	oledw_t *	ctx,
		oledw_data_t	value )

Contrast Setting function.

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

Parameters

[in]	ctx	Click object.
[in]	value	Contrast value to be set.

Returns

Nothing.

oledw_set_page()

void oledw_set_page	(	oledw_t *	ctx,
		oledw_data_t	page_addr )

Page Setting function.

This function sets page address for page addressing mode.

Parameters

[in]	ctx	Click object.
[in]	page_addr	Page address.

Returns

Nothing.

oledw_stop_scroll()

void oledw_stop_scroll

(

oledw_t *

ctx

)

Stop Scrolling function.

This function allows user to stop the scrolling motion.

Parameters

[in]

ctx

Click object.

Returns

Nothing.