Flowcode Help - User contributions [en]

File:ExternalCAN.jpg

2014-02-11T10:09:13Z

Admin: Admin uploaded a new version of "File:ExternalCAN.jpg"

File:InternalCAN.jpg

2014-02-11T10:07:03Z

Admin:

File:ExternalCAN.jpg

2014-02-11T10:07:03Z

Admin:

File:CAN High.jpg

2014-02-11T10:01:32Z

Admin:

File:CAN Low.jpg

2014-02-11T10:01:32Z

Admin:

File:CAN Demo.fcfx

2014-02-11T10:01:32Z

Admin:

File:CAN DataFile.jpg

2014-02-11T10:01:31Z

Admin:

File:CAN File.jpg

2014-02-11T10:01:31Z

Admin:

File:LCDConns.jpg

2014-01-30T17:31:12Z

Admin:

File:FAT Data Logger Fast.fcfx

2014-01-30T17:18:19Z

Admin:

Component: File (SD, SDHC) (Storage)

2014-01-30T17:17:33Z

Admin: /* Examples */

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color: gray;" | Version
| 1.10
|-
| width="20%" style="color: gray;" | Category
| Storage
|}

==[[File:Component Icon 0b61bd39_05a3_46ee_a2a5_da7bffb583c5.png|Image]] FAT (SD, SDHC) component==
FAT component allowing access to read and write files on a SD, SDHC or MMC card.

The component automatically detects the filesystem on the card on initialise so FAT16 and
FAT32 are fully supported.

==Examples==

===Reading data from a text file===

Example to read a text file from a SD card or from a text file in simulation and display on a 16 x 2 character LCD. The text file needs to be in the same directory as the Flowcode .fcfx project file for the simulation to run correctly.

{{Fcfile|FAT Read_File.fcfx|FAT Read File}}

[[File:test.txt]]

Console showing current 512 byte sector data

[[File:FatBuffer.jpg]]

Console showing high level FAT status

[[File:FatStatus.jpg]]

===Parsing a standard .BMP image file===

Example to read a bitmap image file from a SD card or from a bitmap file in simulation and display on a graphical LCD. The bitmapfile needs to be in the same directory as the Flowcode .fcfx project file for the simulation to run correctly.

{{Fcfile|GLCD_FAT_BMP.fcfx|FAT display Bitmap}}

Demo bitmap files referenced in the example.

[[File:FATDemoBitmaps.zip]]

Picture showing a bitmap being displayed on a GLCD component.

[[File:FatSimulatedBitmap.jpg]]

===Data logger Simple===

Example showing how to take a collection of analogue readings and save them into a text based file, the simple way.

{{Fcfile|FAT Data_Logger_Simple_Slow.fcfx|FAT data logger simple but slow}}

===Data logger Advanced===

Example showing how to take a collection of analogue readings and save them into a text based file, the fast way.

{{Fcfile|FAT Data_Logger_Fast.fcfx|FAT data logger fast}}

==Downloadable macro reference==

===<tt>ReadStringFromFile</tt>===
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.

'''Parameters'''

:[[Variable Types|BYTE]] ''NumBytes''
::Maximum number of bytes to attempt to read

:[[Variable Types|BYTE]] ''EndChar''
::Ends the string if the value specified is found, default is 0

'''Return value'''

:[[Variable Types|STRING]]

===<tt>WriteByteToBuffer</tt>===
Writes a single byte to the current 512 byte local sector buffer.

'''Parameters'''

:[[Variable Types|UINT]] ''Address''
::Address Range 0 - 511

:[[Variable Types|BYTE]] ''Data''
::Data Byte to write to the buffer

'''Return value'''

:''This call does not return a value''

===<tt>MoveToNextFileSector</tt>===
Attempts to move to the next sector in the file.

When reading a file you would leave force next sector set to 0.

When writing a file you would leave force next sector set to 1 to allow new sectors to be created as the file grows.

Returns 0 for success

'''Parameters'''

:[[Variable Types|BYTE]] ''Force_Next_Sector''
::0 = Don't add new sector, 1 = Add new sector if we are at the end of the file

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadFileSector</tt>===
Overwrites local buffer with the current file sector from the disk.

Used to restore the local sector buffer with the actual sector stored on the card.

Return = 0 : Local buffer refreshed with current card sector

Return > 0 : Error

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromFile</tt>===
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).

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>DeleteFile</tt>===
Searches for and deletes a file in the current folder location on the card. Default = Root

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 format filename e.g."file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>CreateFile</tt>===
Creates a file in the current folder location on the card. Default = Root

Returns 0 for success

File must be opened using "Open_File" after creation before writing any data.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 format filename e.g."file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ScanCurrentFolder</tt>===
Method for retreiving file or folder names for the card to allow for dynamic file opening or playback. Does not currently simulate.

0 - Filetype found and stored into string array, 1 - End of folder reached, 2 - Filetype mismatch 3 - Empty

'''Parameters'''

:[[Variable Types|UINT]] ''Current_Idx''
::Contains the current pointer in the directory table. Values from 0 to 511 to completley search the current folder for a files or folders

:[[Variable Types|BYTE]] ''Scan_Type''
::Sets the scan to search for Files or Folders. 0 = Scan for files, 1 = Scan for folders

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromScan</tt>===
Returns a byte of the name of the file or folder retreived from the Scan_Current_folder function.

Return = ASCII byte at position Idx from the folder name or file name at position Current_Idx in the directory

'''Parameters'''

:[[Variable Types|BYTE]] ''idx''
::0 - 11 for a file, 0 - 7 for a folder

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>OpenFolder</tt>===
".." - Jumps up a directory, if at root then remains in root

"root" - Jumps directly back to the root directory

"foldername" - Opens folder named foldername

'''Parameters'''

:[[Variable Types|<- STRING]] ''Folder_Name''
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromBuffer</tt>===
Reads a byte of data from the local sector buffer.

Return = Data byte read from the local sector buffer.

'''Parameters'''

:[[Variable Types|UINT]] ''Address''
::0 - 511 - Contains the position of the byte to be read

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadFileLength</tt>===
Returns the number of bytes in the current sector that are used by the current open file.

Return = 512 - Sector is filled with file data

Return < 512 - Last sector of the file, Retval specifies how many bytes of data are remaining in the sector

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|INT]]

===<tt>OpenFile</tt>===
Searches for and opens a file for reading or writing from within the current directory on the disk.

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 filename of the file we are trying to open e.g. "file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>WriteFileSector</tt>===
Overwrites the current sector on the memory card with the contents of the local sector buffer. See write_byte_to_buffer function.

Return = 0 - File sector written successfully.

Return > 0 - File sector write error

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SetFileIndex</tt>===
Sets the current file index and used to switch between several open file streams.

Default = 0.

'''Parameters'''

