Component: API (ECIO40P) (API Slave Devices)
From Flowcode Help
(Redirected from Component: ID 40d5f2e2 3fb5 479a 91e1 f8ec3aae9e3a)
Jump to navigationJump to search| Author | Matrix TSL |
| Version | 4.0 |
| Category | API Slave Devices |
Contents
- 1 API (ECIO40P) component
- 2 Component Source Code
- 3 Detailed description
- 4 Examples
- 5 Macro reference
- 5.1 ADCSample10
- 5.2 ADCSample8
- 5.3 ADCSampleArray10
- 5.4 ADCSampleArray8
- 5.5 ADCSampleAverage10
- 5.6 ADCSampleAverage8
- 5.7 ADCSetPrechargeTime
- 5.8 ADCSetReferenceVoltage
- 5.9 I2CInitialise
- 5.10 I2CReceive
- 5.11 I2CRestart
- 5.12 I2CSend
- 5.13 I2CStart
- 5.14 I2CStop
- 5.15 I2CTransInit
- 5.16 I2CTransReceive
- 5.17 I2CTransSend
- 5.18 IOGetInputPin
- 5.19 IOSetOutputPin
- 5.20 Initialise
- 5.21 PWMDisable
- 5.22 PWMEnable
- 5.23 PWMSetDuty
- 5.24 PWMSetPrescaler
- 5.25 RegisterRead
- 5.26 RegisterWrite
- 5.27 SPIInitialise
- 5.28 SPIPrescaler
- 5.29 SPITransfer
- 5.30 SPITransferTrans
- 5.31 UARTBaud
- 5.32 UARTCheckRX
- 5.33 UARTInitialise
- 5.34 UARTReceive
- 5.35 UARTSend
- 6 Property reference
API (ECIO40P) component
Connects to an ECIO40P 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 to download the component source project: FC_Comp_Source_ECIO40P_API_Comp.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_ECIO40P_API_Comp.fcfx
Detailed description
The App Developer (ECIO40P) component allows an ECIO40P board to be controlled from within the Flowcode simulation runtime.
To allow Flowcode to communicate and control the ECIO40P hardware the board must first be pre-programmed with dedicated firmware.
The firmware hex file and Flowcode source project can be downloaded from here.
ECIO40P 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_ECIO40P 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 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 |
| Device Port Pin | A0 | A1 | A2 | A3 | A4 | A5 | B0 | B1 | B2 | B3 | B4 | B5 | B6 | B7 | C0 | C1 | C2 | C6 | C7 | D0 | D1 | D2 | D3 | D4 | D5 | D6 | D7 | E0 | E1 | E2 |
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 | E0 | E1 | E2 | 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 29 (the LED pin).
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 |
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=VDD 1= VREF+ (AN3) | |
| - 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-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 ECIO40P device, 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-1 | |
| - BYTE
|
Duty |
| - VOID
|
Return |
PWMSetPrescaler
|
|
PWMSetPrescaler |
| Sets the prescaler for the PWM output | |
| - BYTE
|
Channel |
| - BYTE
|
Prescaler |
| - BYTE
|
Period |
| - 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 |
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 |
|
Auto Detect |
|
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 | |
