Component: One Wire Dummy (Misc): Difference between revisions

Latest revision as of 14:23, 13 July 2026

Author	Matrix Ltd
Version	1.4
Category	Misc

One Wire Dummy component

Low level routines for controlling or interacting with a standard one wire interface.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

BusReset

	BusReset
Issue a 'ping' on the bus. If there is at least one sensor on the bus then it will generate a presence pulse. Returns 0 if a presense pulse was detected Returns 1 no device was detected
- BOOL	Return

GetDeviceCount

	GetDeviceCount
Returns the number of devices found by the last ScanBus operation.
- BYTE	Return

GetIDByte

	GetIDByte
Returns byte ectet of the 64-Bit lasered ROM code, 255 on error
- BYTE	Device
Device ID - Range: 0 - NumDevices - 1
- BYTE	ByteIndex
Index of the data byte. 0=FamilyCode, 1-6=Serial, 7=CRC
- BYTE	Return

Initialise

	Initialise
Sets up the 1-Wire output pin ready for communications.
- VOID	Return

MatchROM

	MatchROM
Performs a reset followed by the MatchROM code and then the 8-bit ROM code.
- BYTE	FamilyCode

- BYTE	SerialNumber

- VOID	Return

ReceiveByte

	ReceiveByte
Receives a byte from the one wire bus a bit at a time
- BYTE	Return

ScanBus

	ScanBus
Scans the one wire bus to detect all connected devices. Returns the number of one wire devices found.
- BYTE	Return

SkipROM

	SkipROM
Performs a bus reset and the sends the SkipROM command byte
- VOID	Return

TransmitByte

	TransmitByte
Transmit a byte to the one wire bus a bit at a time
- BYTE	Command

- VOID	Return

Property reference

	Properties

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/One_Wire_Dummy.fcfx FC_Comp_Source_temp/One_Wire_Dummy.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_One_Wire_Dummy.fcfx FC_Comp_Source_One_Wire_Dummy.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/One_Wire_Dummy.fcfx FC_Comp_Source_temp/One_Wire_Dummy.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_One_Wire_Dummy.fcfx FC_Comp_Source_One_Wire_Dummy.fcfx]
 ==Detailed description==
@@ Line 77: / Line 77: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 90: / Line 92: @@
 ===BusReset===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''BusReset'''
+| width="90%" class="mtx-class-macrohead" | '''BusReset'''
 |-
 | colspan="2" | Issue a 'ping' on the bus. If there is at least one sensor on the bus then it will generate a presence pulse.  Returns 0 if a presense pulse was detected Returns 1 no device was detected&nbsp;
@@ Line 104: / Line 106: @@
 ===GetDeviceCount===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDeviceCount'''
+| width="90%" class="mtx-class-macrohead" | '''GetDeviceCount'''
 |-
 | colspan="2" | Returns the number of devices found by the last ScanBus operation.&nbsp;
@@ Line 118: / Line 120: @@
 ===GetIDByte===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetIDByte'''
+| width="90%" class="mtx-class-macrohead" | '''GetIDByte'''
 |-
 | colspan="2" | Returns byte ectet of the 64-Bit lasered ROM code, 255 on error&nbsp;
@@ Line 142: / Line 144: @@
 ===Initialise===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+| width="90%" class="mtx-class-macrohead" | '''Initialise'''
 |-
 | colspan="2" | Sets up the 1-Wire output pin ready for communications.&nbsp;
@@ Line 156: / Line 158: @@
 ===MatchROM===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MatchROM'''
+| width="90%" class="mtx-class-macrohead" | '''MatchROM'''
 |-
 | colspan="2" | Performs a reset followed by the MatchROM code and then the 8-bit ROM code.&nbsp;
@@ Line 180: / Line 182: @@
 ===ReceiveByte===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveByte'''
+| width="90%" class="mtx-class-macrohead" | '''ReceiveByte'''
 |-
 | colspan="2" | Receives a byte from the one wire bus a bit at a time&nbsp;
@@ Line 194: / Line 196: @@
 ===ScanBus===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ScanBus'''
+| width="90%" class="mtx-class-macrohead" | '''ScanBus'''
 |-
 | colspan="2" | Scans the one wire bus to detect all connected devices. Returns the number of one wire devices found.&nbsp;
@@ Line 208: / Line 210: @@
 ===SkipROM===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SkipROM'''
+| width="90%" class="mtx-class-macrohead" | '''SkipROM'''
 |-
 | colspan="2" | Performs a bus reset and the sends the SkipROM command byte&nbsp;
@@ Line 222: / Line 224: @@
 ===TransmitByte===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TransmitByte'''
+| width="90%" class="mtx-class-macrohead" | '''TransmitByte'''
 |-
 | colspan="2" | Transmit a byte to the one wire bus a bit at a time&nbsp;
@@ Line 242: / Line 244: @@
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |}

SteveT (talk | contribs)