#include <PCD8544.hh>

Inheritance diagram for PCD8544:

Collaboration diagram for PCD8544:

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

Public Member Functions
	PCD8544 (LCD::IO io, Board::DigitalPin dc=Board::D8, Font font=&system5x7)

virtual bool	begin ()

virtual bool	end ()

virtual void	display_contrast (uint8_t level)

virtual void	display_on ()

virtual void	display_off ()

virtual void	display_normal ()

virtual void	display_inverse ()

virtual void	display_clear ()

virtual void	set_cursor (uint8_t x, uint8_t y)

Font *	get_text_font () const

Font *	set_text_font (Font *font)

void	draw_icon (const uint8_t *bp)

void	draw_bitmap (uint8_t *bp, uint8_t width, uint8_t height)

void	draw_bar (uint8_t percent, uint8_t width, uint8_t pattern=0x55)

virtual int	putchar (char c)

virtual void	backlight_on ()

virtual void	backlight_off ()

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

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	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 ()

Static Public Attributes
static const uint8_t	WIDTH = 84

static const uint8_t	HEIGHT = 48

static const uint8_t	LINES = HEIGHT / CHARBITS

Protected Types
enum	{ NOP = 0x00, SET_FUNC = 0x20, BASIC_INST = 0x00, EXTENDED_INST = 0x01, HORIZONTAL_ADDR = 0x00, VERTICAL_ADDR = 0x02, POWER_UP_MODE = 0x00, POWER_DOWN_MODE = 0x04, DISPLAY_CNTL = 0x08, DISPLAY_OFF = 0x00, DISPLAY_ON = 0x01, NORMAL_MODE = 0x04, INVERSE_MODE = 0x05, SET_Y_ADDR = 0x40, Y_ADDR_MASK = 0x07, SET_X_ADDR = 0x80, X_ADDR_MASK = 0x7f, SET_TEMP_COEFF = 0x04, SET_BIAS_SYS = 0x10, SET_VOP = 0x80, VOP_MASK = 0x7f, SCRIPT_END = 0xff }

Protected Member Functions
void	set (uint8_t cmd)

void	set (uint8_t x, uint8_t y)

void	fill (uint8_t data, uint16_t count)

Protected Attributes
LCD::IO *	m_io
	Display adapter. More...

OutputPin	m_dc
	Data/command output pin. More...

Font *	m_font
	Font. More...

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

Static Protected Attributes
static const uint8_t	script []

Detailed Description

PCD8544 48x84 pixels matrix LCD controller/driver, device driver for IOStream access. Binding to trace, etc. Supports simple text scroll, cursor, and handling of special characters such as form-feed, back-space and new-line. Graphics may be performed with OffScreen Canvas and copied to the display with draw_bitmap().

Circuit

PCD8544 is a low voltage device (3V3) and signals require level shifter (74HC4050 or 10K resistor).

                   PCD8544/LCD::Serial3W
                      +------------+
(RST)--------[ > ]--1-|RST         |
(D9/D3)------[ > ]--2-|CE          |
(D8/D2)------[ > ]--3-|DC          |
(D6/D0)------[ > ]--4-|DIN         |
(D7/D1)------[ > ]--5-|CLK         |
(3V3)---------------6-|VCC         |
(GND)--------[220]--7-|LED         |
(GND)---------------8-|GND         |
                      +------------+
                      PCD8544/LCD::SPI3W
                       +------------+
(RST)---------[ > ]--1-|RST         |
(D9/D3)-------[ > ]--2-|CE          |
(D8/D2)-------[ > ]--3-|DC          |
(MOSI/D11/D5)-[ > ]--4-|DIN         |
(SCK/D13/D4)--[ > ]--5-|CLK         |
(3V3)----------------6-|VCC         |
(GND)---------[220]--7-|LED         |
(GND)----------------8-|GND         |
                       +------------+

References

Product Specification, Philips Semiconductors, 1999 Apr 12. https://www.sparkfun.com/datasheets/LCD/Monochrome/Nokia5110.pdf

Definition at line 71 of file PCD8544.hh.

Member Enumeration Documentation

anonymous enum

protected

Instruction set (table 1, pp. 14).

