Component: API (Arduino Uno) (API Slave Devices)

Author	Matrix TSL
Version	2.0
Category	API Slave Devices

API (Arduino Uno) component

Connects to an Arduino Uno 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 / PWM See Flowcode Help Wiki for firmware.

Component Source Code

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

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

Detailed description

The App Developer (Arduino Uno) component allows an Arduino Uno board to be controlled from within the Flowcode simulation runtime.

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

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

Arduino Uno App Developer Firmware

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

The COM port to the Arduino hardware is selected via the App Developer_Ard_Uno componennt COM port property.

When building the component into a App Developer project remember to expose the COM port property to allow the end user to select the correct port 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	0	1	2	3	4	5	6	7	8	9	10	11	12	13	14	15	16	17	18	19
Device Port Pin	D0	D1	D2	D3	D4	D5	D6	D7	B0	B1	B2	B3	B4	B5	C0	C1	C2	C3	C4	C5
Arduino Style Pin	0	1	2	3	4	5	6	7	8	9	10	11	12	13	A0	A1	A2	A3	A4	A5

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

App Developer Slave Analogue Pin	0	1	2	3	4	5
Device Port Pin	C0	C1	C2	C3	C4	C5
Arduino Style Pin	A0	A1	A2	A3	A4	A5

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

PWM 0

PWM 1

PWM 2

PWM 3

PWM 4

PWM 5

OneWire

Servo 0

Servo 1

Servo 2

Servo 3

Servo 4

Servo 5

Servo 6

Servo 7

Device Port Pin

C4

C5

B3

B4

B5

D6

D5

B1

B2

B3

D3

D2

D2

D3

D4

D5

D6

D7

D8

D9

Arduino Style Pin

A4

A5

11

12

13

6

5

9

10

11

3

2

2

3

4

5

6

7

8

9

Direct Slave Access

Here is a simple demo to switch on and off digital pin 5.

Simple Arduino Uno Demo

Rapid Development - Virtualised SPI

A feature of the App Developer Slave interface is to use the component for rapid development.

The App Developer Slave hardware can be used to take communications from the Flowcode simulation and transfer them to a real world device allowing for easy code generation and test without having to download to a target microcontroller device.

The CS pin and SPI Prescaler are set via the properties of the Injector component.

The SPI Master component is linked to the Injector component via the Injector property.

The Injector component is linked to the App Developer Slave component via the App Developer Slave property.

Arduino Uno App Developer Slave SPI Demo

Rapid Development - Virtualised I2C

A feature of the App Developer Slave interface is to use the component for rapid development.

The App Developer Slave hardware can be used to take communications from the Flowcode simulation and transfer them to a real world device allowing for easy code generation and test without having to download to a target microcontroller device.

The I2C Master component is linked to the Injector component via the Injector property.

The Injector component is linked to the App Developer Slave component via the App Developer Slave property.

Arduino Uno App Developer Slave I2C Demo

Rapid Development - Virtualised UART

A feature of the App Developer Slave interface is to use the component for rapid development.

The App Developer Slave hardware can be used to take communications from the Flowcode simulation and transfer them to a real world device allowing for easy code generation and test without having to download to a target microcontroller device.

The Baud rate and optional RS485 Properties are set via the properties of the Injector component.

The UART component is linked to the Injector component via the Injector property.

The Injector component is linked to the App Developer Slave component via the App Developer Slave property.

Arduino Uno App Developer Slave UART Demo

Macro reference

ADCSample10

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

ADCSample8

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

ADCSampleArray10

	ADCSampleArray10
Reads the voltage present on an Analog pin as an 10-bit value range 0-1023 Performs the selected number of samples with the selected time in microseconds in between samples and returns each sample in a single packet
- BYTE	ADCChannel
Range: 0-5
- BYTE	SampleCount
Range: 1- 32
- UINT	SampleDelay
Delay in us between each sample
- UINT	Samples
10-bit samples returned from the function
- VOID	Return

ADCSampleArray8

	ADCSampleArray8
Reads the voltage present on an Analog pin as an 8-bit value range 0-255 Performs the selected number of samples with the selected time in microseconds in between samples and returns each sample in a single packet
- BYTE	ADCChannel
Range: 0-5
- BYTE	SampleCount
Range: 1- 32
- UINT	SampleDelay
Delay in us between each sample
- BYTE	Samples
8-bit samples returned from the function
- VOID	Return

