Jump to content

Component: File (RPI) (File): Difference between revisions

From Flowcode Help
← Older editNewer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
No edit summary
No edit summary
Line 17: Line 17:
==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_File_RPI.fcfx FC_Comp_Source_File_RPI.fcfx]
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_File_RPI.fcfx FC_Comp_Source_File_RPI.fcfx]


Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_File_RPI.fcfx FC_Comp_Source_File_RPI.fcfx]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_File_RPI.fcfx FC_Comp_Source_File_RPI.fcfx]


==Detailed description==
==Detailed description==




Line 32: Line 34:


==Examples==
==Examples==




Line 42: Line 46:


==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;" | '''ReadStringFromFile'''
|-
| colspan="2" | Reads a string from the currently open file. Auto increments the position in the file. An empty string signifies the end of the file has been reached. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | NumBytes
|-
| colspan="2" | Maximum number of bytes to attempt to read 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | EndChar
|-
| colspan="2" | Ends the string if the value specified is found, default is 0 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| 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;" | '''MoveToNextFileSector'''
|-
| colspan="2" | Not currently implemented on the RPI 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ForceNextSector
|-
| colspan="2" |  
|-
| 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;" | '''WriteByteToBuffer'''
|-
| colspan="2" | Not currently implemented on the RPI 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Address
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| colspan="2" |  
|-
| 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''
|}
{| 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;" | '''AppendByteToFile'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| colspan="2" |  
|-
| 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;" | '''CloseFile'''
|-
| colspan="2" |  
|-
|-
| 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''
|}
{| 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;" | '''ReadByteFromFile'''
|-
| colspan="2" | Reads a byte from the currently open file. Auto increments the position in the file. A return value of 0 may signify the end of the file has been reached (depending on the contents of the file). 
|-
|-
| 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;" | '''ReadByteFromIndex'''
|-
| colspan="2" | Reads a byte of data from the local sector buffer. Return = Data byte read from the local sector buffer.  
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Address
|-
| colspan="2" |  
|-
| 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;" | '''DeleteFile'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Filename
|-
| colspan="2" |  
|-
| 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;" | '''CreateFile'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Filename
|-
| colspan="2" |  
|-
| 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;" | '''OpenFolder'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Folder_Name
|-
| colspan="2" |  
|-
| 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;" | '''ReadFileLength'''
|-
| colspan="2" | Not currently implemented on the RPI 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| 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;" | '''OpenFile'''
|-
| colspan="2" | Searches for and opens a file for reading or writing from within the current directory on the disk. Returns 0 for success. 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Filename
|-
| colspan="2" | 8.3 filename of the file we are trying to open e.g. "file.txt" 
|-
| 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;" | '''WriteFileSector'''
|-
| colspan="2" | Not currently implemented on the RPI 
|-
|-
| 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;" | '''SetFileIndex'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | File_Index
|-
| colspan="2" | Range: 0 to 4 
|-
| 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''
|}
{| 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;" | '''AppendStringToFile'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Data_String
|-
| colspan="2" |  
|-
| 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;" | '''ReadFileSize'''
|-
| colspan="2" | Reads the entire size of the current file in bytes. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
| 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-10-icon.png]]
| width="90%" | Root Folder
|-
| colspan="2" | Root location on the RPI where the files will be stored 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | File Count
|-
| colspan="2" | Number of simultaneous files we want to access. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-20-icon.png]]
| width="90%" | Sim Root Folder
|-
| colspan="2" |  
|}==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 09:56, 27 January 2023

Author Matrix Ltd.
Version 2.7
Category File


File (RPI) component

File component allowing access to read and write files on the Raspberry Pi file system.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_File_RPI.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_File_RPI.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

ReadStringFromFile
Reads a string from the currently open file. Auto increments the position in the file. An empty string signifies the end of the file has been reached. 
- UINT NumBytes
Maximum number of bytes to attempt to read 
- BYTE EndChar
Ends the string if the value specified is found, default is 0 
- STRING Return


