Difference between revisions of "Component: Injector (File) (Test Injectors)"
From Flowcode Help
Jump to navigationJump to search| Line 14: | Line 14: | ||
==Injector (File) component== | ==Injector (File) component== | ||
Comms data injector to allow data to be streamed to and from a file during simulation. The component will read data from the incoming file and write data to the outgoing file. | Comms data injector to allow data to be streamed to and from a file during simulation. The component will read data from the incoming file and write data to the outgoing file. | ||
| + | |||
| + | ==Component Pack== | ||
| + | |||
| + | FREE | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 28: | Line 34: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 157: | Line 165: | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | | 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;" | '''GetConsoleHandle''' | ||
| + | |- | ||
| + | | colspan="2" | Gets the handle to the console allowing data displaying on the panel etc. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
Revision as of 16:19, 7 January 2022
| Author | Matrix Ltd |
| Version | 1.0 |
| Category | Test Injectors |
Contents
Injector (File) component
Comms data injector to allow data to be streamed to and from a file during simulation. The component will read data from the incoming file and write data to the outgoing file.
Component Pack
FREE
Detailed description
No detailed description exists yet for this component
Examples
Example to log the bytes sent via the UART RS232 component to a file as comma separated decimal numbers.
LogToFile
Contents of the file in the Flowcode project directory after running the simulation.
Downloadable macro reference
|
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 |
| - BYTE
|
Channel |
| - BYTE
|
Rate |
| - VOID
|
Return |
|
|
UARTCheckRX |
| - BYTE
|
Channel |
| - BYTE
|
Return |
|
|
UARTInitialise |
| - BYTE
|
Channel |
| - VOID
|
Return |
|
|
SPITransfer |
| Transfer a byte using the SPI bus | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - SPI Bus Count - 1 | |
| - BYTE
|
DataOut |
| - BYTE
|
Return |
|
|
GetConsoleHandle |
| Gets the handle to the console allowing data displaying on the panel etc. | |
 - HANDLE
|
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 |
|
|
UARTReceive |
| - BYTE
|
Channel |
| - BYTE
|
Return |
|
|
SPIInitialise |
| Initialsie the SPI module ready for communications | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - SPI Bus Count - 1 | |
| - VOID
|
Return |
|
|
UARTSend |
| - BYTE
|
Channel |
| - BYTE
|
Data |
| - VOID
|
Return |
Property reference
|
Properties |
|
Show Console |
|
Incoming File |
| File to stream incoming data from. File -> Communications component. | |
|
Parse Mode |
| Specifies the way we read in the data from the file. Detailed Byte : "z - 122 - 0x7a" Raw : "z" CSV Decimal : "122, " CSV Hex : "0x7a, " | |
|
|
Display Mode |
| Specifies the way we show the data on the console. Detailed Byte : "z - 122 - 0x7a" Raw : "z" CSV Decimal : "122, " CSV Hex : "0x7a, " | |
|
Values Per Line |
| Number of values to display on a single line of the data console. 0 = Infinite number of characters | |
|
|
Skip Timestamp |
| A file populated with data from an injector may have a timestamp built in which we may not want to receive. Yes: Skip first 22 characters of each line of data so we don't receive any of the timestamp info. No: Read data normally. | |
|
|
Outgoing File |
| File to store outgoing data. Communications component -> File | |
|
|
Clear On Init |
| No - Append to the end of the file. Yes - Empty file on initialise and start from the beginning of the file. | |
|
|
Data Mode |
| Specifies how the data is represented in the outgoing file. Detailed Byte : "z - 122 - 0x7a" Raw : "z" CSV Decimal : "122, " CSV Hex : "0x7a, " | |
|
|
Values Per Line |
| Number of values to display on a single line, applies to the file and data console. 0 = Infinite number of characters | |
|
|
Append Timestamp |
| Appends a timestamp to the beginning of every line relating to the time the first byte in the line was received. Based on the PC system time. Timestamp in the format "YY/MM/DD - HH:MM:SS - " | |
|
Connections |
|
|
Simulations |
