odometry_nwheel.h

#pragma once
 
#include <Eigen/Dense>
 
#include "core/subsystems/custom_encoder.h"
#include "core/subsystems/odometry/odometry_base.h"
#include "core/utils/math_util.h"


typedef struct {
  double x;         
  double y;         
  double theta_rad; 
  double radius;    
} tracking_wheel_cfg_t;
 
template <int WHEELS> class OdometryNWheel : public OdometryBase {
public:
  OdometryNWheel(
    const std::array<CustomEncoder, WHEELS> &encoders, const std::array<tracking_wheel_cfg_t, WHEELS> wheel_configs,
    vex::inertial *imu, bool is_async
  )
      : OdometryBase(is_async), imu(imu), encoders(encoders) {
    Eigen::Matrix<double, WHEELS, 3> transfer_matrix;
    for (int i = 0; i < WHEELS; i++) {
      double x = wheel_configs[i].x;
      double y = wheel_configs[i].y;
      double theta_rad = wheel_configs[i].theta_rad;
      double radius = wheel_configs[i].radius;
      // Eigen::Vector of the radii of the tracking wheels
      // defined at the bottom of private:
      wheel_radii(i) = radius;
 
      double x_factor = cos(theta_rad);
      double y_factor = -sin(theta_rad);
      double theta_factor = -(x * sin(theta_rad)) - (y * cos(theta_rad));
 
      // prevent numerical error due to float precision
      if (abs(y_factor) < 1e-9) {
        y_factor = 0;
      }
      if (abs(x_factor) < 1e-9) {
        x_factor = 0;
      }
 
      transfer_matrix.row(i) << x_factor, y_factor, theta_factor;
    }
 
    transfer_matrix_pseudoinverse = transfer_matrix.completeOrthogonalDecomposition().pseudoInverse();
    angle_offset = 0;
    old_wheel_angles.fill(0);
  }

  Pose2d update() override {
    Eigen::Vector<double, WHEELS> radian_deltas;
 
    for (int i = 0; i < WHEELS; i++) {
      double angle_rad = encoders[i].position(rev) * M_PI * 2;
      radian_deltas(i) = angle_rad - old_wheel_angles[i];
 
      old_wheel_angles[i] = angle_rad;
    }
 
    Pose2d updated_pos = calculate_new_pos(radian_deltas, current_pos);
 
    // if we do not pass in an IMU we use the wheels for rotation
    if (imu != nullptr) {
      angle = 0;
      // Translate "0 forward and clockwise positive" to "CCW positive and radians"
      angle = -imu->rotation(vex::rotationUnits::rev) * 2 * M_PI;
      // Offset the angle, if we've done a set_position
      angle += angle_offset;
    }
 
    static Pose2d last_pos = updated_pos;
    static double last_speed = 0;
    static double last_ang_speed = 0;
    static timer tmr;
 
    double speed_local = 0;
    double accel_local = 0;
    double ang_speed_local = 0;
    double ang_accel_local = 0;
    bool update_vel_accel = tmr.time(sec) > 0.1;
 
    // This loop runs too fast. Only check at LEAST every 1/10th sec
    if (update_vel_accel) {
      // Calculate robot velocity
      speed_local = updated_pos.translation().distance(last_pos.translation()) / tmr.time(sec);
 
      // Calculate robot acceleration
      accel_local = (speed_local - last_speed) / tmr.time(sec);
 
      // Calculate robot angular velocity (deg/sec)
      ang_speed_local = smallest_angle(updated_pos.rotation().degrees(), last_pos.rotation().degrees()) / tmr.time(sec);
 
      // Calculate robot angular acceleration (deg/sec^2)
      ang_accel_local = (ang_speed_local - last_ang_speed) / tmr.time(sec);
 
      tmr.reset();
      last_pos = updated_pos;
      last_speed = speed_local;
      last_ang_speed = ang_speed_local;
    }
 
    this->current_pos = updated_pos;
    if (update_vel_accel) {
      this->speed = speed_local;
      this->accel = accel_local;
      this->ang_speed_deg = ang_speed_local;
      this->ang_accel_deg = ang_accel_local;
    }
 
    if (imu != nullptr) {
      old_angle = angle;
    }
 
    return current_pos;
  }

  void set_position(const Pose2d &newpos) override {
    mut.lock();
    angle_offset = newpos.rotation().degrees() - (current_pos.rotation().degrees() - angle_offset);
    mut.unlock();
 
    OdometryBase::set_position(newpos);
  }

  Pose2d get_position(void) {
    Pose2d without_wrapped_angle  = OdometryBase::get_position();
    Pose2d with_wrapped_angle(without_wrapped_angle.translation(),  without_wrapped_angle.rotation().wrapped_radians_360());
    return with_wrapped_angle;
  }
 
private:
  Pose2d calculate_new_pos(Eigen::Vector<double, WHEELS> radian_deltas, Pose2d old_pose) {
    // Mr T = E -> Mr^{+} E = T
    // We take the diagonal of radian_deltas to do a coefficient wise multiplication rather than a dot product
    Eigen::Vector3d pose_delta = transfer_matrix_pseudoinverse * (radian_deltas.asDiagonal() * wheel_radii);
    Eigen::Vector3d old_pose_vector{old_pose.x(), old_pose.y(), old_pose.rotation().degrees()};
    // we achieve better performance by using the imu for rotation directly when possible
    // If an imu is not passed in when constructing, simply use the wheels for rotation
    if (imu != nullptr) {
      pose_delta(2) = angle - old_angle;
    }
    Pose2d pose_delta2d(pose_delta);
    Pose2d old_pose_Pose2d(old_pose_vector);
 
    Pose2d new_pose = old_pose_Pose2d.exp(pose_delta);
 
    // simply replaces the calculated angle with the imu angle directly
    if (imu != nullptr) {
      new_pose.setRotationDeg(angle);
    }
    return new_pose;
  }
 
  // values used for imu integration
  double angle;
  double old_angle;
  double angle_offset;
 
  vex::inertial *imu;
 
  Eigen::Matrix<double, 3, WHEELS> transfer_matrix_pseudoinverse;
 
  std::array<CustomEncoder, WHEELS> encoders;
  Eigen::Vector<double, WHEELS> wheel_radii;
  // from the last timestep, used for finding deltas
  Eigen::Vector<double, WHEELS> old_wheel_angles;
};