MoveToNextFileSector
Not currently implemented on the RPI 
- BYTE ForceNextSector
 
- BYTE Return


WriteByteToBuffer
Not currently implemented on the RPI 
- UINT Address
 
- BYTE Data
 
- VOID Return


AppendByteToFile
 
- BYTE Data
 
- BYTE Return


CloseFile
 
- VOID Return


ReadByteFromFile
Reads a byte from the currently open file. Auto increments the position in the file. A return value of 0 may signify the end of the file has been reached (depending on the contents of the file). 
- BYTE Return


ReadByteFromIndex
Reads a byte of data from the local sector buffer. Return = Data byte read from the local sector buffer.  
- ULONG Address
 
- BYTE Return


DeleteFile
 
- STRING Filename
 
- BYTE Return


CreateFile
 
- STRING Filename
 
- BYTE Return


OpenFolder
 
- STRING Folder_Name
 
- BYTE Return


ReadFileLength
Not currently implemented on the RPI 
- INT Return


OpenFile
Searches for and opens a file for reading or writing from within the current directory on the disk. Returns 0 for success. 
- STRING Filename
8.3 filename of the file we are trying to open e.g. "file.txt" 
- BYTE Return


WriteFileSector
Not currently implemented on the RPI 
- BYTE Return


SetFileIndex
 
- BYTE File_Index
Range: 0 to 4 
- VOID Return


AppendStringToFile
 
- STRING Data_String
 
- BYTE Return


ReadFileSize
Reads the entire size of the current file in bytes. 
- ULONG Return



Property reference

Properties
Root Folder
Root location on the RPI where the files will be stored 
File Count
Number of simultaneous files we want to access. 
Simulation
Sim Root Folder
 

==Macro reference==

ReadStringFromFile
Reads a string from the currently open file. Auto increments the position in the file. An empty string signifies the end of the file has been reached. 
- UINT NumBytes
Maximum number of bytes to attempt to read 
- BYTE EndChar
Ends the string if the value specified is found, default is 0 
- STRING Return


MoveToNextFileSector
Not currently implemented on the RPI 
- BYTE ForceNextSector
 
- BYTE Return


WriteByteToBuffer
Not currently implemented on the RPI 
- UINT Address
 
- BYTE Data
 
- VOID Return


AppendByteToFile
 
- BYTE Data
 
- BYTE Return


CloseFile
 
- VOID Return


ReadByteFromFile
Reads a byte from the currently open file. Auto increments the position in the file. A return value of 0 may signify the end of the file has been reached (depending on the contents of the file). 
- BYTE Return


ReadByteFromIndex
Reads a byte of data from the local sector buffer. Return = Data byte read from the local sector buffer.  
- ULONG Address
 
- BYTE Return


DeleteFile
 
- STRING Filename
 
- BYTE Return


CreateFile
 
- STRING Filename
 
- BYTE Return


OpenFolder
 
- STRING Folder_Name
 
- BYTE Return


ReadFileLength
Not currently implemented on the RPI 
- INT Return


OpenFile
Searches for and opens a file for reading or writing from within the current directory on the disk. Returns 0 for success. 
- STRING Filename
8.3 filename of the file we are trying to open e.g. "file.txt" 
- BYTE Return


WriteFileSector
Not currently implemented on the RPI 
- BYTE Return


SetFileIndex
 
- BYTE File_Index
Range: 0 to 4 
- VOID Return


AppendStringToFile
 
- STRING Data_String
 
- BYTE Return


ReadFileSize
Reads the entire size of the current file in bytes. 
- ULONG Return



Property reference

Properties
Root Folder
Root location on the RPI where the files will be stored 
File Count
Number of simultaneous files we want to access. 
Simulation
Sim Root Folder
 

==Macro reference==

