ptolemy.domains.ptinyos.lib
Class MicaCompositeActor

java.lang.Object
  extended by ptolemy.kernel.util.NamedObj
      extended by ptolemy.kernel.InstantiableNamedObj
          extended by ptolemy.kernel.Entity
              extended by ptolemy.kernel.ComponentEntity
                  extended by ptolemy.kernel.CompositeEntity
                      extended by ptolemy.actor.CompositeActor
                          extended by ptolemy.actor.TypeOpaqueCompositeActor
                              extended by ptolemy.domains.ptinyos.kernel.NCCompositeActor
                                  extended by ptolemy.domains.ptinyos.kernel.PtinyOSCompositeActor
                                      extended by ptolemy.domains.ptinyos.lib.MicaCompositeActor
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class MicaCompositeActor
extends PtinyOSCompositeActor

This composite actor represents the hardware interface to the Mica mote and is designed for use in the PtinyOS domain. It contains input ports for the photosensor, temperature sensor, microphone, accelerometer (x- and y-axis), magnetometer (x- and y-axis); and output ports for the LEDs (red, green, and yellow).

This actor is always a type opaque composite actor. The outside types of the input ports (the sensor ports) are of type DoubleToken, and the inside types are of type unsigned short (uint16_t) in C. The C code ( tinyos-1.x/contrib/ptII/ptinyos/tos/platform/ptII/adc_model.c) masks the unsigned short for 10-bit usage (10 least significant bits), to reflect the bit-width of the ADC registers on the actual Mica hardware. The outside types of the output ports (the LED ports) are of type BooleanToken, and the inside types are of type short in C.

Detailed port information can be found in tinyos-1.x/tos/platform/pc/sensorboard.h.

Also see tinyos-1.x/contrib/ptII/ptinyos/tos/platform/ptII/ptII.c and tinyos-1.x/contrib/ptII/ptinyos/tos/platform/ptII/adc_model.c

Since:
Ptolemy II 5.1
Version:
$Id: MicaCompositeActor.java 57040 2010-01-27 20:52:32Z cxh $
Author:
Elaine Cheong
See Also:
Serialized Form
Accepted Rating:
Green (celaine)
Proposed Rating:
Green (celaine)

Nested Class Summary
 
Nested classes/interfaces inherited from class ptolemy.kernel.CompositeEntity
CompositeEntity.ContainedObjectsIterator
 
Field Summary
 PortParameter accelerometerX
          Persistent accelerometer (x-axis) input data.
 PortParameter accelerometerY
          Persistent accelerometer (y-axis) input data.
 TypedIOPort ledGreen
          Green LED output port.
 TypedIOPort ledRed
          Red LED output port.
 TypedIOPort ledYellow
          Yellow LED output port.
 PortParameter magnetometerX
          Persistent magnetometer (x-axis) input data.
 PortParameter magnetometerY
          Persistent magnetometer (y-axis) input data.
 PortParameter microphone
          Persistent microphone input data.
 PortParameter photo
          Persistent photosensor input data.
 PortParameter temperature
          Persistent temperature input data.
 
Fields inherited from class ptolemy.domains.ptinyos.kernel.PtinyOSCompositeActor
packetIn, packetOut
 
Fields inherited from class ptolemy.domains.ptinyos.kernel.NCCompositeActor
rotatePorts
 
Fields inherited from class ptolemy.actor.CompositeActor
_actorFiringListeners, _causalityInterface, _initializables, _notifyingActorFiring, _publishedPorts, _publisherRelations, _stopRequested
 
Fields inherited from class ptolemy.kernel.CompositeEntity
_levelCrossingLinks
 
Fields inherited from class ptolemy.kernel.util.NamedObj
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
 
Fields inherited from interface ptolemy.actor.Executable
COMPLETED, NOT_READY, STOP_ITERATING
 
Constructor Summary
MicaCompositeActor()
          Construct an actor in the default workspace with an empty string as its name.
MicaCompositeActor(CompositeEntity container, java.lang.String name)
          Construct an actor in the specified container with the specified name.
MicaCompositeActor(Workspace workspace)
          Construct an actor in the specified workspace with an empty string as a name.
 
Method Summary
 
Methods inherited from class ptolemy.domains.ptinyos.kernel.PtinyOSCompositeActor
fire
 
Methods inherited from class ptolemy.actor.TypeOpaqueCompositeActor
_addPort, newPort, typeConstraints
 
Methods inherited from class ptolemy.actor.CompositeActor
_actorFiring, _actorFiring, _addEntity, _addRelation, _finishedAddEntity, _getPublishedPort, _setDirector, addActorFiringListener, addInitializable, addPiggyback, clone, connectionsChanged, createReceivers, createSchedule, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inferringWidths, inferWidths, initialize, inputPortList, isFireFunctional, isOpaque, isStrict, iterate, linkToPublishedPort, linkToPublishedPort, needsWidthInference, newInsideReceiver, newReceiver, newRelation, notifyConnectivityChange, outputPortList, postfire, prefire, preinitialize, recordFiring, registerPublisherPort, removeActorFiringListener, removeInitializable, removePiggyback, requestChange, setContainer, setDirector, setManager, stop, stopFire, terminate, unlinkToPublishedPort, unlinkToPublishedPort, unregisterPublisherPort, wrapup
 
Methods inherited from class ptolemy.kernel.CompositeEntity
_adjustDeferrals, _deepOpaqueEntityList, _description, _exportMoMLContents, _recordDecoratedAttributes, _removeEntity, _removeRelation, _validateSettables, allAtomicEntityList, allCompositeEntityList, allowLevelCrossingConnect, classDefinitionList, connect, connect, containedObjectsIterator, deepEntityList, deepGetEntities, deepOpaqueEntityList, deepRelationSet, entityList, entityList, exportLinks, exportMoML, getAttribute, getEntities, getEntity, getPort, getRelation, getRelations, isAtomic, lazyAllAtomicEntityList, lazyAllCompositeEntityList, lazyClassDefinitionList, lazyDeepEntityList, lazyEntityList, lazyRelationList, numberOfEntities, numberOfRelations, numEntities, numRelations, relationList, removeAllEntities, removeAllRelations, setClassDefinition, statistics, uniqueName
 
Methods inherited from class ptolemy.kernel.ComponentEntity
_checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName
 
Methods inherited from class ptolemy.kernel.Entity
_removePort, connectedPortList, connectedPorts, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts
 
Methods inherited from class ptolemy.kernel.InstantiableNamedObj
_setParent, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition
 
Methods inherited from class ptolemy.kernel.util.NamedObj
_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, attributeTypeChanged, clone, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ptolemy.actor.Actor
createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList
 
Methods inherited from interface ptolemy.actor.Executable
isFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminate
 
Methods inherited from interface ptolemy.actor.Initializable
addInitializable, initialize, preinitialize, removeInitializable, wrapup
 
Methods inherited from interface ptolemy.kernel.util.Nameable
description, getContainer, getDisplayName, getFullName, getName, getName, setName
 
Methods inherited from interface ptolemy.kernel.util.Derivable
getDerivedLevel, getDerivedList, propagateValue
 

Field Detail

photo

public PortParameter photo
Persistent photosensor input data. The default value is a DoubleToken with value 0. The valid range is between 0 and 0x3FF.


temperature

public PortParameter temperature
Persistent temperature input data. The default value is a DoubleToken with value 0. The valid range is between 0 and 0x3FF.


microphone

public PortParameter microphone
Persistent microphone input data. The default value is a DoubleToken with value 0. The valid range is between 0 and 0x3FF.


accelerometerX

public PortParameter accelerometerX
Persistent accelerometer (x-axis) input data. The default value is a DoubleToken with value 0. The valid range is between 0 and 0x3FF.


accelerometerY

public PortParameter accelerometerY
Persistent accelerometer (y-axis) input data. The default value is a DoubleToken with value 0. The valid range is between 0 and 0x3FF.


magnetometerX

public PortParameter magnetometerX
Persistent magnetometer (x-axis) input data. The default value is a DoubleToken with value 0. The valid range is between 0 and 0x3FF.


magnetometerY

public PortParameter magnetometerY
Persistent magnetometer (y-axis) input data. The default value is a DoubleToken with value 0. The valid range is between 0 and 0x3FF.


ledRed

public TypedIOPort ledRed
Red LED output port. The default type is BooleanToken.


ledGreen

public TypedIOPort ledGreen
Green LED output port. The default type is BooleanToken.


ledYellow

public TypedIOPort ledYellow
Yellow LED output port. The default type is BooleanToken.

Constructor Detail

MicaCompositeActor

public MicaCompositeActor()
Construct an actor in the default workspace with an empty string as its name. The object is added to the workspace directory. Increment the version number of the workspace.


MicaCompositeActor

public MicaCompositeActor(Workspace workspace)
Construct an actor in the specified workspace with an empty string as a name. You can then change the name with setName(). If the workspace argument is null, then use the default workspace. The object is added to the workspace directory. Increment the version number of the workspace.

Parameters:
workspace - The workspace that will list the entity.

MicaCompositeActor

public MicaCompositeActor(CompositeEntity container,
                          java.lang.String name)
                   throws IllegalActionException,
                          NameDuplicationException
Construct an actor in the specified container with the specified name.

Parameters:
container - The container.
name - The name of this actor within the container.
Throws:
IllegalActionException - If the actor cannot be contained by the proposed container.
NameDuplicationException - If the name coincides with an actor already in the container.