com.sun.spot.sensorboard.hardware
Class ADT7411

java.lang.Object
  com.sun.spot.resources.Resource
      com.sun.spot.sensorboard.hardware.SimpleSPIControlledIOChip
          com.sun.spot.sensorboard.hardware.ADT7411

All Implemented Interfaces:

IDriver, IResource, IADT7411, ISPIControlledIOChip

public class ADT7411
extends SimpleSPIControlledIOChip
implements IDriver, IADT7411

Class implementing SPI access to the ADT7411 a-to-d converter. It extends SimpleSPIControlledIOChip and provides a constructor that initializes the device. This initialized ADT7411 object can then be used by the classes derived from AbstractADT7411RangeInput to communicate with the device.

Note: by default the ADT7411 uses the slow conversion rate so as to make sure readings of A0 are correct. To read faster than every 17.1 milliseconds, ~58Hz, requires setting the ADT7411 to use its fast conversion rate.

Note: by default the ADT7411 reads all of the channels, one after the other, in round robin mode. If a program needs to read values faster then it should put the ADT7411 into single channel mode. However doing so will break the code used to read the accelerometer, the analog inputs A0-A3 and the internal thermometer. In single channel mode it is the programmer's responsibility to set the channel before reading.

Author:

Syntropy & Ron Goldman

Field Summary

static int	SPI_CONFIG How the SPI needs to be configured for ADT7411
static int	SPI_CONFIG8

Constructor Summary

ADT7411(ISPI spi)
Constructor that initialises the device.

ADT7411(ISPI spi, boolean init)
Constructor that maybe initialises the device.

Method Summary

boolean	areThresholdEventsEnabled(int pin) Return whether threshold events are enabled or disabled.
int	checkInterrupts() Check if any interrupts have occurred.
void	enableThresholdEvents(int pin, boolean enable) Enable or disable threshold events.
String	getDriverName() Routine to return this driver's name.
int	getHighThreshold(int pin) Return the current high threshold value for this scalar input.
int	getLowThreshold(int pin) Return the current low threshold value for this scalar input.
byte	read(byte addr) Read a byte from the ADC.
int	readPin(int idx) Read the current value of one of the inputs to the ADC.
void	setAveraging(boolean val) Set the global averaging bit of the ADC, if set to true then the part will internally sample 16 times before setting the average value, if false that behaviour is turned off.
void	setFastConversion(boolean val) Set the fast/slow conversion rate bit of the ADC.
void	setThresholdValues(int pin, int low, int high) Set the low and high threshold values for this scalar input.
void	setUp() Driver routine called to initialize the ADT7411 when powering up the sensor board.
void	shutDown() Notify the driver that the VM is about to exit.
boolean	tearDown() Driver routine called before powering down sensor board (for deep sleep).
void	write(byte addr, byte value) Write a byte to the ADC.

Methods inherited from class com.sun.spot.sensorboard.hardware.SimpleSPIControlledIOChip

claimedPins, claimPin, getSPI

Methods inherited from class com.sun.spot.resources.Resource

addTag, getTags, getTagValue, hasTag, removeTag

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sun.spot.sensorboard.hardware.ISPIControlledIOChip

claimedPins, claimPin, getSPI

Methods inherited from interface com.sun.spot.resources.IResource

addTag, getTags, getTagValue, hasTag, removeTag

Field Detail

SPI_CONFIG

public static final int SPI_CONFIG

How the SPI needs to be configured for ADT7411

See Also:

Constant Field Values

SPI_CONFIG8

public static final int SPI_CONFIG8

See Also:

Constant Field Values

Constructor Detail

ADT7411

public ADT7411(ISPI spi)

Constructor that initialises the device.

Parameters:

spi - ISPI to be used to access the device

ADT7411

public ADT7411(ISPI spi,
               boolean init)

Constructor that maybe initialises the device.

Parameters:

spi - ISPI to be used to access the device

init - if true then initialize the device

Method Detail

setUp

public void setUp()

Driver routine called to initialize the ADT7411 when powering up the sensor board.

Specified by:

setUp in interface IDriver

tearDown

public boolean tearDown()

Driver routine called before powering down sensor board (for deep sleep).

Specified by:

tearDown in interface IDriver

Returns:

true = always ok to deactivate ADT7411 device

setAveraging

public void setAveraging(boolean val)

Set the global averaging bit of the ADC, if set to true then the part will internally sample 16 times before setting the average value, if false that behaviour is turned off.

When averaging is active the sample rate is slower.

Specified by:

setAveraging in interface IADT7411

Parameters:

val - if true set averaging on

setFastConversion

public void setFastConversion(boolean val)

Set the fast/slow conversion rate bit of the ADC. If set to true then the part will use the fast conversion rate. If false then the slow conversion rate will be used.

Update time in milliseconds: fast/slow
Round robin mode, w/averaging off: 0.58 / 17.1
Round robin mode, w/averaging on: 9.26 / 125.4
Single channel mode, w/averaging off: 0.04 / 0.71
Single channel mode, w/averaging on: 0.71 / 11.4

Note: reading values for A0 at the fast rate may be inaccurate.

Specified by:

setFastConversion in interface IADT7411

Parameters:

val - if true set to the fast conversion rate

read

public byte read(byte addr)

Read a byte from the ADC.

Specified by:

read in interface IADT7411

Parameters:

addr - address to be read

Returns:

byte read

write

public void write(byte addr,
                  byte value)

Write a byte to the ADC.

Specified by:

write in interface IADT7411

Parameters:

addr - address to write

value - to be written

readPin

public int readPin(int idx)

Read the current value of one of the inputs to the ADC.

Parameters:

idx - number of pin to read.

Returns:

the value read.

setThresholdValues

public void setThresholdValues(int pin,
                               int low,
                               int high)

Set the low and high threshold values for this scalar input. Callbacks occur when the scalar input reading falls below or equal to the low threshold value, or when it rises above or equal to the high threshold value. Note: the ADT7411, only compares against the most significant 8-bits.

Parameters:

pin - pin to be monitored.

low - the new low threshold value.

high - the new high threshold value.

getHighThreshold

public int getHighThreshold(int pin)

Return the current high threshold value for this scalar input.

Parameters:

pin - pin to be read

Returns:

the current high threshold value.

getLowThreshold

public int getLowThreshold(int pin)

Return the current low threshold value for this scalar input.

Parameters:

pin - pin to be read

Returns:

the current low threshold value.

enableThresholdEvents

public void enableThresholdEvents(int pin,
                                  boolean enable)

Enable or disable threshold events. Should not be called by user applications.

Parameters:

pin - pin to be monitored.

enable - if true then listeners will be notified if the scalar input reading goes above the high threshold or below the low threshold.

areThresholdEventsEnabled

public boolean areThresholdEventsEnabled(int pin)

Return whether threshold events are enabled or disabled.

Parameters:

pin - pin to be read

Returns:

true if events are enabled

checkInterrupts

public int checkInterrupts()

Check if any interrupts have occurred. If so disable any interrupts that have triggered. Called by EDemoBoard interrupt handler. Should not be called by user applications.

Returns:

a bitmask with a bit set for each interrupt that has triggered

getDriverName

public String getDriverName()

Routine to return this driver's name.

Specified by:

getDriverName in interface IDriver

Returns:

this driver's name

shutDown

public void shutDown()

Description copied from interface: IDriver

Notify the driver that the VM is about to exit.

Specified by:

shutDown in interface IDriver