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

From Flowcode Help
Jump to navigationJump to search
Line 1: Line 1:
 
+
{| style="width:50%"
 
 
{| width="50%"
 
 
|-
 
|-
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| MatrixTSL
 
| MatrixTSL
 
|-
 
|-
| 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
 
|}
 
|}
  
  
 +
==EEPROM (DS28E07) component==
 +
A rugged EEPROM allowing one or more devices to be addressed and accessed. Requires a One Wire component to perform the bus operations.
  
==[[File:Component Icon d96f06b4_e7cc_4222_831e_520b53cfa278.png|Image]] EEPROM (DS28E07) component==
+
==Detailed description==
A rugged EEPROM allowing one or more devices to be addressed and accessed.
+
 
Requires a One Wire component to perform the bus operations.
+
''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 25: Line 27:
 
==Downloadable macro reference==
 
==Downloadable macro reference==
  
===<span style="font-weight: normal;"><u><tt>SetString</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Writes a string to the EE memory starting at the selected address.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetString'''
 +
|-
 +
| colspan="2" | Writes a string to the EE memory starting at the selected address. All bytes from the string will be written including the null termination.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Address of the value to write&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | Data string to write&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''
 +
|}
  
All bytes from the string will be written including the null termination.
 
  
'''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;" | '''GetString'''
 +
|-
 +
| colspan="2" | Gets a string from the specified start address.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Address of the first data byte&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | MaxLength
 +
|-
 +
| colspan="2" | Maximum number of bytes in the string, also includes null termination byte&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
:[[Variable Types|UINT]] ''Address''
 
::Address of the value to write
 
  
:[[Variable Types|<- STRING]] ''Value''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
::Data string to write
+
|-
::''This parameter may be returned back to the caller''
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetByteArray'''
 +
|-
 +
| colspan="2" | Writes an array of bytes to the EE memory.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Starting address of the first value to write&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" | Number of bytes to write to the EE memory, Range: 1 to 128 bytes&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;" | '''SetInt'''
 +
|-
 +
| colspan="2" | Writes a 16-bit value to the EE memory. For consecutive 16-bit values the address must be incremented by 2.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Address of the value to write&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | 16-bit value to write&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | MSBFirst
 +
|-
 +
| colspan="2" | 0: LSB is the first byte, 1: MSB is the first byte&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''
 +
|}
  
:''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;" | '''AddressSpecificDevice'''
 +
|-
 +
| colspan="2" | Starts a temperature conversion on a specific device using a hex string identifier. SerialNumber parameter should be 12 characters and contain the 48-bit Serial.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | SerialNumber
 +
|-
 +
| colspan="2" | 48-bit Serial Number e.g. "32DF4A3C1901"&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''
 +
|}
  
===<span style="font-weight: normal;"><u><tt>GetString</tt></u></span>===
 
Gets a string from the specified start 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;" | '''GetSerialString'''
 +
|-
 +
| colspan="2" | Gets the Serial String for the current addressed device.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
:[[Variable Types|UINT]] ''Address''
 
::Address of the first data byte
 
  
:[[Variable Types|BYTE]] ''MaxLength''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
::Maximum number of bytes in the string, also includes null termination byte
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AddressNextDevice'''
 +
|-
 +
| colspan="2" | Scans for the next connected device with a matching family code. Goes through the device list generated by the ScanBus macro.&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;" | '''SetLong'''
 +
|-
 +
| colspan="2" | Writes a 32-bit value to the EE memory. For consecutive 32-bit values the address must be incremented by 4.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Address of the value to write&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | 32-bit value to write&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | MSBFirst
 +
|-
 +
