com.dalsemi.onewire.adapter
Class TINIInternalAdapter

java.lang.Object
  |
  +--com.dalsemi.onewire.adapter.DSPortAdapter
        |
        +--com.dalsemi.onewire.adapter.TINIAdapter
              |
              +--com.dalsemi.onewire.adapter.TINIInternalAdapter

public class TINIInternalAdapter

extends com.dalsemi.onewire.adapter.TINIAdapter

Port adapter for the TINI internal one wire bus. TINIInternalAdapter differs from other adapters in that it is a simple port pin with a 2.2K pull up resistor with no fancy FET pull up source. The canDeliverPower method will return true, but be aware that this only applies to single low current devices (single EEPROM, temperature, or potentiometer).

Fields inherited from class com.dalsemi.onewire.adapter.TINIAdapter

classVersion, OW_EXTERNAL, OW_INTERNAL, OWDISPATCH_CANCELSTRONGPU, OWDISPATCH_CANPROGRAM, OWDISPATCH_DOPROGRAMPULSE, OWDISPATCH_GETSPEED, OWDISPATCH_GETVERSION, OWDISPATCH_ISPRESENT, OWDISPATCH_SETSPEED, portSelected, portType

Fields inherited from class com.dalsemi.onewire.adapter.DSPortAdapter

CONDITION_AFTER_BIT, CONDITION_AFTER_BYTE, CONDITION_NOW, DELIVERY_CURRENT_DETECT, DELIVERY_EPROM, DELIVERY_FOUR_SECONDS, DELIVERY_HALF_SECOND, DELIVERY_INFINITE, DELIVERY_ONE_SECOND, DELIVERY_SMART_DONE, DELIVERY_TWO_SECONDS, LEVEL_BREAK, LEVEL_NORMAL, LEVEL_POWER_DELIVERY, LEVEL_PROGRAM, RESET_ALARM, RESET_NOPRESENCE, RESET_PRESENCE, RESET_SHORT, SPEED_FLEX, SPEED_HYPERDRIVE, SPEED_OVERDRIVE, SPEED_REGULAR

Constructor Summary

TINIInternalAdapter()
Constructor TINIInternalAdapter

Method Summary

boolean	canDeliverPower() Returns whether the adapter can physically support strong 5 volt power mode.
boolean	canFlex() Returns whether the adapter can physically support flex speed mode.
boolean	canHyperdrive() Returns whether the adapter can physically support hyperdrive mode.
boolean	canOverdrive() Returns whether adapter can physically support overdrive mode.
java.lang.String	getAdapterName() Retrieve the name of the port adapter as a string.
java.lang.String	getClassVersion() Retrieve a version string for this class
java.lang.String	getPortName() Retrieve the name of the selected port as a String.
java.util.Enumeration	getPortNames() Retrieve a list of the platform appropriate port names for this adapter.
java.lang.String	getPortTypeDescription() Retrieve a description of the port required by this port adapter.
boolean	selectPort(java.lang.String portName) Specify a platform appropriate port name for this adapter.

Methods inherited from class com.dalsemi.onewire.adapter.TINIAdapter

adapterDetected, beginExclusive, canProgram, dataBlock, endExclusive, findFirstDevice, findNextDevice, freePort, getAdapterVersion, getAddress, getBit, getBlock, getBlock, getBlock, getByte, getSpeed, isAlarming, isPresent, OWDispatchNative, putBit, putByte, reset, select, setNoResetSearch, setPowerDuration, setPowerNormal, setSearchAllDevices, setSearchOnlyAlarmingDevices, setSpeed, startPowerDelivery

Methods inherited from class com.dalsemi.onewire.adapter.DSPortAdapter

canBreak, canDeliverSmartPower, excludeFamily, excludeFamily, getAdapterAddress, getAddressAsLong, getAddressAsString, getAllDeviceContainers, getDeviceContainer, getDeviceContainer, getDeviceContainer, getDeviceContainer, getFirstDeviceContainer, getNextDeviceContainer, isAlarming, isAlarming, isPresent, isPresent, isValidFamily, registerOneWireContainerClass, select, select, setProgramPulseDuration, startBreak, startProgramPulse, targetAllFamilies, targetFamily, targetFamily

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TINIInternalAdapter

public TINIInternalAdapter()

Constructor TINIInternalAdapter

Method Detail

getAdapterName

public java.lang.String getAdapterName()

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.

Overrides:

getAdapterName in class DSPortAdapter

getPortTypeDescription

public java.lang.String getPortTypeDescription()

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.

Overrides:

getPortTypeDescription in class DSPortAdapter

getClassVersion

public java.lang.String getClassVersion()

Retrieve a version string for this class

Returns:

version string

Overrides:

getClassVersion in class DSPortAdapter

getPortNames

public java.util.Enumeration getPortNames()

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

Overrides:

getPortNames in class DSPortAdapter

selectPort

public boolean selectPort(java.lang.String portName)
                   throws OneWireIOException,
                          OneWireException

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.

Throws:

OneWireIOException -

OneWireException -

Overrides:

selectPort in class DSPortAdapter

getPortName

public java.lang.String getPortName()
                             throws OneWireException

Retrieve the name of the selected port as a String.

Returns:

String of selected port

Throws:

OneWireException -

Overrides:

getPortName in class DSPortAdapter

canOverdrive

public boolean canOverdrive()
                     throws OneWireIOException,
                            OneWireException

Returns whether adapter can physically support overdrive mode.

Returns:

true if this port adapter can do OverDrive, false otherwise.

Throws:

OneWireIOException -

OneWireException -

Overrides:

canOverdrive in class DSPortAdapter

canHyperdrive

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

Throws:

OneWireIOException -

OneWireException -

Overrides:

canHyperdrive in class DSPortAdapter

canFlex

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

Throws:

OneWireIOException -

OneWireException -

Overrides:

canFlex in class DSPortAdapter

canDeliverPower

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

Throws:

OneWireIOException -

OneWireException -

Overrides:

canDeliverPower in class DSPortAdapter