Component: API (ECIO28P) (API Slave Devices)

Author	Matrix TSL
Version	2.0
Category	API Slave Devices

API (ECIO28P) component

Connects to an ECIO28P 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 / UART See Flowcode Help Wiki for firmware.

Component Source Code

Please click here for the component source code: FC_Comp_Source_ECIO28P_API_Comp.fcfx

Detailed description

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

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

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

ECIO28P App Developer Firmware

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

The COM port to the ECIO hardware is selected via the SCADA_ECIO28P component 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
Device Port Pin	A0	A1	A2	A3	A4	A5	B0	B1	B2	B3	B4	B5	B6	B7	C0	C1	C2	C6	C7

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	6	7	8	9	10	11	12
Device Port Pin	A0	A1	A2	A3	A5				B2	B3	B1	B4	B0

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	B0	B1	C7	B0	B1	C7	C6	C2	C1

Direct Slave Access

Here is a simple demo to switch on and off digital pin 5 (the LED pin).

ECIO28P App Developer Example

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.

ECIO 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.

ECIO 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.

ECIO App Developer Slave UART Demo

Macro reference

	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

	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

	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

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

	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

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

	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

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

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

	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

	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

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

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

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

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

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

	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

	I2CStop
Put the I2C Module into Stop mode
- BYTE	Channel
- VOID	Return

	ADCSetReferenceVoltage
Specified the reference setting for ADC reads.
- BYTE	RefType
0=AREF, 1=VCC, 3=Internal 1.1V
- VOID	Return

	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

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

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

	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

	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

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

	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

	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

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

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

	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

	PWMSetPrescaler
Sets the prescaler for the PWM output
- BYTE	Channel
- BYTE	Prescaler
- BYTE	Period
Default 255
- VOID	Return

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

	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

	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

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

Property reference

	Properties
	Connection
	Auto Detect Port
	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
	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