Component: API (RPI) (API Slave Devices): Difference between revisions

Latest revision as of 14:37, 13 July 2026

Author	Matrix TSL
Version	2.0
Category	API Slave Devices

API (RPI) component

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

Component Source Code

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

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

Detailed description

The App Developer (RaspberryPi) component allows an Raspberry Pi to be controlled from within the Flowcode simulation runtime.

To allow Flowcode to communicate and control the Raspberry Pi hardware the board must first be pre-programmed with dedicated firmware.

The firmware file and Flowcode source project can be downloaded from here.

RPI App Developer Firmware

More information about the workings of the firmware project can be found on the FiniteStateMachine page.

The IP Address to the Raspberry Pi hardware is selected via the SCADA_RPI component IP Address property.

When building the component into a App Developer project remember to expose the IP Address property to allow the end user to select the correct address for the hardware.

The console window can display data in two modes which is set via a component property.

fixed statistics showing IO / ADC inputs / PWM
scrolling log showing all commands and returns

Examples

Pin Mapping

Here is a table showing how the App Developer Slave digital pins are mapped on the device.

App Developer Slave Digital Pin	2	3	4	5	6	7	8	9	10	11	12	13	14	15	16	17	18	19	20	21	22	23	24	25	26	27
Device Port Pin	G2	G3	G4	G5	G6	G7	G8	G9	G10	G11	G12	G13	G14	G15	G16	G17	G18	G19	G20	G21	G22	G23	G24	G25	G26	G27

Here is a table showing how the App Developer Slave peripheral pins are mapped on the device.

App Developer Slave Peripheral Pin	I2C SDA	I2C SCL	SPI MOSI	SPI MISO	SPI SCK	UART RX	UART TX	PWM 0	PWM 1
Device Port Pin	G2	G3	G10	G9	G11	G15	G14	G12	G13

Macro reference

ADCSample10

	ADCSample10
Reads the voltage present on an Alanog pin as an 10-bit value range 0-1023
- BYTE	ADCChannel
Range: 0-12
- UINT	Return

ADCSample8

	ADCSample8
Reads the voltage present on an Alanog pin as an 8-bit value range 0-255
- BYTE	ADCChannel
Range: 0-12
- BYTE	Return

I2CInitialise

	I2CInitialise
Initialsie the I2C module ready for communications
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Baud
0=100KHz, 1=400KHz, 2=1MHz
- VOID	Return

I2CReceive

	I2CReceive
Receive a byte using the I2C bus
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BOOL	Last
Last byte to receive: Range 0-1
- BYTE	Return

I2CRestart

	I2CRestart
Put the I2C Module into Restart mode
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- VOID	Return

I2CSend

	I2CSend
Transmit a byte using the I2C bus
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	DataOut

- BOOL	Return

I2CStart

	I2CStart
Put the I2C Module into Start mode
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- VOID	Return

I2CStop

	I2CStop
Put the I2C Module into Stop mode
- BYTE	Channel

- VOID	Return

I2CTransInit

	I2CTransInit
Initialises the I2C Transaction mode with the 7-bit device address
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	DeviceAddress
7-bit Device Address
- BYTE	Baud
0=100KHz, 1=400KHz, 2=1MHz
- VOID	Return

I2CTransReceive

	I2CTransReceive
Receives an I2C Transaction on the selected I2C channel. Returns the number of bytes received.
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Data
Data variable to receive into
- UINT	Count
Number of bytes to receive
- UINT	Return

I2CTransSend

	I2CTransSend
Sends an I2C Transaction on the selected I2C channel. Returns the number of bytes sent.
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Data
Data to send
- UINT	Count
Number of bytes to send out, MS bit 0x8000 signifies no Stop if set
- UINT	Return

IOGetInputPin

	IOGetInputPin
Sets the selected digital pin to an input and reads the input state.
- BYTE	Pin
Range: 0-29
- BOOL	Return

IOSetOutputPin

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

Initialise

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

PWMDisable

	PWMDisable
Disable a PWM output
- BYTE	Channel
Range: 0-1
- VOID	Return

PWMEnable

	PWMEnable
Enable a PWM output
- BYTE	Channel
Range: 0-1
- VOID	Return

PWMSetDuty

	PWMSetDuty
Sets the duty for the PWM output
- BYTE	Channel
Range: 0-5
- BYTE	Duty

- VOID	Return

PWMSetPrescaler

	PWMSetPrescaler
Sets the prescaler for the PWM output
- BYTE	Channel

- BYTE	Prescaler

- BYTE	Period

- 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

UARTBaud

	UARTBaud
Control the communications rate of the UART module
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Rate
0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200
- VOID	Return

UARTCheckRX

	UARTCheckRX
Check to see if the UART module has received any data
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Return

UARTInitialise

	UARTInitialise
Initialise the UART module ready for communications
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- VOID	Return

UARTReceive

	UARTReceive
Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available.
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Return

UARTSend

	UARTSend
Send a byte via the UART module
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Data
Data Byte to send. Range: 0-255
- VOID	Return

Property reference

	Properties
	Connection
	RPI IP Address
IP Address of the Raspbery Pi we want to control
	RPI Port
Port number we want to communicate on. Default 1234
	Network Interface
Some computers may have several network interfaces such as ethernet ports and wifi access. Select the correct network interface for the network you wish to connect to. Use the IP address to confirm you are connected to the right network.
	IP Address
IP Address of the selected network interface.
	API Peripherals
	Digital IO

	Analog Input

	Analog Output

	PWM Output

	I2C Bus

	SPI Bus

	UART

	SERVO

	Console
	Console Log
Create an automatic console log of the commands sent to the Arduino
	Log Mode
Controls how the console data is formatted. Fixed statistics gives an easy to read overview of the IO, Analog and PWM functionality Command Log gives a more in depth analysis of the outgoing commands and incoming returns ASCII mode allows serial data to be shown in raw text form, other commands are shown as in the Command Log mode

@@ Line 200: / Line 200: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSample10'''
+| width="90%" class="mtx-class-macrohead" | '''ADCSample10'''
 |-
 | colspan="2" | Reads the voltage present on an Alanog pin as an 10-bit value range 0-1023&nbsp;
@@ Line 219: / Line 219: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSample8'''
+| width="90%" class="mtx-class-macrohead" | '''ADCSample8'''
 |-
 | colspan="2" | Reads the voltage present on an Alanog pin as an 8-bit value range 0-255&nbsp;
@@ Line 238: / Line 238: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CInitialise'''
+| width="90%" class="mtx-class-macrohead" | '''I2CInitialise'''
 |-
 | colspan="2" | Initialsie the I2C module ready for communications&nbsp;
@@ Line 262: / Line 262: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CReceive'''
+| width="90%" class="mtx-class-macrohead" | '''I2CReceive'''
 |-
 | colspan="2" | Receive a byte using the I2C bus&nbsp;
@@ Line 286: / Line 286: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CRestart'''
+| width="90%" class="mtx-class-macrohead" | '''I2CRestart'''
 |-
 | colspan="2" | Put the I2C Module into Restart mode&nbsp;
@@ Line 305: / Line 305: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CSend'''
+| width="90%" class="mtx-class-macrohead" | '''I2CSend'''
 |-
 | colspan="2" | Transmit a byte using the I2C bus&nbsp;
@@ Line 329: / Line 329: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CStart'''
+| width="90%" class="mtx-class-macrohead" | '''I2CStart'''
 |-
 | colspan="2" | Put the I2C Module into Start mode&nbsp;
@@ Line 348: / Line 348: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CStop'''
+| width="90%" class="mtx-class-macrohead" | '''I2CStop'''
 |-
 | colspan="2" | Put the I2C Module into Stop mode&nbsp;
@@ Line 367: / Line 367: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CTransInit'''
+| width="90%" class="mtx-class-macrohead" | '''I2CTransInit'''
 |-
 | colspan="2" | Initialises the I2C Transaction mode with the 7-bit device address&nbsp;
@@ Line 396: / Line 396: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CTransReceive'''
+| width="90%" class="mtx-class-macrohead" | '''I2CTransReceive'''
 |-
 | colspan="2" | Receives an I2C Transaction on the selected I2C channel. Returns the number of bytes received.&nbsp;