| colspan="2" | 0: LSB is the first byte, 1: MSB is the first byte&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|STRING]]
 
  
 +
{| 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;" | '''GetFloat'''
 +
|-
 +
| colspan="2" | Reads a 32-bit floating point value starting from the specified byte address. For consecutive float values the address must be incremented by 4.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | The starting byte address&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | MSBFirst
 +
|-
 +
| colspan="2" | 0: LSB is the first byte, 1: MSB is the first byte&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
===<span style="font-weight: normal;"><u><tt>SetByteArray</tt></u></span>===
 
Writes an array of bytes to the EE memory.
 
  
'''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;" | '''GetLong'''
 +
|-
 +
| colspan="2" | Reads a 32-bit value starting from the specified byte address. For consecutive 32-bit values the address must be incremented by 4.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | The starting byte address&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | MSBFirst
 +
|-
 +
| colspan="2" | 0: LSB is the first byte, 1: MSB is the first byte&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''
 +
|}
  
:[[Variable Types|UINT]] ''Address''
 
::Starting address of the first value to write
 
  
:[[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;" | '''GetInt'''
 +
|-
 +
| colspan="2" | Reads a 16-bit value starting from the specified byte address. For consecutive 16-bit values the address must be incremented by 2.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | The starting byte address&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | MSBFirst
 +
|-
 +
| colspan="2" | 0: LSB is the first byte, 1: MSB is the first byte&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
:[[Variable Types|BYTE]] ''Count''
 
::Number of bytes to write to the EE memory, Range: 1 to 128 bytes
 
  
 +
{| 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;" | '''GetByteArray'''
 +
|-
 +
| colspan="2" | Reads an array of bytes starting from the selected address.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Starting address of the first value to read&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | Byte array to store incoming data&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Count
 +
|-
 +
| colspan="2" | Number of bytes to read from the EE memory, Range: 1 to 128 bytes&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;" | '''SetByte'''
 +
|-
 +
| colspan="2" | Writes a single byte to the EE memory.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Address of the value to write&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''
 +
|}
  
  
===<span style="font-weight: normal;"><u><tt>SetInt</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Writes a 16-bit value to the EE memory.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetByte'''
 +
|-
 +
| colspan="2" | Reads a single byte from the selected address.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Address of the value to read&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''
 +
|}
  
