Jump to content

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

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,414 edits
No edit summary
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(13 intermediate revisions by 2 users not shown)
Line 17: Line 17:
==Component Source Code==
==Component Source Code==


Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_API_OneWire_Dummy.fcfx FC_Comp_Source_API_OneWire_Dummy.fcfx]
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_API_OneWire_Dummy.fcfx FC_Comp_Source_API_OneWire_Dummy.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_API_OneWire_Dummy.fcfx FC_Comp_Source_API_OneWire_Dummy.fcfx]


==Detailed description==
==Detailed description==




Line 26: Line 40:


==Examples==
==Examples==




Line 31: Line 57:
''<span style="color:red;">No additional examples</span>''
''<span style="color:red;">No additional examples</span>''


==Downloadable macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
 
 
 
 
 
 
 
 
==Macro reference==
 
===OneWireBusReset===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OneWireBusReset'''
| 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&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;
Line 51: Line 88:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===OneWireGetDeviceCount===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OneWireInitialise'''
| width="90%" class="mtx-class-macrohead" | '''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 64: Line 102:
| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===OneWireGetIDByte===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OneWireMatchROM'''
| width="90%" class="mtx-class-macrohead" | '''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 83: Line 122:
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| 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="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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===OneWireInitialise===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OneWireTransmitByte'''
| width="90%" class="mtx-class-macrohead" | '''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 109: Line 149:
|-
|-
| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
| 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
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 120: Line 155:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===OneWireMatchROM===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OneWireGetIDByte'''
| width="90%" class="mtx-class-macrohead" | '''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 134: Line 170:
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| 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="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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===OneWireReceiveByte===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OneWireSkipROM'''
| width="90%" class="mtx-class-macrohead" | '''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 161: Line 198:
| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===OneWireScanBus===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OneWireScanBus'''
| 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.&nbsp;
| colspan="2" | Scans the one wire bus to detect all connected devices. Returns the number of one wire devices found.&nbsp;
Line 184: Line 222:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===OneWireSkipROM===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OneWireReceiveByte'''
| width="90%" class="mtx-class-macrohead" | '''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 197: Line 236:
| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===OneWireTransmitByte===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OneWireGetDeviceCount'''
| width="90%" class="mtx-class-macrohead" | '''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 215: Line 255:
| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




==Property reference==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| 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
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_API_OneWire_Dummy_(API_Slave_Devices)&oldid=46369"