Wiki

This version (16 Jan 2019 17:12) was approved by TheFeminineEngineer.The Previously approved version (16 Jan 2019 17:04) is available.Diff

Using the ADIS16470 IMU Board for FRC in Java

This guide will walk you through the various features of the Analog Devices library for the ADIS16470 FRC IMU Board and how to use it in your robot code. If you're looking for a guide in another language, click here for LabVIEW or here for C++.

If you need help getting started with the basics of programming your robot in java, you may want to check out the WPI Screensteps documentation, which can be found here. Another useful resource can be found here.

Installing the Library

In order to use the IMU, you will need to download and install the appropriate library. You can either do an online install or an offline install. The instructions below assume you are using VS Code, the official supported development environment for FRC.

Online Install

  1. Open FRC Visual Studio Code
  2. Click the WPILib command pallete icon
  3. Select “Manage Vendor Libraries” in the menu
  4. Choose “Install New Libraries (Online)”

Offline Install

  1. Download the latest release zip from this page. The zip will be named adis16470_roborio-[releaseversion].zip.
  2. Close all instances of FRC Visual Studio Code
  3. If using Windows, extract the zip you downloaded to C:\Users\Public\frc2019. If using Linux or Mac, extract the zip to ~/home/frc2019/.
  4. Open FRC Visual Studio Code
  5. Click the WPILib command pallete icon
  6. Select “Manage Vendor Libraries” in the menu
  7. Choose “Install New Libraries (Offline)”
  8. Check ADIS16470, then click “OK”.



Instance Definition and Instantiation

Before you can use the gyro in your code, you must first define an instance. Where exactly it needs to be defined will depend heavily on how your team organizes its robot code, but it needs to be accessible by the Robot class in order to work properly and give you no build errors. If your team is using an Iterative Robot with a RobotMap structure for example, you would put it inside of the RobotMap class. The ADIS16470 has its own dedicated class.

Because the IMU plugs directly into the MXP port, the library will pre-define your SPI port for you. IMU is a 3-axis sensor, so you will need to tell it which axis is the yaw axis. By default, this will be the Z axis if you don't define anything (this would be with the RoboRIO and the sensor sitting flat on or in the robot, facing up). Don't worry about defining an algorithm argument, the library will take care of this for you. A typical definition and instantiation will look like this:

public static final ADIS16470_IMU imu = new ADIS16470_IMU();


Sensor Initialization/Calibration with calibrate()

The IMU library will perform a calibration for you in its constructor, since this calibration MUST be performed in order for the IMU to function properly. If you wish to re-calibrate at some point in your code, you can call the calibrate() function. For more general information about offset calibration, please see the general ADIS16470 IMU page.

Using getAngle() and getRate()

Now that your gyro is calibrated when the robot turns on, you can access data from the robot in your code. You can do this using the getAngle() method to obtain the robot's current yaw heading, or more rarely by using the getRate() method to obtain the current rotation rate being measured should you happen to need it. The most common places to use these functions are inside of the autonomousPeriodic() and teleopPeriodic() methods. If you want a specific angle, you can also call that angle directly using getAngleX(), getAngleY(), or getAngleZ(). You can do the same for rotation rates, using getRateX(), getRateY(), and getRateZ().

As a general note, the getAngle() functions will count continuously, meaning when they reach 360 degrees, they will continue to 361, not zero. This is to make any functionality in your code using the IMU angle easier to implement without having to keep track of where in the 0-360 range your robot is or how many rotations have happened.



Re-Zeroing the Sensor with reset()

Sometimes it may be necessary to reset the IMU gyro's “zero degrees” position. All gyros will have some amount of drift over time and it's physically impossible to calibrate out all sources of drift. In this case, you can use reset() to reset the current gyro heading to 0 degrees. When doing this, your robot should be facing the direction you want zero degrees to be, particularly if you are driving with field-oriented drive using an omnidirectional drive base. Otherwise, your robot may begin to behave incorrectly. For this reason, you should never automate this routine. Note that this does not recalibrate the gyro, so you don't have to be sitting still to perform this method properly.

Drive Straight Example

The code block shown below is a modification of the WPI Library gyro drive straight example to use the ADIS16470 IMU instead.

/*----------------------------------------------------------------------------*/
/* Copyright (c) 2017-2018 FIRST. All Rights Reserved.                        */
/* Open Source Software - may be modified and shared by FRC teams. The code   */
/* must be accompanied by the FIRST BSD license file in the root directory of */
/* the project.                                                               */
/*----------------------------------------------------------------------------*/

package org.usfirst.frc.team12333.robot;

import com.analog.adis16470.frc.ADIS16470_IMU;
import edu.wpi.first.wpilibj.IterativeRobot;
import edu.wpi.first.wpilibj.Joystick;
import edu.wpi.first.wpilibj.Spark;
import edu.wpi.first.wpilibj.drive.DifferentialDrive;

/**
 * This is a sample program to demonstrate how to use a gyro sensor to make a
 * robot drive straight. This program uses a joystick to drive forwards and
 * backwards while the gyro is used for direction keeping.
 */
public class Robot extends IterativeRobot {
	private static final double kAngleSetpoint = 0.0;
	private static final double kP = 0.005; // propotional turning constant

	// gyro calibration constant, may need to be adjusted;
	// gyro value of 360 is set to correspond to one full revolution
	private static final double kVoltsPerDegreePerSecond = 0.0128;

	private static final int kLeftMotorPort = 0;
	private static final int kRightMotorPort = 1;
	private static final int kJoystickPort = 0;

	private DifferentialDrive m_myRobot
			= new DifferentialDrive(new Spark(kLeftMotorPort),
			new Spark(kRightMotorPort));
	private AnalogGyro m_gyro = new AnalogGyro(kGyroPort);
	private Joystick m_joystick = new Joystick(kJoystickPort);
	
	public static final ADIS16470_IMU imu = new ADIS16470_IMU();

	@Override
	public void robotInit() {
		// You can put a calibrate() method call here, but it's not necessary since the library does it for you
	}

	/**
	 * The motor speed is set from the joystick while the RobotDrive turning
	 * value is assigned from the error between the setpoint and the gyro angle.
	 */
	@Override
	public void teleopPeriodic() {
		double turningValue = (kAngleSetpoint - imu.getAngle()) * kP;
		// Invert the direction of the turn if we are going backwards
		turningValue = Math.copySign(turningValue, m_joystick.getY());
		m_myRobot.arcadeDrive(m_joystick.getY(), turningValue);
	}
}
first/adis16470_imu_frc/java.txt · Last modified: 16 Jan 2019 17:12 by TheFeminineEngineer