Sensor óptico#

Introducción #

The optical class is used to access data from the Optical Sensor. It uses reflected light to detect objects, identify colors, and measure brightness and hue.

Constructor de clases #

optical Optical = optical(index);

Instructor de clase #

Destroys the optical object and releases associated resources.

virtual ~optical();

Parámetros #

Parámetro	Tipo	Descripción
`index`	`int32_t`	The Smart Port that the Optical Sensor is connected to, written as `PORTx`, where `x` is the port number (for example, `PORT1`).

Ejemplos #

// Create an optical instance in Port 1
optical Optical1 = optical(PORT1);

Funciones de los miembros #

The optical class includes the following member functions:

setLight — Turns the Optical Sensor’s LED on or off.
setLightPower — Sets the Optical Sensor’s light power level.
isNearObject — Returns whether or not the Optical Sensor detects an object within range.
color — Returns the color detected by the Optical Sensor.
brightness — Returns the amount of light reflected from the object.
hue — Returns the hue detected by the Optical Sensor.
objectDetected — Registers a function to be called when the Optical Sensor detects an object.
objectLost — Registers a function to be called when the Optical Sensor loses an object.

Before calling any optical member functions, an optical instance must be created, as shown below:

/* This constructor is required when using VS Code.
Optical Sensor configuration is generated automatically
in VEXcode using the Device Menu. Replace the values
as needed. */

// Create an optical object in Port 1
optical Optical1 = optical(PORT1);

setLight #

Permite encender o apagar el LED del sensor óptico. Esta luz ayuda al sensor óptico a detectar objetos y colores con mayor claridad.

Available Functions

void  setLight(ledState state);

Parameters

Parámetro	Tipo	Descripción
`state`	`ledState`	Sets the LED on or off. `ledState::on` turns the LED on at 100% brightness. `ledState::off` turns it off.

Return Values

Esta función no devuelve ningún valor.

Examples

// Turn on LED with previous intensity.
Optical.setLight(ledState::on);

setLightPower #

Esta opción determina el nivel de brillo de la luz del sensor óptico. La luz ayuda al sensor óptico a detectar objetos y colores con mayor claridad.

Un porcentaje mayor hace que la luz sea más brillante. Un porcentaje menor hace que la luz sea más tenue.

Si la luz del sensor óptico está apagada, al ajustar la potencia de la luz por encima del 0% se encenderá la luz.

Si la luz del sensor óptico está encendida, al ajustar la potencia de la luz al 0%, esta se apagará.

Available Functions

void setLightPower( 
      int32_t      intensity, 
      percentUnits units = percent );

Parameters

Parámetro	Tipo	Descripción
`intensity`	`int32_t`	Nivel de potencia para ajustar la luz de 0 a 100.
`units`	`percentUnits`	The unit that represents the light intensity: `percent` / `pct` — percent

Return Values

Esta función no devuelve ningún valor.

Examples

// Set the light power to 50 percent.
Optical.setLightPower(50, percent);

isNearObject #

Indica si el sensor óptico detecta o no un objeto dentro de su alcance.

Available Functions

bool  isNearObject();

Parameters

Esta función no acepta ningún parámetro.

Return Values

Esta función devuelve un valor booleano que indica si se ha detectado un objeto cercano:

true — An object is detected nearby.
false — An object is not detected.

Examples

// If an object is detected by the Optical Sensor, print
// "near object".
if (Optical.isNearObject()){
  Brain.Screen.print("near object");
}

color #

Devuelve el color detectado por el sensor óptico, basándose en el valor de tono detectado.

Available Functions

vex::color  color();

Parameters

Esta función no acepta ningún parámetro.

Return Values

El color detectado por el sensor óptico como una instancia de la clase de color.

Los colores posibles son:

blue – Hue value between 196° and 229°
blue_green – Hue value between 140° and 195°
blue_violet – Hue value between 230° and 239°
green – Hue value between 84° and 139°
orange – Hue value between 21° and 30°
red – Hue value between 350° and 14°
red_orange – Hue value between 15° and 20°
red_violet – Hue value between 281° and 350°
violet – Hue value between 240° and 280°
yellow – Hue value between 54° and 74°
yellow_green – Hue value between 75° and 83°
yellow_orange – Hue value between 31° and 53°

Examples

// Set a variable, detectColor, to the color detected by the
// Optical Sensor
color detectColor = Optical.color();

// Print the color detected by the Optical Sensor
// to the Brain's screen
Brain.Screen.print(detectColor);

brightness #

Indica la cantidad de luz que se refleja de vuelta al sensor óptico.

Un porcentaje más alto significa que se refleja más luz de vuelta al sensor óptico. Un porcentaje más bajo significa que se refleja menos luz.

Available Functions

double  brightness(bool bRaw = false);

Parameters

Parámetro	Tipo	Descripción
`bRaw`	`bool`	A Boolean value to read raw brightness data instead of percentage. The default is `false`.

Return Values

Un valor doble que representa el brillo detectado por el sensor óptico en el rango de 0 a 100 %, o un valor doble que representa los datos brutos detectados por el sensor.

Examples

// Set a variable, brightness, to the value of the brightness
// detected by the Optical Sensor
double brightness = Optical.brightness();

// Print the brightness detected by the Optical Sensor to the
// Brain's screen
Brain.Screen.print(brightness);

hue #

Devuelve el tono detectado por el sensor óptico.

El matiz es una forma de describir el color utilizando números alrededor de una rueda de colores.

La rueda de colores VEX que muestra los grados de los colores alrededor de un círculo, con el rojo en 0 grados y haciendo la transición a través del arco iris a medida que aumenta el valor.

Available Functions

double hue();

Parameters

Esta función no acepta ningún parámetro.

Return Values

Un valor double que representa el valor del tono detectado por el sensor óptico en el rango de 0 a 359,00.

Examples

// Set a variable, hue, to the value of the hue detected
// by the Optical Sensor.
double hue = Optical.hue();

objectDetected #

Registra una función de devolución de llamada para cuando se detecta un objeto.

Available Functions

void objectDetected(void (* callback)(void));

Parameters

Parámetro	Tipo	Descripción
`callback`	`void (*)(void)`	Una función definida previamente que se ejecuta cuando el sensor óptico detecta un nuevo objeto.

Return Values

Esta función no devuelve ningún valor.

Examples

Define the callback function (outside of int main())

// Called when the Optical Sensor detects an object
void detected() {
  // The Brain will print that the Optical Sensor detected an
  // object to the Brain's screen.
  Brain.Screen.print("object detected");
}

/* vexcodeInit() is only required when using VEXcode.
Remove vexcodeInit() if compiling in VS Code. */
int main() {

  // Run when the Optical Sensor detects an object.
  Optical.objectDetected(detected);
}

objectLost #

Registra una función de devolución de llamada para cuando se pierde un objeto.

Available Functions

void objectLost(void (* callback)(void));

Parameters

Parámetro	Tipo	Descripción
`callback`	`void (*)(void)`	Una función definida previamente que se ejecuta cuando el sensor óptico pierde un objeto detectado.

Return Values

Esta función no devuelve ningún valor.

Examples

Define the callback function (outside of int main())

// Called when the Optical Sensor loses an object
void lost() {
  // The Brain will print that the Optical Sensor lost an
  // object to the Brain's screen.
  Brain.Screen.print("object lost");
}

/* vexcodeInit() is only required when using VEXcode.
Remove vexcodeInit() if compiling in VS Code. */
int main() {

  // Run lost when the Optical Sensor loses an object.
  Optical.objectLost(lost);
}