Difference between revisions of "Component: Embed File (File)"
From Flowcode Help
Jump to navigationJump to search| Line 16: | Line 16: | ||
==Component Source Code== | ==Component Source Code== | ||
| + | |||
| + | Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_EmbedFile.fcfx FC_Comp_Source_EmbedFile.fcfx] | ||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EmbedFile.fcfx FC_Comp_Source_EmbedFile.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EmbedFile.fcfx FC_Comp_Source_EmbedFile.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 40: | Line 44: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 78: | Line 84: | ||
==Macro reference== | ==Macro reference== | ||
| + | |||
| + | {| 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;" | '''GetFileByte''' | ||
| + | |- | ||
| + | | colspan="2" | Reads a single byte from the file at the specified address. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
| + | | width="90%" | Address | ||
| + | |- | ||
| + | | colspan="2" | Address range 0 to NumBytesInFile - 1 | ||
| + | |- | ||
| + | | 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;" | '''GetFileLength''' | ||
| + | |- | ||
| + | | colspan="2" | Returns the file size in bytes. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT | ||
| + | | 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;" | '''GetFileArray''' | ||
| + | |- | ||
| + | | colspan="2" | Reads a number of bytes from the file from the specified start address. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
| + | | width="90%" | StartAddress | ||
| + | |- | ||
| + | | colspan="2" | Address of the first byte to read | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
| + | | width="90%" | NumBytes | ||
| + | |- | ||
| + | | colspan="2" | Number of bytes to read from the file | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Data | ||
| + | |- | ||
| + | | colspan="2" | Variable to pass the data into | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Property reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-13-icon.png]] | ||
| + | | width="90%" | File | ||
| + | |- | ||
| + | | colspan="2" | File you wish to embed into the program | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | File Length | ||
| + | |- | ||
| + | | colspan="2" | File size in bytes. Max recommended file size = 65535 bytes 8-bit PICs may struggle with files larger than 256 bytes. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | ROM Size | ||
| + | |- | ||
| + | | colspan="2" | Number of bytes available in the target device ROM memory | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 15:21, 20 January 2023
| Author | Matrix TSL |
| Version | 1.0 |
| Category | File |
Contents
Embed File component
A component to simplify the process of embedding files into ROM. Stores the file inside a ROM look up table.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_EmbedFile.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_EmbedFile.fcfx
Detailed description
No detailed description exists yet for this component
Examples
Basic example program which embeds a text file into the microcontrollers ROM memory and then prints the file out to a LCD display.
EmbedFileExample
Text file to go with the example, must be placed into the same directory as the Flowcode file.
Here is an archive which packages the example and text file together for you.
The file is selected using the File component property.
Clicking the small arrow to the right of the property and selecting Browse allows you to select a file using a Windows file explorer.
Macro reference
|
GetFileByte |
| Reads a single byte from the file at the specified address. | |
 - UINT
|
Address |
| Address range 0 to NumBytesInFile - 1 | |
 - BYTE
|
Return |
|
|
GetFileLength |
| Returns the file size in bytes. | |
| - UINT
|
Return |
|
|
GetFileArray |
| Reads a number of bytes from the file from the specified start address. | |
| - UINT
|
StartAddress |
| Address of the first byte to read | |
| - UINT
|
NumBytes |
| Number of bytes to read from the file | |
| - BYTE
|
Data |
| Variable to pass the data into | |
 - VOID
|
Return |
Property reference
|
Properties |
|
File |
| File you wish to embed into the program | |
|
File Length |
| File size in bytes. Max recommended file size = 65535 bytes 8-bit PICs may struggle with files larger than 256 bytes. | |
|
|
ROM Size |
| Number of bytes available in the target device ROM memory | |
==Macro reference==
|
|
GetFileByte |
| Reads a single byte from the file at the specified address. | |
| - UINT
|
Address |
| Address range 0 to NumBytesInFile - 1 | |
| - BYTE
|
Return |
|
|
GetFileLength |
| Returns the file size in bytes. | |
| - UINT
|
Return |
|
|
GetFileArray |
| Reads a number of bytes from the file from the specified start address. | |
| - UINT
|
StartAddress |
| Address of the first byte to read | |
| - UINT
|
NumBytes |
| Number of bytes to read from the file | |
| - BYTE
|
Data |
| Variable to pass the data into | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
File |
| File you wish to embed into the program | |
|
|
File Length |
| File size in bytes. Max recommended file size = 65535 bytes 8-bit PICs may struggle with files larger than 256 bytes. | |
|
|
ROM Size |
| Number of bytes available in the target device ROM memory | |
==Macro reference==
|
|
GetFileByte |
| Reads a single byte from the file at the specified address. | |
| - UINT
|
Address |
| Address range 0 to NumBytesInFile - 1 | |
| - BYTE
|
Return |
|
|
GetFileLength |
| Returns the file size in bytes. | |
| - UINT
|
Return |
|
|
GetFileArray |
| Reads a number of bytes from the file from the specified start address. | |
| - UINT
|
StartAddress |
| Address of the first byte to read | |
| - UINT
|
NumBytes |
| Number of bytes to read from the file | |
| - BYTE
|
Data |
| Variable to pass the data into | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
File |
| File you wish to embed into the program | |
|
|
File Length |
| File size in bytes. Max recommended file size = 65535 bytes 8-bit PICs may struggle with files larger than 256 bytes. | |
|
|
ROM Size |
| Number of bytes available in the target device ROM memory | |
