Difference between revisions of "Component: API SPI Dummy (API Slave Devices)"

Latest revision as of 13:08, 7 February 2023

Author	Matrix TSL
Version	2.0
Category	API Slave Devices

API SPI Dummy component

Connects to an Arduino Mega running the API Firmware allowing the board to become a slave to the Flowcode Embedded simulation or Flowcode App Developer. Supports: Digital IO / ADC / I2C / SPI / UART / PWM See Flowcode Help Wiki for firmware.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_API_SPI_Dummy.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_API_SPI_Dummy.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

IOSetOutputPin

	IOSetOutputPin
Sets the selected digital pin to an output and assigns the output state.
- BYTE	Pin
Range: 0-53
- BOOL	State
Range: 0-1
- VOID	Return

Initialise

	Initialise
Initialise the comms to the Arduino board ready for commands to be sent.
- VOID	Return

SPIInitialise

	SPIInitialise
Initialsie the SPI module ready for communications
- BYTE	Channel
Channel Index: Range 0 - SPI Bus Count - 1
- VOID	Return

SPIPrescaler

	SPIPrescaler
Modify the speed of the SPI bus
- BYTE	Channel
Channel Index: Range 0 - SPI Bus Count - 1
- BYTE	Prescaler
Range: 0-2
- VOID	Return

SPITransfer

	SPITransfer
Transfer a byte using the SPI bus
- BYTE	Channel
Channel Index: Range 0 - SPI Bus Count - 1
- BYTE	DataOut

- BYTE	Return

SPITransferTrans

	SPITransferTrans
Transfer an array of bytes using the SPI bus
- BYTE	Channel
Channel Index: Range 0 - SPI Bus Count - 1
- UINT	Count
Number of bytes to send and receive
- BYTE	DataOut
Outgoing data
- BYTE	DataIn
Incoming data
- VOID	Return

Property reference

	Properties

Difference between revisions of "Component: API SPI Dummy (API Slave Devices)"

Latest revision as of 13:08, 7 February 2023

Contents

API SPI Dummy component

Component Source Code

Detailed description

Examples

Macro reference

IOSetOutputPin

Initialise

SPIInitialise

SPIPrescaler

SPITransfer

SPITransferTrans

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 16: / Line 16: @@
 ==Component Source Code==
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_API_SPI_Dummy.fcfx FC_Comp_Source_API_SPI_Dummy.fcfx]
 Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_API_SPI_Dummy.fcfx FC_Comp_Source_API_SPI_Dummy.fcfx]
 ==Detailed description==
@@ Line 30: / Line 40: @@
 ==Examples==
@@ Line 39: / Line 57: @@
 ''<span style="color:red;">No additional examples</span>''
-==Macro reference==
-{| 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;" | '''SPITransferTrans'''
-|-
-| colspan="2" | Transfer an array of bytes using the SPI bus&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Channel
-|-
-| colspan="2" | Channel Index: Range 0 - SPI Bus Count - 1&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Count
-|-
-| colspan="2" | Number of bytes to send and receive&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | DataOut
-|-
-| colspan="2" | Outgoing data&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | DataIn
-|-
-| colspan="2" | Incoming data&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''
-|}
-{| 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;" | '''SPITransfer'''
-|-
-| colspan="2" | Transfer a byte using the SPI bus&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Channel
-|-
-| colspan="2" | Channel Index: Range 0 - SPI Bus Count - 1&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | DataOut
-|-
-| colspan="2" | &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''
-|}
-{| 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;" | '''SPIPrescaler'''
-|-
-| colspan="2" | Modify the speed of the SPI bus&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Channel
-|-
-| colspan="2" | Channel Index: Range 0 - SPI Bus Count - 1&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Prescaler
-|-
-| colspan="2" | Range: 0-2&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''
-|}
+==Macro reference==
+===IOSetOutputPin===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 143: / Line 93: @@
+===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;" | '''SPIInitialise'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| colspan="2" | Initialsie the SPI module ready for communications&nbsp;
+| colspan="2" | Initialise the comms to the Arduino board ready for commands to be sent.&nbsp;
 |-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Channel
-|-
-| colspan="2" | Channel Index: Range 0 - SPI Bus Count - 1&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 161: / Line 107: @@
+===SPIInitialise===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SPIInitialise'''
+|-
+| colspan="2" | Initialsie the SPI module ready for communications&nbsp;
+|-
 |-
-| colspan="2" | Initialise the comms to the Arduino board ready for commands to be sent.&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Channel
 |-
+| colspan="2" | Channel Index: Range 0 - SPI Bus Count - 1&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 174: / Line 126: @@
+===SPIPrescaler===
-==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
-|-
-|}==Macro reference==
 {| 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;" | '''SPITransferTrans'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SPIPrescaler'''
 |-
-| colspan="2" | Transfer an array of bytes using the SPI bus&nbsp;
+| colspan="2" | Modify the speed of the SPI bus&nbsp;
 |-
 |-
@@ Line 197: / Line 139: @@
 |-
 | colspan="2" | Channel Index: Range 0 - SPI Bus Count - 1&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Count
-|-
-| colspan="2" | Number of bytes to send and receive&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | DataOut
+| width="90%" | Prescaler
 |-
-| colspan="2" | Outgoing data&nbsp;
+| colspan="2" | Range: 0-2&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | DataIn
-|-
-| colspan="2" | Incoming data&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 218: / Line 150: @@
+===SPITransfer===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 241: / Line 174: @@
+===SPITransferTrans===
 {| 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;" | '''SPIPrescaler'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SPITransferTrans'''
 |-
-| colspan="2" | Modify the speed of the SPI bus&nbsp;
+| colspan="2" | Transfer an array of bytes using the SPI bus&nbsp;
 |-
 |-
@@ Line 254: / Line 188: @@
 | colspan="2" | Channel Index: Range 0 - SPI Bus Count - 1&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Prescaler
+| width="90%" | Count
-|-
-| colspan="2" | Range: 0-2&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''
-|}
-{| 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;" | '''IOSetOutputPin'''
-|-
-| colspan="2" | Sets the selected digital pin to an output and assigns the output state.&nbsp;
 |-
+| colspan="2" | Number of bytes to send and receive&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Pin
+| width="90%" | DataOut
-|-
-| colspan="2" | Range: 0-53&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | State
-|-
-| colspan="2" | Range: 0-1&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''
-|}
-{| 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;" | '''SPIInitialise'''
-|-
-| colspan="2" | Initialsie the SPI module ready for communications&nbsp;
 |-
+| colspan="2" | Outgoing data&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Channel
+| width="90%" | DataIn
 |-
-| colspan="2" | Channel Index: Range 0 - SPI Bus Count - 1&nbsp;
+| colspan="2" | Incoming data&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''
 |}
-{| 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" | Initialise the comms to the Arduino board ready for commands to be sent.&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''
-|}