vexiq.ColorSensor Class Reference

Config Color Sensor: detects color hue or a grayscale value. More...

Public Member Functions
def	__init__ (self, port=None, is_graysale=False, proximity=700)
def	set_proximity_threshold (self, proximity)
	Set the proximity threshold setting. More...
def	set_grayscale_mode (self, is_grayscale)
	Turn grayscale mode setting on (True) or off (False). More...
def	named_color (self)
	Get color as a number corresponding to a NamedColor value. More...
def	raw_color (self)
	Get raw color info as a tuple of ints (red, green, blue, brightness). More...
def	grayscale (self)
	Get grayscale value in the [0-100] range. More...
def	led_on (self)
	Turn on the LED. More...
def	led_off (self)
	Turn off the LED. More...

Detailed Description

Config Color Sensor: detects color hue or a grayscale value.

Parameters

port	1-12, None to autodetect. Default None.
is_grayscale	True if grayscale mode, False if color mode. Default False.
proximity	Set proximity threshold. Default 700.

Constructor & Destructor Documentation

__init__()

def vexiq.ColorSensor.__init__	(		self,
			port = None,
			is_graysale = False,
			proximity = 700
	)

Member Function Documentation

set_proximity_threshold()

def vexiq.ColorSensor.set_proximity_threshold	(		self,
			proximity
	)

Set the proximity threshold setting.

Higher is closer.

Parameters

proximity

threshold

set_grayscale_mode()

def vexiq.ColorSensor.set_grayscale_mode	(		self,
			is_grayscale
	)

Turn grayscale mode setting on (True) or off (False).

Parameters

is_grayscale

True if grayscale, False if color

named_color()

def vexiq.ColorSensor.named_color

(

self

)

Get color as a number corresponding to a NamedColor value.

Returns

NamedColor value (number)

raw_color()

def vexiq.ColorSensor.raw_color

(

self

)

Get raw color info as a tuple of ints (red, green, blue, brightness).

Returns

tuple (red, green, blue, brightness)

grayscale()

def vexiq.ColorSensor.grayscale

(

self

)

Get grayscale value in the [0-100] range.

Returns

number [0...100]

led_on()

def vexiq.ColorSensor.led_on

(

self

)

Turn on the LED.

led_off()

def vexiq.ColorSensor.led_off

(

self

)

Turn off the LED.