Enumerator
NOP	No operation.
SET_FUNC	Set function.
BASIC_INST	Basic instruction set.
EXTENDED_INST	Extended instruction set control.
HORIZONTAL_ADDR	Horizontal addressing.
VERTICAL_ADDR	Vertical addressing.
POWER_UP_MODE	Power up mode.
POWER_DOWN_MODE	Power down mode.
DISPLAY_CNTL	Display control.
DISPLAY_OFF	Turn display off.
DISPLAY_ON	Turn display on.
NORMAL_MODE	Normal display mode.
INVERSE_MODE	Inverse display mode.
SET_Y_ADDR	Sets Y-address of RAM (0..5).
Y_ADDR_MASK	Mask Y-address.
SET_X_ADDR	Sets X-address of RAM (0..83).
X_ADDR_MASK	Mask X-addres.
SET_TEMP_COEFF	Set temperature coefficient (0..3).
SET_BIAS_SYS	Set Bias System (0..7).
SET_VOP	Write Vop to register.
VOP_MASK	Mask Vop.
SCRIPT_END	Init script end.

Definition at line 213 of file PCD8544.hh.

enum LCD::Device::TextMode

inherited

Text display mode.

Enumerator
NORMAL_TEXT_MODE
INVERTED_TEXT_MODE

Definition at line 45 of file LCD.hh.

Constructor & Destructor Documentation

PCD8544::PCD8544	(	LCD::IO *	io,
		Board::DigitalPin	dc = `Board::D8`,
		Font *	font = `&system5x7`
	)

Construct display device driver with given io adapter, chip select pin and font.

Parameters

[in]	io	adapter;
[in]	dc	data/command control pin (default D8/D2).
[in]	font	bitmap (default System 5X7).

Definition at line 36 of file PCD8544.cpp.

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 ( )

inlinevirtualinherited

Turn display backlight off.

Reimplemented in HD44780, and VLCD.

Definition at line 86 of file LCD.hh.

virtual void LCD::Device::backlight_on ( )

inlinevirtualinherited

Turn display backlight on.

Reimplemented in HD44780, and VLCD.

Definition at line 80 of file LCD.hh.

bool PCD8544::begin ( )

virtual

Start interaction with display.

Returns: true(1) if successful otherwise false(0)

Implements LCD::Device.

Definition at line 74 of file PCD8544.cpp.

void IOStream::Device::blocking ( )

inlineinherited

Set blocking mode.

Definition at line 85 of file IOStream.hh.

void PCD8544::display_clear ( )

virtual

Clear display and move cursor to home.

Implements LCD::Device.

Definition at line 120 of file PCD8544.cpp.

void PCD8544::display_contrast ( uint8_t level )

virtual

Set display contrast (0..127).

Parameters

[in] contrast level.

Reimplemented from LCD::Device.

Definition at line 128 of file PCD8544.cpp.

void PCD8544::display_inverse ( )

virtual

Display inverse mode.

Reimplemented from LCD::Device.

Definition at line 114 of file PCD8544.cpp.

void PCD8544::display_normal ( )

virtual

Display normal mode.

Reimplemented from LCD::Device.

Definition at line 108 of file PCD8544.cpp.

void PCD8544::display_off ( )

virtual

Turn display off.

Implements LCD::Device.

Definition at line 102 of file PCD8544.cpp.

void PCD8544::display_on ( )

virtual

Turn display on.

Implements LCD::Device.

Definition at line 96 of file PCD8544.cpp.

void PCD8544::draw_bar	(	uint8_t	percent,
		uint8_t	width,
		uint8_t	pattern = `0x55`
	)

Draw a bar at the current position with the given width. The bar is filled from left to right proportional to the given precent (0..100).

Parameters

[in]	precent	filled from left to right.
[in]	width	of bar.
[in]	pattern	of filled section of bar.

Definition at line 183 of file PCD8544.cpp.

void PCD8544::draw_bitmap	(	uint8_t *	bp,
		uint8_t	width,
		uint8_t	height
	)

Draw bitmap in the current mode.

Parameters

[in]	bp.
[in]	width.
[in]	height.

Definition at line 167 of file PCD8544.cpp.

