`parameters` – Parameters and Constants¶

Constant parameters/arguments for the Pybricks API.

class parameters.Port¶

Port on the EV3 Programmable Brick.

Motor Ports:

A¶

B¶

C¶

D¶

Sensor Ports:

S1¶

S2¶

S3¶

S4¶

class parameters.Direction¶

Rotational direction for positive speed values: clockwise or counterclockwise.

CLOCKWISE¶: A positive speed value should make the motor move clockwise.

COUNTERCLOCKWISE¶: A positive speed value should make the motor move counterclockwise.

For all motors, this is defined when looking at the shaft, just like looking at a clock.

For NXT or EV3 motors, make sure to look at the motor with the red/orange shaft to the lower right.

Parameter	Positive Speed	Negative Speed
Direction.CLOCKWISE	clockwise	counterclockwise
Direction.COUNTERCLOCKWISE	counterclockwise	clockwise

Medium EV3 Motor:


    counterclockwise          clockwise
|        ____                _____
|       /                         \
|      /       _____________       \
|     /      /              \       \
|    |      |        _       |       |
|    |      |     __| |__    |       |
|    v      |    |__ o __|   |       v
|           |       |_|      |
|           |                |
|            \______________/


Large EV3 Motor:

    __________
    /         \       ___    ___
    |          \     /          \
    |            ---/------      \
    counterclockwise|    __\__    |  clockwise
    \__________     v  /      \   v
                -------|  +   |
                        \_____/

class parameters.Stop¶

Action after the motor stops: coast, brake, or hold.

COAST¶: Let the motor move freely.

BRAKE¶: Passively resist small external forces.

HOLD¶: Keep controlling the motor to hold it at the commanded angle. This is only available on motors with encoders.

The stop type defines the resistance to motion after coming to a standstill:

Parameter	Resistance	Physical meaning
Stop.COAST	low	Friction
Stop.BRAKE	medium	Friction + Torque opposite to motion
Stop.HOLD	high	Friction + Torque to hold commanded angle

class parameters.Color¶

Light or surface color.

BLACK¶

BLUE¶

GREEN¶

YELLOW¶

RED¶

WHITE¶

BROWN¶

ORANGE¶

PURPLE¶

class parameters.Button¶

Buttons on a brick or remote.

LEFT_DOWN¶

DOWN¶

RIGHT_DOWN¶

LEFT¶

CENTER¶

RIGHT¶

LEFT_UP¶

UP¶

BEACON¶

RIGHT_UP¶

LEFT_UP	UP/BEACON	RIGHT_UP
LEFT	CENTER	RIGHT
LEFT_DOWN	DOWN	RIGHT_DOWN

class parameters.Align¶

Alignment of an image on the display.

BOTTOM_LEFT¶

BOTTOM¶

BOTTOM_RIGHT¶

LEFT¶

CENTER¶

RIGHT¶

TOP_LEFT¶

TOP¶

TOP_RIGHT¶

TOP_LEFT	TOP	TOP_RIGHT
LEFT	CENTER	RIGHT
BOTTOM_LEFT	BOTTOM	BOTTOM_RIGHT

class parameters.ImageFile¶

Paths to standard EV3 images.

Information

RIGHT¶

FORWARD¶

ACCEPT¶

QUESTION_MARK¶

STOP_1¶

LEFT¶

DECLINE¶

THUMBS_DOWN¶

BACKWARD¶

NO_GO¶

WARNING¶

STOP_2¶

THUMBS_UP¶

LEGO

EV3¶

EV3_ICON¶

Objects

TARGET¶

Eyes

BOTTOM_RIGHT¶

BOTTOM_LEFT¶

EVIL¶

CRAZY_2¶

KNOCKED_OUT¶

PINCHED_RIGHT¶

WINKING¶

DIZZY¶

DOWN¶

TIRED_MIDDLE¶

MIDDLE_RIGHT¶

SLEEPING¶

MIDDLE_LEFT¶

TIRED_RIGHT¶

PINCHED_LEFT¶

PINCHED_MIDDLE¶

CRAZY_1¶

NEUTRAL¶

AWAKE¶

UP¶

TIRED_LEFT¶

ANGRY¶

class parameters.SoundFile¶

Paths to standard EV3 sounds.

Expressions

SHOUTING¶

CHEERING¶

CRYING¶

OUCH¶

LAUGHING_2¶

SNEEZING¶

SMACK¶

BOING¶

BOO¶

UH_OH¶

SNORING¶

KUNG_FU¶

FANFARE¶

CRUNCHING¶

MAGIC_WAND¶

LAUGHING_1¶

Information

LEFT¶

BACKWARDS¶

RIGHT¶

OBJECT¶

COLOR¶

FLASHING¶

ERROR¶

ERROR_ALARM¶

DOWN¶

FORWARD¶

ACTIVATE¶

SEARCHING¶

TOUCH¶

UP¶

ANALYZE¶

STOP¶

DETECTED¶

TURN¶

START¶

Communication

MORNING¶

EV3¶

GO¶

GOOD_JOB¶

OKEY_DOKEY¶

GOOD¶

NO¶

THANK_YOU¶

YES¶

GAME_OVER¶

OKAY¶

SORRY¶

BRAVO¶

GOODBYE¶

HI¶

HELLO¶

MINDSTORMS¶

LEGO¶

FANTASTIC¶

Movements

SPEED_IDLE¶

SPEED_DOWN¶

SPEED_UP¶

Color

BROWN¶

GREEN¶

BLACK¶

WHITE¶

RED¶

BLUE¶

YELLOW¶

Mechanical

TICK_TACK¶

HORN_1¶

BACKING_ALERT¶

MOTOR_IDLE¶

AIR_RELEASE¶

AIRBRAKE¶

RATCHET¶

MOTOR_STOP¶

HORN_2¶

LASER¶

SONAR¶

MOTOR_START¶

Animals

INSECT_BUZZ_2¶

ELEPHANT_CALL¶

SNAKE_HISS¶

DOG_BARK_2¶

DOG_WHINE¶

INSECT_BUZZ_1¶

DOG_SNIFF¶

T_REX_ROAR¶

INSECT_CHIRP¶

DOG_GROWL¶

SNAKE_RATTLE¶

DOG_BARK_1¶

CAT_PURR¶

Numbers

ZERO¶

ONE¶

TWO¶

THREE¶

FOUR¶

FIVE¶

SIX¶

SEVEN¶

EIGHT¶

NINE¶

TEN¶

System

READY¶

CONFIRM¶

GENERAL_ALERT¶

CLICK¶

OVERPOWER¶

parameters – Parameters and Constants¶

`parameters` – Parameters and Constants¶