#include <LCD.hh>

Inheritance diagram for LCD::Device:

Collaboration diagram for LCD::Device:

Public Types
enum	TextMode { NORMAL_TEXT_MODE = 0x00, INVERTED_TEXT_MODE = 0xff }

Public Member Functions
	Device ()

virtual bool	begin ()=0

virtual bool	end ()=0

virtual void	backlight_on ()

virtual void	backlight_off ()

virtual void	display_contrast (uint8_t level)

virtual void	display_on ()=0

virtual void	display_off ()=0

virtual void	display_normal ()

virtual void	display_inverse ()

virtual void	display_clear ()=0

void	get_cursor (uint8_t &x, uint8_t &y) const

virtual void	set_cursor (uint8_t x, uint8_t y)=0

uint8_t	get_tab_step () const

void	set_tab_step (uint8_t step)

TextMode	text_mode (TextMode mode)

void	non_blocking ()

void	blocking ()

bool	is_blocking () const

void	eol (Mode mode)

Mode	eol () const

virtual int	available ()

virtual int	room ()

virtual int	putchar (char c)

virtual int	puts (const char *s)

virtual int	puts (str_P s)

virtual int	write (const void *buf, size_t size)

virtual int	write (const iovec_t *vec)

virtual int	write_P (const void *buf, size_t size)

virtual int	peekchar ()

virtual int	peekchar (char c)

virtual int	getchar ()

virtual char *	gets (char *s, size_t count)

virtual int	read (void *buf, size_t size)

virtual int	read (iovec_t *vec)

virtual int	flush ()

virtual void	empty ()

Protected Attributes
uint8_t	m_x
	Cursor position x. More...

uint8_t	m_y
	Cursor position y. More...

uint8_t	m_tab
	Tab step. More...

uint8_t	m_mode
	Text mode. More...

bool	m_blocking

Mode	m_eol

Detailed Description

LCD device driver interface. LCD delegates to device driver.

Definition at line 42 of file LCD.hh.

Member Enumeration Documentation

enum LCD::Device::TextMode

Text display mode.

Enumerator
NORMAL_TEXT_MODE
INVERTED_TEXT_MODE

Definition at line 45 of file LCD.hh.

Constructor & Destructor Documentation

LCD::Device::Device ( )

inline

Initate LCD device driver.

Definition at line 53 of file LCD.hh.

Member Function Documentation

int IOStream::Device::available ( )

virtualinherited

Number of bytes available (possible to read).

Returns: bytes.

Reimplemented in W5200::Driver, W5500::Driver, W5100::Driver, Soft::UART, UART, IOBuffer< SIZE >, and CC3000::Driver.

Definition at line 24 of file IOStream_Device.cpp.

virtual void LCD::Device::backlight_off ( )

inlinevirtual

Turn display backlight off.

Reimplemented in HD44780, and VLCD.

Definition at line 86 of file LCD.hh.

virtual void LCD::Device::backlight_on ( )

inlinevirtual

Turn display backlight on.

Reimplemented in HD44780, and VLCD.

Definition at line 80 of file LCD.hh.

virtual bool LCD::Device::begin ( )

pure virtual

Start display for text output. Returns true if successful otherwise false.

Returns: boolean.

Implemented in HD44780, ST7565, PCD8544, MAX72XX, and VLCD.

void IOStream::Device::blocking ( )

inlineinherited

Set blocking mode.

Definition at line 85 of file IOStream.hh.

virtual void LCD::Device::display_clear ( )

pure virtual

Clear display and move cursor to home.

Implemented in HD44780, ST7565, PCD8544, MAX72XX, and VLCD.

virtual void LCD::Device::display_contrast ( uint8_t level )

inlinevirtual

Set display contrast level.

Parameters

[in] level to set.

Reimplemented in ST7565, PCD8544, and MAX72XX.

Definition at line 93 of file LCD.hh.

virtual void LCD::Device::display_inverse ( )

inlinevirtual

Display inverse mode.

Reimplemented in ST7565, and PCD8544.

Definition at line 120 of file LCD.hh.

virtual void LCD::Device::display_normal ( )

