Component: API OneWire Dummy (API Slave Devices)

From Flowcode Help
Revision as of 12:18, 3 February 2023 by Wiki bot (talk | contribs)
Jump to navigationJump to search
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_temp/API_OneWire_Dummy.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/API_OneWire_Dummy.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples





Macro reference

OneWireBusReset

Fc9-comp-macro.png 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 
Fc9-u8-icon.png - BYTE Channel
Channel Index: Range 0 - I2C Bus Count - 1 
Fc9-bool-icon.png - BOOL Return


OneWireGetDeviceCount

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


OneWireGetIDByte

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


OneWireInitialise

Fc9-comp-macro.png OneWireInitialise
Initialise the OneWire module ready for communications 
Fc9-u8-icon.png - BYTE Channel
Channel Index: Range 0 - I2C Bus Count - 1 
Fc9-void-icon.png - VOID Return


OneWireMatchROM

Fc9-comp-macro.png OneWireMatchROM
Performs a reset followed by the MatchROM code and then the 8-bit ROM code. 
Fc9-u8-icon.png - BYTE Channel
Channel Index: Range 0 - I2C Bus Count - 1 
Fc9-u8-icon.png - BYTE FamilyCode
 
Fc9-u8-icon.png - BYTE SerialNumber
 
Fc9-void-icon.png - VOID Return


OneWireReceiveByte

Fc9-comp-macro.png OneWireReceiveByte
Receives a byte from the one wire bus a bit at a time 
Fc9-u8-icon.png - BYTE Channel
Channel Index: Range 0 - I2C Bus Count - 1 
Fc9-u8-icon.png - BYTE Return


OneWireScanBus

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


OneWireSkipROM

Fc9-comp-macro.png OneWireSkipROM
Performs a bus reset and the sends the SkipROM command byte 
Fc9-u8-icon.png - BYTE Channel
Channel Index: Range 0 - I2C Bus Count - 1 
Fc9-void-icon.png - VOID Return


OneWireTransmitByte

Fc9-comp-macro.png OneWireTransmitByte
Transmit a byte to the one wire bus a bit at a time 
Fc9-u8-icon.png - BYTE Channel
Channel Index: Range 0 - I2C Bus Count - 1 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties