Enums#

Analog Units#

Name

C++ Enum

Description

Range 8-bit

range8bit

Encodes the value as an 8-bit integer from 0 to 255.

Range 10-bit

range10bit

Encodes the value as a 10-bit integer from 0 to 1023.

Range 12-bit

range12bit

Encodes the value as a 12-bit integer from 0 to 4095.

Millivolts

mV

Measures the value of the analog input in millivolts.

Axis Types#

Name

C++ Enum

Description

X-Axis

xaxis

Sets the command to generate values based on the X-Axis.

Y-Axis

yaxis

Sets the command to generate values based on the Y-Axis.

Z-Axis

zaxis

Sets the command to generate values based on the Z-Axis.

Brake Types#

Name

C++ Enum

Description

Coast

coast

The coast mode allows the motor to gradually come to a stop.

Brake

brake

The brake mode stops the motor immediately.

Hold

hold

The hold mode stops the robot immediately and holds the motor in the stopped position.

Color Types#

Name

C++ Enum

Description

Black

black

The predefined color constant for black as the RGB value: (0, 0, 0).

White

white

The predefined color constant for white as the RGB value: (255, 255, 255).

Red

red

The predefined color constant for red as the RGB value: (255, 0, 0).

Green

green

The predefined color constant for green as the RGB value: (0, 255, 0).

Blue

blue

The predefined color constant for blue as the RGB value: (0, 0, 255).

Yellow

yellow

The predefined color constant for yellow as the RGB value: (255, 255, 0).

Orange

orange

The predefined color constant for orange as the RGB value: (255, 165, 0).

Purple

purple

The predefined color constant for purple as the RGB value: (255, 0, 255).

Cyan

cyan

The predefined color constant for cyan as the RGB value: (0, 255, 255).

Transparent

transparent

The predefined color constant for transparent.

Controller Types#

Name

C++ Enum

Description

Primary

primary

Sets a V5 controller as the primary controller when initializing a controller.

Partner

partner

Sets a V5 controller as the partner controller when initializing a controller.

Direction Types#

Name

C++ Enum

Description

Forward

forward or fwd

Sets the direction for a motor or drivetrain to move to forward.

Reverse

reverse

Sets the direction for a motor or drivetrain to move to reverse.

Distance Units#

Name

C++ Enum

Description

Inches

inches

Measures the value of the distance in inches.

Millimeters

mm

Measures the value of the distance in millimeters.

Centimeters

distanceUnits::cm

Measures the value of the distance in centimeters.

Font Types#

There are two different types of fonts available on the V5 Brain’s screen:

  • mono is for Monotype font, where each character will take up the same width on the screen.

  • prop is for Proportional, where each character will take up different widths on the screen based on that character.

Name

C++ Enum

Description

Mono 12

mono12 or monoXS

The predefined monotype font of size 12.

Mono 15

mono15 or monoS

The predefined monotype font of size 15.

Mono 20

mono20 or monoM

The predefined monotype font of size 20.

Mono 30

mono30 or monoL

The predefined monotype font of size 30.

Mono 40

mono40 or monoXL

The predefined monotype font of size 40.

Mono 60

mono60 or monXXL

The predefined monotype font of size 60.

Prop 20

prop20 or propM

The predefined proportional font of size 20.

Prop 30

prop30 or propL

The predefined proportional font of size 30.

Prop 40

prop40 or propXL

The predefined proportional font of size 40.

Prop 60

prop60 or propXXL

The predefined proportional font of size 60.

CJK 16

fontType::cjk16

The predefined Chinese/Japanese/Korean font of size 16.

Gear Setting#

Name

C++ Enum

Description

Ratio 36:1

ratio36_1

The constant to represent a 36:1 gear ratio. A red gearbox for a V5 SmartMotor.

Ratio 18:1

ratio18_1

The constant to represent a 18:1 gear ratio. A green gearbox for a V5 SmartMotor.

Ratio 6:1

ratio6_1

The constant to represent a 6:1 gear ratio. A blue gearbox for a V5 SmartMotor.

LED State Types#

Name

C++ Enum

Description

On

ledState::on

Sets the command to turn on the optical sensor’s LED.

Off

ledState::off

Sets the command to turn off the optical sensor’s LED.

Object Types#

Name

C++ Enum

Description

Color Object

objectType::colorObject

A colordesc object.

Code Object

objectType::codeObject

A codedesc object.

Model Object

objectType::modelObject

An AI Model object, also known as an AI Classification. Use the modelDetection method to enable AI Classification detection.

Tag Object

objectType::tagObject

A tagdesc.

All Object

objectType::allObject

The AI Vision Sensor will look for all objects.

Orientation Types#

Name

C++ Enum

Description

Roll

roll

Sets the command to generate values based on the roll.

Pitch

pitch

Sets the command to generate values based on the pitch.

Yaw

yaw

Sets the command to generate values based on the yaw.

Percent Units#

Name

C++ Enum

Description

Percent

percent or pct

A percentage unit representing a value from 0% - 100%.

Ports#

Name

C++ Enum

Description

Port 1

PORT1

Sets the port that device is connected to on the V5 Brain to port 1.

Port 2

PORT2

Sets the port that device is connected to on the V5 Brain to port 2.

Port 3

PORT3

Sets the port that device is connected to on the V5 Brain to port 3.

Port 4

PORT4

Sets the port that device is connected to on the V5 Brain to port 4.

Port 5

PORT5

Sets the port that device is connected to on the V5 Brain to port 5.

Port 6

PORT6

Sets the port that device is connected to on the V5 Brain to port 6.

Port 7

PORT7

Sets the port that device is connected to on the V5 Brain to port 7.

Port 8

PORT8

Sets the port that device is connected to on the V5 Brain to port 8.

Port 9

PORT9

Sets the port that device is connected to on the V5 Brain to port 9.

Port 10

PORT10

Sets the port that device is connected to on the V5 Brain to port 10.

Port 11

PORT11

Sets the port that device is connected to on the V5 Brain to port 11.

Port 12

PORT12

Sets the port that device is connected to on the V5 Brain to port 12.

Port 13

PORT13

Sets the port that device is connected to on the V5 Brain to port 13.

Port 14

PORT14

Sets the port that device is connected to on the V5 Brain to port 14.

Port 15

PORT15

Sets the port that device is connected to on the V5 Brain to port 15.

Port 16

PORT16

Sets the port that device is connected to on the V5 Brain to port 16.

Port 17

PORT17

Sets the port that device is connected to on the V5 Brain to port 17.

Port 18

PORT18

Sets the port that device is connected to on the V5 Brain to port 18.

Port 19

PORT19

Sets the port that device is connected to on the V5 Brain to port 19.

Port 20

PORT20

Sets the port that device is connected to on the V5 Brain to port 20.

Port 21

PORT21

Sets the port that device is connected to on the V5 Brain to port 21.

Rotation Units#

Name

C++ Enum

Description

Degrees

degrees or deg

Expresses the rotation value as a degree.

Turns

turns or rev

Expresses the rotation value in revolutions.

Temperature Units#

Name

C++ Enum

Description

Celsius

celsius

Expresses the temperature value in degrees Celsius.

Fahrenheit

fahrenheit

Expresses the temperature value in degrees Fahrenheit.

Time Units#

Name

C++ Enum

Description

Seconds

seconds or sec

Counts the time value in seconds.

Milliseconds

msec

Counts the time value in milliseconds.

Torque Units#

Name

C++ Enum

Description

Newton Meters

Nm

Expresses the torque value in newton meters.

Inch Pounds

InLb

Expresses the torque value in inch pounds.

Turn Types#

Name

C++ Enum

Description

Left

left

Sets the command to turn to the left.

Right

right

Sets the command to turn to the right.

Velocity Units#

Name

C++ Enum

Description

Rotations per Minute

rpm

Expresses the velocity value in rotations per minute.

Degrees per Second

dps

Expresses the velocity value in degrees per second.

Voltage Units#

Name

C++ Enum

Description

Volt

volt

Expresses the voltage in volts.

Millivolt

voltageUnits::mV

Expresses the voltage in millivolts.