AI2 Component  (Version nb184)
Classes | Public Member Functions | Protected Member Functions | List of all members
com.google.appinventor.components.runtime.NxtColorSensor Class Reference
Inheritance diagram for com.google.appinventor.components.runtime.NxtColorSensor:
com.google.appinventor.components.runtime.LegoMindstormsNxtSensor com.google.appinventor.components.runtime.Deleteable com.google.appinventor.components.runtime.LegoMindstormsNxtBase com.google.appinventor.components.runtime.AndroidNonvisibleComponent com.google.appinventor.components.runtime.Component com.google.appinventor.components.runtime.Deleteable com.google.appinventor.components.runtime.Component

Public Member Functions

 NxtColorSensor (ComponentContainer container)
 
void SensorPort (String sensorPortLetter)
 
boolean DetectColor ()
 
void DetectColor (boolean detectColor)
 
int GetColor ()
 
boolean ColorChangedEventEnabled ()
 
void ColorChangedEventEnabled (boolean enabled)
 
void ColorChanged (int color)
 
int GetLightLevel ()
 
int BottomOfRange ()
 
void BottomOfRange (int bottomOfRange)
 
int TopOfRange ()
 
void TopOfRange (int topOfRange)
 
boolean BelowRangeEventEnabled ()
 
void BelowRangeEventEnabled (boolean enabled)
 
void BelowRange ()
 
boolean WithinRangeEventEnabled ()
 
void WithinRangeEventEnabled (boolean enabled)
 
void WithinRange ()
 
boolean AboveRangeEventEnabled ()
 
void AboveRangeEventEnabled (boolean enabled)
 
void AboveRange ()
 
int GenerateColor ()
 
void GenerateColor (int generateColor)
 
void onDelete ()
 
- Public Member Functions inherited from com.google.appinventor.components.runtime.LegoMindstormsNxtSensor
String SensorPort ()
 
void afterConnect (BluetoothConnectionBase bluetoothConnection)
 
- Public Member Functions inherited from com.google.appinventor.components.runtime.LegoMindstormsNxtBase
final void Initialize ()
 
BluetoothClient BluetoothClient ()
 
void BluetoothClient (BluetoothClient bluetoothClient)
 
void beforeDisconnect (BluetoothConnectionBase bluetoothConnection)
 
- Public Member Functions inherited from com.google.appinventor.components.runtime.AndroidNonvisibleComponent
HandlesEventDispatching getDispatchDelegate ()
 

Protected Member Functions

void initializeSensor (String functionName)
 
- Protected Member Functions inherited from com.google.appinventor.components.runtime.LegoMindstormsNxtSensor
 LegoMindstormsNxtSensor (ComponentContainer container, String logTag)
 
final void setSensorPort (String sensorPortLetter)
 
- Protected Member Functions inherited from com.google.appinventor.components.runtime.LegoMindstormsNxtBase
 LegoMindstormsNxtBase (ComponentContainer container, String logTag)
 
 LegoMindstormsNxtBase ()
 
final void setOutputState (String functionName, int port, int power, int mode, int regulationMode, int turnRatio, int runState, long tachoLimit)
 
final void setInputMode (String functionName, int port, int sensorType, int sensorMode)
 
final byte[] getInputValues (String functionName, int port)
 
final void resetInputScaledValue (String functionName, int port)
 
final int lsGetStatus (String functionName, int port)
 
final void lsWrite (String functionName, int port, byte[] data, int rxDataLength)
 
final byte[] lsRead (String functionName, int port)
 
final boolean checkBluetooth (String functionName)
 
final byte[] sendCommandAndReceiveReturnPackage (String functionName, byte[] command)
 
final void sendCommand (String functionName, byte[] command)
 
final boolean evaluateStatus (String functionName, byte[] returnPackage, byte command)
 
final int getStatus (String functionName, byte[] returnPackage, byte command)
 