ReadStringFromFile
Reads a string from the currently open file. Auto increments the position in the file. An empty string signifies the end of the file has been reached. 
- UINT NumBytes
Maximum number of bytes to attempt to read 
- BYTE EndChar
Ends the string if the value specified is found, default is 0 
- STRING Return


MoveToNextFileSector
Not currently implemented on the RPI 
- BYTE ForceNextSector
 
- BYTE Return


WriteByteToBuffer
Not currently implemented on the RPI 
- UINT Address
 
- BYTE Data
 
- VOID Return


AppendByteToFile
 
- BYTE Data
 
- BYTE Return


CloseFile
 
- VOID Return


ReadByteFromFile
Reads a byte from the currently open file. Auto increments the position in the file. A return value of 0 may signify the end of the file has been reached (depending on the contents of the file). 
- BYTE Return


ReadByteFromIndex
Reads a byte of data from the local sector buffer. Return = Data byte read from the local sector buffer.  
- ULONG Address
 
- BYTE Return


DeleteFile
 
- STRING Filename
 
- BYTE Return


CreateFile
 
- STRING Filename
 
- BYTE Return


OpenFolder
 
- STRING Folder_Name
 
- BYTE Return


ReadFileLength
Not currently implemented on the RPI 
- INT Return


OpenFile
Searches for and opens a file for reading or writing from within the current directory on the disk. Returns 0 for success. 
- STRING Filename
8.3 filename of the file we are trying to open e.g. "file.txt" 
- BYTE Return


WriteFileSector
Not currently implemented on the RPI 
- BYTE Return


SetFileIndex
 
- BYTE File_Index
Range: 0 to 4 
- VOID Return


AppendStringToFile
 
- STRING Data_String
 
- BYTE Return


ReadFileSize
Reads the entire size of the current file in bytes. 
- ULONG Return



Property reference

Properties
Root Folder
Root location on the RPI where the files will be stored 
File Count
Number of simultaneous files we want to access. 
Simulation
Sim Root Folder
 

==Macro reference==

ReadStringFromFile
Reads a string from the currently open file. Auto increments the position in the file. An empty string signifies the end of the file has been reached. 
- UINT NumBytes
Maximum number of bytes to attempt to read 
- BYTE EndChar
Ends the string if the value specified is found, default is 0 
- STRING Return


MoveToNextFileSector
Not currently implemented on the RPI 
- BYTE ForceNextSector
 
- BYTE Return


WriteByteToBuffer
Not currently implemented on the RPI 
- UINT Address
 
- BYTE Data
 
- VOID Return


AppendByteToFile
 
- BYTE Data
 
- BYTE Return


CloseFile
 
- VOID Return


ReadByteFromFile
Reads a byte from the currently open file. Auto increments the position in the file. A return value of 0 may signify the end of the file has been reached (depending on the contents of the file). 
- BYTE Return


ReadByteFromIndex
Reads a byte of data from the local sector buffer. Return = Data byte read from the local sector buffer.  
- ULONG Address
 
- BYTE Return


DeleteFile
 
- STRING Filename
 
- BYTE Return


CreateFile
 
- STRING Filename
 
- BYTE Return


OpenFolder
 
- STRING Folder_Name
 
- BYTE Return


ReadFileLength
Not currently implemented on the RPI 
- INT Return


OpenFile
Searches for and opens a file for reading or writing from within the current directory on the disk. Returns 0 for success. 
- STRING Filename
8.3 filename of the file we are trying to open e.g. "file.txt" 
- BYTE Return


WriteFileSector
Not currently implemented on the RPI 
- BYTE Return


SetFileIndex
 
- BYTE File_Index
Range: 0 to 4 
- VOID Return


AppendStringToFile
 
- STRING Data_String
 
- BYTE Return


ReadFileSize
Reads the entire size of the current file in bytes. 
- ULONG Return



Property reference

Properties
Root Folder
Root location on the RPI where the files will be stored 
File Count
Number of simultaneous files we want to access. 
Simulation
Sim Root Folder
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_File_(RPI)_(File)&oldid=34188"