Difference between revisions of "Component: IO Expander (BL0155) (E-blocks 2)"
(XML import - Pre 8.0 release) |
|||
| Line 17: | Line 17: | ||
==[[File:Component Icon e565ab5d_bf80_4911_938a_75b226ca6f93.png|Image]] IO Expander (BL0155) component== | ==[[File:Component Icon e565ab5d_bf80_4911_938a_75b226ca6f93.png|Image]] IO Expander (BL0155) component== | ||
Provides 16 digital input/output pins arranged into two 8-bit E-block 2 ports using a SPI bus connection. | Provides 16 digital input/output pins arranged into two 8-bit E-block 2 ports using a SPI bus connection. | ||
| + | |||
| + | Before you can start reading or writing data to the different registers or ports, you need to use a macro to initialise the IO expander. There are component macros in flowcode 8 which allow you to write a value to a register on the expander, to write a value to an individual port or even to an individual pin on a port. You can also read values from all these places using component macros as well. | ||
| + | |||
| + | You also need to ensure that all pins in flowcode are connected to the equivalent ones on your E-blocks 2 upstream board for it to work when you compile it to the chip. | ||
==Examples== | ==Examples== | ||
Revision as of 14:39, 7 September 2018
| Author | Matrix TSL |
| Version | 1.0 (Release) |
| Category | E-blocks 2 |
Contents
IO Expander (BL0155) component
Provides 16 digital input/output pins arranged into two 8-bit E-block 2 ports using a SPI bus connection.
Before you can start reading or writing data to the different registers or ports, you need to use a macro to initialise the IO expander. There are component macros in flowcode 8 which allow you to write a value to a register on the expander, to write a value to an individual port or even to an individual pin on a port. You can also read values from all these places using component macros as well.
You also need to ensure that all pins in flowcode are connected to the equivalent ones on your E-blocks 2 upstream board for it to work when you compile it to the chip.
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.
Parameters
- BYTE Port
- 0=PortA, 1=PortB
- BYTE Mask
- Allows port bits to be modified without effecting other bits, 255 = write full port.
Return value
ConfigureInversion
Configures the pin inversion for the two ports.
Disabled on all pins by default.
Parameters
- 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
Return value
- This call does not return a value
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.
Parameters
- BYTE Port
- 0=PortA, 1=PortB
- BYTE Pin
- Port pin to read. Range: 0-7
Return value
WritePortPin
Writes a single port pin on one of the ports.
Configures the pins to be an output before writing the input value.
Parameters
- 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
Return value
- This call does not return a value
WritePort
Writes a value to one of the ports with a mask.
Configures the masked bits to be outputs before writing the output value.
Parameters
- 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
Return value
- This call does not return a value
ConfigurePullups
Configures the pullups for the two ports.
Disabled on all pins by default.
Parameters
- 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
Return value
- This call does not return a value
ReadRegister
Reads an 8-bit value from a register on the I/O expander device.
Parameters
- BYTE Address
- Register address to write to. Range: 0-15
Return value
WriteRegister
Writes an 8-bit value to a register on the I/O expander device.
Parameters
- BYTE Address
- Register address to write to. Range: 0-15
- BYTE Value
- Value to write. Range: 0-255
Return value
- This call does not return a value
Initialise
No additional information
Parameters
- This macro has no parameters
Return value
- This call does not return a value
Simulation macro reference
This component does not contain any simulation macros
Property reference
Channel
This property is of type Fixed list of ints and can be referenced with the variable name cal_spi1::CHANNEL.
SPI Channel selector
Prescale
This property is of type Fixed list of ints and can be referenced with the variable name cal_spi1::PR_SCALE.
Prescale option selector
MOSI
This property is of type Single digital pin and can be referenced with the variable name cal_spi1::MOSI.
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
MISO
This property is of type Single digital pin and can be referenced with the variable name cal_spi1::MISO.
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
CLK
This property is of type Single digital pin and can be referenced with the variable name cal_spi1::CLK.
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
CS / SS
This property is of type Single digital pin and can be referenced with the variable name cal_spi1::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
This property is of type Single digital pin and can be referenced with the variable name reset_pin.
No additional information
Label
This property is of type Line of text and can be referenced with the variable name label.
No additional information
Scope Traces
This property is of type True or false and can be referenced with the variable name cal_spi1::ScopeTraces.
Selects if the scope traces are automatically generated or not
Console Data
This property is of type True or false and can be referenced with the variable name cal_spi1::ConsoleData.
Selects if the console data is automatically generated or not
Injector
This property is of type Fixed list of ints and can be referenced with the variable name cal_spi1::Injector.
No additional information