final void copyBooleanValueToBytes (boolean value, byte[] bytes, int offset)
 
final void copySBYTEValueToBytes (int value, byte[] bytes, int offset)
 
final void copyUBYTEValueToBytes (int value, byte[] bytes, int offset)
 
final void copySWORDValueToBytes (int value, byte[] bytes, int offset)
 
final void copyUWORDValueToBytes (int value, byte[] bytes, int offset)
 
final void copySLONGValueToBytes (int value, byte[] bytes, int offset)
 
final void copyULONGValueToBytes (long value, byte[] bytes, int offset)
 
final void copyStringValueToBytes (String value, byte[] bytes, int offset, int maxCount)
 
final boolean getBooleanValueFromBytes (byte[] bytes, int offset)
 
final int getSBYTEValueFromBytes (byte[] bytes, int offset)
 
final int getUBYTEValueFromBytes (byte[] bytes, int offset)
 
final int getSWORDValueFromBytes (byte[] bytes, int offset)
 
final int getUWORDValueFromBytes (byte[] bytes, int offset)
 
final int getSLONGValueFromBytes (byte[] bytes, int offset)
 
final long getULONGValueFromBytes (byte[] bytes, int offset)
 
final String getStringValueFromBytes (byte[] bytes, int offset)
 
final String getStringValueFromBytes (byte[] bytes, int offset, int count)
 
final int convertMotorPortLetterToNumber (String motorPortLetter)
 
final int convertMotorPortLetterToNumber (char motorPortLetter)
 
final int convertSensorPortLetterToNumber (String sensorPortLetter)
 
final int convertSensorPortLetterToNumber (char sensorPortLetter)
 
final int sanitizePower (int power)
 
final int sanitizeTurnRatio (int turnRatio)
 
- Protected Member Functions inherited from com.google.appinventor.components.runtime.AndroidNonvisibleComponent
 AndroidNonvisibleComponent (Form form)
 

Additional Inherited Members

- Static Public Attributes inherited from com.google.appinventor.components.runtime.Component
static final String ASSET_DIRECTORY = "component"
 
static final int ALIGNMENT_NORMAL = 0
 
static final int ALIGNMENT_CENTER = 1
 
static final int ALIGNMENT_OPPOSITE = 2
 
static final int ACCELEROMETER_SENSITIVITY_WEAK = 1
 
static final int ACCELEROMETER_SENSITIVITY_MODERATE = 2
 
static final int ACCELEROMETER_SENSITIVITY_STRONG = 3
 
static final int BUTTON_SHAPE_DEFAULT = 0
 
static final int BUTTON_SHAPE_ROUNDED = 1
 
static final int BUTTON_SHAPE_RECT = 2
 
static final int BUTTON_SHAPE_OVAL = 3
 
static final int COLOR_NONE = 0x00FFFFFF
 
static final int COLOR_BLACK = 0xFF000000
 
static final int COLOR_BLUE = 0xFF0000FF
 
static final int COLOR_CYAN = 0xFF00FFFF
 
static final int COLOR_DKGRAY = 0xFF444444
 
static final int COLOR_GRAY = 0xFF888888
 
static final int COLOR_GREEN = 0xFF00FF00
 
static final int COLOR_LTGRAY = 0xFFCCCCCC
 
static final int COLOR_MAGENTA = 0xFFFF00FF
 
static final int COLOR_ORANGE = 0xFFFFC800
 
static final int COLOR_PINK = 0xFFFFAFAF
 
static final int COLOR_RED = 0xFFFF0000
 
static final int COLOR_WHITE = 0xFFFFFFFF
 
static final int COLOR_YELLOW = 0xFFFFFF00
 
static final int COLOR_DEFAULT = 0x00000000
 
static final String DEFAULT_VALUE_COLOR_NONE = "&H00FFFFFF"
 
static final String DEFAULT_VALUE_COLOR_BLACK = "&HFF000000"
 
