Unit I2CLCD - Revision history

Ultibo at 05:44, 31 August 2021

2021-08-31T05:44:13Z

Ultibo at 06:18, 21 July 2021

2021-07-21T06:18:23Z

Ultibo at 05:07, 19 June 2021

2021-06-19T05:07:37Z

Ultibo at 05:00, 19 June 2021

2021-06-19T05:00:20Z

Ultibo at 04:52, 19 June 2021

2021-06-19T04:52:56Z

Ultibo at 03:18, 19 June 2021

2021-06-19T03:18:06Z

Ultibo at 03:39, 18 June 2021

2021-06-18T03:39:44Z

Ultibo: Created page with "Return to Unit Reference === Description === ---- ''To be documented'' === Constants === ---- ''To be documented'' === Type definitions === ---- ''To..."

2021-06-18T03:09:41Z

Created page with "Return to Unit Reference === Description === ---- ''To be documented'' === Constants === ---- ''To be documented'' === Type definitions === ---- ''To..."

New page

Return to [[Unit_Reference|Unit Reference]]

=== Description ===
----

''To be documented''

=== Constants ===
----

''To be documented''

=== Type definitions ===
----

''To be documented''

=== Public variables ===
----

''To be documented''

=== Function declarations ===
----

''To be documented''

Return to [[Unit_Reference|Unit Reference]]

@@ Line 5: / Line 5: @@
 ----
-'''Generic I2C LCD Driver'''
+'''Generic I2C LCD Driver unit'''
 Generic 16x2 or 20x4 LCD displays with an I2C interface are available from many suppliers and commonly include a Hitachi HD44780 LCD and NXP PCF8574 I/O expander to convert the I2C data into GPIO inputs for the display.

← Older revision		Revision as of 05:07, 19 June 2021
Line 118:		Line 118:
	----		----

−	~~''To be documented''~~

		+	'''Initialization functions'''
		+
		+	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
		+	<pre style="border: 0; padding-bottom:0px;">procedure I2CLCDInit;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Initialize the I2CLCD unit and parameters</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! Note
		+	\| Called only during system startup
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />
		+	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
		+	<pre style="border: 0; padding-bottom:0px;">function I2CLCDStart(const Device:String; Address:Word; Width,Height:LongWord):THandle;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Start the I2CLCD driver and register the GPIO and Console devices associated with the display</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! Device
		+	\| The I2C device that the PCF8574 I/O Expander on the display is connected to
		+	\|-
		+	! Address
		+	\| The I2C address of the PCF8574 I/O Expander on the display
		+	\|-
		+	! Width
		+	\| The width in columns of the HD44780 LCD on the display
		+	\|-
		+	! Height
		+	\| The height in rows of the HD44780 LCD on the display
		+	\|-
		+	! Return
		+	\| The handle of the I2CLCD on success or INVALID_HANDLE_VALUE on failure
		+	\|-
		+	! Note
		+	\| This function will be called during startup if the parameter I2CLCD_AUTOSTART is True.
		+	Can be called multiple times to support more than one LCD display.
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />
		+	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
		+	<pre style="border: 0; padding-bottom:0px;">function I2CLCDStop(Handle:THandle):Boolean;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Stop the I2CLCD driver and deregister the GPIO and Console devices associated with the display</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! Handle
		+	\| The handle of the I2CLCD or INVALID_HANDLE_VALUE for the default display
		+	\|-
		+	! Return
		+	\| True if completed or False on failure
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />
		+
		+	'''I2CLCD functions'''
		+
		+	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
		+	<pre style="border: 0; padding-bottom:0px;">function I2CLCDBacklightOn(Handle:THandle):Boolean;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Turn on the backlight on the I2CLCD display</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! Handle
		+	\| The handle of the I2CLCD or INVALID_HANDLE_VALUE for the default display
		+	\|-
		+	! Return
		+	\| True if completed or False on failure
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />
		+	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
		+	<pre style="border: 0; padding-bottom:0px;">function I2CLCDBacklightOff(Handle:THandle):Boolean;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Turn off the backlight on the I2CLCD display</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! Handle
		+	\| The handle of the I2CLCD or INVALID_HANDLE_VALUE for the default display
		+	\|-
		+	! Return
		+	\| True if completed or False on failure
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />

	Return to [[Unit_Reference\|Unit Reference]]		Return to [[Unit_Reference\|Unit Reference]]

← Older revision		Revision as of 03:18, 19 June 2021
Line 6:		Line 6:

	'''Generic I2C LCD Driver'''		'''Generic I2C LCD Driver'''
		+
		+	Generic 16x2 or 20x4 LCD displays with an I2C interface are available from many suppliers and commonly include a Hitachi HD44780 LCD and NXP PCF8574 I/O expander to convert the I2C data into GPIO inputs for the display.
		+
		+	This unit combines the drivers for the HD44780 and PCF8574 to create a console device which can be used with the standard console and console window API.
		+
		+	Only text mode is supported as the HD44780 does not support setting individual pixels.
		+
		+	Some examples of generic displays that will work with the unit include the following:
		+
		+	https://www.amazon.com/SunFounder-Serial-Module-Display-Arduino/dp/B019K5X53O
		+
		+	https://www.auselectronicsdirect.com.au/2-x-16-lcd-display-module-with-i2c-interface-for-a
		+
		+	But you can find these units from many suppliers worldwide.

	=== Constants ===		=== Constants ===

@@ Line 75: / Line 75: @@
 ----
-''To be documented''
 === Public variables ===

@@ Line 24: / Line 24: @@
 ----
-''To be documented''
 === Type definitions ===

@@ Line 34: / Line 34: @@
 ----
-''To be documented''
 === Function declarations ===