:[[Variable Types|BYTE]] ''File_Index''
::File index ranges from 0 to (Max Concurrent Files - 1)

'''Return value'''

:''This call does not return a value''

===<tt>AppendStringToFile</tt>===
Adds the contents of the data string parameter to the end of the currently open file.

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Data_String''
::Data to append to the end of the file
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>Initialise</tt>===
Attempts to communicate with the SD card and if successful sets up the file system.

Returns 0 for success.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

==Simulation macro reference==

''This component does not contain any simulation macros''

==Property reference==
Max Concurrent Files

This property is of type ''Signed integer'' and can be referenced with the variable name ''max_concurrent_files''.

Specifies how many concurrent files can be opened at any one time.

Use the SetFileIndex macro to switch between concurrent files.

Channel

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Channel''.

SPI communications channel

Prescaler

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''PR_SCALE''.

SPI initial clock divider - Frequency should be under 400khz to allow startup to work

Chip Select - CS

This property is of type ''Single digital pin'' and can be referenced with the variable name ''cs_pin''.

Chip Select Pin for SPI

Data In - MISO / SDI

This property is of type ''Single digital pin'' and can be referenced with the variable name ''miso_pin''.

Data In SPI Pin

Data Out - MOSI / SDO

This property is of type ''Single digital pin'' and can be referenced with the variable name ''mosi_pin''.

Data Out SPI Pin

Serial Clock - SCK

This property is of type ''Single digital pin'' and can be referenced with the variable name ''sck_pin''.

Master Clock SPI pin

Root Directory

This property is of type ''Directory'' and can be referenced with the variable name ''root_dir''.

Directory flagged as root for simulation.

Modern windows systems do not like you writing files to a hard drive root directory so a directory off the root is advised.

Auto Insert Card

This property is of type ''True or false'' and can be referenced with the variable name ''AutoInsertCard''.

When set to yes the SD card will be automatically inserted at the start of simulation,

Otherwise you must manually click the card on the panel to insert.

Component: File (SD, SDHC) (Storage)

2014-01-30T17:13:32Z

Admin: /* Data logger Simple */

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color: gray;" | Version
| 1.10
|-
| width="20%" style="color: gray;" | Category
| Storage
|}

==[[File:Component Icon 0b61bd39_05a3_46ee_a2a5_da7bffb583c5.png|Image]] FAT (SD, SDHC) component==
FAT component allowing access to read and write files on a SD, SDHC or MMC card.

The component automatically detects the filesystem on the card on initialise so FAT16 and
FAT32 are fully supported.

==Examples==

===Reading data from a text file===

Example to read a text file from a SD card or from a text file in simulation and display on a 16 x 2 character LCD. The text file needs to be in the same directory as the Flowcode .fcfx project file for the simulation to run correctly.

{{Fcfile|FAT Read_File.fcfx|FAT Read File}}

[[File:test.txt]]

Console showing current 512 byte sector data

[[File:FatBuffer.jpg]]

Console showing high level FAT status

[[File:FatStatus.jpg]]

===Parsing a standard .BMP image file===

Example to read a bitmap image file from a SD card or from a bitmap file in simulation and display on a graphical LCD. The bitmapfile needs to be in the same directory as the Flowcode .fcfx project file for the simulation to run correctly.

{{Fcfile|GLCD_FAT_BMP.fcfx|FAT display Bitmap}}

Demo bitmap files referenced in the example.

[[File:FATDemoBitmaps.zip]]

Picture showing a bitmap being displayed on a GLCD component.

[[File:FatSimulatedBitmap.jpg]]

===Data logger Simple===

Example showing how to take a collection of analogue readings and save them into a text based file.

[[File:FAT Sata_Logger_Simple_Slow]]

===Data logger Advanced===

==Downloadable macro reference==

===<tt>ReadStringFromFile</tt>===
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.

'''Parameters'''

:[[Variable Types|BYTE]] ''NumBytes''
::Maximum number of bytes to attempt to read

:[[Variable Types|BYTE]] ''EndChar''
::Ends the string if the value specified is found, default is 0

'''Return value'''

:[[Variable Types|STRING]]

===<tt>WriteByteToBuffer</tt>===
Writes a single byte to the current 512 byte local sector buffer.

'''Parameters'''

:[[Variable Types|UINT]] ''Address''
::Address Range 0 - 511

:[[Variable Types|BYTE]] ''Data''
::Data Byte to write to the buffer

'''Return value'''

:''This call does not return a value''

===<tt>MoveToNextFileSector</tt>===
Attempts to move to the next sector in the file.

When reading a file you would leave force next sector set to 0.

When writing a file you would leave force next sector set to 1 to allow new sectors to be created as the file grows.

Returns 0 for success

'''Parameters'''

:[[Variable Types|BYTE]] ''Force_Next_Sector''
::0 = Don't add new sector, 1 = Add new sector if we are at the end of the file

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadFileSector</tt>===
Overwrites local buffer with the current file sector from the disk.

Used to restore the local sector buffer with the actual sector stored on the card.

Return = 0 : Local buffer refreshed with current card sector

Return > 0 : Error

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromFile</tt>===
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).

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>DeleteFile</tt>===
Searches for and deletes a file in the current folder location on the card. Default = Root

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 format filename e.g."file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>CreateFile</tt>===
Creates a file in the current folder location on the card. Default = Root

Returns 0 for success

File must be opened using "Open_File" after creation before writing any data.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 format filename e.g."file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ScanCurrentFolder</tt>===
Method for retreiving file or folder names for the card to allow for dynamic file opening or playback. Does not currently simulate.

0 - Filetype found and stored into string array, 1 - End of folder reached, 2 - Filetype mismatch 3 - Empty

'''Parameters'''

:[[Variable Types|UINT]] ''Current_Idx''
::Contains the current pointer in the directory table. Values from 0 to 511 to completley search the current folder for a files or folders

:[[Variable Types|BYTE]] ''Scan_Type''
::Sets the scan to search for Files or Folders. 0 = Scan for files, 1 = Scan for folders

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromScan</tt>===
Returns a byte of the name of the file or folder retreived from the Scan_Current_folder function.

Return = ASCII byte at position Idx from the folder name or file name at position Current_Idx in the directory

'''Parameters'''

:[[Variable Types|BYTE]] ''idx''
::0 - 11 for a file, 0 - 7 for a folder

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>OpenFolder</tt>===
".." - Jumps up a directory, if at root then remains in root

"root" - Jumps directly back to the root directory

"foldername" - Opens folder named foldername

'''Parameters'''

:[[Variable Types|<- STRING]] ''Folder_Name''
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromBuffer</tt>===
Reads a byte of data from the local sector buffer.

Return = Data byte read from the local sector buffer.

'''Parameters'''

