Difference between revisions of "Component: IButton (DS1990) (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
 
| 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
 
|}
 
|}
  
  
 +
==IButton (DS1990) component==
 +
A rugged 48-bit unique identifier allowing for unique codes for logistical tracking or device identifiers etc. Compatible with the DS1990A and DS1990R iButton devices. Requires a One Wire component to perform the bus operations.
  
−
==[[File:Component Icon 7bbc8b49_5f3d_419e_8b25_4ea4c93467b6.png|Image]] IButton (DS1990) component==
+
==Detailed description==
−
A rugged 48-bit unique identifier allowing for unique codes for logistical tracking or device identifiers etc.
+
 
−
Compatible with the DS1990A and DS1990R iButton devices.
+
''No detailed description exists yet for this component''
−
Requires a One Wire component to perform the bus operations.
 
  
 
==Examples==
 
==Examples==
 +
 +
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
  
Line 26: Line 27:
 
==Downloadable macro reference==
 
==Downloadable macro reference==
  
−
===<span style="font-weight: normal;"><u><tt>AddressNextDevice</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Scans for the next connected device with a matching family code.
+
|-
 +
| 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''
 +
|}
  
−
Goes through the device list generated by the ScanBus macro.
 
  
−
'''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;" | '''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''
 +
|}
  
−
:''This macro has no 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;" | '''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''
 +
|}
  
−
'''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;" | '''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''
 +
|}
  
  
−
===<span style="font-weight: normal;"><u><tt>GetSerialString</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Gets the Serial String for the current addressed device.
+
|-
 +
| 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''
 +
|}
  
−
'''Parameters'''
 
  
−
:''This macro has no 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;" | '''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''
 +
|}
  
  
−
'''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;" | '''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''
 +
|}
  
−
:[[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;" | '''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''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
 
−
Configures each matching sensor on the bus with the specified conversion bits.
 
  
−
'''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;" | '''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''
 +
|}
  
−
:''This macro has no 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;" | '''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''
 +
|}
  
  
 +
{| 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.&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''
 +
|}
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
+
{| 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''
 +
|}
  
  
−
==Property reference==
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
<span style="font-weight: normal;"><u>One Wire Component</u></span>
+
|-
 +
| 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''
 +
|}
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''OneWireComp''.
 
  
−
Link to the one wire component to host the bus.
 
  
−
<span style="font-weight: normal;"><u>Simulate Comms</u></span>
 
  
−
This property is of type ''True or false'' and can be referenced with the variable name ''SimComms''.
+
==Property reference==
  
−
No - We use the panel GUI to perform the simulation.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Yes - We use OneWire comms via an API to communicate with real hardware.
+
| 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>Number Devices</u></span>
+
|-
−
 
+
|-
−
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-16-icon.png]]
−
 
+
| width="90%" | One Wire Component
−
Sens the number of sensors we can communicate with during simulation
+
|-
−
 
+
| colspan="2" | Link to the one wire component to host the bus.&nbsp;
−
<span style="font-weight: normal;"><u>Serial 0</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Line of text'' and can be referenced with the variable name ''Serial0''.
+
| width="90%" | Number Devices
−
 
+
|-
−
Serial number for simulated one wire device
+
| colspan="2" | Sens the number of sensors we can communicate with during simulation&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Serial 0
 +
|-
 +
| colspan="2" | Serial number for simulated one wire device&nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''  
 +
|-
 +
|-
 +
| 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:58, 16 November 2021

Author MatrixTSL
Version 1.0
Category Storage


IButton (DS1990) component

A rugged 48-bit unique identifier allowing for unique codes for logistical tracking or device identifiers etc. Compatible with the DS1990A and DS1990R iButton devices. 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 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 Initialise
Configures each matching sensor on the bus with the specified conversion bits. 
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-16-icon.png Number 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. 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_IButton_(DS1990)_(Storage)&oldid=25560"