Difference between revisions of "Component: One Wire (DS2482) (Comms: Interface)"

Latest revision as of 13:12, 7 February 2023

Author	MatrixTSL
Version	1.0
Category	Comms: Interface

One Wire (DS2482) component

A One Wire master transciever controlled using I2C comms. Useful for microcontroller devices where One Wire communications timings are too tight to do reliably.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_One_Wire_DS2482_I2C.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_One_Wire_DS2482_I2C.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

BusReset

	BusReset
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
- BOOL	Return

GetDeviceCount

	GetDeviceCount
Returns the number of devices found by the last ScanBus operation.
- BYTE	Return

GetIDByte

	GetIDByte
Returns byte ectet of the 64-Bit lasered ROM code, 255 on error
- BYTE	Device
Device ID - Range: 0 - NumDevices - 1
- BYTE	ByteIndex
Index of the data byte. 0=FamilyCode, 1-6=Serial, 7=CRC
- BYTE	Return

Initialise

	Initialise

- VOID	Return

MatchROM

	MatchROM
Performs a reset followed by the MatchROM code and then the 8-bit ROM code.
- BYTE	FamilyCode

- BYTE	SerialNumber

- VOID	Return

ReceiveByte

	ReceiveByte
Receives a byte from the one wire bus a bit at a time
- BYTE	Return

ScanBus

	ScanBus
Scans the one wire bus to detect all connected devices. Returns the number of one wire devices found.
- BYTE	Return

SkipROM

	SkipROM
Performs a bus reset and the sends the SkipROM command byte
- VOID	Return

TransmitByte

	TransmitByte
Transmit a byte to the one wire bus a bit at a time
- BYTE	Command

- VOID	Return

Property reference

	Properties
	Max Devices
Controls the maximum number of devices that can be detected during a ScanBus. For each additional device we require 8 bytes to store the ROM ID. Default: 8 = 64 Bytes of RAM
	I2C Properties
	Device Address

	Connections
	Channel
Channel selection
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	Options
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Simulation
	Simulate Comms

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_One_Wire_DS2482_I2C.fcfx FC_Comp_Source_One_Wire_DS2482_I2C.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_One_Wire_DS2482_I2C.fcfx FC_Comp_Source_One_Wire_DS2482_I2C.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_One_Wire_DS2482_I2C.fcfx FC_Comp_Source_One_Wire_DS2482_I2C.fcfx]
 ==Detailed description==
 ''No detailed description exists yet for this component''
 ==Examples==
 ''<span style="color:red;">No additional examples</span>''
-==Downloadable macro reference==
+==Macro reference==
+===BusReset===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveByte'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''BusReset'''
 |-
-| colspan="2" | Receives a byte from the one wire bus a bit at a time&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;
 |-
 |-
-| 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-bool-icon.png]] - BOOL
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===GetDeviceCount===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TransmitByte'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDeviceCount'''
 |-
-| colspan="2" | Transmit a byte to the one wire bus a bit at a time&nbsp;
+| colspan="2" | Returns the number of devices found by the last ScanBus operation.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Command
-|-
-| 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''
 |}
+===GetIDByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SkipROM'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetIDByte'''
+|-
+| colspan="2" | Returns byte ectet of the 64-Bit lasered ROM code, 255 on error&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Device
+|-
+| colspan="2" | Device ID - Range: 0 - NumDevices - 1&nbsp;
 |-
-| colspan="2" | Performs a bus reset and the sends the SkipROM command byte&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | ByteIndex
 |-
+| 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''
 |}
+===Initialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''BusReset'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| 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" | &nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| 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''
 |}
+===MatchROM===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 109: / Line 151: @@
+===ReceiveByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ScanBus'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveByte'''
 |-
-| colspan="2" | Scans the one wire bus to detect all connected devices. Returns the number of one wire devices found.&nbsp;
+| colspan="2" | Receives a byte from the one wire bus a bit at a time&nbsp;
 |-
 |-
@@ Line 122: / Line 165: @@
+===ScanBus===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDeviceCount'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ScanBus'''
 |-
-| colspan="2" | Returns the number of devices found by the last ScanBus operation.&nbsp;
+| colspan="2" | Scans the one wire bus to detect all connected devices. Returns the number of one wire devices found.&nbsp;
 |-
 |-
@@ Line 135: / Line 179: @@
+===SkipROM===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetIDByte'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SkipROM'''
 |-
-| colspan="2" | Returns byte ectet of the 64-Bit lasered ROM code, 255 on error&nbsp;
+| colspan="2" | Performs a bus reset and the sends the SkipROM command byte&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" | Device
-|-
-| colspan="2" | Device ID - Range: 0 - NumDevices - 1&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | ByteIndex
-|-
-| 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-u8-icon.png]] - BYTE
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===TransmitByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TransmitByte'''
+|-
+| colspan="2" | Transmit a byte to the one wire bus a bit at a time&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Command
 |-
 | 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''
 |}