Optical#

Initializing the Optical Class #

An Optical Sensor is created by using the following constructor:

Optical(port)

This constructor use one parameter:

Parameter	Description
`port`	A valid `Smart Port` that the Optical Sensor is connected to.

# 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.

Class Methods #

hue()#

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

Returns: The value of the hue detected by the Optical Sensor as a float in the range 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.

Parameters	Description
`readraw`	Optional. A boolean value to read raw brightness data instead of percentage.

Returns: The brightness detected by the Optical Sensor as a float in the range 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.

Returns: The color detected by the Optical Sensor as an instance of the Color class.

# 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.

Parameters	Description
`value`	The state to set the light or the percentage of power in the range 0 - 100.

Returns: None.

# 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.

Parameters	Description
`value`	The power level to set the light from 0 - 100 as a percent.

Returns: None.

# 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.

Parameters	Description
`value`	Optional. The integration time in milliseconds from 5 - 700.

Returns: None.

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

rgb()#

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

Parameters	Description
`raw`	Optional. A boolean value to determine if you return raw or processed values.

Returns: A tuple with red, green, blue, and brightness values.

# 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.

Parameters	Description
`value`	A number in the range 0 - 255. A value of 0 will just return the current value.

Returns: The current value of the object detection threshold.

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

object_detected()#

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

Parameters	Description
`callback`	The callback function to be called when an object is detected.
`arg`	Optional. A tuple of arguments to pass to the callback function.

Returns: An instance of the Event class.

# 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.

Parameters	Description
`callback`	The callback function to be called when an object is lost.
`arg`	Optional. A tuple of arguments to pass to the callback function.

Returns: An instance of the Event class.

# 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)

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.

Returns: The timestamp of the last received status packet in milliseconds.