:[[Variable Types|UINT]] ''Address''
::0 - 511 - Contains the position of the byte to be read

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadFileLength</tt>===
Returns the number of bytes in the current sector that are used by the current open file.

Return = 512 - Sector is filled with file data

Return < 512 - Last sector of the file, Retval specifies how many bytes of data are remaining in the sector

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|INT]]

===<tt>OpenFile</tt>===
Searches for and opens a file for reading or writing from within the current directory on the disk.

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 filename of the file we are trying to open e.g. "file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>WriteFileSector</tt>===
Overwrites the current sector on the memory card with the contents of the local sector buffer. See write_byte_to_buffer function.

Return = 0 - File sector written successfully.

Return > 0 - File sector write error

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SetFileIndex</tt>===
Sets the current file index and used to switch between several open file streams.

Default = 0.

'''Parameters'''

:[[Variable Types|BYTE]] ''File_Index''
::File index ranges from 0 to (Max Concurrent Files - 1)

'''Return value'''

:''This call does not return a value''

===<tt>AppendStringToFile</tt>===
Adds the contents of the data string parameter to the end of the currently open file.

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Data_String''
::Data to append to the end of the file
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>Initialise</tt>===
Attempts to communicate with the SD card and if successful sets up the file system.

Returns 0 for success.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

==Simulation macro reference==

''This component does not contain any simulation macros''

==Property reference==
Max Concurrent Files

This property is of type ''Signed integer'' and can be referenced with the variable name ''max_concurrent_files''.

Specifies how many concurrent files can be opened at any one time.

Use the SetFileIndex macro to switch between concurrent files.

Channel

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Channel''.

SPI communications channel

Prescaler

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''PR_SCALE''.

SPI initial clock divider - Frequency should be under 400khz to allow startup to work

Chip Select - CS

This property is of type ''Single digital pin'' and can be referenced with the variable name ''cs_pin''.

Chip Select Pin for SPI

Data In - MISO / SDI

This property is of type ''Single digital pin'' and can be referenced with the variable name ''miso_pin''.

Data In SPI Pin

Data Out - MOSI / SDO

This property is of type ''Single digital pin'' and can be referenced with the variable name ''mosi_pin''.

Data Out SPI Pin

Serial Clock - SCK

This property is of type ''Single digital pin'' and can be referenced with the variable name ''sck_pin''.

Master Clock SPI pin

Root Directory

This property is of type ''Directory'' and can be referenced with the variable name ''root_dir''.

Directory flagged as root for simulation.

Modern windows systems do not like you writing files to a hard drive root directory so a directory off the root is advised.

Auto Insert Card

This property is of type ''True or false'' and can be referenced with the variable name ''AutoInsertCard''.

When set to yes the SD card will be automatically inserted at the start of simulation,

Otherwise you must manually click the card on the panel to insert.

File:FAT Read File.fcfx

2014-01-30T17:10:14Z

Admin: Admin uploaded a new version of "File:FAT Read File.fcfx"

Component: File (SD, SDHC) (Storage)

2014-01-30T17:05:48Z

Admin: /* Examples */

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color: gray;" | Version
| 1.10
|-
| width="20%" style="color: gray;" | Category
| Storage
|}

==[[File:Component Icon 0b61bd39_05a3_46ee_a2a5_da7bffb583c5.png|Image]] FAT (SD, SDHC) component==
FAT component allowing access to read and write files on a SD, SDHC or MMC card.

The component automatically detects the filesystem on the card on initialise so FAT16 and
FAT32 are fully supported.

==Examples==

===Reading data from a text file===

Example to read a text file from a SD card or from a text file in simulation and display on a 16 x 2 character LCD. The text file needs to be in the same directory as the Flowcode .fcfx project file for the simulation to run correctly.

{{Fcfile|FAT Read_File.fcfx|FAT Read File}}

[[File:test.txt]]

Console showing current 512 byte sector data

[[File:FatBuffer.jpg]]

Console showing high level FAT status

[[File:FatStatus.jpg]]

===Parsing a standard .BMP image file===

Example to read a bitmap image file from a SD card or from a bitmap file in simulation and display on a graphical LCD. The bitmapfile needs to be in the same directory as the Flowcode .fcfx project file for the simulation to run correctly.

{{Fcfile|GLCD_FAT_BMP.fcfx|FAT display Bitmap}}

Demo bitmap files referenced in the example.

[[File:FATDemoBitmaps.zip]]

Picture showing a bitmap being displayed on a GLCD component.

[[File:FatSimulatedBitmap.jpg]]

===Data logger Simple===

===Data logger Advanced===

==Downloadable macro reference==

===<tt>ReadStringFromFile</tt>===
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.

'''Parameters'''

:[[Variable Types|BYTE]] ''NumBytes''
::Maximum number of bytes to attempt to read

:[[Variable Types|BYTE]] ''EndChar''
::Ends the string if the value specified is found, default is 0

'''Return value'''

:[[Variable Types|STRING]]

===<tt>WriteByteToBuffer</tt>===
Writes a single byte to the current 512 byte local sector buffer.

'''Parameters'''

:[[Variable Types|UINT]] ''Address''
::Address Range 0 - 511

:[[Variable Types|BYTE]] ''Data''
::Data Byte to write to the buffer

'''Return value'''

:''This call does not return a value''

===<tt>MoveToNextFileSector</tt>===
Attempts to move to the next sector in the file.

When reading a file you would leave force next sector set to 0.

When writing a file you would leave force next sector set to 1 to allow new sectors to be created as the file grows.

Returns 0 for success

'''Parameters'''

:[[Variable Types|BYTE]] ''Force_Next_Sector''
::0 = Don't add new sector, 1 = Add new sector if we are at the end of the file

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadFileSector</tt>===
Overwrites local buffer with the current file sector from the disk.

Used to restore the local sector buffer with the actual sector stored on the card.

Return = 0 : Local buffer refreshed with current card sector

Return > 0 : Error

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromFile</tt>===
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).

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>DeleteFile</tt>===
Searches for and deletes a file in the current folder location on the card. Default = Root

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 format filename e.g."file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>CreateFile</tt>===
Creates a file in the current folder location on the card. Default = Root

Returns 0 for success

File must be opened using "Open_File" after creation before writing any data.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 format filename e.g."file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ScanCurrentFolder</tt>===
Method for retreiving file or folder names for the card to allow for dynamic file opening or playback. Does not currently simulate.

0 - Filetype found and stored into string array, 1 - End of folder reached, 2 - Filetype mismatch 3 - Empty

'''Parameters'''

:[[Variable Types|UINT]] ''Current_Idx''
::Contains the current pointer in the directory table. Values from 0 to 511 to completley search the current folder for a files or folders

:[[Variable Types|BYTE]] ''Scan_Type''
::Sets the scan to search for Files or Folders. 0 = Scan for files, 1 = Scan for folders

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromScan</tt>===
Returns a byte of the name of the file or folder retreived from the Scan_Current_folder function.

