Unit MCP230XX - Revision history

Ultibo at 05:44, 31 August 2021

2021-08-31T05:44:54Z

Ultibo at 04:35, 24 April 2018

2018-04-24T04:35:49Z

Ultibo at 02:01, 27 March 2017

2017-03-27T02:01:49Z

Ultibo at 05:13, 20 January 2017

2017-01-20T05:13:02Z

Ultibo at 02:44, 30 December 2016

2016-12-30T02:44:12Z

Ultibo at 05:47, 19 December 2016

2016-12-19T05:47:59Z

Ultibo at 05:38, 13 December 2016

2016-12-13T05:38:23Z

Ultibo at 05:37, 13 December 2016

2016-12-13T05:37:30Z

Ultibo at 00:58, 14 October 2016

2016-10-14T00:58:29Z

Ultibo at 00:57, 14 October 2016

2016-10-14T00:57:14Z

@@ Line 5: / Line 5: @@
 ----
-'''Microchip MCP230XX I/O expander Driver unit'''
+'''Microchip MCP230XX I/O Expander Driver unit'''
 The Microchip MCP23008 and MCP23017 are 8 or 16 bit I/O expanders that provide GPIO pin control functions over an I2C connection.

@@ Line 191: / Line 191: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''I2C'''
+! I2C
 | The I2C device this MCP23008 is connected to
 |-
-! '''Address'''
+! Address
 | The I2C address for this MCP23008
 |-
-! '''Return'''
+! Return
 | Pointer to the new GPIO device or nil on failure
 |-
@@ Line 209: / Line 209: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''I2C'''
+! I2C
 | The I2C device this MCP23017 is connected to
 |-
-! '''Address'''
+! Address
 | The I2C address for this MCP23017
 |-
-! '''Return'''
+! Return
 | Pointer to the new GPIO device or nil on failure
 |-
