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

From Flowcode Help
Jump to navigationJump to search
Line 16: Line 16:
  
 
==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_EEPROM_DS28E07.fcfx FC_Comp_Source_EEPROM_DS28E07.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EEPROM_DS28E07.fcfx FC_Comp_Source_EEPROM_DS28E07.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EEPROM_DS28E07.fcfx FC_Comp_Source_EEPROM_DS28E07.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 40: Line 44:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 62: Line 68:
  
 
==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;" | '''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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Address of the value to write 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | Data string to write 
 +
|-
 +
| 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;" | '''GetString'''
 +
|-
 +
| colspan="2" | Gets a string from the specified start address. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Address of the first data byte 
 +
|-
 +
| 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 
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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;" | '''SetByteArray'''
 +
|-
 +
| colspan="2" | Writes an array of bytes to the EE memory. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Starting address of the first value to write 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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 
 +
|-
 +
| 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;" | '''SetInt'''
 +
|-
 +
| colspan="2" | Writes a 16-bit value to the EE memory. For consecutive 16-bit values the address must be incremented by 2. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Address of the value to write 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | 16-bit value to write 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | MSBFirst
 +
|-
 +
| colspan="2" | 0: LSB is the first byte, 1: MSB is the first byte 
 +
|-
 +
| 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;" | '''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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | SerialNumber
 +
|-
 +
| colspan="2" | 48-bit Serial Number e.g. "32DF4A3C1901" 
 +
|-
 +
| 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;" | '''GetSerialString'''
 +
|-
 +
| colspan="2" | Gets the Serial String for the current addressed device. 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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;" | '''AddressNextDevice'''
 +
|-
 +
| colspan="2" | Scans for the next connected device with a matching family code. Goes through the device list generated by the ScanBus macro. 
 +
|-
 +
|-
 +
| 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;" | '''SetLong'''
 +
|-
 +
| colspan="2" | Writes a 32-bit value to the EE memory. For consecutive 32-bit values the address must be incremented by 4. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Address of the value to write 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | 32-bit value to write 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | MSBFirst
 +
|-
 +
| colspan="2" | 0: LSB is the first byte, 1: MSB is the first byte 
 +
|-
 +
| 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;" | '''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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | The starting byte address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | MSBFirst
 +
|-
 +
| colspan="2" | 0: LSB is the first byte, 1: MSB is the first byte 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| 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;" | '''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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | The starting byte address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | MSBFirst
 +
|-
 +
| colspan="2" | 0: LSB is the first byte, 1: MSB is the first byte 
 +
|-
 +
| 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;" | '''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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | The starting byte address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | MSBFirst
 +
|-
 +
| colspan="2" | 0: LSB is the first byte, 1: MSB is the first byte 
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Starting address of the first value to read 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | Byte array to store incoming data 
 +
|-
 +
| 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 
 +
|-
 +
| 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;" | '''SetByte'''
 +
|-
 +
| colspan="2" | Writes a single byte to the EE memory. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Address of the value to write 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| 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''
 +
|}
 +
 +
 +
{| 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;" | '''GetByte'''
 +
|-
 +
| colspan="2" | Reads a single byte from the selected address. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Address of the value to read 
 +
|-
 +
| 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;" | '''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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Address of the value to write 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | Floating point value to write 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | MSBFirst
 +
|-
 +
| colspan="2" | 0: LSB is the first byte, 1: MSB is the first byte 
 +
|-
 +
| 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. 
 +
|-
 +
|-
 +
| 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-16-icon.png]]
 +
| width="90%" | One Wire Component
 +
|-
 +
| colspan="2" | Link to the one wire component to host the bus. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | EEPROM Size (Bytes)
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
 +
|-
 +
|-
 +
| 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. 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Panel Simulation
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Number EE Devices
 +
|-
 +
| colspan="2" | Sens the number of sensors we can communicate with during simulation 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Serial 0
 +
|-
 +
| colspan="2" | Serial number for simulated one wire device 
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:21, 20 January 2023

Author MatrixTSL
Version 1.0
Category EEPROM


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.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


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 
Fc9-bool-icon.png - BOOL 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 
Fc9-bool-icon.png - BOOL 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. 
Fc9-s16-icon.png - INT Address
The starting byte address 
Fc9-bool-icon.png - BOOL MSBFirst
0: LSB is the first byte, 1: MSB is the first byte 
Fc9-f32-icon.png - FLOAT 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. 
Fc9-s16-icon.png - INT Address
The starting byte address 
Fc9-bool-icon.png - BOOL 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. 
Fc9-s16-icon.png - INT Address
The starting byte address 
Fc9-bool-icon.png - BOOL 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 
Fc9-f32-icon.png - FLOAT Value
Floating point value to write 
Fc9-bool-icon.png - BOOL 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-conn-icon.png Simulation
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. 
Fc9-conn-icon.png Panel Simulation
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 

==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 
Fc9-bool-icon.png - BOOL 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 
Fc9-bool-icon.png - BOOL 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. 
Fc9-s16-icon.png - INT Address
The starting byte address 
Fc9-bool-icon.png - BOOL MSBFirst
0: LSB is the first byte, 1: MSB is the first byte 
Fc9-f32-icon.png - FLOAT 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. 
Fc9-s16-icon.png - INT Address
The starting byte address 
Fc9-bool-icon.png - BOOL 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. 
Fc9-s16-icon.png - INT Address
The starting byte address 
Fc9-bool-icon.png - BOOL 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 
Fc9-f32-icon.png - FLOAT Value
Floating point value to write 
Fc9-bool-icon.png - BOOL 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-conn-icon.png Simulation
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. 
Fc9-conn-icon.png Panel Simulation
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 

==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 
Fc9-bool-icon.png - BOOL 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 
Fc9-bool-icon.png - BOOL 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. 
Fc9-s16-icon.png - INT Address
The starting byte address 
Fc9-bool-icon.png - BOOL MSBFirst
0: LSB is the first byte, 1: MSB is the first byte 
Fc9-f32-icon.png - FLOAT 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. 
Fc9-s16-icon.png - INT Address
The starting byte address 
Fc9-bool-icon.png - BOOL 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. 
Fc9-s16-icon.png - INT Address
The starting byte address 
Fc9-bool-icon.png - BOOL 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 
Fc9-f32-icon.png - FLOAT Value
Floating point value to write 
Fc9-bool-icon.png - BOOL 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-conn-icon.png Simulation
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. 
Fc9-conn-icon.png Panel Simulation
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