Component: LCD (BL0169) (E-blocks 2)

Author	Matrix TSL
Version	1.0 (Release)
Category	E-blocks 2

LCD (BL0169) component

LCD component to drive the E-blocks 2 BL0169 LCD board. Provides a 4 x 20 character alphanumeric display.

Make sure each data pin is connected to the right place in flowcode, which corresponds to the port that the LCD board is connected to on your E-blocks 2 upstream board. There are component macros you can use to print things on the LCD screen, in the form of a formatted number, an integer number, a string or the character which corresponds to an inputted ascii value.

You must use the ‘Start’ macro in the program before you can take any data on the LCD.

Examples

No additional examples

Downloadable macro reference

Clear

Clears the entire contents of the display.

Parameters

This macro has no parameters

Return value

This call does not return a value

PrintString

Breaks down a string of text and sends it to the LCD via the private RawSend(byte, mask) macro

Parameters

<- STRING Text

Enter the text or variable to print to the LCD

This parameter may be returned back to the caller

Return value

This call does not return a value

PrintAscii

Takes the ascii value for a character and prints the character

Parameters

BYTE character

Holds an ascii value.

Return value

This call does not return a value

PrintNumber

Based on v5 macro, will allow you to print a number. This is limited to a signed-INT, -32768 to 32767

Parameters

INT Number

Enter the number or variable to print to the LCD

Return value

This call does not return a value

RAMWrite

Modifies the internal memory of the LCD to allow for up to 8 customised characters to be created and stored in the device memory

Parameters

BYTE Index

Values 0 to 7

BYTE d0

BYTE d1

BYTE d2

BYTE d3

BYTE d4

BYTE d5

BYTE d6

BYTE d7

Return value

This call does not return a value

ClearLine

Clears a single line on the display and then moves the cursor to the start of the line to allow you to start populating the line with data.

Parameters

BYTE Line

The line to clear, zero being the first (top) line of the display

Return value

This call does not return a value

Cursor

Moves the cursor on the LCD Display

Parameters

BYTE x

Set the cursor position in the X plane, 0 is the left most cell

BYTE y

Set the cursor position in the Y plane, 0 is the top most cell

Return value

This call does not return a value

Command

Use this method/macro to send a specific command to the LCD. Refer to the Matrix Multimedia EB006 datasheet for a list of supported instructions. For Non-Matrix LCD's refer to the manufacturers datasheet.

Parameters

BYTE instruction

Send a defined command to the LCD Screen. See datasheet for supported commands.

Return value

This call does not return a value

PrintFormattedNumber

Will allow you to print a number up to 32-bits with signed or unsigned formatting.

Signed = -2147483648 to 2147483647

Unsigned = 0 to 4294967295

Parameters

ULONG Number

Enter the number or variable to print to the LCD

BOOL Format

0=Signed, 1=Unsigned

Return value

This call does not return a value

ScrollDisplay

Scrolls the display left or right by a number of given positions.

Parameters

BYTE Position

Holds the number of positions to shift the display

BYTE Direction

0 = left, 1 = right

Return value

This call does not return a value

RawSend

Sends data to the LCD display

Parameters

BYTE data

The data byte to send to the LCD

BOOL type

A boolean to indicate command type: true to write data, false to write a command

Return value

This call does not return a value

RemapCharacter

Assigns a remap character allowing the PrintString function to automatically swap between pre-defined characters.

The characters can be custom (in the range 0-9) or can point to an existing character in the LCD character map.

Parameters

BYTE RemapIdx

Remap Index, Range: 0 to (Remap Characters - 1)

BYTE SearchCharacter

Character to look for a replace

BYTE ReplacementCharacter

New character value to use in place of the search character.

Return value

This call does not return a value

Start

Startup routine required by the hardware device.

Automatically clears the display after initialising.

Parameters

This macro has no parameters

Return value

This call does not return a value

Simulation macro reference

This component does not contain any simulation macros

Property reference

Data 0 (11 / 7)

This property is of type Single digital pin and can be referenced with the variable name LCD1::Pin_Data_0.

Data pin 0 - Connects to Data 4 on the hardware in 4-bit mode or Data 0 in 8-bit mode

Data 1 (12 / 8)

This property is of type Single digital pin and can be referenced with the variable name LCD1::Pin_Data_1.

Data pin 1 - Connects to Data 5 on the hardware in 4-bit mode or Data 1 in 8-bit mode

Data 2 (13 / 9)

This property is of type Single digital pin and can be referenced with the variable name LCD1::Pin_Data_2.

Data pin 2 - Connects to Data 6 on the hardware in 4-bit mode or Data 2 in 8-bit mode

Data 3 (14 / 10)

This property is of type Single digital pin and can be referenced with the variable name LCD1::Pin_Data_3.

Data pin 3 - Connects to Data 7 on the hardware in 4-bit mode or Data 3 in 8-bit mode

Register Select (4)

This property is of type Single digital pin and can be referenced with the variable name LCD1::Pin_RS.

Register Select Pin - Informs the display if a command or data is about to be sent.

Enable (6)

This property is of type Single digital pin and can be referenced with the variable name LCD1::Pin_E.

Enable pin - Used to synchronise data writes to the display