ChainMonitor Class Reference

Inherits com::dalsemi::onewire::application::monitor::AbstractDeviceMonitor.

List of all members.


Detailed Description

Class ChainMonitor represents the monitor that searches the 1-Wire net for Chain Mode devices, otherwise known as "Sequence Detect". Chain Mode devices have two PIO pins (PIOA and PIOB). You can chain multiple devices together by connecting PIOA of one part to PIOB of the next device. The first device in the chain has its PIOB grounded.

This monitor performs a simple search. If a branch is activated/deactivated between search cycles, this monitor will see the arrival/departure of new devices without reference to the branch which they lie on.

Author:
Dallas Semiconductor
Version:
1.00

Public Member Functions

 ChainMonitor (DSPortAdapter adapter)
 Create a simple monitor that does not search branches.
void setAdapter (DSPortAdapter adapter)
 Sets this monitor to search a new DSPortAdapter.
OWPath getDevicePath (Long address)
 Returns the OWPath of the device with the given address.
boolean chainOn () throws OneWireException, OneWireIOException
 chainOn sends the chain mode "ON" command sequence to all chain devices.
boolean chainConditionalReadRom (byte[] chainDeviceAddress) throws OneWireException, OneWireIOException
 chainConditionalReadRom sends the chain mode "DONE" command sequence to current chain device.
boolean chainDone () throws OneWireException, OneWireIOException
 chainDone sends the chain mode "DONE" command sequence to current chain device.
boolean chainOff () throws OneWireException, OneWireIOException
 chainOff sends the chain mode "OFF" command sequence to all chain devices.
void search (Vector arrivals, Vector departures) throws OneWireException, OneWireIOException
 Performs a search of the 1-Wire network without searching branches.
Vector toContainerVector (Vector arrivals) throws OneWireException, OneWireIOException
 A helper method that takes the arrivals Vector from the search method and returns a Vector of OneWireContainers.

Constructor & Destructor Documentation

ChainMonitor ( DSPortAdapter  adapter  ) 

Create a simple monitor that does not search branches.

Parameters:
the DSPortAdapter this monitor should search


Member Function Documentation

void setAdapter ( DSPortAdapter  adapter  )  [virtual]

Sets this monitor to search a new DSPortAdapter.

Parameters:
the DSPortAdapter this monitor should search

Implements AbstractDeviceMonitor.

OWPath getDevicePath ( Long  address  )  [virtual]

Returns the OWPath of the device with the given address.

Parameters:
address a Long object representing the address of the device
Returns:
The OWPath representing the network path to the device.

Implements AbstractDeviceMonitor.

boolean chainOn (  )  throws OneWireException, OneWireIOException

chainOn sends the chain mode "ON" command sequence to all chain devices.

Parameters:
none 
Returns:
true if successful, false otherwise

boolean chainConditionalReadRom ( byte[]  chainDeviceAddress  )  throws OneWireException, OneWireIOException

chainConditionalReadRom sends the chain mode "DONE" command sequence to current chain device.

Parameters:
8-byte array for chain 1-Wire net address
Returns:
true if successful, false otherwise

boolean chainDone (  )  throws OneWireException, OneWireIOException

chainDone sends the chain mode "DONE" command sequence to current chain device.

Parameters:
none 
Returns:
true if successful, false otherwise

boolean chainOff (  )  throws OneWireException, OneWireIOException

chainOff sends the chain mode "OFF" command sequence to all chain devices.

Parameters:
none 
Returns:
true if successful, false otherwise

void search ( Vector  arrivals,
Vector  departures 
) throws OneWireException, OneWireIOException [virtual]

Performs a search of the 1-Wire network without searching branches.

Parameters:
arrivals A vector of Long objects, represent new arrival addresses.
departures A vector of Long objects, represent departed addresses.

Implements AbstractDeviceMonitor.

Vector toContainerVector ( Vector  arrivals  )  throws OneWireException, OneWireIOException

A helper method that takes the arrivals Vector from the search method and returns a Vector of OneWireContainers.

Parameters:
arrivals A vector of Long objects, represent new arrival addresses.
Returns:
A vector of OneWireContainer objects


The documentation for this class was generated from the following file:

Generated on Thu Aug 28 15:42:30 2008 for 1-Wire API for .NET by  doxygen 1.5.6