For consecutive 16-bit values the address must be incremented by 2.
 
  
'''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;" | '''SetFloat'''
 +
|-
 +
| colspan="2" | Writes a 32-bit floating point value to the EE memory. For consecutive float values the address must be incremented by 4.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Address of the value to write&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | Floating point value to write&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | MSBFirst
 +
|-
 +
| colspan="2" | 0: LSB is the first byte, 1: MSB is the first byte&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''
 
::Address of the value to write
 
  
:[[Variable Types|UINT]] ''Value''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
::16-bit value to write
+
|-
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
:[[Variable Types|BOOL]] ''MSBFirst''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
::0: LSB is the first byte, 1: MSB is the first byte
+
|-
 
+
| colspan="2" | Configures each matching sensor on the bus with the specified conversion bits.&nbsp;
 
+
|-
'''Return value'''
+
|-
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
:''This call does not return a value''
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
+
|}
 
 
===<span style="font-weight: normal;"><u><tt>AddressSpecificDevice</tt></u></span>===
 
Starts a temperature conversion on a specific device using a hex string identifier.
 
 
 
SerialNumber parameter should be 12 characters and contain the 48-bit Serial.
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|<- STRING]] ''SerialNumber''
 
::48-bit Serial Number e.g. "32DF4A3C1901"
 
::''This parameter may be returned back to the caller''
 
 
 
 
 
'''Return value'''
 
 
 
:''This call does not return a value''
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>AddressNextDevice</tt></u></span>===
 
Scans for the next connected device with a matching family code.
 
 
 
Goes through the device list generated by the ScanBus macro.
 
 
 
'''Parameters'''
 
 
 
:''This macro has no parameters''
 
 
 
 
 
'''Return value'''
 
 
 
:''This call does not return a value''
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>GetSerialString</tt></u></span>===
 
Gets the Serial String for the current addressed device.
 
 
 
'''Parameters'''
 
 
 
:''This macro has no parameters''
 
 
 
 
 
'''Return value'''
 
 
 
:[[Variable Types|STRING]]
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>SetLong</tt></u></span>===
 
Writes a 32-bit value to the EE memory.
 
 
 
For consecutive 32-bit values the address must be incremented by 4.
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|UINT]] ''Address''
 
::Address of the value to write
 
 
 
:[[Variable Types|ULONG]] ''Value''
 
::32-bit value to write
 
 
 
:[[Variable Types|BOOL]] ''MSBFirst''
 
::0: LSB is the first byte, 1: MSB is the first byte
 
 
 
 
 
'''Return value'''
 
 
 
:''This call does not return a value''
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>GetFloat</tt></u></span>===
 
Reads a 32-bit floating point value starting from the specified byte address.
 
 
 
For consecutive float values the address must be incremented by 4.
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|INT]] ''Address''
 
::The starting byte address
 
 
 
:[[Variable Types|BOOL]] ''MSBFirst''
 
::0: LSB is the first byte, 1: MSB is the first byte
 
 
 
 
 
'''Return value'''
 
 
 
:[[Variable Types|FLOAT]]
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>GetLong</tt></u></span>===
 
Reads a 32-bit value starting from the specified byte address.
 
 
 
For consecutive 32-bit values the address must be incremented by 4.
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|INT]] ''Address''
 
::The starting byte address
 
 
 
:[[Variable Types|BOOL]] ''MSBFirst''
 
::0: LSB is the first byte, 1: MSB is the first byte
 
 
 
 
 
'''Return value'''
 
 
 
:[[Variable Types|ULONG]]
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>GetInt</tt></u></span>===
 
Reads a 16-bit value starting from the specified byte address.
 
 
 
For consecutive 16-bit values the address must be incremented by 2.
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|INT]] ''Address''
 
::The starting byte address
 
 
 
:[[Variable Types|BOOL]] ''MSBFirst''
 
::0: LSB is the first byte, 1: MSB is the first byte
 
 
 
 
 
'''Return value'''
 
 
 
:[[Variable Types|UINT]]
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>GetByteArray</tt></u></span>===
 
Reads an array of bytes starting from the selected address.
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|UINT]] ''Address''
 
::Starting address of the first value to read
 
 
 
:[[Variable Types|BYTE]] ''Data''
 
::Byte array to store incoming data
 
 
 
:[[Variable Types|UINT]] ''Count''
 
::Number of bytes to read from the EE memory, Range: 1 to 128 bytes
 
 
 
 
 
'''Return value'''
 
 
 
:''This call does not return a value''
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>SetByte</tt></u></span>===
 
Writes a single byte to the EE memory.
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|UINT]] ''Address''
 
::Address of the value to write
 
 
 
:[[Variable Types|BYTE]] ''Data''
 
 
 
 
 
'''Return value'''
 
 
 
:''This call does not return a value''
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>GetByte</tt></u></span>===
 
Reads a single byte from the selected address.
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|UINT]] ''Address''
 
::Address of the value to read
 
 
 
 
 
'''Return value'''
 
 
 
:[[Variable Types|BYTE]]
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>SetFloat</tt></u></span>===
 
Writes a 32-bit floating point value to the EE memory.
 
 
 
For consecutive float values the address must be incremented by 4.
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|UINT]] ''Address''
 
::Address of the value to write
 
 
 
:[[Variable Types|FLOAT]] ''Value''
 
::Floating point value to write
 
 
 
:[[Variable Types|BOOL]] ''MSBFirst''
 
::0: LSB is the first byte, 1: MSB is the first byte
 
 
 
 
 
'''Return value'''
 
 
 
:''This call does not return a value''
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
 
Configures each matching sensor on the bus with the specified conversion bits.
 
 
 
'''Parameters'''
 
 
 
:''This macro has no parameters''
 
 
 
 
 
'''Return value'''
 
  
:''This call does not return a value''
 
  
 
 
==Simulation macro reference==
 
 
''This component does not contain any simulation macros''
 
  
  
 
==Property reference==
 
==Property reference==
<span style="font-weight: normal;"><u>One Wire Component</u></span>
 
  
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''OneWireComp''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
Link to the one wire component to host the bus.
+
| 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>EEPROM Size (Bytes)</u></span>
+
|-
 
+
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''EESize''.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
+
| width="90%" | One Wire Component
The number of bytes of memory available on the device.
+
|-
 
+
| colspan="2" | Link to the one wire component to host the bus.&nbsp;
<span style="font-weight: normal;"><u>Simulate Comms</u></span>
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
This property is of type ''True or false'' and can be referenced with the variable name ''SimComms''.
+
| width="90%" | EEPROM Size (Bytes)
 
+
|-
No - We use the panel GUI to perform the simulation.
+
| colspan="2" | &nbsp;
 
+
|-
Yes - We use OneWire comms via an API to communicate with real hardware.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
+
| width="90%" | Number EE Devices
<span style="font-weight: normal;"><u>Number EE Devices</u></span>
+
|-
 
+
| colspan="2" | Sens the number of sensors we can communicate with during simulation&nbsp;
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''NumSensors''.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
Sens the number of sensors we can communicate with during simulation
+
| width="90%" | Serial 0
 
+
|-
<span style="font-weight: normal;"><u>Serial 0</u></span>
+
| colspan="2" | Serial number for simulated one wire device&nbsp;
 
+
|-
This property is of type ''Line of text'' and can be referenced with the variable name ''Serial0''.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''  
Serial number for simulated one wire device
+
|-
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Simulate Comms
 +
|-
 +
| colspan="2" | No - We use the panel GUI to perform the simulation. Yes - We use OneWire comms via an API to communicate with real hardware.&nbsp;
 +
|}

Revision as of 20:57, 16 November 2021

Author MatrixTSL
Version 1.0
Category Storage


EEPROM (DS28E07) component

A rugged EEPROM allowing one or more devices to be addressed and accessed. Requires a One Wire component to perform the bus operations.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png SetString
Writes a string to the EE memory starting at the selected address. All bytes from the string will be written including the null termination. 
Fc9-u16-icon.png - UINT Address
Address of the value to write 
Fc9-string-icon.png - STRING Value
Data string to write 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetString
Gets a string from the specified start address. 
Fc9-u16-icon.png - UINT Address
Address of the first data byte 
Fc9-u8-icon.png - BYTE MaxLength
Maximum number of bytes in the string, also includes null termination byte 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png SetByteArray
Writes an array of bytes to the EE memory. 
Fc9-u16-icon.png - UINT Address
Starting address of the first value to write 
Fc9-u8-icon.png - BYTE Data
 
Fc9-u8-icon.png - BYTE Count
Number of bytes to write to the EE memory, Range: 1 to 128 bytes 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetInt
Writes a 16-bit value to the EE memory. For consecutive 16-bit values the address must be incremented by 2. 
Fc9-u16-icon.png - UINT Address
Address of the value to write 
Fc9-u16-icon.png - UINT Value
16-bit value to write 
[[File:]] - MSBFirst
0: LSB is the first byte, 1: MSB is the first byte 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png AddressSpecificDevice
Starts a temperature conversion on a specific device using a hex string identifier. SerialNumber parameter should be 12 characters and contain the 48-bit Serial. 
Fc9-string-icon.png - STRING SerialNumber
48-bit Serial Number e.g. "32DF4A3C1901" 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetSerialString
Gets the Serial String for the current addressed device. 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png AddressNextDevice
Scans for the next connected device with a matching family code. Goes through the device list generated by the ScanBus macro. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetLong
Writes a 32-bit value to the EE memory. For consecutive 32-bit values the address must be incremented by 4. 
Fc9-u16-icon.png - UINT Address
Address of the value to write 
Fc9-u32-icon.png - ULONG Value
32-bit value to write 
[[File:]] - MSBFirst
0: LSB is the first byte, 1: MSB is the first byte 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetFloat
Reads a 32-bit floating point value starting from the specified byte address. For consecutive float values the address must be incremented by 4. 
[[File:]] - Address
The starting byte address 
[[File:]] - MSBFirst
0: LSB is the first byte, 1: MSB is the first byte 
[[File:]] - Return


Fc9-comp-macro.png GetLong
Reads a 32-bit value starting from the specified byte address. For consecutive 32-bit values the address must be incremented by 4. 
[[File:]] - Address
The starting byte address 
[[File:]] - MSBFirst
0: LSB is the first byte, 1: MSB is the first byte 
Fc9-u32-icon.png - ULONG Return


Fc9-comp-macro.png GetInt
Reads a 16-bit value starting from the specified byte address. For consecutive 16-bit values the address must be incremented by 2. 
[[File:]] - Address
The starting byte address 
[[File:]] - MSBFirst
0: LSB is the first byte, 1: MSB is the first byte 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png GetByteArray
Reads an array of bytes starting from the selected address. 
Fc9-u16-icon.png - UINT Address
Starting address of the first value to read 
Fc9-u8-icon.png - BYTE Data
Byte array to store incoming data 
Fc9-u16-icon.png - UINT Count
Number of bytes to read from the EE memory, Range: 1 to 128 bytes 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetByte
Writes a single byte to the EE memory. 
Fc9-u16-icon.png - UINT Address
Address of the value to write 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetByte
Reads a single byte from the selected address. 
Fc9-u16-icon.png - UINT Address
Address of the value to read 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png SetFloat
Writes a 32-bit floating point value to the EE memory. For consecutive float values the address must be incremented by 4. 
Fc9-u16-icon.png - UINT Address
Address of the value to write 
[[File:]] - Value
Floating point value to write 
[[File:]] - MSBFirst
0: LSB is the first byte, 1: MSB is the first byte 
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-type-16-icon.png One Wire Component
Link to the one wire component to host the bus. 
Fc9-type-21-icon.png EEPROM Size (Bytes)
 
Fc9-type-16-icon.png Number EE Devices
Sens the number of sensors we can communicate with during simulation 
Fc9-type-10-icon.png Serial 0
Serial number for simulated one wire device 
Fc9-conn-icon.png Connections
Fc9-conn-icon.png Simulations
Fc9-type-7-icon.png Simulate Comms
No - We use the panel GUI to perform the simulation. Yes - We use OneWire comms via an API to communicate with real hardware.