@@ Line 425: / Line 425: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CTransSend'''
+| width="90%" class="mtx-class-macrohead" | '''I2CTransSend'''
 |-
 | colspan="2" | Sends an I2C Transaction on the selected I2C channel. Returns the number of bytes sent.&nbsp;
@@ Line 454: / Line 454: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IOGetInputPin'''
+| width="90%" class="mtx-class-macrohead" | '''IOGetInputPin'''
 |-
 | colspan="2" | Sets the selected digital pin to an input and reads the input state.&nbsp;
@@ Line 473: / Line 473: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IOSetOutputPin'''
+| width="90%" class="mtx-class-macrohead" | '''IOSetOutputPin'''
 |-
 | colspan="2" | Sets the selected digital pin to an output and assigns the output state.&nbsp;
@@ Line 497: / Line 497: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+| width="90%" class="mtx-class-macrohead" | '''Initialise'''
 |-
 | colspan="2" | Initialise the comms to the Arduino board ready for commands to be sent.&nbsp;
@@ Line 511: / Line 511: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMDisable'''
+| width="90%" class="mtx-class-macrohead" | '''PWMDisable'''
 |-
 | colspan="2" | Disable a PWM output&nbsp;
@@ Line 530: / Line 530: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMEnable'''
+| width="90%" class="mtx-class-macrohead" | '''PWMEnable'''
 |-
 | colspan="2" | Enable a PWM output&nbsp;
@@ Line 549: / Line 549: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMSetDuty'''
+| width="90%" class="mtx-class-macrohead" | '''PWMSetDuty'''
 |-
 | colspan="2" | Sets the duty for the PWM output&nbsp;
@@ Line 573: / Line 573: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMSetPrescaler'''
+| width="90%" class="mtx-class-macrohead" | '''PWMSetPrescaler'''
 |-
 | colspan="2" | Sets the prescaler for the PWM output&nbsp;
@@ Line 602: / Line 602: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SPIInitialise'''
+| width="90%" class="mtx-class-macrohead" | '''SPIInitialise'''
 |-
 | colspan="2" | Initialsie the SPI module ready for communications&nbsp;
@@ Line 621: / Line 621: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SPIPrescaler'''
+| width="90%" class="mtx-class-macrohead" | '''SPIPrescaler'''
 |-
 | colspan="2" | Modify the speed of the SPI bus&nbsp;
@@ Line 645: / Line 645: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SPITransfer'''
+| width="90%" class="mtx-class-macrohead" | '''SPITransfer'''
 |-
 | colspan="2" | Transfer a byte using the SPI bus&nbsp;
@@ Line 669: / Line 669: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SPITransferTrans'''
+| width="90%" class="mtx-class-macrohead" | '''SPITransferTrans'''
 |-
 | colspan="2" | Transfer an array of bytes using the SPI bus&nbsp;
@@ Line 703: / Line 703: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTBaud'''
+| width="90%" class="mtx-class-macrohead" | '''UARTBaud'''
 |-
 | colspan="2" | Control the communications rate of the UART module&nbsp;
@@ Line 727: / Line 727: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTCheckRX'''
+| width="90%" class="mtx-class-macrohead" | '''UARTCheckRX'''
 |-
 | colspan="2" | Check to see if the UART module has received any data&nbsp;
@@ Line 746: / Line 746: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTInitialise'''
+| width="90%" class="mtx-class-macrohead" | '''UARTInitialise'''
 |-
 | colspan="2" | Initialise the UART module ready for communications&nbsp;
@@ Line 765: / Line 765: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTReceive'''
+| width="90%" class="mtx-class-macrohead" | '''UARTReceive'''
 |-
 | colspan="2" | Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available.&nbsp;
@@ Line 784: / Line 784: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTSend'''
+| width="90%" class="mtx-class-macrohead" | '''UARTSend'''
 |-
 | colspan="2" | Send a byte via the UART module&nbsp;
@@ Line 808: / Line 808: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connection
+| width="90%" class="mtx-class-propfolder" | Connection
 |-
 |-
@@ Line 836: / Line 836: @@
 | colspan="2" | IP Address of the selected network interface.&nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | API Peripherals
+| width="90%" class="mtx-class-propfolder" | API Peripherals
 |-
 |-
@@ Line 880: / Line 880: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Console
+| width="90%" class="mtx-class-propfolder" | Console
 |-
 |-

SteveT (talk | contribs)