Public function

Functions
void	c4dotmatrixr_cfg_setup (c4dotmatrixr_cfg_t *cfg)
	Config Object Initialization function.
C4DOTMATRIXR_RETVAL	c4dotmatrixr_init (c4dotmatrixr_t *ctx, c4dotmatrixr_cfg_t *cfg)
	Initialization function.
void	c4dotmatrixr_default_cfg (c4dotmatrixr_t *ctx)
	Click Default Configuration function.
void	c4dotmatrixr_generic_write (c4dotmatrixr_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic write function.
void	c4dotmatrixr_generic_read (c4dotmatrixr_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic read function.
void	c4dot_write_char (c4dotmatrixr_t *ctx, uint8_t char_num, uint8_t char_value)
	4DotMatrix Char Write.
void	c4dot_write_char0 (c4dotmatrixr_t *ctx, uint8_t char_value)
	4DotMatrix Char 0 Write.
void	c4dot_write_char1 (c4dotmatrixr_t *ctx, uint8_t char_value)
	4DotMatrix Char 1 Write.
void	c4dot_write_char2 (c4dotmatrixr_t *ctx, uint8_t char_value)
	4DotMatrix Char 2 Write.
void	c4dot_write_char3 (c4dotmatrixr_t *ctx, uint8_t char_value)
	4DotMatrix Char 3 Write.
void	c4dot_write_text (c4dotmatrixr_t *ctx, uint8_t *text_to_write)
	4DotMatrix Text Write.
void	c4dot_write_int (c4dotmatrixr_t *ctx, int16_t int_to_write, uint8_t int_base)
	4DotMatrix Int Write.
void	c4dot_write_int_bin (c4dotmatrixr_t *ctx, int16_t int_to_write)
	4DotMatrix Binary Int Write.
void	c4dot_write_int_oct (c4dotmatrixr_t *ctx, int16_t int_to_write)
	4DotMatrix Octal Int Write.
void	c4dot_write_int_dec (c4dotmatrixr_t *ctx, int16_t int_to_write)
	4DotMatrix Decimal Int Write.
void	c4dot_write_int_hex (c4dotmatrixr_t *ctx, int16_t int_to_write)
	4DotMatrix Hexadecimal Int Write.
void	c4dot_clear_display (c4dotmatrixr_t *ctx)
	4DotMatrix Display Clear.

Detailed Description

Function Documentation

c4dot_clear_display()

void c4dot_clear_display

(

c4dotmatrixr_t *

ctx

)

4DotMatrix Display Clear.

Parameters

ctx	Click object.

@description This function clears all four display characters.

c4dot_write_char()

void c4dot_write_char	(	c4dotmatrixr_t *	ctx,
		uint8_t	char_num,
		uint8_t	char_value )

4DotMatrix Char Write.

Parameters

ctx	Click object.
char_num	Number of char to write.
char_value	Value to write to char.

Writes charValue to the character on the position of charNum. 0 is the rightmost character, and 3 is the leftmost one. Character value can go from 0 to 127. Values in the range from 32 to 126 represent the corresponding ASCII characters. Refer to the OSRAM SLx2016 datasheet for a complete list of character values that can be written.

@description This function will do nothing in case of bad charNum or charValue.

c4dot_write_char0()

void c4dot_write_char0	(	c4dotmatrixr_t *	ctx,
		uint8_t	char_value )

4DotMatrix Char 0 Write.

Parameters

ctx	Click object.
char_value	Value to write to char.

Writes charValue to character 0, the rightmost character. Character value can go from 0 to 127. Values in the range from 32 to 126 represent the corresponding ASCII characters. Refer to the OSRAM SLx2016 datasheet for a complete list of character values that can be written.

@description This function will do nothing in case of bad charValue.

c4dot_write_char1()

void c4dot_write_char1	(	c4dotmatrixr_t *	ctx,
		uint8_t	char_value )

4DotMatrix Char 1 Write.

Parameters

ctx	Click object.
char_value	Value to write to char.

Writes charValue to character 0, the rightmost character. Character value can go from 0 to 127. Values in the range from 32 to 126 represent the corresponding ASCII characters. Refer to the OSRAM SLx2016 datasheet for a complete list of character values that can be written.

@description This function will do nothing in case of bad charValue.

c4dot_write_char2()

void c4dot_write_char2	(	c4dotmatrixr_t *	ctx,
		uint8_t	char_value )

4DotMatrix Char 2 Write.

Parameters

ctx	Click object.
char_value	Value to write to char.

Writes charValue to character 0, the rightmost character. Character value can go from 0 to 127. Values in the range from 32 to 126 represent the corresponding ASCII characters. Refer to the OSRAM SLx2016 datasheet for a complete list of character values that can be written.

@description This function will do nothing in case of bad charValue.

c4dot_write_char3()

void c4dot_write_char3	(	c4dotmatrixr_t *	ctx,
		uint8_t	char_value )

4DotMatrix Char 3 Write.

Parameters

ctx	Click object.
char_value	Value to write to char.

Writes charValue to character 0, the rightmost character. Character value can go from 0 to 127. Values in the range from 32 to 126 represent the corresponding ASCII characters. Refer to the OSRAM SLx2016 datasheet for a complete list of character values that can be written.

@description This function will do nothing in case of bad charValue.

c4dot_write_int()

void c4dot_write_int	(	c4dotmatrixr_t *	ctx,
		int16_t	int_to_write,
		uint8_t	int_base )

4DotMatrix Int Write.

Parameters

ctx	Click object.
int_to_write	Integer to write to character display.
int_base	Numeral system base.

@description This function Writes up to four characters from textToWrite to the display characters.

c4dot_write_int_bin()

void c4dot_write_int_bin	(	c4dotmatrixr_t *	ctx,
		int16_t	int_to_write )

4DotMatrix Binary Int Write.

Parameters

ctx	Click object.
int_to_write	Integer to write to character display.

Writes intToWrite as a binary integer to the character display. Obviously, only the lowest four digits will be shown. If the given number is negative, '-' will be shown if there is space left.

c4dot_write_int_dec()

void c4dot_write_int_dec	(	c4dotmatrixr_t *	ctx,
		int16_t	int_to_write )

4DotMatrix Decimal Int Write.

Parameters

ctx	Click object.
int_to_write	Integer to write to character display.

Writes intToWrite as a binary integer to the character display. Obviously, only the lowest four digits will be shown. If the given number is negative, '-' will be shown if there is space left.

c4dot_write_int_hex()

void c4dot_write_int_hex	(	c4dotmatrixr_t *	ctx,
		int16_t	int_to_write )

4DotMatrix Hexadecimal Int Write.

Parameters

ctx	Click object.
int_to_write	Integer to write to character display.

Writes intToWrite as a binary integer to the character display. Obviously, only the lowest four digits will be shown. If the given number is negative, '-' will be shown if there is space left.

c4dot_write_int_oct()

void c4dot_write_int_oct	(	c4dotmatrixr_t *	ctx,
		int16_t	int_to_write )

4DotMatrix Octal Int Write.

Parameters

ctx	Click object.
int_to_write	Integer to write to character display.

Writes intToWrite as a binary integer to the character display. Obviously, only the lowest four digits will be shown. If the given number is negative, '-' will be shown if there is space left.

c4dot_write_text()

void c4dot_write_text	(	c4dotmatrixr_t *	ctx,
		uint8_t *	text_to_write )

4DotMatrix Text Write.

Parameters

ctx	Click object.
text_to_write	Text to write to character display.

@description This function Writes up to four characters from textToWrite to the display characters.

c4dotmatrixr_cfg_setup()

void c4dotmatrixr_cfg_setup

(

c4dotmatrixr_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.

c4dotmatrixr_default_cfg()

void c4dotmatrixr_default_cfg

(

c4dotmatrixr_t *

ctx

)

Click Default Configuration function.

Parameters

ctx	Click object.

@description This function executes default configuration for c4dotmatrixr click.

c4dotmatrixr_generic_read()

void c4dotmatrixr_generic_read	(	c4dotmatrixr_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic read function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Output data buf
len	Number of the bytes to be read

@description This function reads data from the desired register.

c4dotmatrixr_generic_write()

void c4dotmatrixr_generic_write	(	c4dotmatrixr_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic write function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Data buf to be written.
len	Number of the bytes in data buf.

@description This function writes data to the desired register.

c4dotmatrixr_init()

C4DOTMATRIXR_RETVAL c4dotmatrixr_init	(	c4dotmatrixr_t *	ctx,
		c4dotmatrixr_cfg_t *	cfg )

Initialization function.

Parameters

c4dotmatrixr	Click object.
cfg	Click configuration structure.

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