8x8 Y Click Driver

API for configuring and manipulating 8x8 Y Click driver. More...

Topics
	8x8 Y Registers List
	List of registers of 8x8 Y Click driver.
	8x8 Y Registers Settings
	Settings for registers of 8x8 Y Click driver.
	8x8 Y MikroBUS Map
	MikroBUS pin mapping of 8x8 Y Click driver.
	C8x8y_scroll_speed
	8x8 Y description setting.

Functions
void	c8x8y_cfg_setup (c8x8y_cfg_t *cfg)
	8x8 Y configuration object setup function.
err_t	c8x8y_init (c8x8y_t *ctx, c8x8y_cfg_t *cfg)
	8x8 Y initialization function.
void	c8x8y_default_cfg (c8x8y_t *ctx)
	8x8 Y default configuration function.
void	c8x8y_write_cmd (c8x8y_t *ctx, uint8_t cmd, uint8_t tx_data)
	8x8 Y data writing function.
void	c8x8y_display_refresh (c8x8y_t *ctx)
	8x8 Y function for refresh display.
void	c8x8y_set_speed_scroll (c8x8y_t *ctx, uint8_t speed)
	8x8 Y scroll setting function.
void	c8x8y_display_string (c8x8y_t *ctx, char *p_array)
	8x8 Y function for displaying scrolling string.
void	c8x8y_display_byte (c8x8y_t *ctx, char tx_byte)
	8x8 Y function for displaying one character.
void	c8x8y_display_image (c8x8y_t *ctx, uint8_t *p_image)
	8x8 Y function for displaying image.

Detailed Description

API for configuring and manipulating 8x8 Y 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

c8x8y_cfg_setup()

void c8x8y_cfg_setup

(

c8x8y_cfg_t *

cfg

)

8x8 Y configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See c8x8y_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

c8x8y_default_cfg()

void c8x8y_default_cfg

(

c8x8y_t *

ctx

)

8x8 Y default configuration function.

This function executes a default configuration of 8x8 Y click board.

Parameters

[in]

ctx

: Click context object. See c8x8y_t object definition for detailed explanation.

Returns

Nothing.

Note

This function can consist any necessary configuration or setting to put device into operating mode.

c8x8y_display_byte()

void c8x8y_display_byte	(	c8x8y_t *	ctx,
		char	tx_byte )

8x8 Y function for displaying one character.

This function displayes one character to the display.

Parameters

[in]	ctx	: Click context object. See c8x8y_t object definition for detailed explanation.
[in]	tx_byte	: Character to be displayed.

Returns

Nothing.

Note

None.

c8x8y_display_image()

void c8x8y_display_image	(	c8x8y_t *	ctx,
		uint8_t *	p_image )

8x8 Y function for displaying image.

This function displayes image to the display.

Parameters

[in]	ctx	: Click context object. See c8x8y_t object definition for detailed explanation.
[in]	p_image	: Pointer to the image to be displayed.

Returns

Nothing.

Note

Function for displays the image. The image consists of eight elements (eight columns that build the image).

c8x8y_display_refresh()

void c8x8y_display_refresh

(

c8x8y_t *

ctx

)

8x8 Y function for refresh display.

The function switches off all LEDs.

Parameters

[in]

ctx

: Click context object. See c8x8y_t object definition for detailed explanation.

Returns

Nothing.

Note

None.

c8x8y_display_string()

void c8x8y_display_string	(	c8x8y_t *	ctx,
		char *	p_array )

8x8 Y function for displaying scrolling string.

This function displayes scrolling string to the display.

Parameters

[in]	ctx	: Click context object. See c8x8y_t object definition for detailed explanation.
[in]	p_array	: Pointer to the string to be displayed

Returns

Nothing.

Note

Function that displays scrolled string with set speed. If the speed is not set before calling the function, default scroll speed is 100ms per character.

c8x8y_init()

err_t c8x8y_init	(	c8x8y_t *	ctx,
		c8x8y_cfg_t *	cfg )

8x8 Y initialization function.

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

Parameters

[out]	ctx	: Click context object. See c8x8y_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See c8x8y_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

c8x8y_set_speed_scroll()

void c8x8y_set_speed_scroll	(	c8x8y_t *	ctx,
		uint8_t	speed )

8x8 Y scroll setting function.

This function sets the sroll speed.

Parameters

[in]	ctx	: Click context object. See c8x8y_t object definition for detailed explanation.
[in]	cmd	: The command to be executed.
[in]	speed	: Speed that will be set.

Returns

Nothing.

Note

Options: Fast speed (30ms per character), Medium speed (100ms per character) - default speed, Slow speed ( 200ms per character),

c8x8y_write_cmd()

void c8x8y_write_cmd	(	c8x8y_t *	ctx,
		uint8_t	cmd,
		uint8_t	tx_data )

8x8 Y data writing function.

This function writes a desired number of data bytes starting from the selected register by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See c8x8y_t object definition for detailed explanation.
[in]	cmd	: The command to be executed.
[in]	tx_data	: Data to be sent.

Returns

Nothing.

Note

None.