Sensor GPS#

The gps class is used to control and access data from the V5 GPS (Game Positioning System™) Sensor. This sensor provides accurate position and orientation tracking for a robot on the VEX Field. It uses the GPS Field Code around the Field’s perimeter to calculate the robot’s X and Y coordinates and heading in real time.

El sensor GPS devuelve la posición del robot utilizando un punto de referencia calculado automáticamente a partir de los desplazamientos introducidos al configurar el sensor GPS en la ventana Dispositivos.

Para obtener más información sobre el sensor GPS, lea Uso del sensor GPS con VEX V5 en la biblioteca VEX.

El punto de referencia actúa como la posición (0, 0) del propio sensor GPS, donde todas las coordenadas, rumbos y movimientos devueltos por los métodos GPS son relativos a este punto configurado.

El sensor GPS VEX V5.

Constructores de clases #

1 — Creates a gps object on the specified Smart Port using the default origin (0, 0).
gps(
  int32_t  index,
  double   heading_offset = 0,
  turnType dir = right );

2 — Creates a gps object on the specified Smart Port and defines a custom origin position.
gps(
  int32_t       index,
  double        ox,
  double        oy,
  distanceUnits units = mm,
  double        heading_offset = 0,
  turnType      dir = right );

Instructor de clase #

Destroys the gps object and releases associated resources.

~gps();

Parámetros #

Parámetro	Tipo	Descripción
`index`	`int32_t`	The Smart Port that the GPS Sensor is connected to, written as `PORTx`, where `x` is the port number (for example, `PORT1`).
`ox`	`double`	La coordenada X de la posición de origen.
`oy`	`double`	La coordenada Y de la posición de origen.
`units`	`distanceUnits`	The unit of measurement used for `ox` and `oy`: `mm` (default) — millimeters `distanceUnits::in` / `inches` — inches `distanceUnits::cm` — centimeters
`heading_offset`	`double`	Desfase rotacional del sensor GPS en grados, de 0,00 a 359,99. El valor predeterminado es 0.
`dir`	`turnType`	The direction that will return positive heading values: `right` (default) `left`

Ejemplos #

// Create the gps instance
gps GPS1 = gps(
    PORT1,      // Smart Port 1
    180);       // heading_offset

// Create the gps instance
gps GPS1 = gps(
    PORT1,   // Smart Port 1
    50.00,   // ox
    100.00,  // oy
    mm,      // units
    180 );   // heading_offset

Funciones de los miembros #

The gps class includes the following member functions:

calibrate — Calibrates the GPS Sensor.
setOrigin — Sets the origin position for the GPS coordinate system.
setLocation — Sets the current location and heading of the GPS Sensor.
xPosition — Returns the current X position.
yPosition — Returns the current Y position.
heading — Returns the current heading.
acceleration — Returns linear acceleration along the specified axis.
gyroRate — Returns the angular velocity for the specified axis.
orientation — Returns the orientation for the specified axis.
quality — Returns the current GPS signal quality.
changed — Registers a callback function that runs when GPS data changes.

Before calling any gps member functions, a gps instance must be created, as shown below:

/* This constructor is required when using VS Code.
GPS Sensor configuration is generated automatically
in VEXcode using the Device Menu. Replace the values
as needed. */

// Create the gps instance in Smart Port 1
gps GPS1 = gps(PORT1);

Métodos de clase #

calibrate #

Calibra el sensor GPS. Esto establecerá la orientación configurada del GPS (según su desviación angular) como la orientación actual del sistema de transmisión.

El sensor GPS debe permanecer inmóvil durante el proceso de calibración.

Available Functions

void calibrate();

Parameters

Esta función no requiere ningún parámetro.

Return Values

Esta función no devuelve ningún valor.

Examples

// Turn to face the lower Field wall using data from the GPS Sensor.
GPS1.calibrate();
Drivetrain.turnToHeading(180, degrees)

setOrigin #

Establece el origen del sistema de coordenadas GPS.

Available Functions

1 — Establece el origen en la posición X e Y especificada.
void setOrigin( 
  double        x, 
  double        y, 
  distanceUnits units = mm );

2 — Establece el origen en la posición actual del sensor.
void setOrigin();

Parameters

Parámetro	Tipo	Descripción
`x`	`double`	La coordenada X de la nueva posición de origen.
`y`	`double`	La coordenada Y de la nueva posición de origen.
`units`	`distanceUnits`	The unit of measurement used for `x` and `y`: `mm` (default) — millimeters `distanceUnits::cm` — centimeters `distanceUnits::in` — inches

Parámetro

Tipo

Descripción

x

double

La coordenada X de la nueva posición de origen.

y

double

La coordenada Y de la nueva posición de origen.

units

distanceUnits

The unit of measurement used for x and y:

mm (default) — millimeters
distanceUnits::cm — centimeters
distanceUnits::in — inches

Return Values

Esta función no devuelve ningún valor.

Notes

Changing the origin affects values returned by xPosition and yPosition.

setLocation #

Establece la posición y el rumbo GPS actuales.

Available Functions

1 — Establece la ubicación actual utilizando las unidades de distancia y rotación especificadas.
void setLocation(
  double        x,
  double        y,
  distanceUnits units = mm,
  double        angle = 0,
  rotationUnits units_r = degrees );

2 — Establece la ubicación actual usando milímetros y grados.
void setLocation( double x, double y, double angle );

Parameters

Parámetro	Tipo	Descripción
`x`	`double`	La coordenada X de la ubicación actual.
`y`	`double`	La coordenada Y de la ubicación actual.
`units`	`distanceUnits`	The unit of measurement used for `x` and `y`: `mm` (default) — millimeters `distanceUnits::in` / `inches` — inches `distanceUnits::cm` — centimeters
`angle`	`double`	El valor del encabezado para la ubicación actual.
`units_r`	`rotationUnits`	The unit of measurement used for `angle`: `deg` (default) — degrees `rev` — revolutions

Return Values

Esta función no devuelve ningún valor.

Notes

Calling this function updates the internal position and heading values reported by xPosition, yPosition, and heading.

xPosition #

Devuelve la posición X actual del sensor GPS.

Available Functions

double xPosition( distanceUnits units = distanceUnits::mm );

Parameters

Parámetro	Tipo	Descripción
`units`	`distanceUnits`	The unit of measurement for the returned X position: `mm` (default) — millimeters `distanceUnits::cm` — centimeters `distanceUnits::in` — inches

Parámetro

Tipo

Descripción

units

distanceUnits

The unit of measurement for the returned X position:

mm (default) — millimeters
distanceUnits::cm — centimeters
distanceUnits::in — inches

Return Values

Returns a double representing the x positional offset from the origin in the specified units.

Notes

La posición X se mide en relación con el origen actual.
The origin may be changed using setOrigin.

Examples

// Drive slowly towards the center of the Field
Drivetrain.setDriveVelocity(20.0, percent);
Drivetrain.drive(forward);
// Stop driving when the GPS returns an x position
// near the center of the Field
waitUntil((GPS1.xPosition(mm) < 0.0));
Drivetrain.stop();

yPosition #

Devuelve la posición Y actual del sensor GPS.

Available Functions

double yPosition( distanceUnits units = distanceUnits::mm );

Parameters

Parámetro	Tipo	Descripción
`units`	`distanceUnits`	The unit of measurement for the returned Y position: `mm` (default) — millimeters `distanceUnits::cm` — centimeters `distanceUnits::in` — inches

Parámetro

Tipo

Descripción

units

distanceUnits

The unit of measurement for the returned Y position:

mm (default) — millimeters
distanceUnits::cm — centimeters
distanceUnits::in — inches

Return Values

Returns a double representing the Y positional offset from the origin in the specified units.

Notes

La posición Y se mide en relación con el origen actual.
The origin may be changed using setOrigin().

Examples

// Drive slowly towards the center of the Field
Drivetrain.setDriveVelocity(20.0, percent);
Drivetrain.drive(forward);
// Stop driving when the GPS reports an y position
// near the center of the Field
waitUntil((GPS1.yPosition(mm) < 0.0));
Drivetrain.stop();

heading #

Devuelve la orientación actual (ángulo de guiñada) del sensor GPS.

Available Functions

double heading( rotationUnits units = rotationUnits::deg );

