Public function

Functions
void	oledswitch_cfg_setup (oledswitch_cfg_t *cfg)
	Config Object Initialization function.
OLEDSWITCH_RETVAL	oledswitch_init (oledswitch_t *ctx, oledswitch_cfg_t *cfg)
	Initialization function.
void	oledswitch_default_cfg (oledswitch_t *ctx, uint8_t buffer_size)
	Click Default Configuration function.
void	oledswitch_reg_write (oledswitch_t *ctx, uint8_t *write_buf, uint8_t len)
	Register write function.
void	oledswitch_draw_image (oledswitch_t *ctx, const uint8_t *image_buf, uint16_t image_size)
	Register write function.
void	oledswitch_set_contrast (oledswitch_t *ctx)
	Set contrast function.
void	oledswitch_set_master_current (oledswitch_t *ctx)
	Set master current function.
void	oledswitch_set_remap_color_depth (oledswitch_t *ctx)
	Set remap color depth function.
void	oledswitch_set_display_start_line (oledswitch_t *ctx)
	Set display start line function.
void	oledswitch_set_display_offset (oledswitch_t *ctx)
	Set display offset function.
void	oledswitch_set_normal_display (oledswitch_t *ctx)
	Set normal display function.
void	oledswitch_set_multiplex_ratio (oledswitch_t *ctx)
	Set multiplex ratio function.
void	oledswitch_set_dim_mode (oledswitch_t *ctx)
	Set dim mode function.
void	oledswitch_set_master_config (oledswitch_t *ctx)
	Set master config function.
void	oledswitch_set_power_save_mode (oledswitch_t *ctx)
	Set power save mode function.
void	oledswitch_set_phase_period_adjustment (oledswitch_t *ctx)
	Set phase period adjustment function.
void	oledswitch_display_clock_divider_oscillator_frequency (oledswitch_t *ctx)
	Display clock divider oscillator frequency function.
void	oledswitch_enable_linear_gray_scale (oledswitch_t *ctx)
	Enable linear gray scale function.
void	oledswitch_pre_charge_level (oledswitch_t *ctx)
	Set pre-charge level function.
void	oledswitch_set_vcomh (oledswitch_t *ctx)
	Set vcomh function.
void	oledswitch_display_normal_mode (oledswitch_t *ctx)
	Display normal mode function.
void	oledswitch_set_row_range (oledswitch_t *ctx, uint8_t start, uint8_t end)
	Set row range function.
void	oledswitch_set_column_range (oledswitch_t *ctx, uint8_t start, uint8_t end)
	Set column range function.
void	oledswitch_clear_window (oledswitch_t *ctx)
	Clear window function.
void	oledswitch_deactivate_scrolling (oledswitch_t *ctx)
	Deactivate scrolling function.
void	oledswitch_activate_scrolling (oledswitch_t *ctx)
	Activate scrolling function.
void	oledswitch_demo_scrolling_setup (oledswitch_t *ctx)
	Demo scroling setup function.
void	oledswitch_software_reset (oledswitch_t *ctx)
	Software reset function.
void	oledswitch_digital_write_pwm (oledswitch_t *ctx, uint8_t signal)
	Digital write pwm function.
void	oledswitch_digital_write_rst (oledswitch_t *ctx, uint8_t signal)
	Digital write reset function.

Detailed Description

Function Documentation

oledswitch_activate_scrolling()

void oledswitch_activate_scrolling

(

oledswitch_t *

ctx

)

Activate scrolling function.

Parameters

ctx	Click object.

@description This function writes the activate scrolling command to the chip.

oledswitch_cfg_setup()

void oledswitch_cfg_setup

