OneWireContainer1A Class Reference

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

List of all members.


Detailed Description

1-Wire container for 512 byte memory iButton with write cycle counters, DS1963L. This container encapsulates the functionality of the iButton family type 1A (hex)

This iButton is primarily used as a read/write portable memory device that provides tamper detection when utilizing the write counters.

Features

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 and PagedMemoryBank for bank specific operations.

DataSheet

http://pdfserv.maxim-ic.com/arpdf/DS1963L.pdf

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

com.dalsemi.onewire.container.PagedMemoryBank

com.dalsemi.onewire.container.OneWireContainer18

Version:
0.00, 28 Aug 2000
Author:
DS

Public Member Functions

 OneWireContainer1A ()
 Create an empty container that is not complete until after a call to setupContainer.
 OneWireContainer1A (DSPortAdapter sourceAdapter, byte[] newAddress)
 Create a container with the provided adapter instance and the address of the iButton or 1-Wire device.
 OneWireContainer1A (DSPortAdapter sourceAdapter, long newAddress)
 Create a container with the provided adapter instance and the address of the iButton or 1-Wire device.
 OneWireContainer1A (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.
int getMaxSpeed ()
 Get the maximum speed this iButton or 1-Wire device 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.

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()

OneWireContainer1A ( 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:
OneWireContainer1A() OneWireContainer1A

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

OneWireContainer1A ( 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:
OneWireContainer1A() OneWireContainer1A

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

OneWireContainer1A ( 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:
OneWireContainer1A() OneWireContainer1A

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.

int getMaxSpeed (  ) 

Get the maximum speed this iButton or 1-Wire device can communicate at.

Override this method if derived iButton type can go faster then SPEED_REGULAR(0).

Returns:
maximum speed
See also:
com.dalsemi.onewire.container.OneWireContainer.setSpeed super.setSpeed

com.dalsemi.onewire.adapter.DSPortAdapter.SPEED_REGULAR DSPortAdapter.SPEED_REGULAR

com.dalsemi.onewire.adapter.DSPortAdapter.SPEED_OVERDRIVE DSPortAdapter.SPEED_OVERDRIVE

com.dalsemi.onewire.adapter.DSPortAdapter.SPEED_FLEX DSPortAdapter.SPEED_FLEX

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