Component: API OneWire Dummy (API Slave Devices): Difference between revisions
No edit summary |
No edit summary |
||
| Line 20: | Line 20: | ||
==Detailed description== | ==Detailed description== | ||
| Line 26: | Line 28: | ||
==Examples== | ==Examples== | ||
| Line 31: | Line 35: | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
== | ==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 14:09, 20 January 2023
| Author | MatrixTSL |
| Version | 1.0 |
| Category | API Slave Devices |
API OneWire Dummy component
Component Source Code
Please click here for the component source code: FC_Comp_Source_API_OneWire_Dummy.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
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 |
| Initialise the OneWire module ready for communications | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - I2C Bus Count - 1 | |
 - VOID
|
Return |
|
|
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 |
| 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 |
| 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 |
| Performs a bus reset and the sends the SkipROM command byte | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - I2C Bus Count - 1 | |
| - VOID
|
Return |
|
|
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 |
| 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 |
| 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 |