1-Wire API for .NET Version 4.00
Public Member Functions | Static Public Attributes

OneWireContainer2D Class Reference

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

List of all members.

Public Member Functions

 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.
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.
String getName ()
 Retrieve the Maxim Integrated Products part number of the iButton as a string.
String getAlternateNames ()
 Retrieve the alternate Maxim Integrated Products 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.
boolean isPageWriteOnce (int page) throws OneWireIOException, OneWireException
 Query to see if current memory bank is write write once such as with EPROM technology.
void setPageWriteOnce (int page) throws OneWireIOException, OneWireException
 Lock the specifed page in the current memory bank.

Static Public Attributes

static final byte WRITEONCE_FLAG = ( byte ) 0xAA
 Page Lock Flag.

Detailed Description

1-Wire® container for the '1K-Bit protected 1-Wire EEPROM family type 2D (hex), Maxim Integrated Products 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

Constructor & Destructor Documentation

Default Constructor OneWireContainer2D.

Must call setupContainer before using.

OneWireContainer2D ( DSPortAdapter  sourceAdapter,
byte[]  newAddress 
)

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

Parameters:
sourceAdapteradapter object required to communicate with this iButton.
newAddressaddress of this 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.

Parameters:
sourceAdapteradapter object required to communicate with this iButton.
newAddressaddress of this 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.

Parameters:
sourceAdapteradapter object required to communicate with this iButton.
newAddressaddress of this 1-Wire device

Member Function Documentation

String getAlternateNames ( )

Retrieve the alternate Maxim Integrated Products part numbers or names.

A 'family' of MicroLAN devices may have more than one part number depending on packaging.

Returns:
the alternate names for this iButton or 1-Wire device

Reimplemented from OneWireContainer.

String getDescription ( )

Retrieve a short description of the function of the iButton type.

Returns:
string represetation of the function description.

Reimplemented from OneWireContainer.

int getMaxSpeed ( )

Returns the maximum speed this iButton can communicate at.

Returns:
max. communication speed.

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.

String getName ( )

Retrieve the Maxim Integrated Products part number of the iButton as a string.

For example 'DS1992'.

Returns:
string represetation of the iButton name.

Reimplemented from OneWireContainer.

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
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:
pagenumber of page to lock
Exceptions:
OneWireIOException
OneWireException
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.

Parameters:
sourceAdapteradapter object required to communicate with this iButton.
newAddressaddress of this 1-Wire device

Reimplemented from OneWireContainer.

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.

Parameters:
sourceAdapteradapter object required to communicate with this iButton.
newAddressaddress of this 1-Wire device

Reimplemented from OneWireContainer.

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.

Parameters:
sourceAdapteradapter object required to communicate with this iButton.
newAddressaddress of this 1-Wire device

Reimplemented from OneWireContainer.


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