void PCD8544::draw_icon ( const uint8_t * bp )

Draw icon in the current mode. The icon must be stored in program memory with width, height and data.

Parameters

[in] bp

Definition at line 150 of file PCD8544.cpp.

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.

bool PCD8544::end ( )

virtual

Stop sequence of interaction with device.

Returns: true(1) if successful otherwise false(0)

Implements LCD::Device.

Definition at line 89 of file PCD8544.cpp.

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.

void PCD8544::fill	(	uint8_t	data,
		uint16_t	count
	)

protected

Fill display with given data.

Parameters

[in]	data	to fill with.
[in]	count	number of bytes to fill.

Definition at line 66 of file PCD8544.cpp.

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

inlineinherited

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

inlineinherited

Get tab step.

Returns: tab step.

Definition at line 152 of file LCD.hh.

Font* PCD8544::get_text_font ( ) const

inline

Get current text font.

Returns: font setting.

Definition at line 156 of file PCD8544.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 PCD8544::putchar ( char c )

virtual

Write character to display. Handles carriage-return-line-feed, back- space, alert, horizontal tab and form-feed. Returns character or EOF on error.

Parameters

[in] c character to write.

Returns: character written or EOF(-1).

Reimplemented from IOStream::Device.

Definition at line 206 of file PCD8544.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.

void PCD8544::set ( uint8_t cmd )

protected

Set the given command code.

Parameters

[in] cmd command code.

Definition at line 45 of file PCD8544.cpp.

void PCD8544::set	(	uint8_t	x,
		uint8_t	y
	)

protected

Set display address for next data block.

Parameters

[in]	x	position 0..WIDTH-1.
[in]	y	position 0..HEIGHT-1.

Definition at line 55 of file PCD8544.cpp.

void PCD8544::set_cursor	(	uint8_t	x,
		uint8_t	y
	)

virtual

Set cursor to given position.

Parameters

[in]	x	pixel position (0..WIDTH-1).
[in]	y	line position (0..LINES-1).

Implements LCD::Device.

Definition at line 140 of file PCD8544.cpp.

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

inlineinherited

Set tab step to given value.

Parameters

[in] step tab.

Definition at line 161 of file LCD.hh.

Font* PCD8544::set_text_font ( Font * font )

inline

Set text font. Returns previous setting.

Parameters

[in] font.

Returns: previous font setting.

Definition at line 166 of file PCD8544.hh.

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

inlineinherited

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

const uint8_t PCD8544::HEIGHT = 48

static

Definition at line 75 of file PCD8544.hh.

const uint8_t PCD8544::LINES = HEIGHT / CHARBITS

static

Definition at line 76 of file PCD8544.hh.

bool IOStream::Device::m_blocking

protectedinherited

Blocking state

Definition at line 248 of file IOStream.hh.

OutputPin PCD8544::m_dc

protected

Data/command output pin.

Definition at line 243 of file PCD8544.hh.

Mode IOStream::Device::m_eol

protectedinherited

End of line mode

Definition at line 251 of file IOStream.hh.

Font* PCD8544::m_font

protected

Font.

Definition at line 244 of file PCD8544.hh.

LCD::IO* PCD8544::m_io

protected

Display adapter.

Display pins and state.

Definition at line 242 of file PCD8544.hh.

uint8_t LCD::Device::m_mode

protectedinherited

Text mode.

Definition at line 183 of file LCD.hh.

uint8_t LCD::Device::m_tab

protectedinherited

Tab step.

Definition at line 182 of file LCD.hh.

uint8_t LCD::Device::m_x

protectedinherited

Cursor position x.

Definition at line 180 of file LCD.hh.

uint8_t LCD::Device::m_y

protectedinherited

Cursor position y.

Definition at line 181 of file LCD.hh.

const uint8_t PCD8544::script[]

staticprotected

Initialization script to reduce memory footprint.

Definition at line 239 of file PCD8544.hh.

const uint8_t PCD8544::WIDTH = 84

static

Display size.

Definition at line 74 of file PCD8544.hh.

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

libraries/PCD8544/PCD8544.hh
libraries/PCD8544/PCD8544.cpp

Public Types

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Circuit

References

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation