DotNetAdapterx64 Class Reference

Inherits com::dalsemi::onewire::adapter::DSPortAdapter.

List of all members.


Detailed Description

The DSPortAdapter class for all DotNet native adapters for x64 Windows.

Instances of valid DSPortAdapter's are retrieved from methods in OneWireAccessProvider.

The DotNetAdapterx64 methods can be organized into the following categories:

See also:
com.dalsemi.onewire.OneWireAccessProvider

com.dalsemi.onewire.container.OneWireContainer

Version:
0.01, 20 March 2001
Author:
DS

Public Member Functions

 DotNetAdapterx64 () throws ClassNotFoundException
 Constructs a default adapter.
 DotNetAdapterx64 (int newPortType) throws ClassNotFoundException
 Constructs with a specified port type.
String getAdapterName ()
 Retrieve the name of the port adapter as a string.
String getPortTypeDescription ()
 Retrieve a description of the port required by this port adapter.
String getClassVersion ()
 Retrieve a version string for this class.
Enumeration getPortNames ()
 Retrieve a list of the platform appropriate port names for this adapter.
boolean selectPort (String portName) throws OneWireIOException, OneWireException
 Specify a platform appropriate port name for this adapter.
void freePort () throws OneWireException
 Free ownership of the selected port if it is currently owned back to the system.
String getPortName () throws OneWireException
 Retrieve the name of the selected port as a String.
boolean adapterDetected () throws OneWireIOException, OneWireException
 Detect adapter presence on the selected port.
String getAdapterVersion () throws OneWireIOException, OneWireException
 Retrieve the version of the adapter.
String getAdapterAddress () throws OneWireIOException, OneWireException
 Retrieve the address of the adapter if it has one.
boolean canOverdrive () throws OneWireIOException, OneWireException
 Returns whether adapter can physically support overdrive mode.
boolean canHyperdrive () throws OneWireIOException, OneWireException
 Returns whether the adapter can physically support hyperdrive mode.
boolean canFlex () throws OneWireIOException, OneWireException
 Returns whether the adapter can physically support flex speed mode.
boolean canProgram () throws OneWireIOException, OneWireException
 Returns whether adapter can physically support 12 volt power mode.
boolean canDeliverPower () throws OneWireIOException, OneWireException
 Returns whether the adapter can physically support strong 5 volt power mode.
boolean canDeliverSmartPower () throws OneWireIOException, OneWireException
 Returns whether the adapter can physically support "smart" strong 5 volt power mode.
boolean canBreak () throws OneWireIOException, OneWireException
 Returns whether adapter can physically support 0 volt 'break' mode.
boolean findFirstDevice () throws OneWireIOException, OneWireException
 Returns true if the first iButton or 1-Wire device is found on the 1-Wire Network.
boolean findNextDevice () throws OneWireIOException, OneWireException
 Returns true if the next iButton or 1-Wire device is found.
void getAddress (byte[] address)
 Copies the 'current' iButton address being used by the adapter into the array.
boolean isPresent (byte[] address) throws OneWireIOException, OneWireException
 Verifies that the iButton or 1-Wire device specified is present on the 1-Wire Network.
boolean isAlarming (byte[] address) throws OneWireIOException, OneWireException
 Verifies that the iButton or 1-Wire device specified is present on the 1-Wire Network and in an alarm state.
boolean select (byte[] address) throws OneWireIOException, OneWireException
 Selects the specified iButton or 1-Wire device by broadcasting its address.
void setSearchOnlyAlarmingDevices ()
 Set the 1-Wire Network search to find only iButtons and 1-Wire devices that are in an 'Alarm' state that signals a need for attention.
void setNoResetSearch ()
 Set the 1-Wire Network search to not perform a 1-Wire reset before a search.
void setSearchAllDevices ()
 Set the 1-Wire Network search to find all iButtons and 1-Wire devices whether they are in an 'Alarm' state or not and restores the default setting of providing a 1-Wire reset command before each search.
boolean beginExclusive (boolean blocking) throws OneWireException
 Gets exclusive use of the 1-Wire to communicate with an iButton or 1-Wire Device.
void endExclusive ()
 Relinquishes exclusive control of the 1-Wire Network.
void putBit (boolean bitValue) throws OneWireIOException, OneWireException
 Sends a bit to the 1-Wire Network.
boolean getBit () throws OneWireIOException, OneWireException
 Gets a bit from the 1-Wire Network.
void putByte (int byteValue) throws OneWireIOException, OneWireException
 Sends a byte to the 1-Wire Network.
int getByte () throws OneWireIOException, OneWireException
 Gets a byte from the 1-Wire Network.
byte[] getBlock (int len) throws OneWireIOException, OneWireException
 Get a block of data from the 1-Wire Network.
void getBlock (byte[] arr, int len) throws OneWireIOException, OneWireException
 Get a block of data from the 1-Wire Network and write it into the provided array.
void getBlock (byte[] arr, int off, int len) throws OneWireIOException, OneWireException
 Get a block of data from the 1-Wire Network and write it into the provided array.
void dataBlock (byte dataBlock[], int off, int len) throws OneWireIOException, OneWireException
 Sends a block of data and returns the data received in the same array.
int reset () throws OneWireIOException, OneWireException
 Sends a Reset to the 1-Wire Network.
void setPowerDuration (int timeFactor) throws OneWireIOException, OneWireException
 Sets the duration to supply power to the 1-Wire Network.
boolean startPowerDelivery (int changeCondition) throws OneWireIOException, OneWireException
 Sets the 1-Wire Network voltage to supply power to an iButton device.
void setProgramPulseDuration (int timeFactor) throws OneWireIOException, OneWireException
 Sets the duration for providing a program pulse on the 1-Wire Network.
boolean startProgramPulse (int changeCondition) throws OneWireIOException, OneWireException
 Sets the 1-Wire Network voltage to eprom programming level.
void startBreak () throws OneWireIOException, OneWireException
 Sets the 1-Wire Network voltage to 0 volts.
void setPowerNormal () throws OneWireIOException, OneWireException
 Sets the 1-Wire Network voltage to normal level.
void setSpeed (int desiredSpeed) throws OneWireIOException, OneWireException
 This method takes an int representing the new speed of data transfer on the 1-Wire Network.
int getSpeed ()
 This method returns the current data transfer speed through a port to a 1-Wire Network.
boolean setTMEXPortType (int newPortType)
 Select the DotNet specified port type (0 to 15) Use this method if the constructor with the PortType cannot be used.

Static Public Member Functions

static void CleanUpByThread (Thread thread)
 CleanUp the native state for classes owned by the provided thread.
static String getDefaultAdapterName ()
 Get the default Adapter Name.
static String getDefaultPortName ()
 Get the default Adapter Port name.

Protected Member Functions

void finalize ()
 Finalize to Cleanup native.

Protected Attributes

int portType
 DotNet port type number (0-15).
byte[] RomDta = new byte [8]
 Current 1-Wire Network Address.

Constructor & Destructor Documentation

DotNetAdapterx64 (  )  throws ClassNotFoundException

Constructs a default adapter.

Exceptions:
ClassNotFoundException 

DotNetAdapterx64 ( int  newPortType  )  throws ClassNotFoundException

Constructs with a specified port type.

Parameters:
newPortType 
Exceptions:
ClassNotFoundException 


Member Function Documentation

String getAdapterName (  )  [virtual]

Retrieve the name of the port adapter as a string.

The 'Adapter' is a device that connects to a 'port' that allows one to communicate with an iButton or other 1-Wire device. As example of this is 'DS9097U'.

Returns:
String representation of the port adapter.

Implements DSPortAdapter.

String getPortTypeDescription (  )  [virtual]

Retrieve a description of the port required by this port adapter.

An example of a 'Port' would 'serial communication port'.

Returns:
String description of the port type required.

Implements DSPortAdapter.

String getClassVersion (  )  [virtual]

Retrieve a version string for this class.

Returns:
version string

Implements DSPortAdapter.

Enumeration getPortNames (  )  [virtual]

Retrieve a list of the platform appropriate port names for this adapter.

A port must be selected with the method 'selectPort' before any other communication methods can be used. Using a communcation method before 'selectPort' will result in a OneWireException exception.

Returns:
enumeration of type String that contains the port names

Implements DSPortAdapter.

boolean selectPort ( String  portName  )  throws OneWireIOException, OneWireException [virtual]

Specify a platform appropriate port name for this adapter.

Note that even though the port has been selected, it's ownership may be relinquished if it is not currently held in a 'exclusive' block. This class will then try to re-aquire the port when needed. If the port cannot be re-aquired ehen the exception PortInUseException will be thrown.

Parameters:
portName name of the target port, retrieved from getPortNames()
Returns:
true if the port was aquired, false if the port is not available.
Exceptions:
OneWireIOException If port does not exist, or unable to communicate with port.
OneWireException If port does not exist

Implements DSPortAdapter.

void freePort (  )  throws OneWireException [virtual]

Free ownership of the selected port if it is currently owned back to the system.

This should only be called if the recently selected port does not have an adapter or at the end of your application's use of the port.

Exceptions:
OneWireException If port does not exist

Implements DSPortAdapter.

String getPortName (  )  throws OneWireException [virtual]

Retrieve the name of the selected port as a String.

Returns:
String of selected port
Exceptions:
OneWireException if valid port not yet selected

Implements DSPortAdapter.

boolean adapterDetected (  )  throws OneWireIOException, OneWireException [virtual]

Detect adapter presence on the selected port.

Returns:
true if the adapter is confirmed to be connected to the selected port, false if the adapter is not connected.
Exceptions:
OneWireIOException 
OneWireException 

Implements DSPortAdapter.

String getAdapterVersion (  )  throws OneWireIOException, OneWireException

Retrieve the version of the adapter.

Returns:
String of the adapter version. It will return "<na>" if the adapter version is not or cannot be known.
Exceptions:
OneWireIOException on a 1-Wire communication error such as no device present. This could be caused by a physical interruption in the 1-Wire Network due to static native shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
OneWireException on a communication or setup error with the 1-Wire adapter

Reimplemented from DSPortAdapter.

String getAdapterAddress (  )  throws OneWireIOException, OneWireException

Retrieve the address of the adapter if it has one.

Returns:
String of the adapter address. It will return "<na>" if the adapter does not have an address. The address is a string representation of an 1-Wire address.
Exceptions:
OneWireIOException on a 1-Wire communication error such as no device present. This could be caused by a physical interruption in the 1-Wire Network due to static native shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
OneWireException on a communication or setup error with the 1-Wire adapter
See also:
Address

Reimplemented from DSPortAdapter.

boolean canOverdrive (  )  throws OneWireIOException, OneWireException

Returns whether adapter can physically support overdrive mode.

Returns:
true if this port adapter can do OverDrive, false otherwise.
Exceptions:
OneWireIOException on a 1-Wire communication error with the adapter
OneWireException on a setup error with the 1-Wire adapter

Reimplemented from DSPortAdapter.

boolean canHyperdrive (  )  throws OneWireIOException, OneWireException

Returns whether the adapter can physically support hyperdrive mode.

Returns:
true if this port adapter can do HyperDrive, false otherwise.
Exceptions:
OneWireIOException on a 1-Wire communication error with the adapter
OneWireException on a setup error with the 1-Wire adapter

Reimplemented from DSPortAdapter.

boolean canFlex (  )  throws OneWireIOException, OneWireException

Returns whether the adapter can physically support flex speed mode.

Returns:
true if this port adapter can do flex speed, false otherwise.
Exceptions:
OneWireIOException on a 1-Wire communication error with the adapter
OneWireException on a setup error with the 1-Wire adapter

Reimplemented from DSPortAdapter.

boolean canProgram (  )  throws OneWireIOException, OneWireException

Returns whether adapter can physically support 12 volt power mode.

Returns:
true if this port adapter can do Program voltage, false otherwise.
Exceptions:
OneWireIOException on a 1-Wire communication error with the adapter
OneWireException on a setup error with the 1-Wire adapter

Reimplemented from DSPortAdapter.

boolean canDeliverPower (  )  throws OneWireIOException, OneWireException

Returns whether the adapter can physically support strong 5 volt power mode.

Returns:
true if this port adapter can do strong 5 volt mode, false otherwise.
Exceptions:
OneWireIOException on a 1-Wire communication error with the adapter
OneWireException on a setup error with the 1-Wire adapter

Reimplemented from DSPortAdapter.

boolean canDeliverSmartPower (  )  throws OneWireIOException, OneWireException

Returns whether the adapter can physically support "smart" strong 5 volt power mode.

"smart" power delivery is the ability to deliver power until it is no longer needed. The current drop it detected and power delivery is stopped.

Returns:
true if this port adapter can do "smart" strong 5 volt mode, false otherwise.
Exceptions:
OneWireIOException on a 1-Wire communication error with the adapter
OneWireException on a setup error with the 1-Wire adapter

Reimplemented from DSPortAdapter.

boolean canBreak (  )  throws OneWireIOException, OneWireException

Returns whether adapter can physically support 0 volt 'break' mode.

Returns:
true if this port adapter can do break, false otherwise.
Exceptions:
OneWireIOException on a 1-Wire communication error with the adapter
OneWireException on a setup error with the 1-Wire adapter

Reimplemented from DSPortAdapter.

boolean findFirstDevice (  )  throws OneWireIOException, OneWireException [virtual]

Returns true if the first iButton or 1-Wire device is found on the 1-Wire Network.

If no devices are found, then false will be returned.

Returns:
true if an iButton or 1-Wire device is found.
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter

Implements DSPortAdapter.

boolean findNextDevice (  )  throws OneWireIOException, OneWireException [virtual]

Returns true if the next iButton or 1-Wire device is found.

The previous 1-Wire device found is used as a starting point in the search. If no more devices are found then false will be returned.

Returns:
true if an iButton or 1-Wire device is found.
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter

Implements DSPortAdapter.

void getAddress ( byte[]  address  )  [virtual]

Copies the 'current' iButton address being used by the adapter into the array.

This address is the last iButton or 1-Wire device found in a search (findNextDevice()...). This method copies into a user generated array to allow the reuse of the buffer. When searching many iButtons on the one wire network, this will reduce the memory burn rate.

Parameters:
address An array to be filled with the current iButton address.
See also:
Address

Implements DSPortAdapter.

boolean isPresent ( byte[]  address  )  throws OneWireIOException, OneWireException

Verifies that the iButton or 1-Wire device specified is present on the 1-Wire Network.

This does not affect the 'current' device state information used in searches (findNextDevice...).

Parameters:
address device address to verify is present
Returns:
true if device is present else false.
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter
See also:
Address

Reimplemented from DSPortAdapter.

boolean isAlarming ( byte[]  address  )  throws OneWireIOException, OneWireException

Verifies that the iButton or 1-Wire device specified is present on the 1-Wire Network and in an alarm state.

This does not affect the 'current' device state information used in searches (findNextDevice...).

Parameters:
address device address to verify is present and alarming
Returns:
true if device is present and alarming else false.
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter
See also:
Address

Reimplemented from DSPortAdapter.

boolean select ( byte[]  address  )  throws OneWireIOException, OneWireException

Selects the specified iButton or 1-Wire device by broadcasting its address.

This operation is refered to a 'MATCH ROM' operation in the iButton and 1-Wire device data sheets. This does not affect the 'current' device state information used in searches (findNextDevice...).

Warning, this does not verify that the device is currently present on the 1-Wire Network (See isPresent).

Parameters:
address iButton to select
Returns:
true if device address was sent,false otherwise.
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter
See also:
com.dalsemi.onewire.adapter.DSPortAdapter.isPresent(byte[] address)

Address

Reimplemented from DSPortAdapter.

void setSearchOnlyAlarmingDevices (  )  [virtual]

Set the 1-Wire Network search to find only iButtons and 1-Wire devices that are in an 'Alarm' state that signals a need for attention.

Not all iButton types have this feature. Some that do: DS1994, DS1920, DS2407. This selective searching can be canceled with the 'setSearchAllDevices()' method.

See also:
setNoResetSearch

Implements DSPortAdapter.

void setNoResetSearch (  )  [virtual]

Set the 1-Wire Network search to not perform a 1-Wire reset before a search.

This feature is chiefly used with the DS2409 1-Wire coupler. The normal reset before each search can be restored with the 'setSearchAllDevices()' method.

Implements DSPortAdapter.

void setSearchAllDevices (  )  [virtual]

Set the 1-Wire Network search to find all iButtons and 1-Wire devices whether they are in an 'Alarm' state or not and restores the default setting of providing a 1-Wire reset command before each search.

(see setNoResetSearch() method).

See also:
setNoResetSearch

Implements DSPortAdapter.

boolean beginExclusive ( boolean  blocking  )  throws OneWireException [virtual]

Gets exclusive use of the 1-Wire to communicate with an iButton or 1-Wire Device.

This method should be used for critical sections of code where a sequence of commands must not be interrupted by communication of threads with other iButtons, and it is permissible to sustain a delay in the special case that another thread has already been granted exclusive access and this access has not yet been relinquished.

It can be called through the OneWireContainer class by the end application if they want to ensure exclusive use. If it is not called around several methods then it will be called inside each method.

Parameters:
blocking true if want to block waiting for an excluse access to the adapter
Returns:
true if blocking was false and a exclusive session with the adapter was aquired
Exceptions:
OneWireException on a setup error with the 1-Wire adapter

Implements DSPortAdapter.

void endExclusive (  )  [virtual]

Relinquishes exclusive control of the 1-Wire Network.

This command dynamically marks the end of a critical section and should be used when exclusive control is no longer needed.

Implements DSPortAdapter.

void putBit ( boolean  bitValue  )  throws OneWireIOException, OneWireException [virtual]

Sends a bit to the 1-Wire Network.

Parameters:
bitValue the bit value to send to the 1-Wire Network.
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter

Implements DSPortAdapter.

boolean getBit (  )  throws OneWireIOException, OneWireException [virtual]

Gets a bit from the 1-Wire Network.

Returns:
the bit value recieved from the the 1-Wire Network.
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter

Implements DSPortAdapter.

void putByte ( int  byteValue  )  throws OneWireIOException, OneWireException [virtual]

Sends a byte to the 1-Wire Network.

Parameters:
byteValue the byte value to send to the 1-Wire Network.
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter

Implements DSPortAdapter.

int getByte (  )  throws OneWireIOException, OneWireException [virtual]

Gets a byte from the 1-Wire Network.

Returns:
the byte value received from the the 1-Wire Network.
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter

Implements DSPortAdapter.

byte [] getBlock ( int  len  )  throws OneWireIOException, OneWireException [virtual]

Get a block of data from the 1-Wire Network.

Parameters:
len length of data bytes to receive
Returns:
the data received from the 1-Wire Network.
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter

Implements DSPortAdapter.

void getBlock ( byte[]  arr,
int  len 
) throws OneWireIOException, OneWireException [virtual]

Get a block of data from the 1-Wire Network and write it into the provided array.

Parameters:
arr array in which to write the received bytes
len length of data bytes to receive
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter

Implements DSPortAdapter.

void getBlock ( byte[]  arr,
int  off,
int  len 
) throws OneWireIOException, OneWireException [virtual]

Get a block of data from the 1-Wire Network and write it into the provided array.

Parameters:
arr array in which to write the received bytes
off offset into the array to start
len length of data bytes to receive
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter

Implements DSPortAdapter.

void dataBlock ( byte  dataBlock[],
int  off,
int  len 
) throws OneWireIOException, OneWireException [virtual]

Sends a block of data and returns the data received in the same array.

This method is used when sending a block that contains reads and writes. The 'read' portions of the data block need to be pre-loaded with 0xFF's. It starts sending data from the index at offset 'off' for length 'len'.

Parameters:
dataBlock array of data to transfer to and from the 1-Wire Network.
off offset into the array of data to start
len length of data to send / receive starting at 'off'
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter

Implements DSPortAdapter.

int reset (  )  throws OneWireIOException, OneWireException [virtual]

Sends a Reset to the 1-Wire Network.

Returns:
the result of the reset. Potential results are:
  • 0 (RESET_NOPRESENCE) no devices present on the 1-Wire Network.
  • 1 (RESET_PRESENCE) normal presence pulse detected on the 1-Wire Network indicating there is a device present.
  • 2 (RESET_ALARM) alarming presence pulse detected on the 1-Wire Network indicating there is a device present and it is in the alarm condition. This is only provided by the DS1994/DS2404 devices.
  • 3 (RESET_SHORT) inticates 1-Wire appears shorted. This can be transient conditions in a 1-Wire Network. Not all adapter types can detect this condition.
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter

Implements DSPortAdapter.

void setPowerDuration ( int  timeFactor  )  throws OneWireIOException, OneWireException

Sets the duration to supply power to the 1-Wire Network.

This method takes a time parameter that indicates the program pulse length when the method startPowerDelivery().

Note: to avoid getting an exception, use the canDeliverPower() and canDeliverSmartPower() method to check it's availability.

Parameters:
timeFactor 
  • 0 (DELIVERY_HALF_SECOND) provide power for 1/2 second.
  • 1 (DELIVERY_ONE_SECOND) provide power for 1 second.
  • 2 (DELIVERY_TWO_SECONDS) provide power for 2 seconds.
  • 3 (DELIVERY_FOUR_SECONDS) provide power for 4 seconds.
  • 4 (DELIVERY_SMART_DONE) provide power until the the device is no longer drawing significant power.
  • 5 (DELIVERY_INFINITE) provide power until the setPowerNormal() method is called.
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter

Reimplemented from DSPortAdapter.

boolean startPowerDelivery ( int  changeCondition  )  throws OneWireIOException, OneWireException

Sets the 1-Wire Network voltage to supply power to an iButton device.

This method takes a time parameter that indicates whether the power delivery should be done immediately, or after certain conditions have been met.

Note: to avoid getting an exception, use the canDeliverPower() and canDeliverSmartPower() method to check it's availability.

Parameters:
changeCondition 
  • 0 (CONDITION_NOW) operation should occur immediately.
  • 1 (CONDITION_AFTER_BIT) operation should be pending execution immediately after the next bit is sent.
  • 2 (CONDITION_AFTER_BYTE) operation should be pending execution immediately after next byte is sent.
Returns:
true if the voltage change was successful, false otherwise.
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter

Reimplemented from DSPortAdapter.

void setProgramPulseDuration ( int  timeFactor  )  throws OneWireIOException, OneWireException

Sets the duration for providing a program pulse on the 1-Wire Network.

This method takes a time parameter that indicates the program pulse length when the method startProgramPulse().

Note: to avoid getting an exception, use the canDeliverPower() method to check it's availability.

Parameters:
timeFactor 
  • 6 (DELIVERY_EPROM) provide program pulse for 480 microseconds
  • 5 (DELIVERY_INFINITE) provide power until the setPowerNormal() method is called.
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter

Reimplemented from DSPortAdapter.

boolean startProgramPulse ( int  changeCondition  )  throws OneWireIOException, OneWireException

Sets the 1-Wire Network voltage to eprom programming level.

This method takes a time parameter that indicates whether the power delivery should be done immediately, or after certain conditions have been met.

Note: to avoid getting an exception, use the canProgram() method to check it's availability.

Parameters:
changeCondition 
  • 0 (CONDITION_NOW) operation should occur immediately.
  • 1 (CONDITION_AFTER_BIT) operation should be pending execution immediately after the next bit is sent.
  • 2 (CONDITION_AFTER_BYTE) operation should be pending execution immediately after next byte is sent.
Returns:
true if the voltage change was successful, false otherwise.
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter or the adapter does not support this operation

Reimplemented from DSPortAdapter.

void startBreak (  )  throws OneWireIOException, OneWireException

Sets the 1-Wire Network voltage to 0 volts.

This method is used rob all 1-Wire Network devices of parasite power delivery to force them into a hard reset.

Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter or the adapter does not support this operation

Reimplemented from DSPortAdapter.

void setPowerNormal (  )  throws OneWireIOException, OneWireException

Sets the 1-Wire Network voltage to normal level.

This method is used to disable 1-Wire conditions created by startPowerDelivery and startProgramPulse. This method will automatically be called if a communication method is called while an outstanding power command is taking place.

Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter or the adapter does not support this operation

Reimplemented from DSPortAdapter.

void setSpeed ( int  desiredSpeed  )  throws OneWireIOException, OneWireException

This method takes an int representing the new speed of data transfer on the 1-Wire Network.

Parameters:
speed 
  • 0 (SPEED_REGULAR) set to normal communciation speed
  • 1 (SPEED_FLEX) set to flexible communciation speed used for long lines
  • 2 (SPEED_OVERDRIVE) set to normal communciation speed to overdrive
  • 3 (SPEED_HYPERDRIVE) set to normal communciation speed to hyperdrive
  • >3 future speeds
desiredSpeed 
Exceptions:
OneWireIOException on a 1-Wire communication error
OneWireException on a setup error with the 1-Wire adapter or the adapter does not support this operation

Reimplemented from DSPortAdapter.

int getSpeed (  ) 

This method returns the current data transfer speed through a port to a 1-Wire Network.

Returns:
  • 0 (SPEED_REGULAR) set to normal communication speed
  • 1 (SPEED_FLEX) set to flexible communication speed used for long lines
  • 2 (SPEED_OVERDRIVE) set to normal communication speed to overdrive
  • 3 (SPEED_HYPERDRIVE) set to normal communication speed to hyperdrive
  • >3 future speeds

Reimplemented from DSPortAdapter.

boolean setTMEXPortType ( int  newPortType  ) 

Select the DotNet specified port type (0 to 15) Use this method if the constructor with the PortType cannot be used.

Parameters:
newPortType 
Returns:
true if port type valid. Instance is only usable if this returns false.

static String getDefaultAdapterName (  )  [static]

Get the default Adapter Name.

Returns:
String containing the name of the default adapter

static String getDefaultPortName (  )  [static]

Get the default Adapter Port name.

Returns:
String containing the name of the default adapter port


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