Difference between revisions of "Component: API OneWire Dummy (API Slave Devices)"

Latest revision as of 13:08, 7 February 2023

Author	MatrixTSL
Version	1.0
Category	API Slave Devices

API OneWire Dummy component

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

OneWireBusReset

	OneWireBusReset
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
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BOOL	Return

OneWireGetDeviceCount

	OneWireGetDeviceCount
Returns the number of devices found by the last ScanBus operation.
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Return

OneWireGetIDByte

	OneWireGetIDByte
Returns a single byte of the 64-Bit lasered ROM code, 255 on error
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Device
Device ID - Range: 0 - NumDevices - 1
- BYTE	ByteIndex
Index of the data byte. 0=FamilyCode, 1-6=Serial, 7=CRC
- BYTE	Return

OneWireInitialise

	OneWireInitialise
Initialise the OneWire module ready for communications
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- VOID	Return

OneWireMatchROM

	OneWireMatchROM
Performs a reset followed by the MatchROM code and then the 8-bit ROM code.
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	FamilyCode

- BYTE	SerialNumber

- VOID	Return

OneWireReceiveByte

	OneWireReceiveByte
Receives a byte from the one wire bus a bit at a time
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Return

OneWireScanBus

	OneWireScanBus
Scans the one wire bus to detect all connected devices. Returns the number of one wire devices found.
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Return

OneWireSkipROM

	OneWireSkipROM
Performs a bus reset and the sends the SkipROM command byte
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- VOID	Return

OneWireTransmitByte

	OneWireTransmitByte
Transmit a byte to the one wire bus a bit at a time
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Data

- VOID	Return

Property reference

	Properties

@@ Line 56: / Line 56: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 61: / Line 69: @@
 ==Macro reference==
+===OneWireBusReset===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 79: / Line 88: @@
+===OneWireGetDeviceCount===
 {| 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;" | '''OneWireInitialise'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OneWireGetDeviceCount'''
 |-
-| colspan="2" | Initialise the OneWire module ready for communications&nbsp;
+| colspan="2" | Returns the number of devices found by the last ScanBus operation.&nbsp;
 |-
 |-
@@ Line 92: / Line 102: @@
 | colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&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''
 |}
+===OneWireGetIDByte===
 {| 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;" | '''OneWireMatchROM'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OneWireGetIDByte'''
 |-
-| colspan="2" | Performs a reset followed by the MatchROM code and then the 8-bit ROM code.&nbsp;
+| colspan="2" | Returns a single byte of the 64-Bit lasered ROM code, 255 on error&nbsp;
 |-
 |-
@@ Line 111: / Line 122: @@
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | FamilyCode
+| width="90%" | Device
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Device ID - Range: 0 - NumDevices - 1&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | SerialNumber
+| width="90%" | ByteIndex
 |-
-| colspan="2" | &nbsp;
+| 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''
 |}
+===OneWireInitialise===
 {| 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;" | '''OneWireTransmitByte'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OneWireInitialise'''
 |-
-| colspan="2" | Transmit a byte to the one wire bus a bit at a time&nbsp;
+| colspan="2" | Initialise the OneWire module ready for communications&nbsp;
 |-
 |-
@@ Line 137: / Line 149: @@
 |-
 | colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&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
@@ Line 148: / Line 155: @@
+===OneWireMatchROM===
 {| 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;" | '''OneWireGetIDByte'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OneWireMatchROM'''
 |-
-| colspan="2" | Returns a single byte of the 64-Bit lasered ROM code, 255 on error&nbsp;
+| colspan="2" | Performs a reset followed by the MatchROM code and then the 8-bit ROM code.&nbsp;
 |-
 |-
@@ Line 162: / Line 170: @@
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Device
+| width="90%" | FamilyCode
 |-
-| colspan="2" | Device ID - Range: 0 - NumDevices - 1&nbsp;
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | ByteIndex
+| width="90%" | SerialNumber
 |-
-| colspan="2" | Index of the data byte. 0=FamilyCode, 1-6=Serial, 7=CRC&nbsp;
+| colspan="2" | &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-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===OneWireReceiveByte===
 {| 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;" | '''OneWireSkipROM'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OneWireReceiveByte'''
 |-
-| colspan="2" | Performs a bus reset and the sends the SkipROM command byte&nbsp;
+| colspan="2" | Receives a byte from the one wire bus a bit at a time&nbsp;
 |-
 |-
@@ Line 189: / Line 198: @@
 | colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&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''
 |}
+===OneWireScanBus===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 212: / Line 222: @@
+===OneWireSkipROM===
 {| 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;" | '''OneWireReceiveByte'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OneWireSkipROM'''
 |-
-| colspan="2" | Receives a byte from the one wire bus a bit at a time&nbsp;
+| colspan="2" | Performs a bus reset and the sends the SkipROM command byte&nbsp;
 |-
 |-
@@ Line 225: / Line 236: @@
 | colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&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-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===OneWireTransmitByte===
 {| 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;" | '''OneWireGetDeviceCount'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OneWireTransmitByte'''
 |-
-| colspan="2" | Returns the number of devices found by the last ScanBus operation.&nbsp;
+| colspan="2" | Transmit a byte to the one wire bus a bit at a time&nbsp;
 |-
 |-
@@ Line 243: / Line 255: @@
 | colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| 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''
 |}