@@ Line 227: / Line 227: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''GPIO'''
+! GPIO
 | The GPIO device to destroy
 |-
-! '''Return'''
+! Return
 | ERROR_SUCCESS if completed or another error code on failure
 |-
@@ Line 245: / Line 245: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use GPIODeviceStart instead
+| Not intended to be called directly by applications, use GPIODeviceStart instead.
 |-
 |}
@@ Line 257: / Line 257: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use GPIODeviceStop instead
+| Not intended to be called directly by applications, use GPIODeviceStop instead.
 |-
 |}
@@ Line 269: / Line 269: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use GPIODeviceRead instead
+| Not intended to be called directly by applications, use GPIODeviceRead instead.
 Will read only a single register byte
 |-
@@ Line 282: / Line 282: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use GPIODeviceWrite instead
+| Not intended to be called directly by applications, use GPIODeviceWrite instead.
 Will write only a single register byte
 |-
@@ Line 295: / Line 295: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use GPIODeviceInputGet instead
+| Not intended to be called directly by applications, use GPIODeviceInputGet instead.
 |-
 |}
@@ Line 307: / Line 307: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use GPIODeviceOutputSet instead
+| Not intended to be called directly by applications, use GPIODeviceOutputSet instead.
 |-
 |}
@@ Line 319: / Line 319: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use GPIODevicePullGet instead
+| Not intended to be called directly by applications, use GPIODevicePullGet instead.
 |-
 |}
@@ Line 331: / Line 331: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use GPIODevicePullSelect instead
+| Not intended to be called directly by applications, use GPIODevicePullSelect instead.
 |-
 |}
@@ Line 343: / Line 343: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use GPIODeviceFunctionGet instead
+| Not intended to be called directly by applications, use GPIODeviceFunctionGet instead.
 |-
 |}
@@ Line 355: / Line 355: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use GPIODeviceFunctionSelect instead
+| Not intended to be called directly by applications, use GPIODeviceFunctionSelect instead.
 |-
 |}

@@ Line 74: / Line 74: @@
 <br />
 <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
-<div style="font-size: 14px; padding-left: 12px;">'''MCP230XX chip constants''' <code> MCP230XX_CHIP_* </code></div>
+<div style="font-size: 14px; padding-left: 12px;">'''MCP230XX chip''' <code> MCP230XX_CHIP_* </code></div>
 <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 {| class="wikitable" style="font-size: 14px; background: white;"
@@ Line 88: / Line 88: @@
 <br />
 <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
-<div style="font-size: 14px; padding-left: 12px;">'''MCP230XX I2C constants''' <code> MCP230XX_I2C_* </code></div>
+<div style="font-size: 14px; padding-left: 12px;">'''MCP230XX I2C''' <code> MCP230XX_I2C_* </code></div>
 <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 {| class="wikitable" style="font-size: 14px; background: white;"

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

@@ Line 128: / Line 128: @@
 ----
-''To be documented''
+''None defined''
 === Function declarations ===

@@ Line 4: / Line 4: @@
 === Description ===
 ----
 The Microchip MCP23008 and MCP23017 are 8 or 16 bit I/O expanders that provide GPIO pin control functions over an I2C connection.

@@ Line 91: / Line 91: @@
 |-
 | <code>MCP230XX_I2C_RATE = 400000;</code>
-| Default I2C clock rate (Device supports 100KHz, 400KHz and 1.7MHz
+| Default I2C clock rate (Device supports 100KHz, 400KHz and 1.7MHz)
 |-
 |colspan="2"|&nbsp;

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

← Older revision		Revision as of 00:58, 14 October 2016
Line 86:		Line 86:
	<br />		<br />

		+	'''MCP230XX GPIO 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 MCP230XXGPIOStart(GPIO:PGPIODevice):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODeviceStart API for MCP230XX</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! '''Note'''
		+	\| Not intended to be called directly by applications, use GPIODeviceStart instead
		+	\|-
		+	\|}
		+	</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 MCP230XXGPIOStop(GPIO:PGPIODevice):LongWord; </pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODeviceStop API for MCP230XX</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! '''Note'''
		+	\| Not intended to be called directly by applications, use GPIODeviceStop instead
		+	\|-
		+	\|}
		+	</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 MCP230XXGPIORead(GPIO:PGPIODevice; Reg:LongWord):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODeviceRead API for MCP230XX</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! '''Note'''
		+	\| Not intended to be called directly by applications, use GPIODeviceRead instead
		+	Will read only a single register byte
		+	\|-
		+	\|}
		+	</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;">procedure MCP230XXGPIOWrite(GPIO:PGPIODevice; Reg,Value:LongWord);</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODeviceWrite API for MCP230XX</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! '''Note'''
		+	\| Not intended to be called directly by applications, use GPIODeviceWrite instead
		+	Will write only a single register byte
		+	\|-
		+	\|}
		+	</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 MCP230XXGPIOInputGet(GPIO:PGPIODevice; Pin:LongWord):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODeviceInputGet API for MCP230XX</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! '''Note'''
		+	\| Not intended to be called directly by applications, use GPIODeviceInputGet instead
		+	\|-
		+	\|}
		+	</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 MCP230XXGPIOOutputSet(GPIO:PGPIODevice; Pin,Level:LongWord):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODeviceOutputSet API for MCP230XX</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! '''Note'''
		+	\| Not intended to be called directly by applications, use GPIODeviceOutputSet instead
		+	\|-
		+	\|}
		+	</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 MCP230XXGPIOPullGet(GPIO:PGPIODevice; Pin:LongWord):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODevicePullGet API for MCP230XX</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! '''Note'''
		+	\| Not intended to be called directly by applications, use GPIODevicePullGet instead
		+	\|-
		+	\|}
		+	</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 MCP230XXGPIOPullSelect(GPIO:PGPIODevice; Pin,Mode:LongWord):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODevicePullSelect API for MCP230XX</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! '''Note'''
		+	\| Not intended to be called directly by applications, use GPIODevicePullSelect instead
		+	\|-
		+	\|}
		+	</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 MCP230XXGPIOFunctionGet(GPIO:PGPIODevice; Pin:LongWord):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODeviceFunctionGet API for MCP230XX</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! '''Note'''
		+	\| Not intended to be called directly by applications, use GPIODeviceFunctionGet instead
		+	\|-
		+	\|}
		+	</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 MCP230XXGPIOFunctionSelect(GPIO:PGPIODevice; Pin,Mode:LongWord):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of GPIODeviceFunctionSelect API for MCP230XX</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! '''Note'''
		+	\| Not intended to be called directly by applications, use GPIODeviceFunctionSelect instead
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />

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

@@ Line 31: / Line 31: @@
 ----
-''To be documented''
 Return to [[Unit_Reference|Unit Reference]]