Component: IO Expander (MCP23017) (Comms: System)

Author	Matrix TSL
Version	1.0
Category	Comms: System

IO Expander component

Provides 16 digital input/output pins arranged into two 8-bit ports using a I2C bus connection. Up to eight expanders can be connected to the same I2C peripheral by means of three address pins.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	ReadPort
Reads a value to one of the ports with a mask. Configures the masked bits to be inputs before reading the input value.
- BYTE	Port
0=PortA, 1=PortB
- BYTE	Mask
Allows port bits to be modified without effecting other bits, 255 = write full port.
- BYTE	Return

	ConfigureInversion
Configures the pin inversion for the two ports. Disabled on all pins by default.
- BYTE	PortA
Port A inversion sent as an 8-bit value, 0 = Disabled, 1 = Enabled
- BYTE	PortB
Port B inversion sent as an 8-bit value, 0 = Disabled, 1 = Enabled
- VOID	Return

	ReadPortPin
Reads a single port pin from one of the ports. Configures the pins to be an input before reading the input value. Returns 0 or 1 corresponding to the value on the port pin.
- BYTE	Port
0=PortA, 1=PortB
- BYTE	Pin
Port pin to read. Range: 0-7
- BYTE	Return

	WritePortPin
Writes a single port pin on one of the ports. Configures the pins to be an output before writing the input value.
- BYTE	Port
0=PortA, 1=PortB
- BYTE	Pin
Port pin to read. Range: 0-7
- BYTE	Value
Value to output on the selected pin. Range: 0-1
- VOID	Return

	WritePort
Writes a value to one of the ports with a mask. Configures the masked bits to be outputs before writing the output value.
- BYTE	Port
0=PortA, 1=PortB
- BYTE	Mask
Allows port bits to be modified without effecting other bits, 255 = write full port.
- BYTE	Value
Value to write. Range 0-255
- VOID	Return

	ConfigurePullups
Configures the pullups for the two ports. Disabled on all pins by default.
- BYTE	PortA
Port A pull ups sent as an 8-bit value, 0 = Disabled, 1 = Enabled
- BYTE	PortB
Port B pull ups sent as an 8-bit value, 0 = Disabled, 1 = Enabled
- VOID	Return

	ReadRegister
Reads an 8-bit value from a register on the I/O expander device.
- BYTE	Address
Register address to write to. Range: 0-15
- BYTE	Return

	SetAddress
Allows the slave address to be overridden to allow multiple modules to be controlled using a single component.
- BYTE	Address
Range: 0-7
- VOID	Return

	WriteRegister
Writes an 8-bit value to a register on the I/O expander device.
- BYTE	Address
Register address to write to. Range: 0-15
- BYTE	Value
Value to write. Range: 0-255
- VOID	Return

	Initialise
- VOID	Return

	Unregister
Removes the object to the list if present
[[File:]] -	Target
- VOID	Return

	SetMovementFor
Sets the movement in units or PI/16 steps for the button
[[File:]] -	Target
[[File:]] -	Move
Movement to set to, default 4
- VOID	Return

	CardBitmap
Displays a monochrome bitmap read from the card on the LCD
- BYTE	X
Range 0-127
- BYTE	Y
Range 0-31
- STRING	Filename
- BYTE	Return

	CardRecordMic
Records an audio stream on the card from the microphone
- BYTE	BitDepth
0=8-bit, 1=16-bit
- BYTE	SampleRate
Sample Rate 0=8KHz, 1=16KHz
- UINT	RecordTime
Time to record for in seconds, Range 0-65535
- STRING	Filename
- BYTE	Return

	CardOpen
Attempts to open an existing file on the SD card 255=Error, 1=File not found, 0=Open OK
- STRING	Filename
- BYTE	Return

	Forwards
Drives the robot forwards - waits for the distance to be traversed before returning
- UINT	Distance
Distance in mm
- VOID	Return

	ReadBearing
Reads the compass bearing based on the degrees clockwise from magnetic north.
[[File:]] -	Return

	GetConsoleHandle
Gets the handle to the console allowing data displaying on the panel etc.
[[File:]] -	Return

	LCDDrawLine
Allows a single pixel width line to be drawn on the LCD
- BYTE	X1
X Pixel 0-127
- BYTE	Y1
Y Pixel 0-31
- BYTE	X2
X Pixel 0-127
- BYTE	Y2
Y Pixel 0-31
- VOID	Return

	ServoAutoMoveToPosition
Allows one of the servo positions to move gradually to a new position
- BYTE	Channel
Range 0-3
- BYTE	Position
Range 0-255
- VOID	Return

	ReadAllValue
Reads a single value stored from the read all command Index dictates which sensor value to read
- BYTE	Index
0=SW, 1-8=IR, 9-10=Line, 11=Light, 12=Mic, 13-15=Accel
- UINT	Return

	LCDBacklight
Allows the LCD backlight brighntess to be adjusted
- BYTE	Intensity
Range 0-100, 0=Off, 1=Min Brightness, 100=Max Brightness
- VOID	Return

	LCDDrawRect
Allows a rectangle to be drawn on the LCD
- BYTE	X1
X Pixel 0-127
- BYTE	Y1
Y Pixel 0-31
- BYTE	X2
X Pixel 0-127
- BYTE	Y2
Y Pixel 0-31
- VOID	Return

	ReadLine
Reads one of the IR line sensors 0-1 0=Left, 1=Right
- BYTE	index
0=Left, 1=Right
- UINT	Return

	ServoDisable
Allows one of the servo outputs 0-3 to be disabled
- BYTE	Channel
Range 0-3
- VOID	Return

	ServoEnable
Allows one of the servo outputs 0-3 to be enabled
- BYTE	Channel
Range 0-3
- VOID	Return

	CardReadByte
Reads a byte from the currently open file. Starts at the beginning of the file and auto increments to the end
- BYTE	Return

	CardErase
Attempts to delete an existing file on the SD card 255=Error, 1=File not found, 0=Delete OK
- STRING	Filename
- BYTE	Return

	CardWriteByte
Appends a byte to the end of the currently open file
- BYTE	Data
- VOID	Return

	EncoderRead
Reads one of the motor encoder counters. Approx 0.328296mm of travel per encoder unit.
- BYTE	index
0=Left, 1=Right
- UINT	Return

	SetMotors
Sets the motor speeds without feedback Range -100 to 100
[[File:]] -	Left
Range -100 to 100
[[File:]] -	Right
Range -100 to 100
- VOID	Return

	Backwards
Drives the robot backwards - waits for the distance to be traversed before returning
- UINT	Distance
Distance in mm
- VOID	Return

	EncoderReset
Resets the motor encoder counters
- VOID	Return

	LCDVerbose
Allows the LCD to automatically report the API commands as they get processed. Default - verbose on
- BYTE	State
0=Off 1=On
- VOID	Return

	SetProp
Allows the COM port property to be set from a parent component.
- STRING	PropName
- ULONG	PropVal
- VOID	Return

	CardInit
Attempts to startup the SD card 255=No Card, 254=Init Fail, 0=Init OK
- BYTE	Return

	GetProp
Allows the property filter for the COM port list to be copied to a parent component.
- STRING	PropName
- STRING	Return

	LCDClear
Clears the LCD
- VOID	Return

Property reference

	Properties
	External Address
Selects the value of the three address pins for the MCP23S17.
	Channel
Channel selection
	Stop Delay
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.
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	Use Reset
	Connections
	Simulations
	Label
	Scope Traces
Selects if the scope traces are automatically generated or not
	Console Data
Selects if the console data is automatically generated or not
	API