Component: One Wire (DS2482) (Comms: Interface)

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

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

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

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

	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

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

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

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

	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
- 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

==Macro reference==

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

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

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

	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

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

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

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

	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
- 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

==Macro reference==

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

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

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

	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

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

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

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

	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
- 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

==Macro reference==

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

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

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

	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

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

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

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

	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
- 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