Component: LCD (Adafruit, OLED) (Displays: Alphanumeric)
| Author | Matrix Ltd |
| Version | 1.8 (Release) |
| Category | Displays: Alphanumeric |
Contents
LCD (Adafruit, OLED) component
Adafruit OLED LCD display
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
- 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
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 before moving the cursor back to the start of the line to allow new data to be displayed.
Parameters
- BYTE Line
Return value
- This call does not return a value
Cursor
Moves the cursor on the LCD Display
Parameters
- BYTE x
- BYTE y
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
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
Start
Startup routine required by the hardware device.
Automatically clears the display when complete.
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)
This property is of type Single digital pin and can be referenced with the variable name d0_pin.
Data pin 0 connects to data pin 4 on the hardware
Data 1 (12)
This property is of type Single digital pin and can be referenced with the variable name d1_pin.
Data pin 1 connects to data pin 5 on the hardware
Data 2 (13)
This property is of type Single digital pin and can be referenced with the variable name d2_pin.
Data pin 2 connects to data pin 6 on the hardware
Data 3 (14)
This property is of type Single digital pin and can be referenced with the variable name d3_pin.
Data pin 3 connects to data pin 7 on the hardware
Register Select (4)
This property is of type Single digital pin and can be referenced with the variable name rs_pin.
Register select pin, determines if the incoming value is a command or a data byte
Read / Write (5)
This property is of type Single digital pin and can be referenced with the variable name rw_pin.
Read / Write pin determines the data direction
Enable (6)
This property is of type Single digital pin and can be referenced with the variable name enable_pin.
Enable pin, used to clock data in and out of the device.
Rows
This property is of type Signed integer and can be referenced with the variable name Rows.
Number of vertical characters that can be shown on the display
Columns
This property is of type Signed integer and can be referenced with the variable name Columns.
Number of horizontal characters that can be shown on the display
Background Color
This property is of type Color picker and can be referenced with the variable name BackgroundColor.
Simulation only property to control the background colour, on the hardware the colour is fixed.
Line Color
This property is of type Color picker and can be referenced with the variable name LineColor.
Simulation only property to control the line colour, on the hardware the colour is fixed.
Text Color
This property is of type Color picker and can be referenced with the variable name TextColor.
Simulation only property to control the text colour, on the hardware the colour is fixed.
Font
This property is of type Font picker and can be referenced with the variable name Font.
Simulation only property to control the display font, on the hardware the font is fixed.
