Component: IO Expander (BL0155) (E-blocks 2): Difference between revisions

Revision as of 12:00, 3 February 2023

Author	Matrix TSL
Version	1.0
Category	E-blocks 2

IO Expander component

Provides 16 digital input/output pins arranged into two 8-bit E-block 2 ports using a SPI bus connection.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_temp/EBlocks2_IOEXP_BL0155.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/EBlocks2_IOEXP_BL0155.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

ConfigureInversion

	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

ConfigurePullups

	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

Initialise

	Initialise

- VOID	Return

ReadPort

	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

ReadPortPin

	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

ReadRegister

	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

WritePort

	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

WritePortPin

	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

WriteRegister

	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

Property reference

	Properties
	SPI Communications
	External Address
Selects the value of the three address pins for the MCP23S17.
	Channel
SPI Channel selector
	Prescale
Prescale option selector
	MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
	MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
	CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
	CS / SS
Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.
	Reset Pin

	Simulation
	Label

	Show Comms Flasher

	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

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EBlocks2_IOEXP_BL0155.fcfx FC_Comp_Source_EBlocks2_IOEXP_BL0155.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/EBlocks2_IOEXP_BL0155.fcfx FC_Comp_Source_temp/EBlocks2_IOEXP_BL0155.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBlocks2_IOEXP_BL0155.fcfx FC_Comp_Source_EBlocks2_IOEXP_BL0155.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/EBlocks2_IOEXP_BL0155.fcfx FC_Comp_Source_temp/EBlocks2_IOEXP_BL0155.fcfx]
 ==Detailed description==
@@ Line 49: / Line 49: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 57: / Line 59: @@
 ==Macro reference==
-===ReadPort===
+===ConfigureInversion===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadPort'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ConfigureInversion'''
 |-
-| colspan="2" | Reads a value to one of the ports with a mask. Configures the masked bits to be inputs before reading the input value.&nbsp;
+| colspan="2" | Configures the pin inversion for the two ports.  Disabled on all pins by default.&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Port
+| width="90%" | PortA
 |-
-| colspan="2" | 0=PortA, 1=PortB&nbsp;
+| colspan="2" | Port A inversion sent as an 8-bit value, 0 = Disabled, 1 = Enabled&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Mask
+| width="90%" | PortB
 |-
-| colspan="2" | Allows port bits to be modified without effecting other bits, 255 = write full port.&nbsp;
+| colspan="2" | Port B inversion sent as an 8-bit value, 0 = Disabled, 1 = Enabled&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===ConfigureInversion===
+===ConfigurePullups===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ConfigureInversion'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ConfigurePullups'''
 |-
-| colspan="2" | Configures the pin inversion for the two ports.  Disabled on all pins by default.&nbsp;
+| colspan="2" | Configures the pullups for the two ports. Disabled on all pins by default.&nbsp;
 |-
 |-
@@ Line 93: / Line 95: @@
 | width="90%" | PortA
 |-
-| colspan="2" | Port A inversion sent as an 8-bit value, 0 = Disabled, 1 = Enabled&nbsp;
+| colspan="2" | Port A pull ups sent as an 8-bit value, 0 = Disabled, 1 = Enabled&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 | width="90%" | PortB
 |-
-| colspan="2" | Port B inversion sent as an 8-bit value, 0 = Disabled, 1 = Enabled&nbsp;
+| colspan="2" | Port B pull ups sent as an 8-bit value, 0 = Disabled, 1 = Enabled&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===Initialise===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+|-
+| colspan="2" | &nbsp;
+|-
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 105: / Line 121: @@
-===ReadPortPin===
+===ReadPort===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadPortPin'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadPort'''
 |-
-| colspan="2" | 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.&nbsp;
+| colspan="2" | Reads a value to one of the ports with a mask. Configures the masked bits to be inputs before reading the input value.&nbsp;
 |-
 |-
@@ Line 120: / Line 136: @@
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Pin
+| width="90%" | Mask
 |-
-| colspan="2" | Port pin to read. Range: 0-7&nbsp;
+| colspan="2" | Allows port bits to be modified without effecting other bits, 255 = write full port.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 129: / Line 145: @@
-===WritePortPin===
+===ReadPortPin===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WritePortPin'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadPortPin'''
 |-
-| colspan="2" | Writes a single port pin on one of the ports. Configures the pins to be an output before writing the input value. &nbsp;
+| colspan="2" | 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.&nbsp;
 |-
 |-
@@ Line 147: / Line 163: @@
 |-
 | colspan="2" | Port pin to read. Range: 0-7&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===ReadRegister===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadRegister'''
+|-
+| colspan="2" | Reads an 8-bit value from a register on the I/O expander device.&nbsp;
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Value
+| width="90%" | Address
 |-
-| colspan="2" | Value to output on the selected pin. Range: 0-1&nbsp;
+| colspan="2" | Register address to write to. Range: 0-15&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
@@ Line 187: / Line 217: @@
-===ConfigurePullups===
+===WritePortPin===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ConfigurePullups'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WritePortPin'''
 |-
-| colspan="2" | Configures the pullups for the two ports. Disabled on all pins by default.&nbsp;
+| colspan="2" | Writes a single port pin on one of the ports. Configures the pins to be an output before writing the input value. &nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | PortA
+| width="90%" | Port
 |-
-| colspan="2" | Port A pull ups sent as an 8-bit value, 0 = Disabled, 1 = Enabled&nbsp;
+| colspan="2" | 0=PortA, 1=PortB&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | PortB
+| width="90%" | Pin
-|-
-| colspan="2" | Port B pull ups sent as an 8-bit value, 0 = Disabled, 1 = Enabled&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-===ReadRegister===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadRegister'''
-|-
-| colspan="2" | Reads an 8-bit value from a register on the I/O expander device.&nbsp;
 |-
+| colspan="2" | Port pin to read. Range: 0-7&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Address
+| width="90%" | Value
 |-
-| colspan="2" | Register address to write to. Range: 0-15&nbsp;
+| colspan="2" | Value to output on the selected pin. Range: 0-1&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
@@ Line 248: / Line 264: @@
 |-
 | colspan="2" | Value to write. Range: 0-255&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-===Initialise===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
-|-
-| colspan="2" | &nbsp;
-|-
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID

Wiki bot (talk | contribs)