OneWireContainer14 Class Reference

Inherits com::dalsemi::onewire::container::OneWireContainer.

List of all members.


Detailed Description

1-Wire container for 32 byte EEPROM memory iButton, DS1971 and 1-Wire Chip, DS2430A. This container encapsulates the functionality of the 1-Wire family type 14 (hex)

The iButton package for this device is primarily used as a read/write portable memory device. The 1-Wire Chip version is used for small non-volatile storage.

Features

Alternate Names

Memory

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

The following is a list of the MemoryBank instances that are returned:

Usage

See the usage example in OneWireContainer to enumerate the MemoryBanks. See the usage examples in MemoryBank, PagedMemoryBank, and OTPMemoryBank for bank specific operations.

DataSheets

http://pdfserv.maxim-ic.com/arpdf/DS1971.pdf http://pdfserv.maxim-ic.com/arpdf/DS2430A.pdf

See also:
com.dalsemi.onewire.container.MemoryBank

com.dalsemi.onewire.container.PagedMemoryBank

com.dalsemi.onewire.container.OneWireContainer14

Version:
0.00, 28 Aug 2000
Author:
DS

Public Member Functions

 OneWireContainer14 ()
 Create an empty container that is not complete until after a call to setupContainer.
 OneWireContainer14 (DSPortAdapter sourceAdapter, byte[] newAddress)
 Create a container with the provided adapter instance and the address of the iButton or 1-Wire device.
 OneWireContainer14 (DSPortAdapter sourceAdapter, long newAddress)
 Create a container with the provided adapter instance and the address of the iButton or 1-Wire device.
 OneWireContainer14 (DSPortAdapter sourceAdapter, String newAddress)
 Create a container with the provided adapter instance and the address of the iButton or 1-Wire device.
String getName ()
 Get the Maxim Integrated Products part number of the iButton or 1-Wire Device as a string.
String getAlternateNames ()
 Get the alternate Maxim Integrated Products part numbers or names.
String getDescription ()
 Get a short description of the function of this iButton or 1-Wire Device type.
Enumeration getMemoryBanks ()
 Get an enumeration of memory bank instances that implement one or more of the following interfaces: MemoryBank, PagedMemoryBank, and OTPMemoryBank.

Constructor & Destructor Documentation

Create an empty container that is not complete until after a call to setupContainer.

This is one of the methods to construct a container. The others are through creating a OneWireContainer with parameters.

See also:
setupContainer(com.dalsemi.onewire.adapter.DSPortAdapter,byte[]) super.setupContainer()

OneWireContainer14 ( DSPortAdapter  sourceAdapter,
byte[]  newAddress 
)

Create a container with the provided adapter instance and the address of the iButton or 1-Wire device.

This is one of the methods to construct a container. The other is through creating a OneWireContainer with NO parameters.

Parameters:
sourceAdapter adapter instance used to communicate with this iButton
newAddress Address of this 1-Wire device
See also:
OneWireContainer14() OneWireContainer14

com.dalsemi.onewire.utils.Address utils.Address

OneWireContainer14 ( DSPortAdapter  sourceAdapter,
long  newAddress 
)

Create a container with the provided adapter instance and the address of the iButton or 1-Wire device.

This is one of the methods to construct a container. The other is through creating a OneWireContainer with NO parameters.

Parameters:
sourceAdapter adapter instance used to communicate with this 1-Wire device
newAddress Address of this 1-Wire device
See also:
OneWireContainer14() OneWireContainer14

com.dalsemi.onewire.utils.Address utils.Address

OneWireContainer14 ( DSPortAdapter  sourceAdapter,
String  newAddress 
)

Create a container with the provided adapter instance and the address of the iButton or 1-Wire device.

This is one of the methods to construct a container. The other is through creating a OneWireContainer with NO parameters.

Parameters:
sourceAdapter adapter instance used to communicate with this 1-Wire device
newAddress Address of this 1-Wire device
See also:
OneWireContainer14() OneWireContainer14

com.dalsemi.onewire.utils.Address utils.Address


Member Function Documentation

String getName (  ) 

Get the Maxim Integrated Products part number of the iButton or 1-Wire Device as a string.

For example 'DS1992'.

Returns:
iButton or 1-Wire device name

Reimplemented from OneWireContainer.

String getAlternateNames (  ) 

Get the alternate Maxim Integrated Products 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'.

Returns:
1-Wire device alternate names

Reimplemented from OneWireContainer.

String getDescription (  ) 

Get a short description of the function of this iButton or 1-Wire Device type.

Returns:
device description

Reimplemented from OneWireContainer.

Enumeration getMemoryBanks (  ) 

Get an enumeration of memory bank instances that implement one or more of the following interfaces: MemoryBank, PagedMemoryBank, and OTPMemoryBank.

Returns:
Enumeration of memory banks

Reimplemented from OneWireContainer.


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

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