Óptico#

Inicializando la clase óptica#

Un sensor óptico se crea utilizando el siguiente constructor:

Optical(port)

Este constructor utiliza un parámetro:

Parámetro

Descripción

port

Un Puerto inteligente válido al que está conectado el sensor óptico.

# Construct an Optical Sensor "optical" with the
# Optical class.
optical = Optical(Ports.PORT1)

This optical object will be used in all subsequent examples throughout this API documentation when referring to Optical class methods.

Métodos de clase#

hue()#

The hue() method returns the value of the hue detected by the Optical Sensor.

Devuelve: El valor del tono detectado por el sensor óptico como un flotante en el rango 0 - 359,99.

# Set a variable hue, to the value of the hue detected by
# the Optical Sensor.
hue = optical.hue()

brightness()#

The brightness(readraw) method returns the brightness detected by the Optical Sensor.

Parámetros

Descripción

leer dibujo

Opcional. Un valor booleano para leer datos de brillo sin procesar en lugar de porcentaje.

Devuelve: El brillo detectado por el sensor óptico como un flotante en el rango 0 - 100%.

# Set a variable brightness, to the value of the brightness
# detected by the Optical Sensor.
brightness = optical.brightness() 

# Print the brightness detected by the Optical Sensor to
# the Brain's screen.
brain.screen.print(brightness)

color()#

The color() method returns the color detected by the Optical Sensor.

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

# Set a variable, color, to the color detected by the
# Optical Sensor.
color = optical.color()

# Print the color detected by the Optical Sensor to the
# Brain's screen.
brain.screen.print(color)

is_near_object()#

The is_near_object() method checks if the Optical Sensor detects a nearby object.

Returns: True if a nearby object is detected. False if one is not.

# If an object is detected yb the Optical Sensor, print "near object".
if optical.is_near_object():
    brain.screen.print("near object")

set_light()#

The set_light(value) method sets Optical Sensor’s LED to on or off.

Parámetros

Descripción

valor

El estado para configurar la luz o el porcentaje de energía en el rango 0 - 100.

Devoluciones: Ninguna.

# Turn on led with previous intensity.
optical.set_light(LedStateType.ON)

# Turn on led with new intensity.
optical.set_light(65)

set_light_power()#

The set_light_power(value) method sets the light power of the Optical Sensor’s LED.

Parámetros

Descripción

valor

El nivel de potencia para configurar la luz de 0 a 100 como porcentaje.

Devoluciones: Ninguna.

# Set the light power to 50 percent.
optical.set_light_power(50)

integration_time()#

The integration_time(value) method sets the Optical Sensor’s LED to the requested power.

Parámetros

Descripción

valor

Opcional. El tiempo de integración en milisegundos de 5 a 700.

Devoluciones: Ninguna.

# Set the integration time to 50 milliseconds.
optical.integration_time(50)

rgb()#

The rgb(raw) method returns the Optical Sensor’s RGB value.

Parámetros

Descripción

crudo

Opcional. Un valor booleano para determinar si devuelve valores sin procesar o procesados.

Devuelve: Una tupla con valores de rojo, verde, azul y brillo.

# Get the RGB value of the Optical Sensor.
rgb = optical.rgb()

object_detect_threshold()#

The object_detect_threshold(value) method sets the object detection threshold.

Parámetros

Descripción

valor

Un número en el rango 0 - 255. Un valor de 0 solo devolverá el valor actual.

Devuelve: El valor actual del umbral de detección de objetos.

# Set the object detection threshold to 100.
optical.value = object_detect_threshold(100)

gesture_enable()#

The gesture_enable() method enables gesture mode.

Un gesto es el movimiento de un objeto detectado por el sensor óptico. Por lo tanto, si un objeto se mueve hacia arriba en el campo de visión del sensor óptico, se trata de un gesto hacia arriba. Por otro lado, si un objeto se mueve hacia abajo, se trata de un gesto hacia abajo. Lo mismo ocurre con los gestos izquierda y derecha.

Devoluciones: Ninguna.

gesture_disable()#

The gesture_disable() method disables gesture mode.

Un gesto es el movimiento de un objeto detectado por el sensor óptico. Por lo tanto, si un objeto se mueve hacia arriba en el campo de visión del sensor óptico, se trata de un gesto hacia arriba. Por otro lado, si un objeto se mueve hacia abajo, se trata de un gesto hacia abajo. Lo mismo ocurre con los gestos izquierda y derecha.

Devoluciones: Ninguna.

get_gesture()#

The get_gesture(newobject) method returns the gesture detected by the Optical Sensor.

Un gesto es el movimiento de un objeto detectado por el sensor óptico. Por lo tanto, si un objeto se mueve hacia arriba en el campo de visión del sensor óptico, se trata de un gesto hacia arriba. Por otro lado, si un objeto se mueve hacia abajo, se trata de un gesto hacia abajo. Lo mismo ocurre con los gestos izquierda y derecha.

Parámetros

Descripción

nuevo objeto

Opcional. Un valor booleano que determina si se debe crear o no un nuevo objeto Gesto.

Devuelve: Un objeto con los últimos datos del gesto.

object_detected()#

The object_detected(callback, arg) method registers a callback function for when an object is detected.

Parámetros

Descripción

llamar de vuelta

La función de devolución de llamada que se llamará cuando se detecte un objeto.

arg

Opcional. Una tupla de argumentos para pasar a la función de devolución de llamada.

Devuelve: Una instancia de la clase Event.

# Define a function detected().
def detected():
    # The Brain will print that an object was detected on
    # the Brain's screen.
    brain.screen.print("object detected")

# Run detected when the Optical Sensor detects an object.
optical.object_detected(detected)

object_lost()#

The object_lost(callback, arg) method registers a callback function for when an object is lost.

Parámetros

Descripción

llamar de vuelta

La función de devolución de llamada que se llamará cuando se pierda un objeto.

arg

Opcional. Una tupla de argumentos para pasar a la función de devolución de llamada.

Devuelve: Una instancia de la clase Event.

# Define a function lost().
def lost():
    # The Brain will print that an object was lost on the
    # Brain's screen.
    brain.screen.print("object lost")

# Run lost when the Optical Sensor loses an object.
optical.object_lost(lost)

gesture_up()#

The gesture_up(callback, arg) method registers a callback function for when an upward gesture is detected.

Un gesto es el movimiento de un objeto detectado por el sensor óptico. Por lo tanto, si un objeto se mueve hacia arriba en el campo de visión del sensor óptico, se trata de un gesto hacia arriba. Por otro lado, si un objeto se mueve hacia abajo, se trata de un gesto hacia abajo. Lo mismo ocurre con los gestos izquierda y derecha.

Parámetros

Descripción

llamar de vuelta

La función de devolución de llamada que se llamará cuando se detecte un gesto hacia arriba.

arg

Opcional. Una tupla de argumentos para pasar a la función de devolución de llamada.

Devoluciones: Ninguna.

# Define a function detect_gesture_up()
def detect_gesture_up():
    # The Brain will print that the up gesture was detected 
    # on the Brain's screen.
    brain.screen.print("gesture up detected")

# Run detect_gesture_up when the Optical Sensor detects 
# an upward gesture.
optical.gesture_up(detect_gesture_up)

gesture_down()#

The gesture_down(callback, arg) method registers a callback function for when an downward gesture is detected.

Un gesto es el movimiento de un objeto detectado por el sensor óptico. Por lo tanto, si un objeto se mueve hacia arriba en el campo de visión del sensor óptico, se trata de un gesto hacia arriba. Por otro lado, si un objeto se mueve hacia abajo, se trata de un gesto hacia abajo. Lo mismo ocurre con los gestos izquierda y derecha.

Parámetros

Descripción

llamar de vuelta

La función de devolución de llamada que se llamará cuando se detecte un gesto hacia abajo.

arg

Opcional. Una tupla de argumentos para pasar a la función de devolución de llamada.

Devoluciones: Ninguna.

# Define a function detect_gesture_down().
def detect_gesture_down():
    # The Brain will print that the down gesture was detected 
    # on the Brain's screen.
    brain.screen.print("gesture down detected")

# Run detect_gesture_down when the Optical Sensor detects 
# a downward gesture.
optical.gesture_down(detect_gesture_down)

gesture_left()#

The gesture_left(callback, arg) method registers a callback function for when an leftward gesture is detected.

Un gesto es el movimiento de un objeto detectado por el sensor óptico. Por lo tanto, si un objeto se mueve hacia arriba en el campo de visión del sensor óptico, se trata de un gesto hacia arriba. Por otro lado, si un objeto se mueve hacia abajo, se trata de un gesto hacia abajo. Lo mismo ocurre con los gestos izquierda y derecha.

Parámetros

Descripción

llamar de vuelta

La función de devolución de llamada que se llamará cuando se detecte un gesto hacia la izquierda.

arg

Opcional. Una tupla de argumentos para pasar a la función de devolución de llamada.

Devoluciones: Ninguna.

# Define a function detect_gesture_left().
def detect_gesture_left():
    # The Brain will print that the left gesture was detected 
    # on the Brain's screen.
    brain.screen.print("gesture left detected")

# Run detect_gesture_left when the Optical Sensor detects 
# a leftward gesture.
optical.gesture_left(detect_gesture_left)

gesture_right()#

The gesture_right(callback, arg) method registers a callback function for when an rightward gesture is detected.

Un gesto es el movimiento de un objeto detectado por el sensor óptico. Por lo tanto, si un objeto se mueve hacia arriba en el campo de visión del sensor óptico, se trata de un gesto hacia arriba. Por otro lado, si un objeto se mueve hacia abajo, se trata de un gesto hacia abajo. Lo mismo ocurre con los gestos izquierda y derecha.

Parámetros

Descripción

llamar de vuelta

La función de devolución de llamada que se llamará cuando se detecte un gesto hacia la derecha.

arg

Opcional. Una tupla de argumentos para pasar a la función de devolución de llamada.

Devoluciones: Ninguna.

# Define a function detect_gesture_right()
def detect_gesture_right():
    # The Brain will print that the right gesture was
    # detected on the Brain's screen.
    brain.screen.print("gesture right detected")

# Run detect_gesture_right when the Optical Sensor detects 
# a rightward gesture.
optical.gesture_right(detect_gesture_right)

installed()#

The installed() method checks if the Optical Sensor is connected.

Returns: True if the Optical Sensor is connected. False if it is not.

timestamp()#

The timestamp() method returns the timestamp of the last received status packet from the Optical Sensor.

Devuelve: La marca de tiempo del último paquete de estado recibido en milisegundos.