EDemoBoard (SunSPOT API V2.0)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

SunSPOT API V2.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sun.spot.sensorboard
Class EDemoBoard

java.lang.Object
  com.sun.spot.peripheral.external.ExternalBoard
      com.sun.spot.sensorboard.hardware.AtmegaExternalBoard
          com.sun.spot.sensorboard.EDemoBoard

All Implemented Interfaces:: IExternalBoard, IDriver, IADCController, IGPIOController, ILightSensorController, IServoController, ISwitchController, IToneGeneratorController, ITriColorLEDController, IDemoBoard

public class EDemoBoard
extends AtmegaExternalBoard
implements IDemoBoard
extends AtmegaExternalBoard
implements IDemoBoard

This class manages the SPI interfaces and communications to the reachable parts on the EDemoBoard, namely the Atmega88, the Analog to Digital Converter, and the flash eeprom. ( some of this is done by superclasses ) Meant to be used in a singleton manner, this class reflects all of the functionality of the EDemoBoard to the java library space.

Author:: arshan

Field Summary
`static PinDescriptor`	`A0` Analog to Digital convertor input pin, matches silkscreening on the hardware
`static PinDescriptor`	`A1` Analog to Digital convertor input pin, matches silkscreening on the hardware
`static PinDescriptor`	`A2` Analog to Digital convertor input pin, matches silkscreening on the hardware
`static PinDescriptor`	`A3` Analog to Digital convertor input pin, matches silkscreening on the hardware
`static PinDescriptor`	`A4` Analog to Digital convertor input pin, matches silkscreening on the hardware
`static PinDescriptor`	`A5` Analog to Digital convertor input pin, matches silkscreening on the hardware
`static PinDescriptor`	`ACCEL_FULLSCALE` Internal pin used to operate the accelerometer.
`static PinDescriptor`	`ACCEL_SELFTEST` Internal pin used to operate the accelerometer.
`static PinDescriptor`	`ACCEL_X` Descriptor for X Axis accelerometer reading , this is an internal connection.
`static PinDescriptor`	`ACCEL_Y` Descriptor for Y Axis accelerometer reading , this is an internal connection.
`static PinDescriptor`	`ACCEL_Z` Descriptor for Z Axis accelerometer reading , this is an internal connection.
`static PinDescriptor`	`D0` TTL level general purpose input/output pin, matches silkscreening on the hardware
`static PinDescriptor`	`D1` TTL level general purpose input/output pin, matches silkscreening on the hardware
`static PinDescriptor`	`D2` TTL level general purpose input/output pin, matches silkscreening on the hardware
`static PinDescriptor`	`D3` TTL level general purpose input/output pin, matches silkscreening on the hardware
`static PinDescriptor`	`D4` TTL level general purpose input/output pin, matches silkscreening on the hardware
`static PinDescriptor`	`H0` High current output pin, matches silkscreening on the hardware
`static PinDescriptor`	`H1` High current output pin, matches silkscreening on the hardware
`static PinDescriptor`	`H2` High current output pin, matches silkscreening on the hardware
`static PinDescriptor`	`H3` High current output pin, matches silkscreening on the hardware
`static PinDescriptor`	`LED1` 3 Color LED Identifier , matches silkscreening on the hardware
`static PinDescriptor`	`LED2` 3 Color LED Identifier , matches silkscreening on the hardware
`static PinDescriptor`	`LED3` 3 Color LED Identifier , matches silkscreening on the hardware
`static PinDescriptor`	`LED4` 3 Color LED Identifier , matches silkscreening on the hardware
`static PinDescriptor`	`LED5` 3 Color LED Identifier , matches silkscreening on the hardware
`static PinDescriptor`	`LED6` 3 Color LED Identifier , matches silkscreening on the hardware
`static PinDescriptor`	`LED7` 3 Color LED Identifier , matches silkscreening on the hardware
`static PinDescriptor`	`LED8` 3 Color LED Identifier , matches silkscreening on the hardware
`static PinDescriptor`	`LIGHTSENSOR` Descriptor for LightSensor, this is an internal connection.
`static String`	`PART_ID` Identifier string for demoboard
`static PinDescriptor`	`POWER_ENABLE`
`static int`	`SERIAL_SPEED_115200`
`static int`	`SERIAL_SPEED_19200`
`static int`	`SERIAL_SPEED_2400`
`static int`	`SERIAL_SPEED_250000`
`static int`	`SERIAL_SPEED_28800`
`static int`	`SERIAL_SPEED_38400`
`static int`	`SERIAL_SPEED_4800`
`static int`	`SERIAL_SPEED_57600`
`static int`	`SERIAL_SPEED_9600`
`static PinDescriptor`	`SW1` Switch 0, matches silkscreening on the hardware This switch can also be driven by an external switch by using the SW1 pin on the header.
`static PinDescriptor`	`SW2` Switch 1, matches silkscreening on the hardware This switch can also be driven by an external switch by using the SW2 pin on the header.

Fields inherited from class com.sun.spot.sensorboard.hardware.AtmegaExternalBoard
`atmega`

Fields inherited from class com.sun.spot.peripheral.external.ExternalBoard
`BOARD_MAGIC_WORD, ID_PROPERTY_NAME`

Fields inherited from interface com.sun.spot.sensorboard.capabilities.ITriColorLEDController
`BLUE, GREEN, RED`

Method Summary
`void`	`andRegister(int reg, int val)` Perform an AND assignment to one of the registers in the Atmega88 controller.
`IInputPin`	`bindInputPin(PinDescriptor pidx)` Register the use of and return the accessor object for the indicated input pin.
`IIOPin`	`bindIOPin(PinDescriptor pidx)` Register the use of and return the accessor object for the indicated I/O pin.
`ITriColorLED`	`bindLED(PinDescriptor pidx)` Returns an accessor object to the indicated 3 color LED.
`ILightSensor`	`bindLightSensor(PinDescriptor pidx)` Register the use of and return the accessor object to a lightsensor connected to a scalar input pin.
`IOutputPin`	`bindOutputPin(PinDescriptor pidx)` Register the use of and return the accessor object for the indicated output pin.
`IScalarInput`	`bindScalarInput(PinDescriptor pidx)` Registers the use of and return the ScalarInput object that reads from the specified ADC pin.
`IServo`	`bindServo(PinDescriptor pidx)` Register the pin and return an accessor object to control an attached Servo.
`ISwitch`	`bindSwitch(PinDescriptor pidx)` Register the indicated pin as a switch and return the accessor object for it.
`IToneGenerator`	`bindToneGenerator(PinDescriptor pidx)` Register and return accessor object for ToneGenerator on indicated pin.
`void`	`disablePinChangeInterrupt(PinDescriptor pidx)` Stop a pin generating pin change interrupts
`void`	`disableRegistry()` Disable the global pin registry in the EDemoBoard object.
`void`	`enablePinChangeInterrupt(PinDescriptor pidx, boolean lowToHigh, boolean highToLow)` Allow the input pin specified to generate pin change interrupts.
`void`	`error(String txt)` Report an error with regard to the EDemoBoard.
`IAccelerometer3D`	`getAccelerometer()` Convenience method to return the built in accelerometer.
`IADT7411`	`getADC()` Convience function to get an object that corresponds to the ADC on the EDemoBoard.
`ITemperatureInput`	`getADCTemperature()` Convience Function to get internal temperature sensor on the ADC from the EDemoBoard.
`int[]`	`getFirmwareVersion()` Get the major and minor version information from the firmware running on the EDemoBoard.
`static Properties`	`getInitialProperties()` Get the correct set of properties for this board to its flash memory
`static EDemoBoard`	`getInstance()` return the global singleton for the EDemoBoard at board select zero
`ITriColorLED`	`getLED(PinDescriptor pidx)` Convienence method to bind and return the LED that is reqested.
`ITriColorLED[]`	`getLEDs()` Convienence method that returns an array of all the built in LEDs.
`ILightSensor`	`getLightSensor()` Convenience function to return lightsensor object.
`int`	`getLightSensorValue(PinDescriptor pidx)` Get the current value of a lightsensor accessor connected to a particular pin.
`boolean`	`getPinValue(PinDescriptor pidx)` Returns the value of the pin.
`int`	`getPulse(PinDescriptor pidx, int dir)` Ask the controller for a measurement of an incoming pulse on some pin.
`int`	`getRegister(int reg)` Peek method for the atmega firmware.
`int`	`getScalarValue(PinDescriptor pidx)` Returns a scalar value for indicated pin from the ADC.
`ISwitch`	`getSwitch(PinDescriptor pidx)` Register the indicated pin as a switch and return the accessor object for it.
`ISwitch[]`	`getSwitches()` Return an array of all the built in switches on the board.
`boolean`	`getSwitchState(PinDescriptor pidx)` Get the current state of a switch connected to the indicated pin.
`void`	`initUART(int baud, boolean two_stopbit)` Initialize the UART module, sets the speed and selects number of stop bits
`void`	`msg(String txt)` Deliver message to user.
`String`	`name()` Returns the name that should be used by the IDriver subsystem.
`void`	`orRegister(int reg, int val)` Perform an OR assignment to one of the registers in the Atmega88 controller.
`byte`	`receiveUART()` get the next byte from the UART
`void`	`sendUART(byte val)` send a byte over the UART
`protected void`	`setDebugLevel(int x)` Change the verbosity of the EDemoBoard.
`void`	`setLEDColorIntensity(PinDescriptor pidx, int clr, int val)` Set the RGB values of the indicated LED.
`void`	`setLEDValue(PinDescriptor pidx, int r, int g, int b)` Set the RGB values of the indicated LED.
`void`	`setPinDirection(PinDescriptor pidx, boolean output)` Set the mask for the indicated pin to the indicated direction.
`void`	`setPinValue(PinDescriptor pidx, boolean high)` Set the output value of the indicated pin.
`void`	`setPWM(PinDescriptor pidx, int duty)` request the controller maintain a pwm signal on a gpio pin set the duty to 0, to turn off an existing pwm signal.
`void`	`setRegister(int reg, int val)` Poke method for the Atmega88 controller, allows user to set low level registers on the part.
`void`	`setServoPulseWidth(PinDescriptor pidx, int usec)` Ask the controller to maintain a servo pulsewidth of some length.
`void`	`setTone(PinDescriptor pidx, int period)` Ask the controller to start a tone on the indicated pin.
`void`	`setUp()` Perform any tasks necessary for initial setup, and return from hibernation.
`void`	`startPulse(PinDescriptor pidx, int dir, int usec)` Ask the controller to issue a pulse on the indicated pin.
`boolean`	`tearDown()` Perform any tasks necessary for hibernation.
`PinDescriptor[]`	`waitForPinChange()` Wait for a pin change interrupt.
`void`	`warning(String txt)` Report a warning with regard to the EDemoBoard.

Methods inherited from class com.sun.spot.sensorboard.hardware.AtmegaExternalBoard
`getAtmega, getAtmegaSPI, getProgrammingSPI, setAtmega`

Methods inherited from class com.sun.spot.peripheral.external.ExternalBoard
`forceChipSelectPin, getBoardIndex, getProperties, getSerialFlash, hardwareNotValid, isInstalled, newBoardDeviceSPI, setProperties`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

SERIAL_SPEED_9600

public static final int SERIAL_SPEED_9600

See Also:: Constant Field Values

SERIAL_SPEED_19200

public static final int SERIAL_SPEED_19200

See Also:: Constant Field Values

SERIAL_SPEED_28800

public static final int SERIAL_SPEED_28800

See Also:: Constant Field Values

SERIAL_SPEED_38400

public static final int SERIAL_SPEED_38400

See Also:: Constant Field Values

SERIAL_SPEED_57600

public static final int SERIAL_SPEED_57600

See Also:: Constant Field Values

SERIAL_SPEED_115200

public static final int SERIAL_SPEED_115200

See Also:: Constant Field Values

SERIAL_SPEED_250000

public static final int SERIAL_SPEED_250000

See Also:: Constant Field Values

SERIAL_SPEED_2400

public static final int SERIAL_SPEED_2400

See Also:: Constant Field Values

SERIAL_SPEED_4800

public static final int SERIAL_SPEED_4800

See Also:: Constant Field Values

PART_ID

public static final String PART_ID

Identifier string for demoboard

See Also:: Constant Field Values