SunSPOT API V6.0


Package com.sun.spot.peripheral

Access to the hardware peripherals built in to the Sun SPOT main board.

See:
          Description

Interface Summary
IAT91_AIC The interface to the AT91 Interrupt Controller.
IAT91_PIO Interface to the AT91 Parallel I/O Controller.
IAT91_PowerManager Interface to the AT91 power manager for the Sun SPOT, allowing peripheral power consumption to be controlled by switching the peripheral clocks on or off.
IAT91_TC Interface to an AT91 Timer Counter.
IBattery  
IDeepSleepListener Implemented by classes wanting a call back when the SPOT wakes up from deep sleep.
IDriver Interface for all device drivers participating in the deep sleep setUp/tearDown process controlled by the DriverRegistry.
IDriverLookup Deprecated. never used
IDriverRegistry  
IEventHandler  
IFiqInterruptDaemon  
IFlashMemoryDevice Interface to flash memory devices on the main Spot board and external boards.
II2C Interface for communicating with devices using the I2C protocol.
ILed Deprecated. Use ILed instead
ILTC3455 Interface to LTC3455 power control chip on the Spot.
IMultipleHopConnection Connections that implement IMultipleHopConnection support adjustment of the number of hops between nodes that messages can make.
IPowerController  
IRadioControl  
ISecuredSiliconArea  
ISerial Interface for Serial devices
ISleepManager Interface to the low power sleep manager for the Sun SPOT
ISpiMaster Interface to the SPI master controller.
ISpot The interface to the root object of the Spot base library.
ISpotPins Interface to provide PIOPin objects representing pins assigned to various external functions on the Spot board.
ITimeoutableConnection This interface represents any Connection between a pair of Spots that can timeout on receiving data.
IUSBPowerDaemon  
TimerCounterBits Timer counter bit definitions

See headings in the source file for more information

 

Class Summary
AbstractAT91_PIO AbstractAT91_PIO
AT91_I2C Class for communicating with devices using the I2C protocol using the ARM9 TWI hardware.
AT91_Peripherals This class provides symbolic access to the RM9200 peripheral ids.
Battery  
Battery8  
BoundedInputStream Wraps a parent InputStream with an input stream on the assumptions that the first four bytes of the parent's content are a Java int which tells us how many more valid bytes remain in the parent.
BoundedOutputStream An output stream that writes the length of the data at the start.
CC2420Driver  
ConfigPage Each Spot reserves some flash memory for configuration information.
DriverRegistry Acts as a registry for drivers that need to be aware of deep sleep.
FiqInterruptDaemon The FiqInterruptDaemon gives access to the handlers used for various notifications from the power controller.
NorFlashSector Define a segment of memory which is defined as being of type NOR Flash.
PeripheralChipSelect  
PIOPin A PIOPin is a convenient way of manipulating an individual PIO pin.
RadioConnectionBase Abstract base class for classes that implement a radio Connection that can time out if an expected acknowledgment doesn't arrive for a sent packet.
Serial Serial - provides read access to the serial/USB ports of an eSPOT

The rev8 eSPOT has 3 available usarts: usart0, usart1 & usart2.
SpiPcs  
Spot The class of the root object of the Spot base library.
WatchdogTimer Implements a (virtual) watchdog timer that can be used to force the SPOT to reboot.
 

Exception Summary
ChannelBusyException Thrown when an attempt to transmit over the radio fails because the channel is busy - and remains busy for a full set of retries.
NoAckException Thrown when an attempt to transmit over the radio fails because no acknowledgement is received within the time limit specified in the I802.15.4 standard.
NoRouteException  
SpotFatalException This class represents all API precondition violations by client programs.
TimeoutException Thrown when an attempt to receive data over either a "radiostream:" or "radiogram:" connection fails due to a read timeout being exceeded.
UnableToDeepSleepException This exception is thrown when an attempt to ensure a deep sleep fails because deep sleep is impossible.
 

Package com.sun.spot.peripheral Description

Access to the hardware peripherals built in to the Sun SPOT main board. Normally you should access the individual components via interfaces obtained from the singleton instance of Spot. For example:

... ILed the greenLed = Spot.getInstance().getGreenLed(); ...

See Also:
"Sun SPOT Developers' Guide"

SunSPOT API V6.0


Copyright © 2006-2010 Oracle. All Rights Reserved.