Component: LCD (I2C) (Outputs: General)
| Author | Matrix Ltd |
| Version | 1.2 (Release) |
| Category | Outputs: General |
| This inherits from LCD (Generic) | |
Contents
LCD (I2C) component
Standard alphanumeric LCD based on a standard I2C control bus.
Examples
No additional examples
Downloadable macro reference
This component inherits downloadable macros from LCD (Generic)
Clear
No additional information
Parameters
- This macro has no parameters
Return value
- This call does not return a value
PrintString
No additional information
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
Return value
- This call does not return a value
PrintNumber
Allows 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
- 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
No additional information
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
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
This call is provided by LCD (Generic)
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
- BYTE direction
Return value
- This call does not return a value
RawSend
Sends data to the LCD display
This call is provided by LCD (Generic)
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
Start
Startup routine required by the hardware device.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
BacklightControl
No additional information
Parameters
- BYTE State
Return value
- This call does not return a value
Simulation macro reference
This component does not contain any simulation macros
Property reference
Channel
This property is of type Fixed list of ints and can be referenced with the variable name Channel.
No additional information
I2C Data (SDA)
This property is of type Single digital pin and can be referenced with the variable name SDA.
No additional information
I2C Clock (SCL)
This property is of type Single digital pin and can be referenced with the variable name SCL.
No additional information
Stop Delay
This property is of type True or false and can be referenced with the variable name StopDel.
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not
a 10ms delay between an I2C stop event and the next I2C start event.
Most modern microcontrollers will not have a problem so this property can be disabled to speed up the
I2C communications.
LCD Address
This property is of type Unsigned integer and can be referenced with the variable name Address.
No additional information
Rows
This property is of type Fixed list of ints and can be referenced with the variable name Rows.
No additional information
Columns
This property is of type Fixed list of ints and can be referenced with the variable name Columns.
No additional information
