Enums#

Analog Units#

Name

C++ Enum

Description

Percentage

analogUnits::pct

An analog unit that is measured in percentage.

8-bit Range

range8bit or analogUnits::range8bit

An analog unit that is measured in an 8-bit analog value (a value with 256 possible states).

10-bit Range

range10bit or analogUnits::range10bit

An analog unit that is measured in a 10-bit analog value (a value with 1024 possible states).

12-bit Range

range12bit or analogUnits::range12bit

An analog unit that is measured in a 12-bit analog value (a value with 4096 possible states).

Millivolts

mV or analogUnits::mV

An analog unit that is measured in millivolts.

Axis Types#

Name

C++ Enum

Description

X-Axis

xaxis or axisType::xaxis

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

Y-Axis

yaxis or axisType::yaxis

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

Z-Axis

zaxis or axisType::zaxis

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

Brake Types#

Name

C++ Enum

Description

Coast

coast or brakeType::coast

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

Brake

brake or brakeType::brake

The brake mode stops the motor immediately.

Hold

hold or brakeType::hold

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

Color Types#

Name

C++ Enum

Description

Black

black or colorType::black

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

Blue

blue or colorType::blue

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

Blue-Green

blue_green or colorType::blue_green

The predefined color constant for blue-green.

Blue-Violet

blue_violet or colorType::blue_violet

The predefined color constant for blue-violet.

Cyan

cyan or colorType::cyan

The predefined color constant for cyan.

Green

green or colorType::green

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

Orange

orange or colorType::orange

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

Purple

purple or colorType::purple

The predefined color constant for purple.

Red

red or colorType::red

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

Red-Orange

red_orange or colorType::red_orange

The predefined color constant for red-orange.

Red-Violet

red_violet or colorType::red_violet

The predefined color constant for red-violet.

Transparent

transparent or colorType::transparent

The predefined color constant for transparent.

Violet

violet or colorType::violet

The predefined color constant for violet.

White

white or colorType::white

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

Yellow

yellow or colorType::yellow

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

Yellow-Green

yellow_green or colorType::yellow_green

The predefined color constant for yellow-green.

Yellow-Orange

yellow_orange or colorType::yellow_orange

The predefined color constant for yellow-orange.

Controller Types#

Name

C++ Enum

Description

Primary

primary or controllerType::primary

A controller unit defined as a primary controller.

Current Units#

Name

C++ Enum

Description

Amp

amp or currentUnits::amp

A current unit that is measured in amps.

Cylinder Types#

Name

C++ Enum

Description

Cylinder 1

cylinder1 or cylinderType::cylinder1

Cylinder unit 1.

Cylinder 2

cylinder2 or cylinderType::cylinder2

Cylinder unit 2.

Cylinder All

cylinderAll or cylinderType::cylinderAll

All cylinder units.

Direction Types#

Name

C++ Enum

Description

Forward

forward or directionType::fwd

A direction unit that is defined as forward.

Reverse

reverse or directionType::rev

A direction unit that is defined as backward.

Distance Units#

Name

C++ Enum

Description

Centimeters

cm or distanceUnits::cm

A distance unit that is measured in centimeters.

Counts

counts or distanceUnits::counts

A distance unit that is measured in raw counts.

Inches

inches or distanceUnits::in

A distance unit that is measured in inches.

Millimeters

mm or distanceUnits::mm

A distance unit that is measured in millimeters.

Fade Types#

Name

C++ Enum

Description

Fast

fast or fadeType::fast

A fast fade type.

Off

off or fadeType::off

An off fade type.

Slow

slow or fadeType::slow

A slow fade type.

Font Types#

Name

C++ Enum

Description

Mono12

mono12 or fontType::mono12

A font unit that is defined as mono12.

Mono15

mono15 or fontType::mono15

A font unit that is defined as mono15.

Mono20

mono20 or fontType::mono20

A font unit that is defined as mono20.

Mono30

mono30 or fontType::mono30

A font unit that is defined as mono30.

Mono40

mono40 or fontType::mono40

A font unit that is defined as mono40.

Mono60

mono60 or fontType::mono60

A font unit that is defined as mono60.

Prop20

prop20 or fontType::prop20

A font unit that is defined as prop20.

Prop30

prop30 or fontType::prop30

A font unit that is defined as prop30.

Prop40

prop40 or fontType::prop40

A font unit that is defined as prop40.

Prop60

prop60 or fontType::prop60

A font unit that is defined as prop60.

Gear Settings#

Name

C++ Enum

Description

Ratio 1:1

ratio1_1 or gearSetting::ratio1_1

A gear unit that is defined as 1:1 gearing.

Ratio 2:1

ratio2_1 or gearSetting::ratio2_1

A gear unit that is defined as 2:1 gearing.

Ratio 3:1

ratio3_1 or gearSetting::ratio3_1

A gear unit that is defined as 3:1 gearing.

Gesture Types#

Name

C++ Enum

Description

Down

down or gestureType::down

A gesture type defined as down.

Left

left or gestureType::left

A gesture type defined as left.

None

none or gestureType::none

A gesture type defined as none.

Right

right or gestureType::right

A gesture type defined as right.

Up

up or gestureType::up

A gesture type defined as up.

Gyro Calibration Types#

Name

C++ Enum

Description

Normal

calNormal or gyroCalibrationType::calNormal

Normal gyro calibration type.

Slow

calSlow or gyroCalibrationType::calSlow

Slow gyro calibration type.

Extended

calExtended or gyroCalibrationType::calExtended

Extended gyro calibration type.

LED States#

Name

C++ Enum

Description

Blink

blink or ledState::blink

LED state that is defined as blink.

Off

off or ledState::off

LED state that is defined as off.

On

on or ledState::on

LED state that is defined as on.

Ports#

Name

C++ Enum

Description

PORT1

PORT1

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

PORT2

PORT2

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

PORT3

PORT3

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

PORT4

PORT4

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

PORT5

PORT5

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

PORT6

PORT6

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

PORT7

PORT7

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

PORT8

PORT8

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

PORT9

PORT9

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

PORT10

PORT10

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

PORT11

PORT11

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

PORT12

PORT12

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

Rate Units#

Name

C++ Enum

Description

Degrees per Second

dps or rateUnits::dps

A rate unit that is measured in degrees per second.

Rotations per Second

rps or rateUnits::rps

A rate unit that is measured in rotations per second.

Rotation Units#

Name

C++ Enum

Description

Degrees

degrees or rotationUnits::deg

A rotation unit that is measured in degrees.

Raw

raw or rotationUnits::raw

A rotation unit that is measured in raw data form.

Revolutions

turns or rotationUnits::rev

A rotation unit that is measured in revolutions.

Size Types#

Name

C++ Enum

Description

Large

large or sizeType::large

A size type defined as large.

Medium

medium or sizeType::medium

A size type defined as medium.

None

none or sizeType::none

A size type defined as none.

Small

small or sizeType::small

A size type defined as small.

Sound Types#

Name

C++ Enum

Description

Alarm

alarm or soundType::alarm

Alarm sound.

Alarm2

alarm2 or soundType::alarm2

Alarm sound variant 2.

Door Close

doorClose or soundType::doorClose

Door close sound.

Fillup

fillup or soundType::fillup

Fillup sound.

Headlights Off

headlightsOff or soundType::headlightsOff

Headlights off sound.

Headlights On

headlightsOn or soundType::headlightsOn

Headlights on sound.

Power Down

powerDown or soundType::powerDown

Power down sound.

Ratchet

ratchet or soundType::ratchet

Ratchet sound.

Ratchet2

ratchet2 or soundType::ratchet2

Ratchet sound variant 2.

Siren

siren or soundType::siren

Siren sound.

Siren2

siren2 or soundType::siren2

Siren sound variant 2.

Tada

tada or soundType::tada

Tada sound.

Toll Booth

tollBooth or soundType::tollBooth

Toll booth sound.

Wrench

wrench or soundType::wrench

Wrench sound.

Wrong Way

wrongWay or soundType::wrongWay

Wrong way sound.

Wrong Way Slow

wrongWaySlow or soundType::wrongWaySlow

Wrong way sound, slow variant.

Temperature Units#

Name

C++ Enum

Description

Celsius

celsius or temperatureUnits::celsius

A temperature unit that is measured in Celsius.

Fahrenheit

fahrenheit or temperatureUnits::fahrenheit

A temperature unit that is measured in Fahrenheit.

Time Units#

Name

C++ Enum

Description

Milliseconds

msec or timeUnits::msec

A time unit that is measured in milliseconds.

Seconds

seconds or timeUnits::sec

A time unit that is measured in seconds.

Torque Units#

Name

C++ Enum

Description

Inch Pounds

InLb or torqueUnits::InLb

A torque unit that is measured in inch pounds.

Newton Meters

Nm or torqueUnits::Nm

A torque unit that is measured in newton meters.

Turn Types#

Name

C++ 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.

Velocity Units#

Name

C++ Enum

Description

Degrees per Second

dps or velocityUnits::dps

A velocity unit that is measured in degrees per second.

Percentage

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.

Voltage Units#

Name

C++ Enum

Description

Millivolt

mV or voltageUnits::mV

A voltage unit that is measured in millivolts.

Volt

volt or voltageUnits::volt

A voltage unit that is measured in volts.