Return = ASCII byte at position Idx from the folder name or file name at position Current_Idx in the directory

'''Parameters'''

:[[Variable Types|BYTE]] ''idx''
::0 - 11 for a file, 0 - 7 for a folder

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>OpenFolder</tt>===
".." - Jumps up a directory, if at root then remains in root

"root" - Jumps directly back to the root directory

"foldername" - Opens folder named foldername

'''Parameters'''

:[[Variable Types|<- STRING]] ''Folder_Name''
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromBuffer</tt>===
Reads a byte of data from the local sector buffer.

Return = Data byte read from the local sector buffer.

'''Parameters'''

:[[Variable Types|UINT]] ''Address''
::0 - 511 - Contains the position of the byte to be read

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadFileLength</tt>===
Returns the number of bytes in the current sector that are used by the current open file.

Return = 512 - Sector is filled with file data

Return < 512 - Last sector of the file, Retval specifies how many bytes of data are remaining in the sector

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|INT]]

===<tt>OpenFile</tt>===
Searches for and opens a file for reading or writing from within the current directory on the disk.

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 filename of the file we are trying to open e.g. "file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>WriteFileSector</tt>===
Overwrites the current sector on the memory card with the contents of the local sector buffer. See write_byte_to_buffer function.

Return = 0 - File sector written successfully.

Return > 0 - File sector write error

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SetFileIndex</tt>===
Sets the current file index and used to switch between several open file streams.

Default = 0.

'''Parameters'''

:[[Variable Types|BYTE]] ''File_Index''
::File index ranges from 0 to (Max Concurrent Files - 1)

'''Return value'''

:''This call does not return a value''

===<tt>AppendStringToFile</tt>===
Adds the contents of the data string parameter to the end of the currently open file.

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Data_String''
::Data to append to the end of the file
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>Initialise</tt>===
Attempts to communicate with the SD card and if successful sets up the file system.

Returns 0 for success.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

==Simulation macro reference==

''This component does not contain any simulation macros''

==Property reference==
Max Concurrent Files

This property is of type ''Signed integer'' and can be referenced with the variable name ''max_concurrent_files''.

Specifies how many concurrent files can be opened at any one time.

Use the SetFileIndex macro to switch between concurrent files.

Channel

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Channel''.

SPI communications channel

Prescaler

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''PR_SCALE''.

SPI initial clock divider - Frequency should be under 400khz to allow startup to work

Chip Select - CS

This property is of type ''Single digital pin'' and can be referenced with the variable name ''cs_pin''.

Chip Select Pin for SPI

Data In - MISO / SDI

This property is of type ''Single digital pin'' and can be referenced with the variable name ''miso_pin''.

Data In SPI Pin

Data Out - MOSI / SDO

This property is of type ''Single digital pin'' and can be referenced with the variable name ''mosi_pin''.

Data Out SPI Pin

Serial Clock - SCK

This property is of type ''Single digital pin'' and can be referenced with the variable name ''sck_pin''.

Master Clock SPI pin

Root Directory

This property is of type ''Directory'' and can be referenced with the variable name ''root_dir''.

Directory flagged as root for simulation.

Modern windows systems do not like you writing files to a hard drive root directory so a directory off the root is advised.

Auto Insert Card

This property is of type ''True or false'' and can be referenced with the variable name ''AutoInsertCard''.

When set to yes the SD card will be automatically inserted at the start of simulation,

Otherwise you must manually click the card on the panel to insert.

Component: File (SD, SDHC) (Storage)

2014-01-30T17:00:58Z

Admin: /* Examples */

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color: gray;" | Version
| 1.10
|-
| width="20%" style="color: gray;" | Category
| Storage
|}

==[[File:Component Icon 0b61bd39_05a3_46ee_a2a5_da7bffb583c5.png|Image]] FAT (SD, SDHC) component==
FAT component allowing access to read and write files on a SD, SDHC or MMC card.

The component automatically detects the filesystem on the card on initialise so FAT16 and
FAT32 are fully supported.

==Examples==

Example to read a text file from a SD card or from a text file in simulation and display on a 16 x 2 character LCD. The text file needs to be in the same directory as the Flowcode .fcfx project file for the simulation to run correctly.

{{Fcfile|FAT Read_File.fcfx|FAT Read File}}

[[File:test.txt]]

Console showing current 512 byte sector data

[[File:FatBuffer.jpg]]

Console showing high level FAT status

[[File:FatStatus.jpg]]

Example to read a bitmap image file from a SD card or from a bitmap file in simulation and display on a graphical LCD. The bitmapfile needs to be in the same directory as the Flowcode .fcfx project file for the simulation to run correctly.

{{Fcfile|GLCD_FAT_BMP.fcfx|FAT display Bitmap}}

Demo bitmap files referenced in the example.

[[File:FATDemoBitmaps.zip]]

Picture showing a bitmap being displayed on a GLCD component.

[[File:FatSimulatedBitmap.jpg]]

==Downloadable macro reference==

===<tt>ReadStringFromFile</tt>===
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.

'''Parameters'''

:[[Variable Types|BYTE]] ''NumBytes''
::Maximum number of bytes to attempt to read

:[[Variable Types|BYTE]] ''EndChar''
::Ends the string if the value specified is found, default is 0

'''Return value'''

:[[Variable Types|STRING]]

===<tt>WriteByteToBuffer</tt>===
Writes a single byte to the current 512 byte local sector buffer.

'''Parameters'''

:[[Variable Types|UINT]] ''Address''
::Address Range 0 - 511

:[[Variable Types|BYTE]] ''Data''
::Data Byte to write to the buffer

'''Return value'''

:''This call does not return a value''

===<tt>MoveToNextFileSector</tt>===
Attempts to move to the next sector in the file.

When reading a file you would leave force next sector set to 0.

When writing a file you would leave force next sector set to 1 to allow new sectors to be created as the file grows.

Returns 0 for success

'''Parameters'''

:[[Variable Types|BYTE]] ''Force_Next_Sector''
::0 = Don't add new sector, 1 = Add new sector if we are at the end of the file

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadFileSector</tt>===
Overwrites local buffer with the current file sector from the disk.

Used to restore the local sector buffer with the actual sector stored on the card.

Return = 0 : Local buffer refreshed with current card sector

Return > 0 : Error

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromFile</tt>===
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).

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>DeleteFile</tt>===
Searches for and deletes a file in the current folder location on the card. Default = Root

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 format filename e.g."file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>CreateFile</tt>===
Creates a file in the current folder location on the card. Default = Root

Returns 0 for success

File must be opened using "Open_File" after creation before writing any data.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 format filename e.g."file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ScanCurrentFolder</tt>===
Method for retreiving file or folder names for the card to allow for dynamic file opening or playback. Does not currently simulate.

