Difference between revisions of "Component: Serial EEPROM (24C32) (Storage)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
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
−
| 2.0 (Release)
+
| 2.2
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Storage
 
| Storage
 
|}
 
|}
  
  
 +
==Serial EEPROM (24C32) component==
 +
Serial (I2C) EEPROM component for 24C32  Can be added to a MIAC project to give read and write access to the internal non-volatile  memory device (if fitted, depending upon model).
  
−
==[[File:Component Icon 35934f36_5cda_49e7_b1a0_05c85722d858.png|Image]] Serial EEPROM (24C32) component==
+
==Detailed description==
−
Serial (I2C) EEPROM component for 24C32
 
−
Can be added to a MIAC project to give read and write access to the internal non-volatile
 
−
memory device (if fitted, depending upon model).
 
  
 +
''No detailed description exists yet for this component''
  
 
==Examples==
 
==Examples==
 +
 +
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
  
Line 27: Line 27:
 
==Downloadable macro reference==
 
==Downloadable macro reference==
  
−
===<span style="font-weight: normal;"><u><tt>Read</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Read and return the value of the EEPROM at the given address
+
|-
 +
| 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" | Read and return the value of the EEPROM at the given 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-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
'''Parameters'''
 
  
−
:[[Variable Types|UINT]] ''address''
+
{| 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" | Write the given data value to the EEPROM at the given address&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | address
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| 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''
 +
|}
  
  
−
'''Return value'''
+
{| 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;" | '''WritePage'''
 +
|-
 +
| colspan="2" | Write the given data value to the EEPROM at the given address&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | address
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | data
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | count
 +
|-
 +
| colspan="2" | Range: 1-128&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''
 +
|}
  
−
:[[Variable Types|BYTE]]
 
  
 +
{| 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;" | '''GetDate'''
 +
|-
 +
| colspan="2" | Collects the day of the month as a numeric value in the range of 1 - 31.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>Write</tt></u></span>===
 
−
Write the given data value to the EEPROM at the given address
 
  
−
'''Parameters'''
+
{| 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;" | '''SetTimeServer'''
 +
|-
 +
| colspan="2" | Overwrites the default time server setting allowing for multiple time servers to be queried.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | TimeServer
 +
|-
 +
| colspan="2" | e.g. "pool.ntp.org"&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''
 +
|}
  
−
:[[Variable Types|UINT]] ''address''
 
  
−
:[[Variable Types|BYTE]] ''data''
+
{| 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;" | '''GetMonth'''
 +
|-
 +
| colspan="2" | Collects the month as a numeric value in the range of 1 - 12.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 
  
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 +
|-
 +
| colspan="2" | Configures the timeserver variable as well as sets the timezone offset in seconds.&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''
 +
|}
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
{| 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;" | '''SetUTCOffset'''
 +
|-
 +
| colspan="2" | Allows the UTC Offset to be defined in seconds. e.g. for BST use 3600 or for UTC+2 use 7200 or for UTC-2 use -7200&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | UTCOffset
 +
|-
 +
| colspan="2" | Time offset in seconds&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''
 +
|}
  
  
 +
{| 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;" | '''Initialise'''
 +
|-
 +
| colspan="2" | Configures each matching sensor on the bus with the specified conversion bits.&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''
 +
|}
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
 
  
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Device Address</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DEVICE_ADDRESS''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Device address bits, these must match the address pins on the EEPROM IC.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
<span style="font-weight: normal;"><u>Channel</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::CHANNEL''.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''  
−
Channel selection
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Baud Select</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Device Address
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::BAUD_LIST''.
+
|-
−
 
+
| colspan="2" | Device address bits, these must match the address pins on the EEPROM IC.&nbsp;
−
Baud rate option selector
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
<span style="font-weight: normal;"><u>Baud Rate</u></span>
+
| width="90%" | Channel
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''cal_i2c1::BAUD''.
+
| colspan="2" | Channel selection&nbsp;
−
 
+
|-
−
Baud rate to be used
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Baud Select
−
<span style="font-weight: normal;"><u>Stop Delay</u></span>
+
|-
−
 
+
| colspan="2" | Baud rate option selector&nbsp;
−
This property is of type ''True or false'' and can be referenced with the variable name ''cal_i2c1::StopDel''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not  
+
| width="90%" | Baud Rate
−
 
+
|-
−
a 10ms delay between an I2C stop event and the next I2C start event.
+
| colspan="2" | Baud rate to be used&nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Stop Delay
−
Most modern microcontrollers will not have a problem so this property can be disabled to speed up the  
+
|-
−
 
+
| colspan="2" | On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications. &nbsp;
−
I2C communications.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
<span style="font-weight: normal;"><u>SDA</u></span>
+
| width="90%" | SDA
−
 
+
|-
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_i2c1::SDA''.
+
| colspan="2" | Pin used for SDA (data signal)&nbsp;
−
 
+
|-
−
Pin used for SDA (data signal)
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | SCL
−
<span style="font-weight: normal;"><u>SDA Remap Pin</u></span>
+
|-
−
 
+
| colspan="2" | Pin used for SCL (clock signal)&nbsp;
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::SDAPins''.
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
''<span style="color:red;">No additional information</span>''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''  
−
 
+
|-
−
 
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
<span style="font-weight: normal;"><u>SCL</u></span>
+
| width="90%" | Scope Traces
−
 
+
|-
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_i2c1::SCL''.
+
| colspan="2" | Selects if the component pin connections are automatically generated on the data recorder window or not. Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion. No: Do not show the pin signals on the data recorder window.&nbsp;
−
 
+
|-
−
Pin used for SCL (clock signal)
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Console Data
−
<span style="font-weight: normal;"><u>SCL Remap Pin</u></span>
+
|-
−
 
+
| colspan="2" | Selects if the console data is automatically generated or not&nbsp;
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::SCLPins''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
''<span style="color:red;">No additional information</span>''
+
| width="90%" | API
−
 
+
|-
−
 
+
| colspan="2" | &nbsp;
−
 
+
|}
−
<span style="font-weight: normal;"><u>Scope Traces</u></span>
 
−
 
 
−
This property is of type ''True or false'' and can be referenced with the variable name ''cal_i2c1::ScopeTraces''.
 
−
 
 
−
Selects if the component pin connections are automatically generated on the data recorder window or not.
 
−
 
 
−
Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion.
 
−
 
 
−
No: Do not show the pin signals on the data recorder window.
 
−
 
 
−
<span style="font-weight: normal;"><u>Console Data</u></span>
 
−
 
 
−
This property is of type ''True or false'' and can be referenced with the variable name ''cal_i2c1::ConsoleData''.
 
−
 
 
−
Selects if the console data is automatically generated or not
 
−
 
 
−
<span style="font-weight: normal;"><u>Injector</u></span>
 
−
 
 
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::Injector''.
 
−
 
 
−
''<span style="color:red;">No additional information</span>''
 

Revision as of 20:58, 16 November 2021

Author Matrix TSL
Version 2.2
Category Storage


Serial EEPROM (24C32) component

Serial (I2C) EEPROM component for 24C32 Can be added to a MIAC project to give read and write access to the internal non-volatile memory device (if fitted, depending upon model).

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png Read
Read and return the value of the EEPROM at the given address 
Fc9-u16-icon.png - UINT address
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png Write
Write the given data value to the EEPROM at the given address 
Fc9-u16-icon.png - UINT address
 
Fc9-u8-icon.png - BYTE data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WritePage
Write the given data value to the EEPROM at the given address 
Fc9-u16-icon.png - UINT address
 
Fc9-u8-icon.png - BYTE data
 
Fc9-u8-icon.png - BYTE count
Range: 1-128 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetDate
Collects the day of the month as a numeric value in the range of 1 - 31. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png SetTimeServer
Overwrites the default time server setting allowing for multiple time servers to be queried. 
Fc9-string-icon.png - STRING TimeServer
e.g. "pool.ntp.org" 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetMonth
Collects the month as a numeric value in the range of 1 - 12. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png Initialise
Configures the timeserver variable as well as sets the timezone offset in seconds. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetUTCOffset
Allows the UTC Offset to be defined in seconds. e.g. for BST use 3600 or for UTC+2 use 7200 or for UTC-2 use -7200 
[[File:]] - UTCOffset
Time offset in seconds 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
Configures each matching sensor on the bus with the specified conversion bits. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Device Address
Device address bits, these must match the address pins on the EEPROM IC. 
Fc9-type-16-icon.png Channel
Channel selection 
Fc9-type-16-icon.png Baud Select
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
Baud rate to be used 
Fc9-type-7-icon.png Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.  
Fc9-type-5-icon.png SDA
Pin used for SDA (data signal) 
Fc9-type-5-icon.png SCL
Pin used for SCL (clock signal) 
Fc9-conn-icon.png Simulations
Fc9-type-7-icon.png Scope Traces
Selects if the component pin connections are automatically generated on the data recorder window or not. Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion. No: Do not show the pin signals on the data recorder window. 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-16-icon.png API
 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Serial_EEPROM_(24C32)_(Storage)&oldid=25566"