static final String DEFAULT_VALUE_COLOR_BLUE = "&HFF0000FF"
 
static final String DEFAULT_VALUE_COLOR_CYAN = "&HFF00FFFF"
 
static final String DEFAULT_VALUE_COLOR_DKGRAY = "&HFF444444"
 
static final String DEFAULT_VALUE_COLOR_GRAY = "&HFF888888"
 
static final String DEFAULT_VALUE_COLOR_GREEN = "&HFF00FF00"
 
static final String DEFAULT_VALUE_COLOR_LTGRAY = "&HFFCCCCCC"
 
static final String DEFAULT_VALUE_COLOR_MAGENTA = "&HFFFF00FF"
 
static final String DEFAULT_VALUE_COLOR_ORANGE = "&HFFFFC800"
 
static final String DEFAULT_VALUE_COLOR_PINK = "&HFFFFAFAF"
 
static final String DEFAULT_VALUE_COLOR_RED = "&HFFFF0000"
 
static final String DEFAULT_VALUE_COLOR_WHITE = "&HFFFFFFFF"
 
static final String DEFAULT_VALUE_COLOR_YELLOW = "&HFFFFFF00"
 
static final String DEFAULT_VALUE_COLOR_DEFAULT = "&H00000000"
 
static final float FONT_DEFAULT_SIZE = 14
 
static final int LAYOUT_ORIENTATION_HORIZONTAL = ComponentConstants.LAYOUT_ORIENTATION_HORIZONTAL
 
static final int LAYOUT_ORIENTATION_VERTICAL = ComponentConstants.LAYOUT_ORIENTATION_VERTICAL
 
static final int SCALING_SCALE_PROPORTIONALLY = 0
 
static final int SCALING_SCALE_TO_FIT = 1
 
static final int TYPEFACE_DEFAULT = 0
 
static final int TYPEFACE_SANSSERIF = 1
 
static final int TYPEFACE_SERIF = 2
 
static final int TYPEFACE_MONOSPACE = 3
 
static final int LENGTH_PREFERRED = -1
 
static final int LENGTH_FILL_PARENT = -2
 
static final int LENGTH_UNKNOWN = -3
 
static final int LENGTH_PERCENT_TAG = -1000
 
static final int TOAST_LENGTH_SHORT = 0
 
static final int TOAST_LENGTH_LONG = 1
 
static final int DIRECTION_NORTH = 1
 
static final int DIRECTION_NORTHEAST = 2
 
static final int DIRECTION_EAST = 3
 
static final int DIRECTION_SOUTHEAST = 4
 
static final int DIRECTION_SOUTH = -1
 
static final int DIRECTION_SOUTHWEST = -2
 
static final int DIRECTION_WEST = -3
 
static final int DIRECTION_NORTHWEST = -4
 
static final int DIRECTION_NONE = 0
 
static final int DIRECTION_MIN = -4
 
static final int DIRECTION_MAX = 4
 
static float SLIDER_MIN_VALUE = 10
 
static float SLIDER_MAX_VALUE = 50
 
static float SLIDER_THUMB_VALUE = (SLIDER_MIN_VALUE + SLIDER_MAX_VALUE) / 2.0f
 
static final String DEFAULT_VALUE_TEXT_TO_SPEECH_COUNTRY = ""
 
static final String DEFAULT_VALUE_TEXT_TO_SPEECH_LANGUAGE = ""
 
- Protected Attributes inherited from com.google.appinventor.components.runtime.LegoMindstormsNxtSensor
int port
 
- Protected Attributes inherited from com.google.appinventor.components.runtime.LegoMindstormsNxtBase
final String logTag
 
BluetoothClient bluetooth
 
- Protected Attributes inherited from com.google.appinventor.components.runtime.AndroidNonvisibleComponent
final Form form
 

Detailed Description

NXT component icon

A component that provides a high-level interface to a color sensor on a LEGO MINDSTORMS NXT robot.

Author
lizlo.nosp@m.oney.nosp@m.@goog.nosp@m.le.c.nosp@m.om (Liz Looney)

Definition at line 41 of file NxtColorSensor.java.

Constructor & Destructor Documentation

◆ NxtColorSensor()

com.google.appinventor.components.runtime.NxtColorSensor.NxtColorSensor ( ComponentContainer  container)

Creates a new NxtColorSensor component.

Definition at line 92 of file NxtColorSensor.java.

Member Function Documentation

◆ AboveRange()

void com.google.appinventor.components.runtime.NxtColorSensor.AboveRange ( )

Definition at line 511 of file NxtColorSensor.java.

◆ AboveRangeEventEnabled() [1/2]

boolean com.google.appinventor.components.runtime.NxtColorSensor.AboveRangeEventEnabled ( )

Returns whether the AboveRange event should fire when the DetectColor property is set to False and the light level goes above the TopOfRange.

Definition at line 483 of file NxtColorSensor.java.

◆ AboveRangeEventEnabled() [2/2]

void com.google.appinventor.components.runtime.NxtColorSensor.AboveRangeEventEnabled ( boolean  enabled)

Specifies whether the AboveRange event should fire when the DetectColor property is set to False and the light level goes above the TopOfRange.

Definition at line 493 of file NxtColorSensor.java.

◆ BelowRange()

void com.google.appinventor.components.runtime.NxtColorSensor.BelowRange ( )

Definition at line 430 of file NxtColorSensor.java.

◆ BelowRangeEventEnabled() [1/2]

boolean com.google.appinventor.components.runtime.NxtColorSensor.BelowRangeEventEnabled ( )

Returns whether the BelowRange event should fire when the DetectColor property is set to False and the light level goes below the BottomOfRange.

Definition at line 402 of file NxtColorSensor.java.

◆ BelowRangeEventEnabled() [2/2]

void com.google.appinventor.components.runtime.NxtColorSensor.BelowRangeEventEnabled ( boolean  enabled)

Specifies whether the BelowRange event should fire when the DetectColor property is set to False and the light level goes below the BottomOfRange.

Definition at line 412 of file NxtColorSensor.java.

◆ BottomOfRange() [1/2]

int com.google.appinventor.components.runtime.NxtColorSensor.BottomOfRange ( )

Returns the bottom of the range used for the BelowRange, WithinRange, and AboveRange events.

Definition at line 356 of file NxtColorSensor.java.

◆ BottomOfRange() [2/2]

void com.google.appinventor.components.runtime.NxtColorSensor.BottomOfRange ( int  bottomOfRange)

Specifies the bottom of the range used for the BelowRange, WithinRange, and AboveRange events.

Definition at line 367 of file NxtColorSensor.java.

◆ ColorChanged()

void com.google.appinventor.components.runtime.NxtColorSensor.ColorChanged ( int  color)

Definition at line 307 of file NxtColorSensor.java.

◆ ColorChangedEventEnabled() [1/2]

boolean com.google.appinventor.components.runtime.NxtColorSensor.ColorChangedEventEnabled ( )

Returns whether the ColorChanged event should fire when the DetectColor property is set to True and the detected color changes.

Definition at line 279 of file NxtColorSensor.java.

◆ ColorChangedEventEnabled() [2/2]

void com.google.appinventor.components.runtime.NxtColorSensor.ColorChangedEventEnabled ( boolean  enabled)

Specifies whether the ColorChanged event should fire when the DetectColor property is set to True and the detected color changes

Definition at line 289 of file NxtColorSensor.java.

◆ DetectColor() [1/2]

boolean com.google.appinventor.components.runtime.NxtColorSensor.DetectColor ( )

Returns whether the sensor should detect color or light. True indicates that the sensor should detect color; False indicates that the sensor should detect light.

The ColorChanged event will not occur if the DetectColor property is set to False. The BelowRange, WithinRange, and AboveRange events will not occur if the DetectColor property is set to True. The sensor will not generate color when the DetectColor property is set to True.

Definition at line 200 of file NxtColorSensor.java.

◆ DetectColor() [2/2]

void com.google.appinventor.components.runtime.NxtColorSensor.DetectColor ( boolean  detectColor)

Specifies whether the sensor should detect color light. True indicates that the sensor should detect color; False indicates that the sensor should detect light.

Definition at line 212 of file NxtColorSensor.java.

◆ GenerateColor() [1/2]

int com.google.appinventor.components.runtime.NxtColorSensor.GenerateColor ( )

Returns the color that should generated by the sensor. Only None, Red, Green, or Blue are valid values. The sensor will not generate color when the DetectColor property is set to True.

Definition at line 525 of file NxtColorSensor.java.

◆ GenerateColor() [2/2]

void com.google.appinventor.components.runtime.NxtColorSensor.GenerateColor ( int  generateColor)

Specifies the color that should generated by the sensor. Only None, Red, Green, or Blue are valid values. The sensor will not generate color when the DetectColor property is set to True.

Definition at line 538 of file NxtColorSensor.java.

◆ GetColor()

int com.google.appinventor.components.runtime.NxtColorSensor.GetColor ( )

Definition at line 235 of file NxtColorSensor.java.

◆ GetLightLevel()

int com.google.appinventor.components.runtime.NxtColorSensor.GetLightLevel ( )

Definition at line 315 of file NxtColorSensor.java.

◆ initializeSensor()

void com.google.appinventor.components.runtime.NxtColorSensor.initializeSensor ( String  functionName)
protected

Reimplemented from com.google.appinventor.components.runtime.LegoMindstormsNxtSensor.

Definition at line 164 of file NxtColorSensor.java.

◆ onDelete()

void com.google.appinventor.components.runtime.NxtColorSensor.onDelete ( )

Implements com.google.appinventor.components.runtime.Deleteable.

Definition at line 562 of file NxtColorSensor.java.

◆ SensorPort()

void com.google.appinventor.components.runtime.NxtColorSensor.SensorPort ( String  sensorPortLetter)

Specifies the sensor port that the sensor is connected to. Must be set in the Designer.

Reimplemented from com.google.appinventor.components.runtime.LegoMindstormsNxtSensor.

Definition at line 177 of file NxtColorSensor.java.

◆ TopOfRange() [1/2]

int com.google.appinventor.components.runtime.NxtColorSensor.TopOfRange ( )

Returns the top of the range used for the BelowRange, WithinRange, and AboveRange events.

Definition at line 379 of file NxtColorSensor.java.

◆ TopOfRange() [2/2]

void com.google.appinventor.components.runtime.NxtColorSensor.TopOfRange ( int  topOfRange)

Specifies the top of the range used for the BelowRange, WithinRange, and AboveRange events.

Definition at line 390 of file NxtColorSensor.java.

◆ WithinRange()

void com.google.appinventor.components.runtime.NxtColorSensor.WithinRange ( )

Definition at line 472 of file NxtColorSensor.java.

◆ WithinRangeEventEnabled() [1/2]

boolean com.google.appinventor.components.runtime.NxtColorSensor.WithinRangeEventEnabled ( )

Returns whether the WithinRange event should fire when the DetectColor property is set to False and the light level goes between the BottomOfRange and the TopOfRange.

Definition at line 443 of file NxtColorSensor.java.

◆ WithinRangeEventEnabled() [2/2]

void com.google.appinventor.components.runtime.NxtColorSensor.WithinRangeEventEnabled ( boolean  enabled)

Specifies whether the WithinRange event should fire when the DetectColor property is set to False and the light level goes between the BottomOfRange and the TopOfRange.

Definition at line 454 of file NxtColorSensor.java.

The documentation for this class was generated from the following file: