Enums

Analog Units

Name	Python Enum	Description
Percent	PERCENT or AnalogUnits.PCT	An analog unit that is measured in percentage.
Eightbit	AnalogUnits.EIGHTBIT	An analog unit that is measured in an 8-bit analog value (a value with 256 possible states).
Tenbit	AnalogUnits.TENBIT	An analog unit that is measured in a 10-bit analog value (a value with 1024 possible states).
Twelvebit	AnalogUnits.TWELVEBIT	An analog unit that is measured in a 12-bit analog value (a value with 4096 possible states).
Millivolts	AnalogUnits.MV	An analog unit that is measured in millivolts.

Axis Types

Name	Python Enum	Description
X-Axis	XAXIS or AxisType.XAXIS	The X axis of the Inertial sensor.
Y-Axis	YAXIS or AxisType.YAXIS	The Y axis of the Inertial sensor.
Z-Axis	ZAXIS or AxisType.ZAXIS	The Z axis of the Inertial sensor.

Brake Types

Name	Python Enum	Description
Coast	COAST or BrakeType.COAST	A brake unit that is defined as motor coast.
Brake	BRAKE or BrakeType.BRAKE	A brake unit that is defined as motor brake.
Hold	HOLD or BrakeType.HOLD	A brake unit that is defined as motor hold.

Color Types

Name	Python Enum	Description
Black	Color.BLACK	Predefined color black.
White	Color.WHITE	Predefined color white.
Red	Color.RED	Predefined color red.
Green	Color.GREEN	Predefined color green.
Blue	Color.BLUE	Predefined color blue.
Yellow	Color.YELLOW	Predefined color yellow.
Orange	Color.ORANGE	Predefined color orange.
Purple	Color.PURPLE	Predefined color purple.
Cyan	Color.CYAN	Predefined color cyan.
Transparent	Color.TRANSPARENT	Predefined color transparent.
Red Violet	Color.RED_VIOLET	Predefined color red-violet.
Violet	Color.VIOLET	Predefined color violet.
Blue Violet	Color.BLUE_VIOLET	Predefined color blue-violet.
Blue Green	Color.BLUE_GREEN	Predefined color blue-green.
Yellow Green	Color.YELLOW_GREEN	Predefined color yellow-green.
Yellow Orange	Color.YELLOW_ORANGE	Predefined color yellow-orange.
Red Orange	Color.RED_ORANGE	Predefined color red-orange.

Direction Types

Name	Python Enum	Description
Forward	FORWARD or DirectionType.FORWARD	A direction unit that is defined as forward.
Reverse	REVERSE or DirectionType.REVERSE	A direction unit that is defined as backward.

Distance Units

Name	Python Enum	Description
Millimeters	MM or DistanceUnits.MM	A distance unit that is measured in millimeters.
Inches	INCHES or DistanceUnits.IN	A distance unit that is measured in inches.
Centimeters	DistanceUnits.CM	A distance unit that is measured in centimeters.

Fade Types

Name	Python Enum	Description
Off	FadeType.OFF	Sets the TouchLED Sensor’s Fade to off.
Slow	FadeType.SLOW	Sets the TouchLED Sensor to Fade slowly.
Fast	FadeType.FAST	Sets the TouchLED Sensor to Fade quickly.

Font Types

Name	Python Enum	Description
Mono12	FontType.MONO12	Monotype font of size 12.
Mono15	FontType.MONO15	Monotype font of size 15.
Mono20	FontType.MONO20	Monotype font of size 20.
Mono30	FontType.MONO30	Monotype font of size 30.
Mono40	FontType.MONO40	Monotype font of size 40.
Mono60	FontType.MONO60	Monotype font of size 60.
Prop20	FontType.PROP20	Proportional font of size 20.
Prop30	FontType.PROP30	Proportional font of size 30.
Prop40	FontType.PROP40	Proportional font of size 40.
Prop60	FontType.PROP60	Proportional font of size 60.
CJK16	FontType.CJK16	Chinese/Japanese/Korean font of size 16.

Gear Settings

Name	Python Enum	Description
Ratio 1:1	GearSetting.RATIO1_1	A Drivebase or Motor with a Gear ratio of 1:1.
Ratio 2:1	GearSetting.RATIO2_1	A Drivebase or Motor with a Gear ratio of 2:1.
Ratio 3:1	GearSetting.RATIO3_1	A Drivebase or Motor with a Gear ratio of 3:1.

Gesture Types

Name	Python Enum	Description
Up	GestureType.UP	The Up Gesture detected by the Optical Sensor.
Down	GestureType.DOWN	The Down Gesture detected by the Optical Sensor.
Left	GestureType.LEFT	The Left Gesture detected by the Optical Sensor.
Right	GestureType.RIGHT	The Right Gesture detected by the Optical Sensor.

Gyro Calibration Types

Name	Python Enum	Description
Normal	GyroCalibrationType.NORMAL	Normal gyro calibration speed.
Slow	GyroCalibrationType.SLOW	Slow gyro calibration speed.
Extended	GyroCalibrationType.EXTENDED	Extended gyro calibration speed.

LED State Types

Name	Python Enum	Description
Off	LedStateType.OFF	LED state to turn off the LED.
On	LedStateType.ON	LED state to turn on the LED.

Object Size Types

Name	Python Enum	Description
Small	ObjectSizeType.SMALL	Small object size.
Medium	ObjectSizeType.MEDIUM	Medium object size.
Large	ObjectSizeType.LARGE	Large object size.

Orientation Types

Name	Python Enum	Description
Roll	ROLL or OrientationType.ROLL	Roll, orientation around the X axis of the Inertial sensor.
Pitch	PITCH or OrientationType.PITCH	Pitch, orientation around the Y axis of the Inertial sensor.
Yaw	YAW or OrientationType.YAW	Yaw, orientation around the Z axis of the Inertial sensor.

Ports

Name	Python Enum	Description
Port 1	PORT1	Sets the port that device is connected to on the Brain to port 1.
Port 2	PORT2	Sets the port that device is connected to on the Brain to port 2.
Port 3	PORT3	Sets the port that device is connected to on the Brain to port 3.
Port 4	PORT4	Sets the port that device is connected to on the Brain to port 4.
Port 5	PORT5	Sets the port that device is connected to on the Brain to port 5.
Port 6	PORT6	Sets the port that device is connected to on the Brain to port 6.
Port 7	PORT7	Sets the port that device is connected to on the Brain to port 7.
Port 8	PORT8	Sets the port that device is connected to on the Brain to port 8.
Port 9	PORT9	Sets the port that device is connected to on the Brain to port 9.
Port 10	PORT10	Sets the port that device is connected to on the Brain to port 10.
Port 11	PORT11	Sets the port that device is connected to on the Brain to port 11.
Port 12	PORT12	Sets the port that device is connected to on the Brain to port 12.

Rotation Units

Name	Python Enum	Description
Degrees	DEGREES or RotationUnits.DEG	A rotation unit that is measured in degrees.
Revolutions	TURNS or RotationUnits.REV	A rotation unit that is measured in revolutions.
Raw	RotationUnits.RAW	A rotation unit that is measured in raw data form.

Sound Types

Name	Python Enum	Description
Siren	SoundType.SIREN	Sound type siren.
Wrong Way	SoundType.WRONG_WAY	Sound type wrong way.
Wrong Way Slow	SoundType.WRONG_WAY_SLOW	Sound type wrong way slow.
Fill Up	SoundType.FILLUP	Sound type fill up.
Headlights On	SoundType.HEADLIGHTS_ON	Sound type headlights on.
Headlights Off	SoundType.HEADLIGHTS_OFF	Sound type headlights off.
Tollbooth	SoundType.TOLLBOOTH	Sound type tollbooth.
Alarm	SoundType.ALARM	Sound type alarm.
Tada	SoundType.TADA	Sound type tada.
Door Close	SoundType.DOOR_CLOSE	Sound type door close.
Ratchet	SoundType.RATCHET	Sound type ratchet.
Wrench	SoundType.WRENCH	Sound type wrench.
Siren2	SoundType.SIREN2	Sound type siren 2.
Ratchet2	SoundType.RATCHET2	Sound type ratchet 2.
Alarm2	SoundType.ALARM2	Sound type alarm 2.
Power Down	SoundType.POWER_DOWN	Sound type power down.

Temperature Units

Name	Python Enum	Description
Celsius	TemperatureUnits.CELSIUS	A temperature unit that is measured in Celsius.
Fahrenheit	TemperatureUnits.FAHRENHEIT	A temperature unit that is measured in Fahrenheit.

Time Units

Name	Python Enum	Description
Seconds	SECONDS or TimeUnits.SECONDS	A time unit that is measured in seconds.
Milliseconds	MSEC or TimeUnits.MSEC	A time unit that is measured in milliseconds.

Torque Units

Name	Python Enum	Description
Newton Meters	TorqueUnits.NM	A torque unit that is measured in Newton Meters.
Inch Pounds	TorqueUnits.INLB	A torque unit that is measured in Inch Pounds.

Turn Types

Name	Python Enum	Description
Left	LEFT or TurnType.LEFT	A turn unit that is defined as left turning.
Right	RIGHT or TurnType.RIGHT	A turn unit that is defined as right turning.
Undefined	TurnType.UNDEFINED	A turn unit used when direction is not known.

Velocity Units

Name	Python Enum	Description
Percent	VelocityUnits.PCT	A velocity unit that is measured in percentage.
Rotations Per Minute	RPM or VelocityUnits.RPM	A velocity unit that is measured in rotations per minute.
Degrees Per Second	DPS or VelocityUnits.DPS	A velocity unit that is measured in degrees per second.

Voltage Units

Name	Python Enum	Description
Volts	VOLT or VoltageUnits.VOLT	A voltage unit that is measured in volts.
Millivolts	MV or VoltageUnits.MV	A voltage unit that is measured in millivolts.