Parameters

Parámetro	Tipo	Descripción
`units`	`rotationUnits`	The unit of measurement for the returned heading value: `deg` (default) — degrees `rev` — revolutions

Parámetro

Tipo

Descripción

units

rotationUnits

The unit of measurement for the returned heading value:

deg (default) — degrees
rev — revolutions

Return Values

Returns a double representing the current heading in the specified units.

Notes

El valor del encabezado se ajusta entre 0 y 360 grados.
The positive rotation direction is determined by the dir parameter specified during construction.

Examples

// Turn slowly to face the right wall
Drivetrain.setTurnVelocity(20.0, percent);
Drivetrain.turn(right);
// Stop turning when the GPS reports a heading 
// greater than 90 degrees
waitUntil((GPS1.heading() > 90.0));
Drivetrain.stop();

acceleration #

Devuelve la aceleración lineal medida por el sensor GPS a lo largo del eje especificado.

Available Functions

double acceleration( 
  axisType axis );

Parameters

Parámetro	Tipo	Descripción
`axis`	`axisType`	The axis for which acceleration will be returned: `xaxis` `yaxis` `zaxis`

Parámetro

Tipo

Descripción

axis

axisType

The axis for which acceleration will be returned:

xaxis
yaxis
zaxis

Return Values

Returns a double representing the acceleration along the specified axis in G (gravitational units).

Notes

Los valores de aceleración se expresan en unidades de G, donde 1 G equivale a la aceleración debida a la gravedad en la superficie terrestre.

gyroRate #

Devuelve la velocidad angular medida por el sensor GPS a lo largo del eje especificado.

Available Functions

double gyroRate( 
  axisType      axis, 
  velocityUnits units );

Parameters

Parámetro	Tipo	Descripción
`axis`	`axisType`	The axis for which angular velocity will be returned: `xaxis` `yaxis` `zaxis`
`units`	`velocityUnits`	The unit of measurement for the returned angular velocity: `dps` — degrees per second `rpm` — revolutions per minute

Parámetro

Tipo

Descripción

axis

axisType

The axis for which angular velocity will be returned:

xaxis
yaxis
zaxis

units

velocityUnits

The unit of measurement for the returned angular velocity:

dps — degrees per second
rpm — revolutions per minute

Return Values

Returns a double representing the angular velocity along the specified axis in the selected units.

orientation #

Devuelve el ángulo de orientación del sensor GPS para el eje especificado.

Available Functions

double orientation( 
  orientationType axis, 
  rotationUnits   units );

Parameters

Parámetro	Tipo	Descripción
`axis`	`orientationType`	The orientation axis to retrieve: `roll` `pitch` `yaw`
`units`	`rotationUnits`	The unit of measurement for the returned orientation value: `deg` — degrees `rev` — revolutions

Parámetro

Tipo

Descripción

axis

orientationType

The orientation axis to retrieve:

roll
pitch
yaw

units

rotationUnits

The unit of measurement for the returned orientation value:

deg — degrees
rev — revolutions

Return Values

Returns a double representing the orientation of the specified axis in the selected units.

quality #

Devuelve la calidad de la señal GPS percibida.

Available Functions

int32_t quality();

Parameters

Esta función no requiere ningún parámetro.

Return Values

Returns an int32_t representing the GPS signal quality as a percentage:

Valores posibles	Descripción
`100`	Todos los datos de posición y rumbo reportados por el sensor GPS son válidos.
`~90`	Los datos de posición ya no se calculan directamente a partir del código de campo GPS, sino que se estiman mediante métodos alternativos.
`0 – 80`	Only heading values are valid. As time passes without sufficient scanning of the GPS Field Code, signal quality continues to decrease until `0`, at which point GPS data is effectively frozen and no longer valid.

changed #

Registra una función de devolución de llamada que se ejecuta cuando cambia el valor de la dirección GPS.

Available Functions

void changed( 
  void (* callback)(void) );

Parameters

Parámetro	Tipo	Descripción
`callback`	`void (*)(void)`	A pointer to a function that will be called when the GPS heading value changes. The function must take no parameters and return `void`.

Return Values

Esta función no devuelve ningún valor.