ADCSampleAverage10

	ADCSampleAverage10
Reads the voltage present on an Analog pin as an 10-bit value range 0-1023. Performs the selected number of samples with the selected time in microseconds in between samples
- BYTE	ADCChannel
Range: 0-5
- BYTE	SampleCount
Range: 1- 100
- BYTE	SampleDelay
Delay in us between each sample
- UINT	Return

ADCSampleAverage8

	ADCSampleAverage8
Reads the voltage present on an Analog pin as an 8-bit value range 0-255 Performs the selected number of samples with the selected time in microseconds in between samples
- BYTE	ADCChannel
Range: 0-5
- BYTE	SampleCount
Range: 1- 100
- BYTE	SampleDelay
Delay in us between each sample
- BYTE	Return

ADCSetPrechargeTime

	ADCSetPrechargeTime
Specifies the precharge time for the ADC input readings in microseconds. The longer the time the more immune to noise the reading will be.
- BYTE	ChargeTime
Default 10
- VOID	Return

ADCSetReferenceVoltage

	ADCSetReferenceVoltage
Specified the reference setting for ADC reads.
- BYTE	RefType
0=AREF, 1=VCC, 3=Internal 1.1V
- VOID	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-19
- BOOL	Return

IOSetOutputPin

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

Initialise

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

OneWireBusReset

	OneWireBusReset
Issue a 'ping' on the bus. If there is at least one sensor on the bus then it will generate a presence pulse. Returns 0 if a presense pulse was detected Returns 1 no device was detected
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BOOL	Return

OneWireGetDeviceCount

	OneWireGetDeviceCount
Returns the number of devices found by the last ScanBus operation.
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Return

OneWireGetIDByte

	OneWireGetIDByte
Returns a single byte of the 64-Bit lasered ROM code, 255 on error
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Device
Device ID - Range: 0 - NumDevices - 1
- BYTE	ByteIndex
Index of the data byte. 0=FamilyCode, 1-6=Serial, 7=CRC
- BYTE	Return

OneWireInitialise

	OneWireInitialise
Initialise the OneWire module ready for communications
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- VOID	Return

OneWireMatchROM

	OneWireMatchROM
Performs a reset followed by the MatchROM code and then the 8-bit ROM code.
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	FamilyCode
- BYTE	SerialNumber
- VOID	Return

OneWireReceiveByte

	OneWireReceiveByte
Receives a byte from the one wire bus a bit at a time
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Return

OneWireScanBus

	OneWireScanBus
Scans the one wire bus to detect all connected devices. Returns the number of one wire devices found.
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Return

OneWireSkipROM

	OneWireSkipROM
Performs a bus reset and the sends the SkipROM command byte
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- VOID	Return

OneWireTransmitByte

	OneWireTransmitByte
Transmit a byte to the one wire bus a bit at a time
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Data
- VOID	Return

PWMDisable

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

PWMEnable

	PWMEnable
Enable a PWM output
- BYTE	Channel
Range: 0-5
- 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
Range: 0-5
- BYTE	Prescaler
- BYTE	Period
Default 255
- VOID	Return

RegisterRead

	RegisterRead
Read one of the registers on-board the device
- UINT	RegisterAddress
The address of the register
- BYTE	Return

RegisterWrite

	RegisterWrite
Writes to one of the registers on-board the device
- UINT	RegisterAddress
The address of the register
- BYTE	Data
The data value to assign to the register
- 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

ServoDisable

	ServoDisable
Disable a Servo output Ch0 to 7 = Pins 2 to 9
- BYTE	Channel
Range: 0-7
- VOID	Return

ServoEnable

	ServoEnable
Enable a Servo output Ch0 to 7 = Pins 2 to 9
- BYTE	Channel
Range: 0-7
- VOID	Return

ServoSetPosition8

	ServoSetPosition8
Sets the position as an 8-bit value Ch0 to 7 = Pins 2 to 9
- BYTE	Channel
Range: 0-7
- BYTE	Position
Range: 0-255
- VOID	Return

Property reference

	Properties
	Connection
	COM Port
Lists all the current available COM port hardware on your PC.
	Refresh Ports
	API Peripherals
	Digital IO
	Analog Input
	Analog Output
	PWM Output
	I2C Bus
	SPI Bus
	UART
	OneWire
	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