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

Revision as of 11:48, 3 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

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

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

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

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

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

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

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

Property reference

	Properties

@@ Line 56: / Line 56: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 61: / Line 63: @@
 ==Macro reference==
+===OneWireBusReset===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 79: / Line 82: @@
+===OneWireInitialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 97: / Line 101: @@
+===OneWireMatchROM===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 125: / Line 130: @@
+===OneWireTransmitByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 148: / Line 154: @@
+===OneWireGetIDByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 176: / Line 183: @@
+===OneWireSkipROM===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 194: / Line 202: @@
+===OneWireScanBus===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 212: / Line 221: @@
+===OneWireReceiveByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 230: / Line 240: @@
+===OneWireGetDeviceCount===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-