OneWireContainer3A Class Reference

Inherits com::dalsemi::onewire::container::OneWireContainer, and com::dalsemi::onewire::container::SwitchContainer.

List of all members.


Detailed Description

1-Wire® container for a Single Addressable Switch, DS2413. This container encapsulates the functionality of the 1-Wire family type 3A (hex)

Features

Usage

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

com.dalsemi.onewire.container.SwitchContainer

com.dalsemi.onewire.container.OneWireContainer

Version:
1.00, 01 Jun 2002
Author:
JPE

Public Member Functions

 OneWireContainer3A ()
 Creates a new OneWireContainer for communication with a DS2413.
 OneWireContainer3A (DSPortAdapter sourceAdapter, byte[] newAddress)
 Creates a new OneWireContainer for communication with a DS2413.
 OneWireContainer3A (DSPortAdapter sourceAdapter, long newAddress)
 Creates a new OneWireContainer for communication with a DS2413.
 OneWireContainer3A (DSPortAdapter sourceAdapter, String newAddress)
 Creates a new OneWireContainer for communication with a DS2413.
String getName ()
 Gets the Maxim Integrated Products part number of the iButton or 1-Wire Device as a java.lang.String.
String getAlternateNames ()
 Retrieves the alternate Maxim Integrated Products part numbers or names.
String getDescription ()
 Gets a short description of the function of this iButton or 1-Wire Device type.
int getMaxSpeed ()
 Returns the maximum speed this iButton or 1-Wire device can communicate at.
int getNumberChannels (byte[] state)
 Gets the number of channels supported by this switch.
boolean isHighSideSwitch ()
 Checks if the channels of this switch are 'high side' switches.
boolean hasActivitySensing ()
 Checks if the channels of this switch support activity sensing.
boolean hasLevelSensing ()
 Checks if the channels of this switch support level sensing.
boolean hasSmartOn ()
 Checks if the channels of this switch support 'smart on'.
boolean onlySingleChannelOn ()
 Checks if the channels of this switch require that only one channel is on at any one time.
boolean getLevel (int channel, byte[] state)
 Checks the sensed level on the indicated channel.
boolean getLatchState (int channel, byte[] state)
 Checks the latch state of the indicated channel.
boolean getSensedActivity (int channel, byte[] state) throws OneWireException
 Checks if the indicated channel has experienced activity.
void clearActivity () throws OneWireException
 Clears the activity latches the next time possible.
void setLatchState (int channel, boolean latchState, boolean doSmart, byte[] state)
 Sets the latch state of the indicated channel.
void setLatchState (byte set, byte[] state)
 Sets the latch state for all of the channels.
byte[] readDevice () throws OneWireIOException, OneWireException
 Retrieves the 1-Wire device sensor state.
byte[] readRegister () throws OneWireIOException, OneWireException
 Retrieves the 1-Wire device register mask.
void writeDevice (byte state[]) throws OneWireIOException, OneWireException
 Writes the 1-Wire device sensor state that have been changed by 'set' methods.
void writeRegister (byte[] register) throws OneWireIOException, OneWireException
 Writes the 1-Wire device register mask that have been changed by 'set' methods.

Static Public Attributes

static final byte PIO_ACCESS_READ = ( byte ) 0xF5
 PIO Access read command.
static final byte PIO_ACCESS_WRITE = ( byte ) 0x5A
 PIO Access read command.

Constructor & Destructor Documentation

OneWireContainer3A ( DSPortAdapter  sourceAdapter,
byte[]  newAddress 
)

Creates a new OneWireContainer for communication with a DS2413.

Parameters:
sourceAdapter adapter object required to communicate with this 1-Wire device
newAddress address of this DS2413
See also:
OneWireContainer3A()

OneWireContainer3A(com.dalsemi.onewire.adapter.DSPortAdapter,long) OneWireContainer3A(DSPortAdapter,long)

OneWireContainer3A(com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String) OneWireContainer3A(DSPortAdapter,String)

OneWireContainer3A ( DSPortAdapter  sourceAdapter,
long  newAddress 
)

Creates a new OneWireContainer for communication with a DS2413.

Parameters:
sourceAdapter adapter object required to communicate with this 1-Wire device
newAddress address of this DS2413
See also:
OneWireContainer3A()

OneWireContainer3A(com.dalsemi.onewire.adapter.DSPortAdapter,byte[]) OneWireContainer3A(DSPortAdapter,byte[])

OneWireContainer3A(com.dalsemi.onewire.adapter.DSPortAdapter,java.lang.String) OneWireContainer3A(DSPortAdapter,String)

OneWireContainer3A ( DSPortAdapter  sourceAdapter,
String  newAddress 
)

Creates a new OneWireContainer for communication with a DS2413.

Parameters:
sourceAdapter adapter object required to communicate with this 1-Wire device
newAddress address of this DS2413
See also:
OneWireContainer3A()

OneWireContainer3A(com.dalsemi.onewire.adapter.DSPortAdapter,byte[]) OneWireContainer3A(DSPortAdapter,byte[])

OneWireContainer3A(com.dalsemi.onewire.adapter.DSPortAdapter,long) OneWireContainer3A(DSPortAdapter,long)


Member Function Documentation

String getName (  ) 

Gets the Maxim Integrated Products part number of the iButton or 1-Wire Device as a java.lang.String.

For example "DS1992".

Returns:
iButton or 1-Wire device name

Reimplemented from OneWireContainer.

String getAlternateNames (  ) 

Retrieves the alternate Maxim Integrated Products part numbers or names.

A 'family' of MicroLAN devices may have more than one part number depending on packaging. There can also be nicknames such as "Crypto iButton".

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

Reimplemented from OneWireContainer.

String getDescription (  ) 

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

Returns:
device description

Reimplemented from OneWireContainer.

int getMaxSpeed (  ) 

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

Returns:
maximum speed
See also:
DSPortAdapter.setSpeed

Reimplemented from OneWireContainer.

int getNumberChannels ( byte[]  state  ) 

Gets the number of channels supported by this switch.

Channel specific methods will use a channel number specified by an integer from [0 to (getNumberChannels(byte[]) - 1)]. Note that all devices of the same family will not necessarily have the same number of channels.

Parameters:
state current state of the device returned from readDevice()
Returns:
the number of channels for this device
See also:
com.dalsemi.onewire.container.OneWireSensor.readDevice()

Implements SwitchContainer.

boolean isHighSideSwitch (  ) 

Checks if the channels of this switch are 'high side' switches.

This indicates that when 'on' or true, the switch output is connect to the 1-Wire data. If this method returns false then when the switch is 'on' or true, the switch is connected to ground.

Returns:
true if the switch is a 'high side' switch, false if the switch is a 'low side' switch
See also:
getLatchState(int,byte[])

Implements SwitchContainer.

boolean hasActivitySensing (  ) 

Checks if the channels of this switch support activity sensing.

If this method returns true then the method getSensedActivity(int,byte[]) can be used.

Returns:
true if channels support activity sensing
See also:
getSensedActivity(int,byte[])

clearActivity()

Implements SwitchContainer.

boolean hasLevelSensing (  ) 

Checks if the channels of this switch support level sensing.

If this method returns true then the method getLevel(int,byte[]) can be used.

Returns:
true if channels support level sensing
See also:
getLevel(int,byte[])

Implements SwitchContainer.

boolean hasSmartOn (  ) 

Checks if the channels of this switch support 'smart on'.

Smart on is the ability to turn on a channel such that only 1-Wire device on this channel are awake and ready to do an operation. This greatly reduces the time to discover the device down a branch. If this method returns true then the method setLatchState(int,boolean,boolean,byte[]) can be used with the doSmart parameter true.

Returns:
true if channels support 'smart on'
See also:
setLatchState(int,boolean,boolean,byte[])

Implements SwitchContainer.

boolean onlySingleChannelOn (  ) 

Checks if the channels of this switch require that only one channel is on at any one time.

If this method returns true then the method setLatchState(int,boolean,boolean,byte[]) will not only affect the state of the given channel but may affect the state of the other channels as well to insure that only one channel is on at a time.

Returns:
true if only one channel can be on at a time.
See also:
setLatchState(int,boolean,boolean,byte[])

Implements SwitchContainer.

boolean getLevel ( int  channel,
byte[]  state 
)

Checks the sensed level on the indicated channel.

To avoid an exception, verify that this switch has level sensing with the hasLevelSensing(). Level sensing means that the device can sense the logic level on its PIO pin.

Parameters:
channel channel to execute this operation, in the range [0 to (getNumberChannels(byte[]) - 1)]
state current state of the device returned from readDevice()
Returns:
true if level sensed is 'high' and false if level sensed is 'low'
See also:
com.dalsemi.onewire.container.OneWireSensor.readDevice()

hasLevelSensing()

Implements SwitchContainer.

boolean getLatchState ( int  channel,
byte[]  state 
)

Checks the latch state of the indicated channel.

