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

Latest revision as of 13:12, 7 February 2023

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 77: / Line 77: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 85: / Line 91: @@
 ==Macro reference==
-===ReceiveByte===
+===BusReset===
 {| 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;" | '''ReceiveByte'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''BusReset'''
 |-
-| colspan="2" | Receives a byte from the one wire bus a bit at a time&nbsp;
+| 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;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===TransmitByte===
+===GetDeviceCount===
 {| 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;" | '''TransmitByte'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDeviceCount'''
 |-
-| colspan="2" | Transmit a byte to the one wire bus a bit at a time&nbsp;
+| colspan="2" | Returns the number of devices found by the last ScanBus operation.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Command
-|-
-| 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''
 |}
-===SkipROM===
+===GetIDByte===
 {| 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;" | '''SkipROM'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetIDByte'''
+|-
+| colspan="2" | Returns byte ectet of the 64-Bit lasered ROM code, 255 on error&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Device
+|-
+| colspan="2" | Device ID - Range: 0 - NumDevices - 1&nbsp;
 |-
-| colspan="2" | Performs a bus reset and the sends the SkipROM command byte&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | ByteIndex
 |-
+| colspan="2" | Index of the data byte. 0=FamilyCode, 1-6=Serial, 7=CRC&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| 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''
 |}
-===BusReset===
+===Initialise===
 {| 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;" | '''BusReset'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| 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;
+| colspan="2" | Sets up the 1-Wire output pin ready for communications.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| 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''
 |}
@@ Line 170: / Line 181: @@
-===ScanBus===
+===ReceiveByte===
 {| 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;" | '''ScanBus'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveByte'''
 |-
-| colspan="2" | Scans the one wire bus to detect all connected devices. Returns the number of one wire devices found.&nbsp;
+| colspan="2" | Receives a byte from the one wire bus a bit at a time&nbsp;
 |-
 |-
@@ Line 184: / Line 195: @@
-===GetDeviceCount===
+===ScanBus===
 {| 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;" | '''GetDeviceCount'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ScanBus'''
 |-
-| colspan="2" | Returns the number of devices found by the last ScanBus operation.&nbsp;
+| colspan="2" | Scans the one wire bus to detect all connected devices. Returns the number of one wire devices found.&nbsp;
 |-
 |-
@@ Line 198: / Line 209: @@
-===GetIDByte===
+===SkipROM===
 {| 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;" | '''GetIDByte'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SkipROM'''
 |-
-| colspan="2" | Returns byte ectet of the 64-Bit lasered ROM code, 255 on error&nbsp;
+| colspan="2" | Performs a bus reset and the sends the SkipROM command byte&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" | Device
-|-
-| colspan="2" | Device ID - Range: 0 - NumDevices - 1&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | ByteIndex
-|-
-| colspan="2" | Index of the data byte. 0=FamilyCode, 1-6=Serial, 7=CRC&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''
 |}
-===Initialise===
+===TransmitByte===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TransmitByte'''
+|-
+| colspan="2" | Transmit a byte to the one wire bus a bit at a time&nbsp;
+|-
 |-
-| colspan="2" | Sets up the 1-Wire output pin ready for communications.&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Command
 |-
+| 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''
 |}