0 - Filetype found and stored into string array, 1 - End of folder reached, 2 - Filetype mismatch 3 - Empty

'''Parameters'''

:[[Variable Types|UINT]] ''Current_Idx''
::Contains the current pointer in the directory table. Values from 0 to 511 to completley search the current folder for a files or folders

:[[Variable Types|BYTE]] ''Scan_Type''
::Sets the scan to search for Files or Folders. 0 = Scan for files, 1 = Scan for folders

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromScan</tt>===
Returns a byte of the name of the file or folder retreived from the Scan_Current_folder function.

Return = ASCII byte at position Idx from the folder name or file name at position Current_Idx in the directory

'''Parameters'''

:[[Variable Types|BYTE]] ''idx''
::0 - 11 for a file, 0 - 7 for a folder

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>OpenFolder</tt>===
".." - Jumps up a directory, if at root then remains in root

"root" - Jumps directly back to the root directory

"foldername" - Opens folder named foldername

'''Parameters'''

:[[Variable Types|<- STRING]] ''Folder_Name''
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromBuffer</tt>===
Reads a byte of data from the local sector buffer.

Return = Data byte read from the local sector buffer.

'''Parameters'''

:[[Variable Types|UINT]] ''Address''
::0 - 511 - Contains the position of the byte to be read

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadFileLength</tt>===
Returns the number of bytes in the current sector that are used by the current open file.

Return = 512 - Sector is filled with file data

Return < 512 - Last sector of the file, Retval specifies how many bytes of data are remaining in the sector

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|INT]]

===<tt>OpenFile</tt>===
Searches for and opens a file for reading or writing from within the current directory on the disk.

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 filename of the file we are trying to open e.g. "file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>WriteFileSector</tt>===
Overwrites the current sector on the memory card with the contents of the local sector buffer. See write_byte_to_buffer function.

Return = 0 - File sector written successfully.

Return > 0 - File sector write error

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SetFileIndex</tt>===
Sets the current file index and used to switch between several open file streams.

Default = 0.

'''Parameters'''

:[[Variable Types|BYTE]] ''File_Index''
::File index ranges from 0 to (Max Concurrent Files - 1)

'''Return value'''

:''This call does not return a value''

===<tt>AppendStringToFile</tt>===
Adds the contents of the data string parameter to the end of the currently open file.

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Data_String''
::Data to append to the end of the file
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>Initialise</tt>===
Attempts to communicate with the SD card and if successful sets up the file system.

Returns 0 for success.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

==Simulation macro reference==

''This component does not contain any simulation macros''

==Property reference==
Max Concurrent Files

This property is of type ''Signed integer'' and can be referenced with the variable name ''max_concurrent_files''.

Specifies how many concurrent files can be opened at any one time.

Use the SetFileIndex macro to switch between concurrent files.

Channel

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Channel''.

SPI communications channel

Prescaler

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''PR_SCALE''.

SPI initial clock divider - Frequency should be under 400khz to allow startup to work

Chip Select - CS

This property is of type ''Single digital pin'' and can be referenced with the variable name ''cs_pin''.

Chip Select Pin for SPI

Data In - MISO / SDI

This property is of type ''Single digital pin'' and can be referenced with the variable name ''miso_pin''.

Data In SPI Pin

Data Out - MOSI / SDO

This property is of type ''Single digital pin'' and can be referenced with the variable name ''mosi_pin''.

Data Out SPI Pin

Serial Clock - SCK

This property is of type ''Single digital pin'' and can be referenced with the variable name ''sck_pin''.

Master Clock SPI pin

Root Directory

This property is of type ''Directory'' and can be referenced with the variable name ''root_dir''.

Directory flagged as root for simulation.

Modern windows systems do not like you writing files to a hard drive root directory so a directory off the root is advised.

Auto Insert Card

This property is of type ''True or false'' and can be referenced with the variable name ''AutoInsertCard''.

When set to yes the SD card will be automatically inserted at the start of simulation,

Otherwise you must manually click the card on the panel to insert.

File:FatBuffer.jpg

2014-01-30T17:00:17Z

Admin: Admin uploaded a new version of "File:FatBuffer.jpg"

File:FatStatus.jpg

2014-01-30T17:00:17Z

Admin: Admin uploaded a new version of "File:FatStatus.jpg"

File:FATDemoBitmaps.zip

2014-01-30T17:00:16Z

Admin:

Component: File (SD, SDHC) (Storage)

2014-01-30T16:59:51Z

Admin: /* Examples */

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color: gray;" | Version
| 1.10
|-
| width="20%" style="color: gray;" | Category
| Storage
|}

==[[File:Component Icon 0b61bd39_05a3_46ee_a2a5_da7bffb583c5.png|Image]] FAT (SD, SDHC) component==
FAT component allowing access to read and write files on a SD, SDHC or MMC card.

The component automatically detects the filesystem on the card on initialise so FAT16 and
FAT32 are fully supported.

==Examples==

Example to read a text file from a SD card or from a text file in simulation and display on a 16 x 2 character LCD. The text file needs to be in the same directory as the Flowcode .fcfx project file for the simulation to run correctly.

{{Fcfile|FAT Read_File.fcfx|FAT Read File}}

[[File:test.txt]]

Console showing current 512 byte sector data

[[File:FATBuffer.jpg]]

Console showing high level FAT status

[[File:FATStatus.jpg]]

Example to read a bitmap image file from a SD card or from a bitmap file in simulation and display on a graphical LCD. The bitmapfile needs to be in the same directory as the Flowcode .fcfx project file for the simulation to run correctly.

{{Fcfile|GLCD_FAT_BMP.fcfx|FAT display Bitmap}}

Demo bitmap files referenced in the example.

[[File:FATDemoBitmaps.zip]]

Picture showing a bitmap being displayed on a GLCD component.

[[File:FatSimulatedBitmap.jpg]]

==Downloadable macro reference==

===<tt>ReadStringFromFile</tt>===
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.

'''Parameters'''

:[[Variable Types|BYTE]] ''NumBytes''
::Maximum number of bytes to attempt to read

:[[Variable Types|BYTE]] ''EndChar''
::Ends the string if the value specified is found, default is 0

'''Return value'''

:[[Variable Types|STRING]]

===<tt>WriteByteToBuffer</tt>===
Writes a single byte to the current 512 byte local sector buffer.

'''Parameters'''

:[[Variable Types|UINT]] ''Address''
::Address Range 0 - 511

:[[Variable Types|BYTE]] ''Data''
::Data Byte to write to the buffer

'''Return value'''

:''This call does not return a value''

===<tt>MoveToNextFileSector</tt>===
Attempts to move to the next sector in the file.

When reading a file you would leave force next sector set to 0.

When writing a file you would leave force next sector set to 1 to allow new sectors to be created as the file grows.

Returns 0 for success

'''Parameters'''

:[[Variable Types|BYTE]] ''Force_Next_Sector''
::0 = Don't add new sector, 1 = Add new sector if we are at the end of the file

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadFileSector</tt>===
Overwrites local buffer with the current file sector from the disk.

Used to restore the local sector buffer with the actual sector stored on the card.

Return = 0 : Local buffer refreshed with current card sector

Return > 0 : Error

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromFile</tt>===
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).

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>DeleteFile</tt>===
Searches for and deletes a file in the current folder location on the card. Default = Root

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 format filename e.g."file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>CreateFile</tt>===
Creates a file in the current folder location on the card. Default = Root

Returns 0 for success

File must be opened using "Open_File" after creation before writing any data.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 format filename e.g."file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ScanCurrentFolder</tt>===
Method for retreiving file or folder names for the card to allow for dynamic file opening or playback. Does not currently simulate.

0 - Filetype found and stored into string array, 1 - End of folder reached, 2 - Filetype mismatch 3 - Empty

'''Parameters'''

:[[Variable Types|UINT]] ''Current_Idx''
::Contains the current pointer in the directory table. Values from 0 to 511 to completley search the current folder for a files or folders

:[[Variable Types|BYTE]] ''Scan_Type''
::Sets the scan to search for Files or Folders. 0 = Scan for files, 1 = Scan for folders

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromScan</tt>===
Returns a byte of the name of the file or folder retreived from the Scan_Current_folder function.

Return = ASCII byte at position Idx from the folder name or file name at position Current_Idx in the directory

'''Parameters'''

:[[Variable Types|BYTE]] ''idx''
::0 - 11 for a file, 0 - 7 for a folder

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>OpenFolder</tt>===
".." - Jumps up a directory, if at root then remains in root

"root" - Jumps directly back to the root directory

"foldername" - Opens folder named foldername

'''Parameters'''

:[[Variable Types|<- STRING]] ''Folder_Name''
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromBuffer</tt>===
Reads a byte of data from the local sector buffer.

Return = Data byte read from the local sector buffer.

'''Parameters'''

:[[Variable Types|UINT]] ''Address''
::0 - 511 - Contains the position of the byte to be read

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadFileLength</tt>===
Returns the number of bytes in the current sector that are used by the current open file.

Return = 512 - Sector is filled with file data

Return < 512 - Last sector of the file, Retval specifies how many bytes of data are remaining in the sector

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|INT]]

===<tt>OpenFile</tt>===
Searches for and opens a file for reading or writing from within the current directory on the disk.

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 filename of the file we are trying to open e.g. "file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>WriteFileSector</tt>===
Overwrites the current sector on the memory card with the contents of the local sector buffer. See write_byte_to_buffer function.

Return = 0 - File sector written successfully.

Return > 0 - File sector write error

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SetFileIndex</tt>===
Sets the current file index and used to switch between several open file streams.

Default = 0.

'''Parameters'''

:[[Variable Types|BYTE]] ''File_Index''
::File index ranges from 0 to (Max Concurrent Files - 1)

'''Return value'''

:''This call does not return a value''

===<tt>AppendStringToFile</tt>===
Adds the contents of the data string parameter to the end of the currently open file.

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Data_String''
::Data to append to the end of the file
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>Initialise</tt>===
Attempts to communicate with the SD card and if successful sets up the file system.

Returns 0 for success.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

==Simulation macro reference==

''This component does not contain any simulation macros''

==Property reference==
Max Concurrent Files

This property is of type ''Signed integer'' and can be referenced with the variable name ''max_concurrent_files''.

Specifies how many concurrent files can be opened at any one time.

Use the SetFileIndex macro to switch between concurrent files.

Channel

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Channel''.

SPI communications channel

Prescaler

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''PR_SCALE''.

SPI initial clock divider - Frequency should be under 400khz to allow startup to work

Chip Select - CS

This property is of type ''Single digital pin'' and can be referenced with the variable name ''cs_pin''.

Chip Select Pin for SPI

Data In - MISO / SDI

This property is of type ''Single digital pin'' and can be referenced with the variable name ''miso_pin''.

Data In SPI Pin

Data Out - MOSI / SDO

This property is of type ''Single digital pin'' and can be referenced with the variable name ''mosi_pin''.

Data Out SPI Pin

Serial Clock - SCK

This property is of type ''Single digital pin'' and can be referenced with the variable name ''sck_pin''.

Master Clock SPI pin

Root Directory

This property is of type ''Directory'' and can be referenced with the variable name ''root_dir''.

Directory flagged as root for simulation.

Modern windows systems do not like you writing files to a hard drive root directory so a directory off the root is advised.

Auto Insert Card

This property is of type ''True or false'' and can be referenced with the variable name ''AutoInsertCard''.

When set to yes the SD card will be automatically inserted at the start of simulation,

Otherwise you must manually click the card on the panel to insert.

File:Laser.bmp

2014-01-30T16:58:33Z

Admin:

File:Dragon.bmp

2014-01-30T16:58:33Z

Admin:

File:FatBuffer.jpg

2014-01-30T16:58:32Z

Admin:

File:FatSimulatedBitmap.jpg

2014-01-30T16:58:32Z

Admin:

File:FatStatus.jpg

2014-01-30T16:58:32Z

Admin:

File:GLCD FAT BMP.fcfx

2014-01-30T16:58:32Z

Admin:

Component: File (SD, SDHC) (Storage)

2014-01-30T16:57:00Z

Admin: /* Examples */

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color: gray;" | Version
| 1.10
|-
| width="20%" style="color: gray;" | Category
| Storage
|}

==[[File:Component Icon 0b61bd39_05a3_46ee_a2a5_da7bffb583c5.png|Image]] FAT (SD, SDHC) component==
FAT component allowing access to read and write files on a SD, SDHC or MMC card.

The component automatically detects the filesystem on the card on initialise so FAT16 and
FAT32 are fully supported.

==Examples==

Example to read a text file from a SD card or from a text file in simulation and display on a 16 x 2 character LCD. The text file needs to be in the same directory as the Flowcode .fcfx project file for the simulation to run correctly.

{{Fcfile|FAT Read_File.fcfx|FAT Read File}}

[[File:test.txt]]

Console showing current 512 byte sector data

[[File:FATBuffer.jpg]]

Console showing high level FAT status

[[File:FATStatus.jpg]]

Example to read a bitmap image file from a SD card or from a bitmap file in simulation and display on a graphical LCD. The bitmapfile needs to be in the same directory as the Flowcode .fcfx project file for the simulation to run correctly.

{{Fcfile|GLCD_FAT_BMP.fcfx|FAT display Bitmap}}

[[File:dragon.bmp]]

[[File:laser.bmp]]

Picture showing a bitmap being displayed on a GLCD component.

[[File:FatSimulatedBitmap.jpg]]

==Downloadable macro reference==

===<tt>ReadStringFromFile</tt>===
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.

'''Parameters'''

:[[Variable Types|BYTE]] ''NumBytes''
::Maximum number of bytes to attempt to read

:[[Variable Types|BYTE]] ''EndChar''
::Ends the string if the value specified is found, default is 0

'''Return value'''

:[[Variable Types|STRING]]

===<tt>WriteByteToBuffer</tt>===
Writes a single byte to the current 512 byte local sector buffer.

'''Parameters'''

:[[Variable Types|UINT]] ''Address''
::Address Range 0 - 511

:[[Variable Types|BYTE]] ''Data''
::Data Byte to write to the buffer

'''Return value'''

:''This call does not return a value''

===<tt>MoveToNextFileSector</tt>===
Attempts to move to the next sector in the file.

When reading a file you would leave force next sector set to 0.

When writing a file you would leave force next sector set to 1 to allow new sectors to be created as the file grows.

Returns 0 for success

'''Parameters'''

:[[Variable Types|BYTE]] ''Force_Next_Sector''
::0 = Don't add new sector, 1 = Add new sector if we are at the end of the file

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadFileSector</tt>===
Overwrites local buffer with the current file sector from the disk.

Used to restore the local sector buffer with the actual sector stored on the card.

Return = 0 : Local buffer refreshed with current card sector

Return > 0 : Error

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromFile</tt>===
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).

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>DeleteFile</tt>===
Searches for and deletes a file in the current folder location on the card. Default = Root

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 format filename e.g."file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>CreateFile</tt>===
Creates a file in the current folder location on the card. Default = Root

Returns 0 for success

File must be opened using "Open_File" after creation before writing any data.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 format filename e.g."file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ScanCurrentFolder</tt>===
Method for retreiving file or folder names for the card to allow for dynamic file opening or playback. Does not currently simulate.

0 - Filetype found and stored into string array, 1 - End of folder reached, 2 - Filetype mismatch 3 - Empty

'''Parameters'''

:[[Variable Types|UINT]] ''Current_Idx''
::Contains the current pointer in the directory table. Values from 0 to 511 to completley search the current folder for a files or folders

:[[Variable Types|BYTE]] ''Scan_Type''
::Sets the scan to search for Files or Folders. 0 = Scan for files, 1 = Scan for folders

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromScan</tt>===
Returns a byte of the name of the file or folder retreived from the Scan_Current_folder function.

Return = ASCII byte at position Idx from the folder name or file name at position Current_Idx in the directory

'''Parameters'''

:[[Variable Types|BYTE]] ''idx''
::0 - 11 for a file, 0 - 7 for a folder

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>OpenFolder</tt>===
".." - Jumps up a directory, if at root then remains in root

"root" - Jumps directly back to the root directory

"foldername" - Opens folder named foldername

'''Parameters'''

:[[Variable Types|<- STRING]] ''Folder_Name''
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadByteFromBuffer</tt>===
Reads a byte of data from the local sector buffer.

Return = Data byte read from the local sector buffer.

'''Parameters'''

:[[Variable Types|UINT]] ''Address''
::0 - 511 - Contains the position of the byte to be read

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>ReadFileLength</tt>===
Returns the number of bytes in the current sector that are used by the current open file.

Return = 512 - Sector is filled with file data

Return < 512 - Last sector of the file, Retval specifies how many bytes of data are remaining in the sector

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|INT]]

===<tt>OpenFile</tt>===
Searches for and opens a file for reading or writing from within the current directory on the disk.

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::8.3 filename of the file we are trying to open e.g. "file.txt"
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>WriteFileSector</tt>===
Overwrites the current sector on the memory card with the contents of the local sector buffer. See write_byte_to_buffer function.

Return = 0 - File sector written successfully.

Return > 0 - File sector write error

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SetFileIndex</tt>===
Sets the current file index and used to switch between several open file streams.

Default = 0.

'''Parameters'''

:[[Variable Types|BYTE]] ''File_Index''
::File index ranges from 0 to (Max Concurrent Files - 1)

'''Return value'''

:''This call does not return a value''

===<tt>AppendStringToFile</tt>===
Adds the contents of the data string parameter to the end of the currently open file.

Returns 0 for success.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Data_String''
::Data to append to the end of the file
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>Initialise</tt>===
Attempts to communicate with the SD card and if successful sets up the file system.

Returns 0 for success.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

==Simulation macro reference==

''This component does not contain any simulation macros''

==Property reference==
Max Concurrent Files

This property is of type ''Signed integer'' and can be referenced with the variable name ''max_concurrent_files''.

Specifies how many concurrent files can be opened at any one time.

Use the SetFileIndex macro to switch between concurrent files.

Channel

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Channel''.

SPI communications channel

Prescaler

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''PR_SCALE''.

SPI initial clock divider - Frequency should be under 400khz to allow startup to work

Chip Select - CS

This property is of type ''Single digital pin'' and can be referenced with the variable name ''cs_pin''.

Chip Select Pin for SPI

Data In - MISO / SDI

This property is of type ''Single digital pin'' and can be referenced with the variable name ''miso_pin''.

Data In SPI Pin

Data Out - MOSI / SDO

This property is of type ''Single digital pin'' and can be referenced with the variable name ''mosi_pin''.

Data Out SPI Pin

Serial Clock - SCK

This property is of type ''Single digital pin'' and can be referenced with the variable name ''sck_pin''.

Master Clock SPI pin

Root Directory

This property is of type ''Directory'' and can be referenced with the variable name ''root_dir''.

Directory flagged as root for simulation.

Modern windows systems do not like you writing files to a hard drive root directory so a directory off the root is advised.

Auto Insert Card

This property is of type ''True or false'' and can be referenced with the variable name ''AutoInsertCard''.

When set to yes the SD card will be automatically inserted at the start of simulation,

Otherwise you must manually click the card on the panel to insert.

File:SlaveComms.jpg

2014-01-30T15:12:43Z

Admin:

File:USB Slave Driver.zip

2014-01-30T15:09:47Z

Admin:

File:USBSlaveInstance.jpg

2014-01-30T15:08:32Z

Admin:

File:USB Slave Sim.fcfx

2014-01-30T15:08:32Z

Admin:

File:SlaveProps.jpg

2014-01-30T15:08:32Z

Admin:

File:SlaveMacroSetup.jpg

2014-01-30T15:08:32Z

Admin:

File:SlaveDevManager.jpg

2014-01-30T15:08:32Z

Admin:

File:USB Slave.fcfx

2014-01-30T15:08:31Z

Admin:

File:USB Serial Sim.fcfx

2014-01-30T12:30:26Z