(

oledswitch_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

@description This function initializes click configuration structure to init state.

Note

All used pins will be set to unconnected state.

oledswitch_clear_window()

void oledswitch_clear_window

(

oledswitch_t *

ctx

)

Clear window function.

Parameters

ctx	Click object.

@description This function writes the clear display command and sends row and column data to the chip.

oledswitch_deactivate_scrolling()

void oledswitch_deactivate_scrolling

(

oledswitch_t *

ctx

)

Deactivate scrolling function.

Parameters

ctx	Click object.

@description This function writes the deactivate scrolling command to the chip.

oledswitch_default_cfg()

void oledswitch_default_cfg	(	oledswitch_t *	ctx,
		uint8_t	buffer_size )

Click Default Configuration function.

Parameters

ctx	Click object.

@description This function executes default configuration for OLED Switch click.

oledswitch_demo_scrolling_setup()

void oledswitch_demo_scrolling_setup

(

oledswitch_t *

ctx

)

Demo scroling setup function.

Parameters

ctx	Click object.

@description This function writes the scrolling setup configuration to the chip.

oledswitch_digital_write_pwm()

void oledswitch_digital_write_pwm	(	oledswitch_t *	ctx,
		uint8_t	signal )

Digital write pwm function.

Parameters

ctx	Click object.

@description This function sets the digital output signal for the PWM pin.

oledswitch_digital_write_rst()

void oledswitch_digital_write_rst	(	oledswitch_t *	ctx,
		uint8_t	signal )

Digital write reset function.

Parameters

ctx	Click object.

@description This function sets the digital output signal for the RST pin.

oledswitch_display_clock_divider_oscillator_frequency()

void oledswitch_display_clock_divider_oscillator_frequency

(

oledswitch_t *

ctx

)

Display clock divider oscillator frequency function.

Parameters

ctx	Click object.

@description This function writes display clock divider oscillator frequency configuration data to the chip.

oledswitch_display_normal_mode()

void oledswitch_display_normal_mode

(

oledswitch_t *

ctx

)

Display normal mode function.

Parameters

ctx	Click object.

@description This function writes display mode configuration data to the chip.

oledswitch_draw_image()

void oledswitch_draw_image	(	oledswitch_t *	ctx,
		const uint8_t *	image_buf,
		uint16_t	image_size )

Register write function.

Parameters

ctx	Click object.
image_buf	Pointer to a image array that will be displayed.
image_size	Number of bytes in the image array.

@description This function writes image data to the chip, which displays it in real time.

oledswitch_enable_linear_gray_scale()

void oledswitch_enable_linear_gray_scale

(

oledswitch_t *

ctx

)

Enable linear gray scale function.

Parameters

ctx	Click object.

@description This function writes linear gray scale configuration data to the chip.

oledswitch_init()

OLEDSWITCH_RETVAL oledswitch_init	(	oledswitch_t *	ctx,
		oledswitch_cfg_t *	cfg )

Initialization function.

Parameters

oledswitch	Click object.
cfg	Click configuration structure.

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

oledswitch_pre_charge_level()

void oledswitch_pre_charge_level

(

oledswitch_t *

ctx

)

Set pre-charge level function.

Parameters

ctx	Click object.

@description This function writes pre-charge level configuration data to the chip.

oledswitch_reg_write()

void oledswitch_reg_write	(	oledswitch_t *	ctx,
		uint8_t *	write_buf,
		uint8_t	len )

Register write function.

Parameters

ctx	Click object.
write_buf	Pointer to a data array that will be written.
len	Number of bytes in the data array.

@description This function writes to control and configuration registers on the chip.

oledswitch_set_column_range()

void oledswitch_set_column_range	(	oledswitch_t *	ctx,
		uint8_t	start,
		uint8_t	end )

Set column range function.

Parameters

ctx	Click object.
start	Start pixel position value.
end	End pixel position value.

@description This function sets the column range for the display.

oledswitch_set_contrast()

void oledswitch_set_contrast

(

oledswitch_t *

ctx

)

Set contrast function.

Parameters

ctx	Click object.

@description This function writes contrast configuration data to the chip.

oledswitch_set_dim_mode()

void oledswitch_set_dim_mode

(

oledswitch_t *

ctx

)

Set dim mode function.

Parameters

ctx	Click object.

@description This function writes dim mode configuration data to the chip.

oledswitch_set_display_offset()

void oledswitch_set_display_offset

(

oledswitch_t *

ctx

)

Set display offset function.

Parameters

ctx	Click object.

@description This function writes display offset configuration data to the chip.

oledswitch_set_display_start_line()

void oledswitch_set_display_start_line

(

oledswitch_t *

ctx

)

Set display start line function.

Parameters

ctx	Click object.

@description This function writes display start line configuration data to the chip.

oledswitch_set_master_config()

void oledswitch_set_master_config

(

oledswitch_t *

ctx

)

Set master config function.

Parameters

ctx	Click object.

@description This function writes master configuration data to the chip.

oledswitch_set_master_current()

void oledswitch_set_master_current

(

oledswitch_t *

ctx

)

Set master current function.

Parameters

ctx	Click object.

@description This function writes master current configuration data to the chip.

oledswitch_set_multiplex_ratio()

void oledswitch_set_multiplex_ratio

(

oledswitch_t *

ctx

)

Set multiplex ratio function.

Parameters

ctx	Click object.

@description This function writes multiplex ratio configuration data to the chip.

oledswitch_set_normal_display()

void oledswitch_set_normal_display

(

oledswitch_t *

ctx

)

Set normal display function.

Parameters

ctx	Click object.

@description This function writes normal display configuration data to the chip.

oledswitch_set_phase_period_adjustment()

void oledswitch_set_phase_period_adjustment

(

oledswitch_t *

ctx

)

Set phase period adjustment function.

Parameters

ctx	Click object.

@description This function writes phase period adjustment configuration data to the chip.

oledswitch_set_power_save_mode()

void oledswitch_set_power_save_mode

(

oledswitch_t *

ctx

)

Set power save mode function.

Parameters

ctx	Click object.

@description This function writes power save mode configuration data to the chip.

oledswitch_set_remap_color_depth()

void oledswitch_set_remap_color_depth

(

oledswitch_t *

ctx

)

Set remap color depth function.

Parameters

ctx	Click object.

@description This function writes remap color depth configuration data to the chip.

oledswitch_set_row_range()

void oledswitch_set_row_range	(	oledswitch_t *	ctx,
		uint8_t	start,
		uint8_t	end )

Set row range function.

Parameters

ctx	Click object.
start	Start pixel position value.
end	End pixel position value.

@description This function sets the row range for the display.

oledswitch_set_vcomh()

void oledswitch_set_vcomh

(

oledswitch_t *

ctx

)

Set vcomh function.

Parameters

ctx	Click object.

@description This function writes vcomh configuration data to the chip.

oledswitch_software_reset()

void oledswitch_software_reset

(

oledswitch_t *

ctx

)

Software reset function.

Parameters

ctx	Click object.

@description This function does a software reset of the click module.