Difference between revisions of "Unit MCP230XX"
| Line 31: | Line 31: | ||
---- | ---- | ||
| − | '' | + | |
| + | '''MCP230XX 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 MCP23008GPIOCreate(I2C:PI2CDevice; Address:Word):PGPIODevice;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Create, register and start a new MCP23008 GPIO device connected to the specified I2C device</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! '''I2C''' | ||
| + | | The I2C device this MCP23008 is connected to | ||
| + | |- | ||
| + | ! '''Address''' | ||
| + | | The I2C address for this MCP23008 | ||
| + | |- | ||
| + | ! '''Return''' | ||
| + | | Pointer to the new GPIO device or nil 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 MCP23017GPIOCreate(I2C:PI2CDevice; Address:Word):PGPIODevice;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Create, register and start a new MCP23017 GPIO device connected to the specified I2C device</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! '''I2C''' | ||
| + | | The I2C device this MCP23017 is connected to | ||
| + | |- | ||
| + | ! '''Address''' | ||
| + | | The I2C address for this MCP23017 | ||
| + | |- | ||
| + | ! '''Return''' | ||
| + | | Pointer to the new GPIO device or nil 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 MCP230XXGPIODestroy(GPIO:PGPIODevice):LongWord;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Stop, deregister and destroy an MCP230XX GPIO device created by this driver</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! '''GPIO''' | ||
| + | | The GPIO device to destroy | ||
| + | |- | ||
| + | ! '''Return''' | ||
| + | | ERROR_SUCCESS if completed or another error code on failure | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
Return to [[Unit_Reference|Unit Reference]] | Return to [[Unit_Reference|Unit Reference]] | ||
Revision as of 00:57, 14 October 2016
Return to Unit Reference
Description
The Microchip MCP23008 and MCP23017 are 8 or 16 bit I/O expanders that provide GPIO pin control functions over an I2C connection.
The device can be represented in Ultibo as a standard GPIO device which is accessible via the GPIO unit functions. Because the MCP230XX is a chip that can be used and configured in multiple different scenarios this unit does not autocreate a GPIO device, instead you need to call the function MCP23008GPIOCreate or MCP23017GPIOCreate and pass an I2C device and address. The functions will create and return a GPIO device with the appropriate number of pins and other information for the specified chip, the returned devices will have been registered with the GPIO device unit and started ready for use.
Both devices also come in an SPI interface version, these are not currently supported by this unit.
Note: This unit does not currently implement the interrupt capabilities of the MCP230XX chips however it could be expanded to allow the interrupt pin to be connected to a GPIO pin on the SoC and use a trigger event from that to enable GPIOInputWait/GPIOInputEvent functions for the MCP230XX chips.
Constants
To be documented
Type definitions
To be documented
Public variables
To be documented
Function declarations
MCP230XX functions
function MCP23008GPIOCreate(I2C:PI2CDevice; Address:Word):PGPIODevice;
| I2C | The I2C device this MCP23008 is connected to |
|---|---|
| Address | The I2C address for this MCP23008 |
| Return | Pointer to the new GPIO device or nil on failure |
function MCP23017GPIOCreate(I2C:PI2CDevice; Address:Word):PGPIODevice;
| I2C | The I2C device this MCP23017 is connected to |
|---|---|
| Address | The I2C address for this MCP23017 |
| Return | Pointer to the new GPIO device or nil on failure |
function MCP230XXGPIODestroy(GPIO:PGPIODevice):LongWord;
| GPIO | The GPIO device to destroy |
|---|---|
| Return | ERROR_SUCCESS if completed or another error code on failure |
Return to Unit Reference