Parameters:
channel channel to execute this operation, in the range [0 to (getNumberChannels(byte[]) - 1)]
state current state of the device returned from readDevice()
Returns:
true if channel latch is 'on' or conducting and false if channel latch is 'off' and not conducting. Note that the actual output when the latch is 'on' is returned from the isHighSideSwitch() method.
See also:
com.dalsemi.onewire.container.OneWireSensor.readDevice()

isHighSideSwitch()

setLatchState(int,boolean,boolean,byte[])

Implements SwitchContainer.

boolean getSensedActivity ( int  channel,
byte[]  state 
) throws OneWireException

Checks if the indicated channel has experienced activity.

This occurs when the level on the PIO pins changes. To clear the activity that is reported, call clearActivity(). To avoid an exception, verify that this device supports activity sensing by calling the method hasActivitySensing().

Parameters:
channel channel to execute this operation, in the range [0 to (getNumberChannels(byte[]) - 1)]
state current state of the device returned from readDevice()
Returns:
true if activity was detected and false if no activity was detected
Exceptions:
OneWireException if this device does not have activity sensing
See also:
hasActivitySensing()

clearActivity()

Implements SwitchContainer.

void clearActivity (  )  throws OneWireException

Clears the activity latches the next time possible.

For example, on a DS2406/07, this happens the next time the status is read with readDevice().

Exceptions:
OneWireException if this device does not support activity sensing
See also:
com.dalsemi.onewire.container.OneWireSensor.readDevice()

getSensedActivity(int,byte[])

Implements SwitchContainer.

void setLatchState ( int  channel,
boolean  latchState,
boolean  doSmart,
byte[]  state 
)

Sets the latch state of the indicated channel.

The method writeDevice() must be called to finalize changes to the device. Note that multiple 'set' methods can be called before one call to writeDevice().

Parameters:
channel channel to execute this operation, in the range [0 to (getNumberChannels(byte[]) - 1)]
latchState true to set the channel latch 'on' (conducting) and false to set the channel latch 'off' (not conducting). Note that the actual output when the latch is 'on' is returned from the isHighSideSwitch() method.
doSmart If latchState is 'on'/true then doSmart indicates if a 'smart on' is to be done. To avoid an exception check the capabilities of this device using the hasSmartOn() method.
state current state of the device returned from readDevice()
See also:
hasSmartOn()

getLatchState(int,byte[])

com.dalsemi.onewire.container.OneWireSensor.writeDevice(byte[])

Implements SwitchContainer.

void setLatchState ( byte  set,
byte[]  state 
)

Sets the latch state for all of the channels.

The method writeDevice() must be called to finalize changes to the device. Note that multiple 'set' methods can be called before one call to writeDevice().

Parameters:
set the state to set all of the channels, in the range [0 to (getNumberChannels(byte[]) - 1)]
state current state of the device returned from readDevice()
See also:
getLatchState(int,byte[])

com.dalsemi.onewire.container.OneWireSensor.writeDevice(byte[])

byte [] readDevice (  )  throws OneWireIOException, OneWireException

Retrieves the 1-Wire device sensor state.

This state is returned as a byte array. Pass this byte array to the 'get' and 'set' methods. If the device state needs to be changed then call the 'writeDevice' to finalize the changes.

Returns:
1-Wire device sensor state
Exceptions:
OneWireIOException on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
OneWireException on a communication or setup error with the 1-Wire adapter

Implements OneWireSensor.

byte [] readRegister (  )  throws OneWireIOException, OneWireException

Retrieves the 1-Wire device register mask.

This register is returned as a byte array. Pass this byte array to the 'get' and 'set' methods. If the device register mask needs to be changed then call the 'writeRegister' to finalize the changes.

Returns:
1-Wire device register mask
Exceptions:
OneWireIOException on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
OneWireException on a communication or setup error with the 1-Wire adapter

void writeDevice ( byte  state[]  )  throws OneWireIOException, OneWireException

Writes the 1-Wire device sensor state that have been changed by 'set' methods.

Only the state registers that changed are updated. This is done by referencing a field information appended to the state data.

Parameters:
state 1-Wire device PIO access write (x x x x x x PIOB PIOA)
Exceptions:
OneWireIOException on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
OneWireException on a communication or setup error with the 1-Wire adapter

void writeRegister ( byte[]  register  )  throws OneWireIOException, OneWireException

Writes the 1-Wire device register mask that have been changed by 'set' methods.

Parameters:
register 1-Wire device sensor state
Exceptions:
OneWireIOException on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
OneWireException on a communication or setup error with the 1-Wire adapter


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

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