Component: Embed File (File) - Revision history

Wiki bot at 13:10, 7 February 2023

2023-02-07T13:10:13Z

Wiki bot at 12:19, 3 February 2023

2023-02-03T12:19:26Z

Wiki bot at 12:00, 3 February 2023

2023-02-03T12:00:39Z

Wiki bot at 11:49, 3 February 2023

2023-02-03T11:49:46Z

Wiki bot at 16:47, 30 January 2023

2023-01-30T16:47:50Z

Show changes

Wiki bot at 09:56, 27 January 2023

2023-01-27T09:56:26Z

Wiki bot at 15:21, 20 January 2023

2023-01-20T15:21:32Z

Wiki bot at 15:14, 20 January 2023

2023-01-20T15:14:19Z

Wiki bot at 14:11, 20 January 2023

2023-01-20T14:11:02Z

Wiki bot: Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray..."

2023-01-16T14:40:30Z

Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray..."

New page

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| File
|}

==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 for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_EmbedFile.fcfx 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.
{{Fcfile|EmbedFileExample.fcfx|EmbedFileExample}}
Text file to go with the example, must be placed into the same directory as the Flowcode file.

[[File:TextFile.txt]]

Here is an archive which packages the example and text file together for you.

{{Zip|EmbedFile.zip|Embed File Example Files}}

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.

[[File:EmbedFile.jpg]]

==Downloadable 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 
|}

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/EmbedFile.fcfx FC_Comp_Source_temp/EmbedFile.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/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_temp/EmbedFile.fcfx FC_Comp_Source_temp/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==
@@ Line 89: / Line 89: @@
 [[File:EmbedFile.jpg]]

@@ Line 89: / Line 89: @@
 [[File:EmbedFile.jpg]]
@@ Line 95: / Line 97: @@
 ==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 113: / Line 116: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 126: / Line 130: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EmbedFile.fcfx FC_Comp_Source_EmbedFile.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/EmbedFile.fcfx FC_Comp_Source_temp/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_temp/EmbedFile.fcfx FC_Comp_Source_temp/EmbedFile.fcfx]
 ==Detailed description==
@@ Line 89: / Line 89: @@
 [[File:EmbedFile.jpg]]
@@ Line 97: / Line 99: @@
 ==Macro reference==
-===GetFileByte===
+===GetFileArray===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetFileArray'''
 |-
-| colspan="2" | Reads a single byte from the file at the specified address.&nbsp;
+| colspan="2" | Reads a number of bytes from the file from the specified start address.&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Address
+| width="90%" | StartAddress
 |-
-| colspan="2" | Address range 0 to NumBytesInFile - 1&nbsp;
+| colspan="2" | Address of the first byte to read&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
+| width="90%" | NumBytes
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| colspan="2" | Number of bytes to read from the file&nbsp;
 |-
-| colspan="2" | Returns the file size in bytes.&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+| 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''
 |}
-===GetFileArray===
+===GetFileByte===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetFileByte'''
 |-
-| colspan="2" | Reads a number of bytes from the file from the specified start address.&nbsp;
+| colspan="2" | Reads a single byte from the file at the specified address.&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | StartAddress
+| width="90%" | Address
 |-
-| colspan="2" | Address of the first byte to read&nbsp;
+| colspan="2" | Address range 0 to NumBytesInFile - 1&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | NumBytes
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
 |-
-| colspan="2" | Number of bytes to read from the file&nbsp;
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| colspan="2" | Returns the file size in bytes.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| 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''
 |}

@@ Line 20: / Line 20: @@
 ==Detailed description==
@@ Line 36: / Line 38: @@
 ==Examples==
@@ Line 69: / Line 73: @@
-==Downloadable macro reference==
+==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"