inlinevirtual

Display normal mode.

Reimplemented in ST7565, and PCD8544.

Definition at line 114 of file LCD.hh.

virtual void LCD::Device::display_off ( )

pure virtual

Turn display off.

Implemented in HD44780, ST7565, PCD8544, MAX72XX, and VLCD.

virtual void LCD::Device::display_on ( )

pure virtual

Turn display on.

Implemented in HD44780, ST7565, PCD8544, MAX72XX, and VLCD.

void IOStream::Device::empty ( )

virtualinherited

Empty internal device buffers.

Reimplemented in Soft::UART, UART, and IOBuffer< SIZE >.

Definition at line 175 of file IOStream_Device.cpp.

virtual bool LCD::Device::end ( )

pure virtual

Stop display and power down. Returns true if successful otherwise false.

Implemented in HD44780, ST7565, PCD8544, MAX72XX, and VLCD.

void IOStream::Device::eol ( Mode mode )

inlineinherited

Set end of line mode.

Parameters

[in] mode for end of line.

Definition at line 103 of file IOStream.hh.

Mode IOStream::Device::eol ( ) const

inlineinherited

Get end of line mode.

Returns: mode.

Definition at line 112 of file IOStream.hh.

int IOStream::Device::flush ( )

virtualinherited

Flush internal device buffers. Wait for device to become idle.

Returns: zero(0) or negative error code.

Reimplemented in W5200::Driver, W5500::Driver, W5100::Driver, UART, IOBuffer< SIZE >, CC3000::Driver, and WIO.

Definition at line 169 of file IOStream_Device.cpp.

void LCD::Device::get_cursor	(	uint8_t &	x,
		uint8_t &	y
	)		const

inline

Get current cursor position.

Parameters

[out]	x.
[out]	y.

Definition at line 133 of file LCD.hh.

uint8_t LCD::Device::get_tab_step ( ) const

inline

Get tab step.

Returns: tab step.

Definition at line 152 of file LCD.hh.

int IOStream::Device::getchar ( )

virtualinherited

Read character from device.

Returns: character or EOF(-1).

Reimplemented in FAT16::File, CFFS::File, Soft::UART, UART, IOBuffer< SIZE >, and Socket.

Definition at line 112 of file IOStream_Device.cpp.

char * IOStream::Device::gets	(	char *	s,
		size_t	count
	)

virtualinherited

Read string terminated by new-line or until size into given string buffer. Returns pointer to string or NULL if empty line.

Parameters

[in]	s	string buffer to read into.
[in]	count	max number of bytes to read.

Returns: string pointer or NULL.

Definition at line 118 of file IOStream_Device.cpp.

bool IOStream::Device::is_blocking ( ) const

inlineinherited

Is blocking mode?

Returns: bool.

Definition at line 94 of file IOStream.hh.

void IOStream::Device::non_blocking ( )

inlineinherited

Set non-blocking mode.

Definition at line 77 of file IOStream.hh.

int IOStream::Device::peekchar ( )

virtualinherited

Peek at the next character from device.

Returns: character or EOF(-1).

Reimplemented in Soft::UART, UART, and IOBuffer< SIZE >.

Definition at line 99 of file IOStream_Device.cpp.

int IOStream::Device::peekchar ( char c )

virtualinherited

Peek for the given character in device buffer. Return number of characters or EOF(-1).

Parameters

[in] c character to peek for.

Returns: available or EOF(-1).

Reimplemented in Soft::UART, UART, and IOBuffer< SIZE >.

Definition at line 105 of file IOStream_Device.cpp.

int IOStream::Device::putchar ( char c )

virtualinherited

Write character to device.

Parameters

[in] c character to write.

Returns: character written or EOF(-1).

Reimplemented in FAT16::File, HD44780, ST7565, PCD8544, MAX72XX, VLCD, UART, Textbox, IOBuffer< SIZE >, RS485, WIO, and Soft::UAT.

Definition at line 36 of file IOStream_Device.cpp.

int IOStream::Device::puts ( const char * s )

virtualinherited

Write null terminated string to device. Terminating null is not written.

