Sun SPOT API (Green Release)

This document is the API specification for the initial release of the Sun SPOT Libraries.

See:
Description

SPOT library

com.sun.spot.interisolate
com.sun.spot.peripheral	Interfaces and classes dealing with the hardware on the SPOT processor board.
com.sun.spot.peripheral.basestation	Classes that enable a SPOT with a USB connection to a host computer to act as a basestation for applications running on the host.
com.sun.spot.peripheral.driver.proxy
com.sun.spot.peripheral.external	Interfaces and classes to allow control/communication with external boards.
com.sun.spot.peripheral.handler
com.sun.spot.peripheral.ota	Interfaces and classes supporting Over-The-Air (OTA) commands and deployment.
com.sun.spot.peripheral.radio	Interfaces and classes to support 802.15.4 over the SPOT radio.
com.sun.spot.peripheral.radio.proxy
com.sun.spot.peripheral.test
com.sun.spot.sensorboard	Contains highest level interfaces and concrete classes that make up the SunSPOT sensorboard libraries.
com.sun.spot.sensorboard.capabilities	Interfaces that define how a sensorboard should implement a particular type of controller.
com.sun.spot.sensorboard.hardware	Interfaces and concrete classes that embody various pieces of hardware that are built into the SunSPOT sensorboards.
com.sun.spot.sensorboard.io	Interfaces and concrete implmentations of classes to enable simple low-level i/o to and from the SunSPOT sensorboards.
com.sun.spot.sensorboard.peripheral	Interfaces and concrete implementations of various peripherals that are either connected to or built into the daughter cards.
com.sun.spot.sensorboard.protocol	Collection of some simple classes that define external protocols that can be attached to SunSPOT daughtercards.
com.sun.spot.sensorboard.util	Collection of utility classes to deal with the SunSPOT sensorboards.
com.sun.spot.testFramework
com.sun.spot.util	Miscellaneous utility classes.
junit.framework

SPOT Generic Connection Framework

com.sun.spot.io.j2me.memory	Classes to access the raw memory of the host device via the Generic Connection framework.
com.sun.spot.io.j2me.radio	Classes to access the SPOT radio using streams via the Generic Connection framework.
com.sun.spot.io.j2me.radiogram	Classes to access the SPOT radio using datagrams via the Generic Connection framework.
com.sun.spot.io.j2me.socket	Classes to access socket connections on the SPOT via the Generic Connection framework.
com.sun.squawk.io.j2me.memory	Class to define the SPOT raw "memory" protocol via the Generic Connection framework.
com.sun.squawk.io.j2me.radio	Class to define the SPOT "radio" protocol for the Generic Connection framework.
com.sun.squawk.io.j2me.radiogram	Class to define the SPOT "radiogram" protocol for the Generic Connection framework.
com.sun.squawk.io.j2me.serial	Class to define the SPOT USB port "serial" protocol for the Generic Connection framework.
com.sun.squawk.io.j2me.socket	Class to define the socket protocol for the SPOT via the Generic Connection framework.

Squawk Java ME library

com.sun.squawk
com.sun.squawk.io
com.sun.squawk.io.mailboxes
com.sun.squawk.security
com.sun.squawk.security.verifier
com.sun.squawk.util
com.sun.squawk.vm
java.io	Provides classes for input and output through data streams.
java.lang	Provides classes that are fundamental to the Java programming language.
java.lang.ref	Provides support for weak references.
java.util	Contains the collection classes, and the date and time facilities.
javax.microedition.io	Classes for the Generic Connection framework.

This document is the API specification for the initial release of the Sun SPOT Libraries.

Sun SPOTs are small, wireless, Java-based devices being developed as a research effort at Sun Labs. They are programmed in Java using the APIs described here.

Sun SPOT devices are based on the CLDC-compliant Squawk VM running directly on the metal. The goal of this project is to produce a flexible, reliable, easy-to-use Java platform for development, prototyping and deployment to small, wireless devices.

These libraries are a work-in-progress. While every attempt will be made to preserve compatibility, future releases will most likely not be backwards compatible.