ScratchPad Interface Reference

Inherited by MemoryBankScratch.

List of all members.


Detailed Description

Scratchpad interface for Memory banks that require it.

Version:
0.00, 28 Aug 2000
Author:
DS

Public Member Functions

void readScratchpad (byte[] readBuf, int offset, int len, byte[] extraInfo) throws OneWireIOException, OneWireException
 Read the scratchpad page of memory from a NVRAM device This method reads and returns the entire scratchpad after the byte offset regardless of the actual ending offset.
void writeScratchpad (int startAddr, byte[] writeBuf, int offset, int len) throws OneWireIOException, OneWireException
 Write to the scratchpad page of memory a NVRAM device.
void copyScratchpad (int startAddr, int len) throws OneWireIOException, OneWireException
 Copy the scratchpad page to memory.
int getExtraInfoLength ()
 Query to get the length in bytes of extra information that is read when read a page in the current memory bank.
void checkSpeed () throws OneWireIOException, OneWireException
 Check the device speed if has not been done before or if an error was detected.
void forceVerify ()
 Set the flag to indicate the next 'checkSpeed()' will force a speed set and verify.

Member Function Documentation

void readScratchpad ( byte[]  readBuf,
int  offset,
int  len,
byte[]  extraInfo 
) throws OneWireIOException, OneWireException

Read the scratchpad page of memory from a NVRAM device This method reads and returns the entire scratchpad after the byte offset regardless of the actual ending offset.

Parameters:
readBuf byte array to place read data into length of array is always pageLength.
offset offset into readBuf to pug data
len length in bytes to read
extraInfo byte array to put extra info read into (TA1, TA2, e/s byte) length of array is always extraInfoLength. Can be 'null' if extra info is not needed.
Exceptions:
OneWireIOException 
OneWireException 

Implemented in MemoryBankScratch, MemoryBankScratchCRC, MemoryBankScratchCRCPW, and MemoryBankScratchSHAEE.

void writeScratchpad ( int  startAddr,
byte[]  writeBuf,
int  offset,
int  len 
) throws OneWireIOException, OneWireException

Write to the scratchpad page of memory a NVRAM device.

Parameters:
startAddr starting address
writeBuf byte array containing data to write
offset offset into readBuf to place data
len length in bytes to write
Exceptions:
OneWireIOException 
OneWireException 

Implemented in MemoryBankScratch, MemoryBankScratchCRCPW, MemoryBankScratchEE, MemoryBankScratchEx, MemoryBankScratchSHA, and MemoryBankScratchSHAEE.

void copyScratchpad ( int  startAddr,
int  len 
) throws OneWireIOException, OneWireException

Copy the scratchpad page to memory.

Parameters:
startAddr starting address
len length in bytes that was written already
Exceptions:
OneWireIOException 
OneWireException 

Implemented in MemoryBankScratch, MemoryBankScratchCRCPW, MemoryBankScratchEE, MemoryBankScratchEx, and MemoryBankScratchSHAEE.

int getExtraInfoLength (  ) 

Query to get the length in bytes of extra information that is read when read a page in the current memory bank.

See 'hasExtraInfo()'.

Returns:
number of bytes in Extra Information read when reading pages in the current memory bank.

Implemented in MemoryBankScratch.

void checkSpeed (  )  throws OneWireIOException, OneWireException

Check the device speed if has not been done before or if an error was detected.

Exceptions:
OneWireIOException 
OneWireException 

Implemented in MemoryBankScratch.


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

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