EDemoController (SunSPOT API V5.0)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

SunSPOT API V5.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sun.spot.sensorboard
Class EDemoController

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

All Implemented Interfaces:: IExternalBoard, IDriver, IADCController, IGPIOController, ILightSensorController, IServoController, ISwitchController, IToneGeneratorController, ITriColorLEDController, Isolate.LifecycleListener

public class EDemoController
extends AtmegaExternalBoard
implements IDriver, IADCController, ISwitchController, ITriColorLEDController, IServoController, IGPIOController, ILightSensorController, IToneGeneratorController, Isolate.LifecycleListener
extends AtmegaExternalBoard
implements IDriver, IADCController, ISwitchController, ITriColorLEDController, IServoController, IGPIOController, ILightSensorController, IToneGeneratorController, Isolate.LifecycleListener

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 ) Controller interfaces use a model of interaction that allows for behaviours of the controlled functionality to be modified by implementing the accessor interfaces. The end user is meant to request on of these accessor objects and then use their methods to interact with the Controller. The implementor of the Controller should also be responsible for implementing the accessor object as these concrete classes are assumed to be tightly bound. At the same time it is possible to call the methods that actually implement the low level behaviour in the controller, this is generally disuaded, however there are circumstances where the user may want to bypass the sanity checking in order to reduce the latency as much as possible. Note: whenever a servo is active, deep sleep will not happen.

Author:: arshan, Ron Goldman

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` Tri-color LED Identifier, matches silkscreening on the hardware
`static PinDescriptor`	`LED2` Tri-color LED Identifier, matches silkscreening on the hardware
`static PinDescriptor`	`LED3` Tri-color LED Identifier, matches silkscreening on the hardware
`static PinDescriptor`	`LED4` Tri-color LED Identifier, matches silkscreening on the hardware
`static PinDescriptor`	`LED5` Tri-color LED Identifier, matches silkscreening on the hardware
`static PinDescriptor`	`LED6` Tri-color LED Identifier, matches silkscreening on the hardware
`static PinDescriptor`	`LED7` Tri-color LED Identifier, matches silkscreening on the hardware
`static PinDescriptor`	`LED8` Tri-color LED Identifier, matches silkscreening on the hardware
`static PinDescriptor`	`LIGHTSENSOR` Descriptor for LightSensor, this is an internal connection.
`static PinDescriptor`	`POWER_ENABLE` Internal pin used to enable the op-amp and shift registers that drive the LEDs.
`static PinDescriptor`	`SW1` Switch 0, matches silkscreening on the hardware.
`static PinDescriptor`	`SW2` Switch 1, matches silkscreening on the hardware.
`static PinDescriptor`	`TEMPERATURE` Descriptor for internal thermometer reading, this is internal to the ADC chip---a virtual pin.
`static byte`	`TWISTATUS_ERROR`
`static byte`	`TWISTATUS_OFF`
`static byte`	`TWISTATUS_OK`
`static byte`	`TWISTATUS_TIMEOUT`

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, MEMORY_PROPERTY_NAME`

Method Summary
`void`	`accelerometerScaleChanged(int newScale)` Called by accelerometer when it changes its scale.
`void`	`andRegister(int reg, int val)` Perform an AND assignment to one of the registers in the Atmega88 controller.
`boolean`	`areThresholdEventsEnabled(IScalarInput pin)` Return whether threshold events are enabled or disabled.
`int`	`availableUART()` Check if there are any available characters read by the UART.
`void`	`disablePinChangeInterrupts(IInputPin pin)` Stop a pin generating pin change interrupts.
`void`	`enablePinChangeInterrupts(IInputPin pin)` Allow the input pin specified to generate pin change interrupts.
`void`	`enableThresholdEvents(IScalarInput pin, boolean enable)` Enable or disable threshold events.
`static void`	`error(String txt)` Report an error with regard to the EDemoBoard.
`IAccelerometer3D`	`getAccelerometer()` Convenience method to return the built in accelerometer.
`IADT7411`	`getADC()` Convenience function to get an object that corresponds to the ADC on the EDemoBoard.
`ITemperatureInput`	`getADCTemperature()` Get the internal temperature sensor on the ADC on the EDemoBoard.
`int`	`getBlueLEDValue(PinDescriptor pidx)` Get the current blue color value for the indicated LED This method is meant to be used by an accessor object to the ITriColorLEDController.
`String`	`getDriverName()` Returns the name that should be used by the IDriver subsystem.
`int[]`	`getFirmwareVersion()` Get the major and minor version information from the firmware running on the EDemoBoard.
`int`	`getGreenLEDValue(PinDescriptor pidx)` Get the current green color value for the indicated LED This method is meant to be used by an accessor object to the ITriColorLEDController.
`int`	`getHighThreshold(IScalarInput pin)` Return the current high threshold value.
`IIOPin[]`	`getIOPins()` Method to return an array of the builtin bidirectional digital pins.
`ITriColorLED[]`	`getLEDs()` Convienence method that returns an array of all the built in LEDs.
`ILightSensor`	`getLightSensor()` Return light sensor object.
`int`	`getLightSensorValue(PinDescriptor pidx)` Get the current value of a lightsensor accessor connected to a particular pin.
`int`	`getLowThreshold(IScalarInput pin)` Return the current low threshold value.
`IOutputPin[]`	`getOutputPins()` Method to return an array of the builtin high current output pins.
`boolean`	`getPinDirection(PinDescriptor pidx)` Get the current direction for the specified input/output pin.
`boolean`	`getPinValue(PinDescriptor pidx)` Returns the value of the pin.
`int`	`getPulse(PinDescriptor pidx, boolean dir, int timeout)` Ask the controller for a measurement of an incoming pulse on some input pin.
`int`	`getRedLEDValue(PinDescriptor pidx)` Get the current red color value for the indicated LED This method is meant to be used by an accessor object to the ITriColorLEDController.
`int`	`getRegister(int reg)` Peek method for the atmega firmware.
`IScalarInput[]`	`getScalarInputs()` Method to return an array of the builtin analog input pins.
`int`	`getScalarValue(PinDescriptor pidx)` Returns a scalar value for indicated pin from the ADC.
`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.
`byte`	`getTWIstatus()` Return status of whether the last TWI transaction completed ok or not.
`void`	`handleLifecycleListenerEvent(Isolate iso, int eventKind)` This method will be called when the lifecycle event occurs on the isolate that this listener was registered for using `addLifecycleListener`.
`void`	`initUART(int baud, boolean two_stopbit)` Initialize the UART module, set the speed and select the number of stop bits.
`void`	`initUART(int baud, int databits, int parity, int stopbits)` Initialize the UART module on the Atmega note that all valid parameters are defined in EDemoBoard class SERIAL_SPEED_* SERIAL_DATABITS_* SERIAL_PARITY_* SERIAL_STOPBITS_*
`boolean`	`isOnLED(PinDescriptor pidx)` Return if the LED is on or off.
`boolean`	`isTWIBusy()` Test if TWI interrupt has been cleared.
`static void`	`main(String[] args)` Called by Spot class when master isolate is started up.
`static void`	`msg(String txt)` Deliver message to user.
`void`	`orRegister(int reg, int val)` Perform an OR assignment to one of the registers in the Atmega88 controller.
`int`	`readUART(byte[] b, int off, int len)` Read the next byte from the UART plus any more currently available bytes.
`byte`	`readUART(long timeout)` Get the next byte from the UART.
`boolean`	`receiveTWI(int sla, byte[] rcv, int offset, int rcvlen)` Receive bytes into rcv for rcvlen bytes from TWI at slave address sla.
`boolean`	`sendTWI(int sla, byte[] snd, int offset, int sndlen)` Send bytes in snd for sndlen bytes to TWI to slave address sla blocks and returns after transaction.
`protected void`	`setDebugLevel(int x)` Change the verbosity of the EDemoBoard.
`void`	`setLEDValue(PinDescriptor pidx, int r, int g, int b)` Set the RGB values of the indicated LED.
`void`	`setOnLED(PinDescriptor pidx, boolean on)` Turn the LED on or off
`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.
`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`	`setThresholdValues(IScalarInput ipin, int low, int high)` Set the low and high threshold values for this scalar input.
`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`	`setupTWI(byte command, byte data)` Send a command to the TWI controller.
`void`	`shutDown()` Notify the driver that the VM is about to exit.
`void`	`startPulse(PinDescriptor pidx, boolean dir, int usec)` Ask the controller to issue a pulse on the indicated pin.
`boolean`	`supportsThresholdEvents(PinDescriptor pidx)` Returns whether the underlying hardware supports threshold events.
`boolean`	`tearDown()` Record interrupt state so it can be restored later.
`boolean`	`transceiveTWI(int sla, byte[] snd, int sndlen, byte[] rcv, int offset, int rcvlen)` Send bytes in snd for sndlen bytes to TWI to slave address sla, restart and receive rcvlen bytes in rcv byte array.
`static void`	`warning(String txt)` Report a warning with regard to the EDemoBoard.
`void`	`writeUART(byte val)` Send a byte over the UART.
`void`	`writeUART(byte[] msg, int off, int len)` Writes len bytes from the specified byte array starting at offset off to the UART.
`void`	`writeUART(String msg)` Send a string over the UART.

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