Component: API OneWire Dummy (API Slave Devices): Difference between revisions
m Text replacement - "width="10%" align="center" style="background-color:#D8C9D8;"" to "width="10%" align="center" class="mtx-class-macrohead"" |
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
||
| Line 73: | Line 73: | ||
|- | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''OneWireBusReset''' | ||
|- | |- | ||
| 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 | | 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 | ||
| Line 92: | Line 92: | ||
|- | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''OneWireGetDeviceCount''' | ||
|- | |- | ||
| colspan="2" | Returns the number of devices found by the last ScanBus operation. | | colspan="2" | Returns the number of devices found by the last ScanBus operation. | ||
| Line 111: | Line 111: | ||
|- | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''OneWireGetIDByte''' | ||
|- | |- | ||
| colspan="2" | Returns a single byte of the 64-Bit lasered ROM code, 255 on error | | colspan="2" | Returns a single byte of the 64-Bit lasered ROM code, 255 on error | ||
| Line 140: | Line 140: | ||
|- | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''OneWireInitialise''' | ||
|- | |- | ||
| colspan="2" | Initialise the OneWire module ready for communications | | colspan="2" | Initialise the OneWire module ready for communications | ||
| Line 159: | Line 159: | ||
|- | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''OneWireMatchROM''' | ||
|- | |- | ||
| colspan="2" | Performs a reset followed by the MatchROM code and then the 8-bit ROM code. | | colspan="2" | Performs a reset followed by the MatchROM code and then the 8-bit ROM code. | ||
| Line 188: | Line 188: | ||
|- | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''OneWireReceiveByte''' | ||
|- | |- | ||
| colspan="2" | Receives a byte from the one wire bus a bit at a time | | colspan="2" | Receives a byte from the one wire bus a bit at a time | ||
| Line 207: | Line 207: | ||
|- | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''OneWireScanBus''' | ||
|- | |- | ||
| colspan="2" | Scans the one wire bus to detect all connected devices. Returns the number of one wire devices found. | | colspan="2" | Scans the one wire bus to detect all connected devices. Returns the number of one wire devices found. | ||
| Line 226: | Line 226: | ||
|- | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''OneWireSkipROM''' | ||
|- | |- | ||
| colspan="2" | Performs a bus reset and the sends the SkipROM command byte | | colspan="2" | Performs a bus reset and the sends the SkipROM command byte | ||
| Line 245: | Line 245: | ||
|- | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''OneWireTransmitByte''' | ||
|- | |- | ||
| colspan="2" | Transmit a byte to the one wire bus a bit at a time | | colspan="2" | Transmit a byte to the one wire bus a bit at a time | ||
| Line 270: | Line 270: | ||
|- | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|} | |} | ||
Latest revision as of 14:23, 13 July 2026
| 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 |