com.dalsemi.onewire.container
Class OneWireContainer2D

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

public class OneWireContainer2D
extends OneWireContainer

1-Wire® container for the '1K-Bit protected 1-Wire EEPROM family type 2D (hex), Dallas Semiconductor part number: DS2431.

Features

The memory can also be accessed through the objects that are returned from the getMemoryBanks method.

Version:
0.00, 10 March 2004
Author:
DS

Field Summary
static byte WRITEONCE_FLAG
          Page Lock Flag
 
Constructor Summary
OneWireContainer2D()
          Default Constructor OneWireContainer2D.
OneWireContainer2D(DSPortAdapter sourceAdapter, byte[] newAddress)
          Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
OneWireContainer2D(DSPortAdapter sourceAdapter, long newAddress)
          Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
OneWireContainer2D(DSPortAdapter sourceAdapter, String newAddress)
          Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
 
Method Summary
 String getAlternateNames()
          Retrieve the alternate Dallas Semiconductor part numbers or names.
 String getDescription()
          Retrieve a short description of the function of the iButton type.
 int getMaxSpeed()
          Returns the maximum speed this iButton can communicate at.
 Enumeration getMemoryBanks()
          Get an enumeration of memory bank instances that implement one or more of the following interfaces: MemoryBank, PagedMemoryBank, and OTPMemoryBank.
 String getName()
          Retrieve the Dallas Semiconductor part number of the iButton as a string.
 boolean isPageWriteOnce(int page)
          Query to see if current memory bank is write write once such as with EPROM technology.
 void setPageWriteOnce(int page)
          Lock the specifed page in the current memory bank.
 void setupContainer(DSPortAdapter sourceAdapter, byte[] newAddress)
          Provide this container the adapter object used to access this device and provide the address of this iButton or 1-Wire device.
 void setupContainer(DSPortAdapter sourceAdapter, long newAddress)
          Provide this container the adapter object used to access this device and provide the address of this iButton or 1-Wire device.
 void setupContainer(DSPortAdapter sourceAdapter, String newAddress)
          Provide this container the adapter object used to access this device and provide the address of this iButton or 1-Wire device.
 
Methods inherited from class com.dalsemi.onewire.container.OneWireContainer
doSpeed, equals, getAdapter, getAddress, getAddressAsLong, getAddressAsString, hashCode, isAlarming, isPresent, setSpeed, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

WRITEONCE_FLAG

public static final byte WRITEONCE_FLAG
Page Lock Flag
Constructor Detail

OneWireContainer2D

public OneWireContainer2D()
Default Constructor OneWireContainer2D. Must call setupContainer before using.

OneWireContainer2D

public OneWireContainer2D(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

OneWireContainer2D

public OneWireContainer2D(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

OneWireContainer2D

public OneWireContainer2D(DSPortAdapter sourceAdapter,
                          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

setupContainer

public void setupContainer(DSPortAdapter sourceAdapter,
                           byte[] newAddress)
Provide this container the adapter object used to access this device and provide the address of this iButton or 1-Wire device.
Overrides:
setupContainer in class OneWireContainer
Parameters:
sourceAdapter - adapter object required to communicate with this iButton.
newAddress - address of this 1-Wire device

setupContainer

public void setupContainer(DSPortAdapter sourceAdapter,
                           long newAddress)
Provide this container the adapter object used to access this device and provide the address of this iButton or 1-Wire device.
Overrides:
setupContainer in class OneWireContainer
Parameters:
sourceAdapter - adapter object required to communicate with this iButton.
newAddress - address of this 1-Wire device

setupContainer

public void setupContainer(DSPortAdapter sourceAdapter,
                           String newAddress)
Provide this container the adapter object used to access this device and provide the address of this iButton or 1-Wire device.
Overrides:
setupContainer in class OneWireContainer
Parameters:
sourceAdapter - adapter object required to communicate with this iButton.
newAddress - address of this 1-Wire device

getName

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

getAlternateNames

public String getAlternateNames()
Retrieve the alternate Dallas Semiconductor part numbers or names. A 'family' of MicroLAN devices may have more than one part number depending on packaging.
Overrides:
getAlternateNames in class OneWireContainer
Returns:
the alternate names for this iButton or 1-Wire device

getDescription

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

getMaxSpeed

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

getMemoryBanks

public Enumeration getMemoryBanks()
Get an enumeration of memory bank instances that implement one or more of the following interfaces: MemoryBank, PagedMemoryBank, and OTPMemoryBank.
Overrides:
getMemoryBanks in class OneWireContainer
Returns:
Enumeration of memory banks

isPageWriteOnce

public boolean isPageWriteOnce(int page)
                        throws OneWireIOException,
                               OneWireException
Query to see if current memory bank is write write once such as with EPROM technology.
Returns:
'true' if current memory bank can only be written once

setPageWriteOnce

public void setPageWriteOnce(int page)
                      throws OneWireIOException,
                             OneWireException
Lock the specifed page in the current memory bank. Not supported by all devices. See the method 'canLockPage()'.
Parameters:
page - number of page to lock
Throws:
OneWireIOException -  
OneWireException -  


Copyright © 1999-2005 Dallas Semiconductor. All Rights Reserved.