Admin: Admin uploaded a new version of "File:USB Serial Sim.fcfx"

File:USB Serial.fcfx

2014-01-30T12:30:26Z

Admin: Admin uploaded a new version of "File:USB Serial.fcfx"

File:SerialComms.jpg

2014-01-30T12:28:54Z

Admin:

File:SerialProps.jpg

2014-01-30T12:28:54Z

Admin:

File:DeviceManager.jpg

2014-01-30T12:28:53Z

Admin:

File:USB Serial.fcfx

2014-01-30T12:19:34Z

Admin:

File:USB Serial Sim.fcfx

2014-01-30T12:19:34Z

Admin:

Simulation Events

2014-01-24T09:15:31Z

Admin:

<sidebar>Sidebar: What Is a Macro?</sidebar>
[[File:ProjectExplorerEventsTab.jpg|right]]
A Flowcode simulation event is similar to an [[Interrupt Icon Properties|Interrupt]] but aimed at performing a specific job. The events will not be referenced at all for downloaded microcontroller code but may be used in the generation of such code.

Another key difference between events and interrupts is that events can occur at any time whereas interrupts can only occur whilst the simulation is running.

===Event Management===
The [[Project Explorer]] events tab is used to list all the available events and provides a quick way of seeing which events are active in your Flowcode project.

When an event is active a small macro icon will appear next to the event.

By hovering over the events you can see a short description of when the event will be called and what parameters will be passed to it.

By double clicking the event you can edit the macro assigned to it. Double clicking the macro item will automatically add an event macro for you with a name specific to the event name. Selecting disabled will deactivate the event and prevent it from firing.

Each event macro will have a return variable which may or may not be used internally by Flowcode, refer to the event description for specific details.

The [[Component Debugger]] window has a option to log events as they are fired which is useful for debugging purposes.

Full details surrounding each of the events in Flowcode can be found here [[Event_Reference]].

===Video instructions===
The [http://www.youtube.com/watch?v=DflA2gULQuw&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ&index=26 Simulation Events] video consists of an overview of the simulation events and a demonstration of the [[Event Mouse.Click|Mouse.Click]] event by creating the macro Ev_Click event macro and using a [[Simulation Macro Icon Properties|Simulation Macro]] to change the colour of an object.

<div align="center">
{{#ev:youtube|DflA2gULQuw|640}}
</div>

File:GetVarSizeEvent.jpg

2014-01-23T16:36:48Z

Admin:

File:GetVarSizeMacro.jpg

2014-01-23T16:36:48Z

Admin:

File:GetVarSize.fcfx

2014-01-23T16:36:47Z

Admin:

Event Compile.GetVarSize

2014-01-23T16:36:09Z

Admin: /* Examples */

<sidebar>Event Contents</sidebar>
Sent to a component to amend the size of the expected array

This event is part of the [[Event class Compile|Compile]] class

__TOC__

==Parameters==
[[Variable Types|STRING]] ''VarName''
:The original Flowcode variable

[[Variable Types|ULONG]] ''Elements''
:The number of elements in the array
:''This parameter is returned back to Flowcode''

==Return value==
[[Variable Types|ULONG]]
The return of this event is currently unused

==Detailed description==
''No additional information''

==Examples==

On some microcontroller devices there are sometimes limitation on the size of a single data array or other reasons to adjust the size of a variable based on a set of parameters etc.

For example if we try and create an array of size bigger then 256 bytes then this will cause a compilation error.

'''#define FCVsz_DATAARRAY 500'''

'''GetVarSize.c(53): error: total number of array elements can not exceed 0x100'''

By enabling the GetVarSizeevent we can override the number of elements in the array.

[[File:GetVarSizeEvent.jpg]]

Inside the event macro we check for the name of the variable with the size we want to override and overwrite the .Elements local variable to edit the array size.

[[File:GetVarSizeMacro.jpg]]

After saving the project and refreshing the C code window the variable now looks like this.

'''#define FCVsz_DATAARRAY 255'''

And during compilation we now get this.

'''success'''

Here is the file as a demonstration.

{{Fcfile|GetVarSize.fcfx|Get Var Size Event Example}}

File:FarMem.jpg

2014-01-22T16:40:02Z

Admin:

Event Compile.AddVar

2014-01-22T16:39:45Z

Admin: /* Examples */

<sidebar>Event Contents</sidebar>
Sent to a component to allow dynamic amendment of global constant declarations

This event is part of the [[Event class Compile|Compile]] class

__TOC__

==Parameters==
[[Variable Types|STRING]] ''VarName''
:The original Flowcode variable

[[Variable Types|STRING]] ''ExpandName''
:The expanded variable name

[[Variable Types|STRING]] ''Expansion''
:The expanded string to inline to the code
:''This parameter is returned back to Flowcode''

==Return value==
[[Variable Types|ULONG]]
Non-zero to include definition - initialised on call

==Detailed description==
''No additional information''

==Examples==

On some PIC devices there are sometimes two types of RAM memory due to bus limitations, near and far. Near memory is fast to access but is limited by the size of the internal bus. Far memory is much less limited but means additional overhead when fetching or storing values.

[[File:FarMem.jpg]]

When creating Flowcode variables these will default to being stored in near memory to optimise the time to fetch and store values. If you run out of room in near memory then you may get a message like this during compilation.

'''C:\Users\BenR\Desktop\FarMem.o: Link Error: Could not allocate section .nbss, size = 4118 bytes, attributes = bss near'''

'''Link Error: Could not allocate data memory'''

To tell the compiler to move the variable into FAR memory in C you would do something like this.

'''__attribute__((far)) unsigned char data[4096];'''

The Flowcode variable defaults to something like this.

'''MX_GLOBAL MX_UINT8 FCV_DATA[FCVsz_DATA]; // Large Data Array'''

The AddVar event is used during the compile to C process to take the variables from the variable manager and generate the necessary C code. By calling a macro to run on this event we can tailor the way the variables are added to the C and add in the cast to FAR memory.

[[File:AdVar.jpg]]

The first thing we need to do in the macro is compare the name of the variable that is currently being processed with the name of the variable we want to store into FAR memory. The string compare function returns 0 if the two strings match up so in the No branch of the decision we then add the "__attribute__((far)) " string to the expansion string.

[[File:EvAddVar.jpg]]

After saving the project and refreshing the C code window the variable now looks like this.

'''__attribute__((far)) MX_GLOBAL MX_UINT8 FCV_DATA[FCVsz_DATA]; // Large Data Array'''

And during compilation we now get this.

'''Total data memory used (bytes): 0x1116 (4374) 15%'''

'''...'''

'''HEX file creation successful!'''

Here is the file as a demonstration.

[[File:FarMem.fcfx]]

Event Contents

2014-01-22T16:19:41Z

Admin:

API Contents

2014-01-22T16:19:16Z

Admin: