com.dalsemi.onewire.container
Class OneWireContainer1D

java.lang.Object
  |
  +--com.dalsemi.onewire.container.OneWireContainer
        |
        +--com.dalsemi.onewire.container.OneWireContainer1D

public class OneWireContainer1D
extends OneWireContainer

iButton container for iButton family type 1D (hex). This family type is a 'counter' iButton (DS2423). It contains 4 counters assosiated with pages 12 to 15.

Version:
0.00, 28 Aug 2000

Constructor Summary
OneWireContainer1D()
          Default constructor
OneWireContainer1D(DSPortAdapter sourceAdapter, byte[] newAddress)
          Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
OneWireContainer1D(DSPortAdapter sourceAdapter, long newAddress)
          Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
OneWireContainer1D(DSPortAdapter sourceAdapter, java.lang.String newAddress)
          Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
 
Method Summary
 java.lang.String getAlternateNames()
          Retrieve the alternate Dallas Semiconductor part numbers or names.
 java.lang.String getDescription()
          Retrieve a short description of the function of the iButton type.
 int getMaxSpeed()
          Returns the maximum speed this iButton can communicate at.
 java.util.Enumeration getMemoryBanks()
          Return an enumeration of memory banks.
 java.lang.String getName()
          Retrieve the Dallas Semiconductor part number of the iButton as a string.
 long readCounter(int counterPage)
          Read the counter value from a page on this iButton.
 
Methods inherited from class com.dalsemi.onewire.container.OneWireContainer
doSpeed, getAdapter, getAddress, getAddressAsLong, getAddressAsString, isAlarming, isPresent, setSpeed, setupContainer, setupContainer, setupContainer
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OneWireContainer1D

public OneWireContainer1D()
Default constructor

OneWireContainer1D

public OneWireContainer1D(DSPortAdapter sourceAdapter,
                          byte[] newAddress)
Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
Parameters:
sourceAdapter - adapter object required to communicate with this iButton.
newAddress - address of this 1-Wire device

OneWireContainer1D

public OneWireContainer1D(DSPortAdapter sourceAdapter,
                          long newAddress)
Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
Parameters:
sourceAdapter - adapter object required to communicate with this iButton.
newAddress - address of this 1-Wire device

OneWireContainer1D

public OneWireContainer1D(DSPortAdapter sourceAdapter,
                          java.lang.String newAddress)
Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
Parameters:
sourceAdapter - adapter object required to communicate with this iButton.
newAddress - address of this 1-Wire device
Method Detail

getName

public java.lang.String getName()
Retrieve the Dallas Semiconductor part number of the iButton as a string. For example 'DS1992'.
Overrides:
getName in class OneWireContainer
Returns:
String representation of the iButton name.

getAlternateNames

public java.lang.String getAlternateNames()
Retrieve the alternate Dallas Semiconductor part numbers or names. A 'family' of 1-Wire Network devices may have more than one part number depending on packaging. There can also be nicknames such as 'Crypto iButton'.
Overrides:
getAlternateNames in class OneWireContainer
Returns:
String representation of the alternate names.

getDescription

public java.lang.String getDescription()
Retrieve a short description of the function of the iButton type.
Overrides:
getDescription in class OneWireContainer
Returns:
String representation of the function description.

getMaxSpeed

public int getMaxSpeed()
Returns the maximum speed this iButton can communicate at.
Overrides:
getMaxSpeed in class OneWireContainer

getMemoryBanks

public java.util.Enumeration getMemoryBanks()
Return an enumeration of memory banks. Look at the MemoryBank, PagedMemoryBank and OTPMemoryBank classes.
Overrides:
getMemoryBanks in class OneWireContainer
Following copied from class: com.dalsemi.onewire.container.OneWireContainer
Returns:
enumeration of memory banks to read and write memory on this iButton or 1-Wire device.

readCounter

public long readCounter(int counterPage)
                 throws OneWireIOException,
                        OneWireException
Read the counter value from a page on this iButton.
Parameters:
counterPage - page number of the counter to read
Returns:
counter 4 byte value. Since this value is unsigned then the value is returned in an 8 byte long integer.
Throws:
OneWireIOException -  
OneWireException -