Component: EEPROM (EEPROM)

From Flowcode Help
Revision as of 12:19, 3 February 2023 by Wiki bot (talk | contribs)
Jump to navigationJump to search
Author Matrix Ltd
Version 1.2
Category EEPROM


EEPROM component

A means of reading data from and writing data to the EEPROM memory onboard the microcontroller. Fully functional with simulation but the target microcontroller must have EEPROM memory available to allow compilation to work.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_temp/EEPROM.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/EEPROM.fcfx

Detailed description

No detailed description exists yet for this component

Examples

The Console window can be used to show the contents of EE memory during simulation.

Image


Read and Write Bytes

Reads a value from location 0 in the EEPROM and writes back the value incremented by one, the values are displayed on to a LCD.

Starting and stopping the simulation or resetting the microcontroller will allow the program to resume counting from where it left off as opposed to a standard RAM based variable which would reset to an undetermined value. FC6 Icon.png EEPROM

Read and Write Ints

Reads a value from locations 0,1 in the EEPROM and writes back the value incremented by one, the values are displayed on to a LCD.

Starting and stopping the simulation or resetting the microcontroller will allow the program to resume counting from where it left off as opposed to a standard RAM based variable which would reset to an undetermined value. FC6 Icon.png EEPROM_INT

String variables in EE Memory

Example showing how to store and retrieve strings to and from the EEPROM memory. FC6 Icon.png EEStrings





Macro reference

Read

Fc9-comp-macro.png Read
Reads a packet of bits from the EEPROM The number of bits read is 8 or 16, depending on the platform  
Fc9-u16-icon.png - UINT Address
The address, in elements, to read the data from 
Fc9-u16-icon.png - UINT Return


ReadByte

Fc9-comp-macro.png ReadByte
Reads a 8-bit byte value starting from the specified address. A 8-bit byte will consume 1 byte which will be 1 locations on an 8-bit device or half a location on a 16-bit device. 
Fc9-u16-icon.png - UINT ByteAddress
Byte address, EEADDR on 8-bit device or EEADDR/2 on a 16-bit device 
Fc9-bool-icon.png - BOOL MSBFirst
0=LSB First, 1=MSB First 
Fc9-u8-icon.png - BYTE Return


ReadFloat

Fc9-comp-macro.png ReadFloat
Reads a 32-bit float value starting from the specified address. A 32-bit float will consume 4 bytes which will be 4 locations on an 8-bit device or 2 locations on a 16-bit device. 
Fc9-u16-icon.png - UINT StartAddress
Initial EE location to start reading 
Fc9-bool-icon.png - BOOL MSBFirst
0=LSB First, 1=MSB First 
Fc9-f32-icon.png - FLOAT Return


ReadInt

Fc9-comp-macro.png ReadInt
Reads a 16-bit int value starting from the specified address. A 16-bit int will consume 2 bytes which will be 2 locations on an 8-bit device or 1 location on a 16-bit device. 
Fc9-u16-icon.png - UINT StartAddress
Initial EE location to start reading 
Fc9-bool-icon.png - BOOL MSBFirst
0=LSB First, 1=MSB First 
Fc9-u16-icon.png - UINT Return


ReadLong

Fc9-comp-macro.png ReadLong
Reads a 32-bit long value starting from the specified address. A 32-bit long will consume 4 bytes which will be 4 locations on an 8-bit device or 2 locations on a 16-bit device. 
Fc9-u16-icon.png - UINT StartAddress
Initial EE location to start reading 
Fc9-bool-icon.png - BOOL MSBFirst
0=LSB First, 1=MSB First 
Fc9-u32-icon.png - ULONG Return


ReadString

Fc9-comp-macro.png ReadString
Reads a string of data from the EE memory starting at the specified address. 8-bit EE memory stores a character into each memory location. 16-bit EE memory stores two characters into each memory location. 
Fc9-u16-icon.png - UINT StartAddress
EE Address of the first character in the string 
Fc9-u8-icon.png - BYTE MaxChars
The maximum number of characters to try and read plus null termination 
Fc9-string-icon.png - STRING Return