Parameters

[in] s string to write.

Returns: zero(0) or negative error code.

Definition at line 43 of file IOStream_Device.cpp.

int IOStream::Device::puts ( str_P s )

virtualinherited

Write null terminated string from program memory to device. Terminating null is not written.

Parameters

[in] s string in program memory to write.

Returns: zero(0) or negative error code.

Definition at line 54 of file IOStream_Device.cpp.

int IOStream::Device::read	(	void *	buf,
		size_t	size
	)

virtualinherited

Read data to given buffer with given size from device.

Parameters

[in]	buf	buffer to read into.
[in]	size	number of bytes to read.

Returns: number of bytes read or EOF(-1).

Reimplemented in FAT16::File, W5200::Driver, W5500::Driver, W5100::Driver, CFFS::File, Socket, and CC3000::Driver.

Definition at line 144 of file IOStream_Device.cpp.

int IOStream::Device::read ( iovec_t * vec )

virtualinherited

Read data to given buffers in null terminated io vector.

Parameters

[in] vec io vector with buffers to read into.

Returns: number of bytes read or EOF(-1).

Definition at line 157 of file IOStream_Device.cpp.

int IOStream::Device::room ( )

virtualinherited

Number of bytes room (write without blocking).

Returns: bytes.

Reimplemented in W5200::Driver, W5500::Driver, W5100::Driver, UART, IOBuffer< SIZE >, CC3000::Driver, and WIO.

Definition at line 30 of file IOStream_Device.cpp.

virtual void LCD::Device::set_cursor	(	uint8_t	x,
		uint8_t	y
	)

pure virtual

Set cursor position to given position.

Parameters

[in]	x.
[in]	y.

Implemented in HD44780, ST7565, PCD8544, MAX72XX, and VLCD.

void LCD::Device::set_tab_step ( uint8_t step )

inline

Set tab step to given value.

Parameters

[in] step tab.

Definition at line 161 of file LCD.hh.

TextMode LCD::Device::text_mode ( TextMode mode )

inline

Set text mode. Return previous text mode.

Parameters

[in] mode new text mode.

Returns: previous text mode.

Definition at line 171 of file LCD.hh.

int IOStream::Device::write	(	const void *	buf,
		size_t	size
	)

virtualinherited

Write data from buffer with given size to device.

Parameters

[in]	buf	buffer to write.
[in]	size	number of bytes to write.

Returns: number of bytes written or EOF(-1).

Reimplemented in FAT16::File, HD44780, CFFS::File, VLCD, Socket, and CC3000::Driver.

Definition at line 65 of file IOStream_Device.cpp.

int IOStream::Device::write ( const iovec_t * vec )

virtualinherited

Write data from buffers in null terminated io vector.

Parameters

[in] vec io vector with buffers to write.

Returns: number of bytes written or EOF(-1).

Definition at line 87 of file IOStream_Device.cpp.

int IOStream::Device::write_P	(	const void *	buf,
		size_t	size
	)

virtualinherited

Write data from buffer in program memory with given size to device.

Parameters

[in]	buf	buffer to write.
[in]	size	number of bytes to write.

Returns: number of bytes written or EOF(-1).

Reimplemented in CFFS::File, Socket, and CC3000::Driver.

Definition at line 76 of file IOStream_Device.cpp.

Member Data Documentation

bool IOStream::Device::m_blocking

protectedinherited

Blocking state

Definition at line 248 of file IOStream.hh.

Mode IOStream::Device::m_eol

protectedinherited

End of line mode

Definition at line 251 of file IOStream.hh.

uint8_t LCD::Device::m_mode

protected

Text mode.

Definition at line 183 of file LCD.hh.

uint8_t LCD::Device::m_tab

protected

Tab step.

Definition at line 182 of file LCD.hh.

uint8_t LCD::Device::m_x

protected

Cursor position x.

Definition at line 180 of file LCD.hh.

uint8_t LCD::Device::m_y

protected

Cursor position y.

Definition at line 181 of file LCD.hh.

The documentation for this class was generated from the following file:

cores/cosa/Cosa/LCD.hh

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation