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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Storage
 
| Storage
 
|}
 
|}
  
  
 +
==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.
  
−
==[[File:Component Icon 06829bc6_9e27_4353_9d95_3ba9dabc3384.png|Image]] Flash EEPROM component==
+
==Component Pack==
−
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.
 
  
−
==Examples==
+
FREE
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
−
==Downloadable macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>Read</tt></u></span>===
 
−
Reads a single value from the Flash EEPROM at the specified address
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|UINT]] ''Address''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|ULONG]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>Write</tt></u></span>===
 
−
Writes a single value to the Flash EEPROM at the specified address
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|UINT]] ''Address''
+
''No detailed description exists yet for this component''
  
−
:[[Variable Types|ULONG]] ''Data''
+
==Examples==
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
 
  
  
−
==Property reference==
 
−
<span style="font-weight: normal;"><u>Enabled</u></span>
 
  
−
This property is of type ''True or false'' and can be referenced with the variable name ''Enabled''.
 
  
−
Is the Flash EEPROM component  currently supported on the selected MCU device?
 
  
−
<span style="font-weight: normal;"><u>Number Of Values</u></span>
+
''<span style="color:red;">No additional examples</span>''
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''NumValues''.
 
  
−
Number of individual values that can be read and written using the component.
+
==Downloadable macro reference==
  
−
The more values you want the bigger the RAM buffer required to store the data when performing a write.
+
{| 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&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
<span style="font-weight: normal;"><u>Flash Page</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''FlashPage''.
+
{| 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&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
Flash Page to use as EEPROM
 
  
−
<span style="font-weight: normal;"><u>Flash Address</u></span>
 
  
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''FlashAddress''.
 
  
−
''<span style="color:red;">No additional information</span>''
+
==Property reference==
  
−
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
<span style="font-weight: normal;"><u>Initialiser</u></span>
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
This property is of type ''Line of text'' and can be referenced with the variable name ''Initaliser''.
+
|-
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| 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?&nbsp;
−
<span style="font-weight: normal;"><u>Bits Per Value</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''BitsPerVal''.
+
| width="90%" | Number Of Values
−
 
+
|-
−
Number of bits available when initialising the Flash memory.
+
| 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. &nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Bits Per Instruction</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Flash Page
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''BitsPerInst''.
+
|-
−
 
+
| colspan="2" | Flash Page to use as EEPROM&nbsp;
−
Number of bits that can be stored or retreived using a single flash address
+
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Flash Address
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Initialiser
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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&nbsp;
 +
|}

Latest revision as of 17:24, 9 November 2022

Author Matrix TSL
Version 1.0
Category Storage


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 Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable 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 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Flash_EEPROM_(Storage)&oldid=28878"