SunSPOT host API V3.0


Package com.sun.spot.client

General facilities for communicating from a desktop with Sun SPOTs, both locally and remotely.

See:
          Description

Interface Summary
IAdminTarget IAdminTarget allows data to be sent to and from the admin command processor on a SPOT, either locally via USB or remotely via the radio.
IBootloaderTarget IBootloaderTarget allows data to be sent to and from the bootloader executing on a SPOT connected locally.
IPrivateCommandHelper IPrivateCommandHelper is an extension of ISpotClientCommandHelper that is intended for use only by the built-in bootloader commands.
ISpotClientCommandHelper ISpotClientCommandHelper provides useful facilities to executing ISpotClientCommands.
ISpotClientExtension ISpotClientExtension An interface which extenders of the standard SpotClient command set must implement.
ISpotManager ISpotManager is not intended for direct use by new instances of ISpotClientCommand, which should normally use the facilities available via ISpotClientCommandHelper, IAdminTarget and by executing other built-in instances of ISpotClientCommand such as SynchronizeCommand and QuitCommand.
ITargetFlashAccess ITargetFlashAccess provides sector-level access to the flash memory of a locally connected SPOT.
IUI Interface that must be implemented by the Spot Client UI component.
 

Class Summary
DummySpotClientUI DummySpotClientUI provides a null implementation of IUI convenient for using SpotClientCommands facilities when feedback is not required.
Flashable Flashable represents data to be flashed to a SPOT, which may be either a host file or an in-memory byte array.
RemoteLogger RemoteLogger.
SerialPortLogger SerialPortLogger.
SerialPortWrapper SerialPortWrapper wraps an RXTX SerialPort to centralise the parameters for opening it, and to provide easy access to its streams.
SpotClientCommands SpotClientCommands

An instance of this holds all the commands available in a SpotClient including user extensions.
SpotPropertiesManager SpotPropertiesManager manages the retrieval and setting of the persistent system properties on the SPOT.
SpotState SpotState is internal to the implementation of the ISpotClientCommandHelper and all the information it contains should be accessed via that interface.
 

Exception Summary
SpotClientArgumentException SpotClientArgumentException is thrown when an ISpotClientCommand is invoked with incompatible arguments
SpotClientException SpotClientException superclass for runtime exceptions thrown by SpotClient
SpotClientFailureException SpotClientFailureException thrown by SpotClient to indicate general errors not covered by a more specific subtype of SpotClientException.
SpotClientFatalException This exception is thrown when the SpotClient encounters a condition from which it cannot recover.
SpotClientUnknownCommandException SpotClientUnknownCommandException indicates that an attempt was made to send a command to a SPOT (either an admin command processor or a bootloader) and that the command was not recognised by the SPOT.
SpotObsoleteVersionException SpotObsoleteVersionException indicates a failure caused by the SPOT running software versions different to those expected by the installed SDK.
SpotSerialPortException SpotSerialPortException represents a failure in serial port communications.
SpotSerialPortInUseException SpotSerialPortInUseException indicates that the host operating system has reported that the specified COM port is not available.
SpotSerialPortNotFoundException SpotSerialPortNotFoundException is thrown when a specified COM port is unknown to the host operating system.
 

Package com.sun.spot.client Description

General facilities for communicating from a desktop with Sun SPOTs, both locally and remotely. These facilities will be of interest to developers who plan to either extend the facilities available through ant or SpotWorld, or who plan to develop their own alternative development tools.

See Also:
for more details. See also the Sun SPOT Developer's Guide.

SunSPOT host API V3.0


Copyright © 2006, 2007 Sun Microsystems, Inc. All Rights Reserved.