Write

Fc9-comp-macro.png Write
Writes a packet of bits from the EEPROM The number of bits written is 8 or 16, depending on the platform  
Fc9-u16-icon.png - UINT Address
The address, in elements, to write the data to 
Fc9-u16-icon.png - UINT Value
The 8 or 16 bit value to store in EEPROM 
Fc9-void-icon.png - VOID Return


WriteByte

Fc9-comp-macro.png WriteByte
Writes a 8-bit byte value to the specified address. A 8-bit byte will consume 1 bytes which will be 1 locations on an 8-bit device or half a location on a 16-bit device. 
Fc9-u16-icon.png - UINT ByteAddress
Byte address, EEADDR on 8-bit device or EEADDR/2 on a 16-bit device 
Fc9-u8-icon.png - BYTE Value
Floating point value to write 
Fc9-void-icon.png - VOID Return


WriteFloat

Fc9-comp-macro.png WriteFloat
Writes a 32-bit float value starting at the specified address. A 32-bit float will consume 4 bytes which will be 4 locations on an 8-bit device or 2 locations on a 16-bit device. 
Fc9-u16-icon.png - UINT StartAddress
Initial EE location to start reading 
Fc9-f32-icon.png - FLOAT Value
Floating point value to write 
Fc9-bool-icon.png - BOOL MSBFirst
0=LSB First, 1=MSB First 
Fc9-void-icon.png - VOID Return


WriteInt

Fc9-comp-macro.png WriteInt
Writes a 16-bit int value starting at the specified address. A 16-bit int will consume 2 bytes which will be 2 locations on an 8-bit device or 1 location on a 16-bit device. 
Fc9-u16-icon.png - UINT StartAddress
Initial EE location to start reading 
Fc9-u16-icon.png - UINT Value
Floating point value to write 
Fc9-bool-icon.png - BOOL MSBFirst
0=LSB First, 1=MSB First 
Fc9-void-icon.png - VOID Return


WriteLong

Fc9-comp-macro.png WriteLong
Writes a 32-bit long value starting at the specified address. A 32-bit long will consume 4 bytes which will be 4 locations on an 8-bit device or 2 locations on a 16-bit device. 
Fc9-u16-icon.png - UINT StartAddress
Initial EE location to start reading 
Fc9-u32-icon.png - ULONG Value
Floating point value to write 
Fc9-bool-icon.png - BOOL MSBFirst
0=LSB First, 1=MSB First 
Fc9-void-icon.png - VOID Return


WriteString

Fc9-comp-macro.png WriteString
Writes a string of data to the EE memory starting at the specified address. 8-bit EE memory stores a character into each memory location. 16-bit EE memory stores two characters into each memory location. 
Fc9-u16-icon.png - UINT StartAddress
EE Address of the first character in the string 
Fc9-u8-icon.png - BYTE MaxChars
The maximum number of characters to try and read plus null termination 
Fc9-string-icon.png - STRING DataString
 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-10-icon.png EE Size
Number of memory locations available in EEPROM onboard the target microcontroller. 
Fc9-type-10-icon.png EE Bit Depth
Number of bits in each EEPROM memory location onboard the target microcontroller. 
Fc9-type-10-icon.png Initial Values
Comma seperated list of values to assign to the EEPROM memory while programming the device. The simulation will automatically load these values into the simulated EE locations on simulation start. Leave blank to remove initialisation code from the compiled C code Supported Formats Decimal 0 - 255 Hexadecimal 0x00 - 0xFF ASCII character 'x' Strings "text" 
Fc9-type-7-icon.png Reset To Defaults
Decides what to do on a simulation start event. Siim data will reset to initial values after reloading project or changing initial values property. Yes: Resets the contents of the EEPROM data to the initial values. No: EEPROM contents will be retained between simulations.