Difference between revisions of "Component: Flash EEPROM (EEPROM)"

From Flowcode Help
Jump to navigationJump to search
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_FlashEE.fcfx FC_Comp_Source_FlashEE.fcfx]
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_FlashEE.fcfx FC_Comp_Source_FlashEE.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_FlashEE.fcfx FC_Comp_Source_FlashEE.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_FlashEE.fcfx FC_Comp_Source_FlashEE.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 44: Line 46:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 68: Line 72:
  
 
==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;" | '''Read'''
 +
|-
 +
| colspan="2" | Reads a single value from the Flash EEPROM at the specified address 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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;" | '''Write'''
 +
|-
 +
| colspan="2" | Writes a single value to the Flash EEPROM at the specified address 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| 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''
 +
|}
 +
 +
 +
 +
 +
==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-7-icon.png]]
 +
| width="90%" | Enabled
 +
|-
 +
| colspan="2" | Is the Flash EEPROM component  currently supported on the selected MCU device? 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Number Of Values
 +
|-
 +
| colspan="2" | Number of individual values that can be read and written using the component. The more values you want the bigger the RAM buffer required to store the data when performing a write.  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Flash Page
 +
|-
 +
| colspan="2" | Flash Page to use as EEPROM 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Flash Address
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Initialiser
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Bits Per Value
 +
|-
 +
| colspan="2" | Number of bits available when initialising the Flash memory. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Bits Per Instruction
 +
|-
 +
| colspan="2" | Number of bits that can be stored or retreived using a single flash address 
 +
|}==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 TSL
Version 1.0
Category EEPROM


Flash EEPROM component

Provides an emulated version of EEPROM using the microcontrollers on-board flash program memory. Requires a microcontroller with write and erase access to the flash memory.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Macro reference

Fc9-comp-macro.png Read
Reads a single value from the Flash EEPROM at the specified address 
Fc9-u16-icon.png - UINT Address
 
Fc9-u32-icon.png - ULONG Return


Fc9-comp-macro.png Write
Writes a single value to the Flash EEPROM at the specified address 
Fc9-u16-icon.png - UINT Address
 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-7-icon.png Enabled
Is the Flash EEPROM component currently supported on the selected MCU device? 
Fc9-type-16-icon.png Number Of Values
Number of individual values that can be read and written using the component. The more values you want the bigger the RAM buffer required to store the data when performing a write.  
Fc9-type-16-icon.png Flash Page
Flash Page to use as EEPROM 
Fc9-type-21-icon.png Flash Address
 
Fc9-type-10-icon.png Initialiser
 
Fc9-type-21-icon.png Bits Per Value
Number of bits available when initialising the Flash memory. 
Fc9-type-21-icon.png Bits Per Instruction
Number of bits that can be stored or retreived using a single flash address 

==Macro reference==

Fc9-comp-macro.png Read
Reads a single value from the Flash EEPROM at the specified address 
Fc9-u16-icon.png - UINT Address
 
Fc9-u32-icon.png - ULONG Return


Fc9-comp-macro.png Write
Writes a single value to the Flash EEPROM at the specified address 
Fc9-u16-icon.png - UINT Address
 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-7-icon.png Enabled
Is the Flash EEPROM component currently supported on the selected MCU device? 
Fc9-type-16-icon.png Number Of Values
Number of individual values that can be read and written using the component. The more values you want the bigger the RAM buffer required to store the data when performing a write.  
Fc9-type-16-icon.png Flash Page
Flash Page to use as EEPROM 
Fc9-type-21-icon.png Flash Address
 
Fc9-type-10-icon.png Initialiser
 
Fc9-type-21-icon.png Bits Per Value
Number of bits available when initialising the Flash memory. 
Fc9-type-21-icon.png Bits Per Instruction
Number of bits that can be stored or retreived using a single flash address 

==Macro reference==

Fc9-comp-macro.png Read
Reads a single value from the Flash EEPROM at the specified address 
Fc9-u16-icon.png - UINT Address
 
Fc9-u32-icon.png - ULONG Return


Fc9-comp-macro.png Write
Writes a single value to the Flash EEPROM at the specified address 
Fc9-u16-icon.png - UINT Address
 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-7-icon.png Enabled
Is the Flash EEPROM component currently supported on the selected MCU device? 
Fc9-type-16-icon.png Number Of Values
Number of individual values that can be read and written using the component. The more values you want the bigger the RAM buffer required to store the data when performing a write.  
Fc9-type-16-icon.png Flash Page
Flash Page to use as EEPROM 
Fc9-type-21-icon.png Flash Address
 
Fc9-type-10-icon.png Initialiser
 
Fc9-type-21-icon.png Bits Per Value
Number of bits available when initialising the Flash memory. 
Fc9-type-21-icon.png Bits Per Instruction
Number of bits that can be stored or retreived using a single flash address 

==Macro reference==

Fc9-comp-macro.png Read
Reads a single value from the Flash EEPROM at the specified address 
Fc9-u16-icon.png - UINT Address
 
Fc9-u32-icon.png - ULONG Return


Fc9-comp-macro.png Write
Writes a single value to the Flash EEPROM at the specified address 
Fc9-u16-icon.png - UINT Address
 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-7-icon.png Enabled
Is the Flash EEPROM component currently supported on the selected MCU device? 
Fc9-type-16-icon.png Number Of Values
Number of individual values that can be read and written using the component. The more values you want the bigger the RAM buffer required to store the data when performing a write.  
Fc9-type-16-icon.png Flash Page
Flash Page to use as EEPROM 
Fc9-type-21-icon.png Flash Address
 
Fc9-type-10-icon.png Initialiser
 
Fc9-type-21-icon.png Bits Per Value
Number of bits available when initialising the Flash memory. 
Fc9-type-21-icon.png Bits Per Instruction
Number of bits that can be stored or retreived using a single flash address