blob: 7d297e0a7f37822f135a3ef7f5bd8388861f700e [file] [log] [blame]
Comran Morshed5323ecb2015-12-26 20:50:55 +00001#include "frc971/control_loops/drivetrain/drivetrain.h"
Brian Silverman17f503e2015-08-02 18:17:18 -07002
Brian Silverman17f503e2015-08-02 18:17:18 -07003#include <sched.h>
James Kuszmaul61750662021-06-21 21:32:33 -07004
Brian Silverman17f503e2015-08-02 18:17:18 -07005#include <cmath>
Tyler Chatowbf0609c2021-07-31 16:13:27 -07006#include <cstdio>
Brian Silverman17f503e2015-08-02 18:17:18 -07007#include <memory>
Brian Silverman17f503e2015-08-02 18:17:18 -07008
James Kuszmaul61750662021-06-21 21:32:33 -07009#include "Eigen/Dense"
John Park33858a32018-09-28 23:05:48 -070010#include "aos/logging/logging.h"
Austin Schuh3a378462019-01-04 21:48:04 -080011#include "frc971/control_loops/drivetrain/down_estimator.h"
Austin Schuh3a378462019-01-04 21:48:04 -080012#include "frc971/control_loops/drivetrain/drivetrain_config.h"
Alex Perrycb7da4b2019-08-28 19:35:56 -070013#include "frc971/control_loops/drivetrain/drivetrain_goal_generated.h"
14#include "frc971/control_loops/drivetrain/drivetrain_output_generated.h"
15#include "frc971/control_loops/drivetrain/drivetrain_position_generated.h"
16#include "frc971/control_loops/drivetrain/drivetrain_status_generated.h"
Comran Morshed5323ecb2015-12-26 20:50:55 +000017#include "frc971/control_loops/drivetrain/polydrivetrain.h"
18#include "frc971/control_loops/drivetrain/ssdrivetrain.h"
Austin Schuh3a378462019-01-04 21:48:04 -080019#include "frc971/control_loops/runge_kutta.h"
Alex Perrycb7da4b2019-08-28 19:35:56 -070020#include "frc971/queues/gyro_generated.h"
Brian Silverman17f503e2015-08-02 18:17:18 -070021#include "frc971/shifter_hall_effect.h"
Austin Schuhac17fba2020-03-28 15:55:33 -070022#include "frc971/wpilib/imu_batch_generated.h"
Brian Silverman17f503e2015-08-02 18:17:18 -070023
Austin Schuh9993fb32017-03-15 20:17:46 -070024using ::aos::monotonic_clock;
25namespace chrono = ::std::chrono;
Brian Silverman17f503e2015-08-02 18:17:18 -070026
Comran Morshed5323ecb2015-12-26 20:50:55 +000027namespace frc971 {
Brian Silverman17f503e2015-08-02 18:17:18 -070028namespace control_loops {
Austin Schuh6197a182015-11-28 16:04:40 -080029namespace drivetrain {
Brian Silverman17f503e2015-08-02 18:17:18 -070030
James Kuszmaulc53de4a2022-03-12 21:32:06 -080031namespace {
32// Maximum variation to allow in the gyro when zeroing.
33constexpr double kMaxYawGyroZeroingRange = 0.05;
34}
35
Austin Schuhfb0f35c2021-02-14 21:25:29 -080036DrivetrainFilters::DrivetrainFilters(const DrivetrainConfig<double> &dt_config,
37 ::aos::EventLoop *event_loop,
38 LocalizerInterface *localizer)
39 : dt_config_(dt_config),
Alex Perrycb7da4b2019-08-28 19:35:56 -070040 localizer_control_fetcher_(
41 event_loop->MakeFetcher<LocalizerControl>("/drivetrain")),
Austin Schuh73b6e3b2019-05-27 16:37:15 -070042 imu_values_fetcher_(
James Kuszmaule5f67dd2022-02-12 20:08:29 -080043 event_loop->TryMakeFetcher<::frc971::IMUValuesBatch>("/drivetrain")),
Austin Schuh1ea89bb2019-05-27 16:59:59 -070044 gyro_reading_fetcher_(
45 event_loop->MakeFetcher<::frc971::sensors::GyroReading>(
Alex Perrycb7da4b2019-08-28 19:35:56 -070046 "/drivetrain")),
Austin Schuhfb0f35c2021-02-14 21:25:29 -080047 down_estimator_(dt_config_),
James Kuszmaul3431d622019-02-17 17:07:44 -080048 localizer_(localizer),
Austin Schuh41565602016-02-28 20:10:49 -080049 kf_(dt_config_.make_kf_drivetrain_loop()),
Austin Schuh093535c2016-03-05 23:21:00 -080050 left_gear_(dt_config_.default_high_gear ? Gear::HIGH : Gear::LOW),
51 right_gear_(dt_config_.default_high_gear ? Gear::HIGH : Gear::LOW),
52 left_high_requested_(dt_config_.default_high_gear),
53 right_high_requested_(dt_config_.default_high_gear) {
Austin Schuhfb0f35c2021-02-14 21:25:29 -080054 last_voltage_.setZero();
55 last_last_voltage_.setZero();
James Kuszmaul61750662021-06-21 21:32:33 -070056 frc971::controls::HPolytope<0>::Init();
James Kuszmaul30aca502020-01-19 15:05:33 -080057 event_loop->OnRun([this]() {
58 // On the first fetch, make sure that we are caught all the way up to the
59 // present.
James Kuszmaule5f67dd2022-02-12 20:08:29 -080060 if (imu_values_fetcher_.valid()) {
61 imu_values_fetcher_.Fetch();
62 }
James Kuszmaul30aca502020-01-19 15:05:33 -080063 });
James Kuszmaul2215d922020-02-11 17:17:26 -080064 if (dt_config.is_simulated) {
65 down_estimator_.assume_perfect_gravity();
66 }
Austin Schuh209f1702015-11-29 17:03:00 -080067}
68
Austin Schuhfb0f35c2021-02-14 21:25:29 -080069flatbuffers::Offset<LocalizerState> DrivetrainFilters::PopulateLocalizerState(
70 flatbuffers::FlatBufferBuilder *fbb) {
71 return localizer_->PopulateStatus(fbb);
72}
73flatbuffers::Offset<ImuZeroerState> DrivetrainFilters::PopulateImuZeroerState(
74 flatbuffers::FlatBufferBuilder *fbb) {
75 return imu_zeroer_.PopulateStatus(fbb);
Austin Schuh093535c2016-03-05 23:21:00 -080076}
77
Austin Schuhfb0f35c2021-02-14 21:25:29 -080078flatbuffers::Offset<DownEstimatorState>
79DrivetrainFilters::PopulateDownEstimatorState(
80 flatbuffers::FlatBufferBuilder *fbb,
81 aos::monotonic_clock::time_point monotonic_now) {
82 return down_estimator_.PopulateStatus(fbb, monotonic_now);
Austin Schuh093535c2016-03-05 23:21:00 -080083}
84
Austin Schuhfb0f35c2021-02-14 21:25:29 -080085void DrivetrainFilters::Reset(aos::monotonic_clock::time_point monotonic_now,
86 const drivetrain::Position *position) {
87 // If all the sensors got reset (e.g., due to wpilib_interface restarting),
88 // reset the localizer and down estimator to avoid weird jumps in the
89 // filters.
90 down_estimator_.Reset();
91 // Just reset the localizer to the current state, except for the encoders.
92 LocalizerInterface::Ekf::State X_hat = localizer_->Xhat();
93 X_hat(LocalizerInterface::StateIdx::kLeftEncoder) = position->left_encoder();
94 X_hat(LocalizerInterface::StateIdx::kRightEncoder) =
95 position->right_encoder();
96 localizer_->Reset(monotonic_now, X_hat);
97}
Austin Schuh9993fb32017-03-15 20:17:46 -070098
Austin Schuhfb0f35c2021-02-14 21:25:29 -080099void DrivetrainFilters::Correct(aos::monotonic_clock::time_point monotonic_now,
100 const drivetrain::Position *position) {
Austin Schuh093535c2016-03-05 23:21:00 -0800101 // TODO(austin): Put gear detection logic here.
102 switch (dt_config_.shifter_type) {
103 case ShifterType::SIMPLE_SHIFTER:
104 // Force the right controller for simple shifters since we assume that
105 // gear switching is instantaneous.
106 if (left_high_requested_) {
107 left_gear_ = Gear::HIGH;
108 } else {
109 left_gear_ = Gear::LOW;
110 }
111 if (right_high_requested_) {
112 right_gear_ = Gear::HIGH;
113 } else {
114 right_gear_ = Gear::LOW;
115 }
116 break;
117 case ShifterType::HALL_EFFECT_SHIFTER:
Alex Perrycb7da4b2019-08-28 19:35:56 -0700118 left_gear_ = ComputeGear(position->left_shifter_position(),
Austin Schuh093535c2016-03-05 23:21:00 -0800119 dt_config_.left_drive, left_high_requested_);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700120 right_gear_ = ComputeGear(position->right_shifter_position(),
Austin Schuh093535c2016-03-05 23:21:00 -0800121 dt_config_.right_drive, right_high_requested_);
122 break;
Adam Snaider18f44172016-10-22 15:30:21 -0700123 case ShifterType::NO_SHIFTER:
124 break;
Brian Silverman17f503e2015-08-02 18:17:18 -0700125 }
Brian Silverman17f503e2015-08-02 18:17:18 -0700126
James Kuszmaule5f67dd2022-02-12 20:08:29 -0800127 while (imu_values_fetcher_.valid() && imu_values_fetcher_.FetchNext()) {
Austin Schuhac17fba2020-03-28 15:55:33 -0700128 CHECK(imu_values_fetcher_->has_readings());
James Kuszmaul3e1bb272020-01-17 18:38:19 -0800129 last_gyro_time_ = monotonic_now;
Austin Schuhac17fba2020-03-28 15:55:33 -0700130 for (const IMUValues *value : *imu_values_fetcher_->readings()) {
131 imu_zeroer_.InsertMeasurement(*value);
132 if (!imu_zeroer_.Zeroed()) {
133 continue;
134 }
135 const aos::monotonic_clock::time_point reading_time(
136 std::chrono::nanoseconds(value->monotonic_timestamp_ns()));
137 if (last_imu_update_ == aos::monotonic_clock::min_time) {
138 last_imu_update_ = reading_time;
139 }
James Kuszmaul6d6e1302022-03-12 15:22:48 -0800140 down_estimator_.Predict(imu_zeroer_.ZeroedGyro().value(),
141 imu_zeroer_.ZeroedAccel().value(),
Austin Schuhac17fba2020-03-28 15:55:33 -0700142 reading_time - last_imu_update_);
James Kuszmaul3e1bb272020-01-17 18:38:19 -0800143 last_imu_update_ = reading_time;
144 }
James Kuszmaul3e1bb272020-01-17 18:38:19 -0800145 }
Diana Burgessd0180f12018-03-21 21:24:17 -0700146
James Kuszmaul3e1bb272020-01-17 18:38:19 -0800147 bool got_imu_reading = false;
James Kuszmaule5f67dd2022-02-12 20:08:29 -0800148 if (imu_values_fetcher_.valid() && imu_values_fetcher_.get() != nullptr) {
James Kuszmaulb7f45bb2020-02-26 20:27:48 -0800149 imu_zeroer_.ProcessMeasurements();
James Kuszmaul3e1bb272020-01-17 18:38:19 -0800150 got_imu_reading = true;
Austin Schuhac17fba2020-03-28 15:55:33 -0700151 CHECK(imu_values_fetcher_->has_readings());
James Kuszmaul0a981402021-10-09 21:00:34 -0700152 if (imu_values_fetcher_->readings()->size() > 0) {
153 const IMUValues *value = imu_values_fetcher_->readings()->Get(
154 imu_values_fetcher_->readings()->size() - 1);
155 switch (dt_config_.imu_type) {
156 case IMUType::IMU_X:
157 last_accel_ = -value->accelerometer_x();
158 break;
159 case IMUType::IMU_FLIPPED_X:
160 last_accel_ = value->accelerometer_x();
161 break;
162 case IMUType::IMU_Y:
163 last_accel_ = -value->accelerometer_y();
164 break;
165 case IMUType::IMU_Z:
166 last_accel_ = value->accelerometer_z();
167 break;
168 }
Diana Burgessd0180f12018-03-21 21:24:17 -0700169 }
Austin Schuh05c5a612016-04-02 15:10:25 -0700170 }
Austin Schuh05c5a612016-04-02 15:10:25 -0700171
Austin Schuh093535c2016-03-05 23:21:00 -0800172 // TODO(austin): Signal the current gear to both loops.
James Kuszmaul6d6e1302022-03-12 15:22:48 -0800173 bool imu_zeroer_zeroed = imu_zeroer_.Zeroed();
Austin Schuh093535c2016-03-05 23:21:00 -0800174
Campbell Crowley2527ed22017-02-17 21:10:02 -0800175 switch (dt_config_.gyro_type) {
176 case GyroType::IMU_X_GYRO:
James Kuszmaul3e1bb272020-01-17 18:38:19 -0800177 if (got_imu_reading) {
James Kuszmaul6d6e1302022-03-12 15:22:48 -0800178 last_gyro_rate_ =
179 imu_zeroer_zeroed ? imu_zeroer_.ZeroedGyro().value().x() : 0.0;
Campbell Crowley2527ed22017-02-17 21:10:02 -0800180 }
181 break;
182 case GyroType::IMU_Y_GYRO:
James Kuszmaul3e1bb272020-01-17 18:38:19 -0800183 if (got_imu_reading) {
James Kuszmaul6d6e1302022-03-12 15:22:48 -0800184 last_gyro_rate_ =
185 imu_zeroer_zeroed ? imu_zeroer_.ZeroedGyro().value().y() : 0.0;
Campbell Crowley2527ed22017-02-17 21:10:02 -0800186 }
187 break;
188 case GyroType::IMU_Z_GYRO:
James Kuszmaul3e1bb272020-01-17 18:38:19 -0800189 if (got_imu_reading) {
James Kuszmaul6d6e1302022-03-12 15:22:48 -0800190 last_gyro_rate_ =
191 imu_zeroer_zeroed ? imu_zeroer_.ZeroedGyro().value().z() : 0.0;
Campbell Crowley2527ed22017-02-17 21:10:02 -0800192 }
193 break;
Austin Schuh90b43b42019-01-04 07:45:05 +1100194 case GyroType::FLIPPED_IMU_Z_GYRO:
James Kuszmaul3e1bb272020-01-17 18:38:19 -0800195 if (got_imu_reading) {
James Kuszmaul6d6e1302022-03-12 15:22:48 -0800196 last_gyro_rate_ =
197 imu_zeroer_zeroed ? -imu_zeroer_.ZeroedGyro().value().z() : 0.0;
Austin Schuh90b43b42019-01-04 07:45:05 +1100198 }
199 break;
Campbell Crowley2527ed22017-02-17 21:10:02 -0800200 case GyroType::SPARTAN_GYRO:
Austin Schuh1ea89bb2019-05-27 16:59:59 -0700201 if (gyro_reading_fetcher_.Fetch()) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700202 last_gyro_rate_ = gyro_reading_fetcher_->velocity();
Austin Schuh9993fb32017-03-15 20:17:46 -0700203 last_gyro_time_ = monotonic_now;
Campbell Crowley2527ed22017-02-17 21:10:02 -0800204 }
205 break;
206 case GyroType::FLIPPED_SPARTAN_GYRO:
Austin Schuh1ea89bb2019-05-27 16:59:59 -0700207 if (gyro_reading_fetcher_.Fetch()) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700208 last_gyro_rate_ = -gyro_reading_fetcher_->velocity();
Austin Schuh9993fb32017-03-15 20:17:46 -0700209 last_gyro_time_ = monotonic_now;
Campbell Crowley2527ed22017-02-17 21:10:02 -0800210 }
211 break;
212 default:
Austin Schuhf257f3c2019-10-27 21:00:43 -0700213 AOS_LOG(FATAL, "invalid gyro configured");
Campbell Crowley2527ed22017-02-17 21:10:02 -0800214 break;
Austin Schuh9ab4d9d2016-02-16 23:55:44 -0800215 }
216
James Kuszmaulc53de4a2022-03-12 21:32:06 -0800217 switch (dt_config_.gyro_type) {
218 case GyroType::SPARTAN_GYRO:
219 case GyroType::FLIPPED_SPARTAN_GYRO:
220 if (!yaw_gyro_zero_.has_value()) {
221 yaw_gyro_zeroer_.AddData(last_gyro_rate_);
222 if (yaw_gyro_zeroer_.GetRange() < kMaxYawGyroZeroingRange) {
223 yaw_gyro_zero_ = yaw_gyro_zeroer_.GetAverage()(0);
224 }
225 }
226 ready_ = yaw_gyro_zero_.has_value();
227 if (ready_) {
228 last_gyro_rate_ = last_gyro_rate_ - yaw_gyro_zero_.value();
229 }
230 break;
231 case GyroType::IMU_X_GYRO:
232 case GyroType::IMU_Y_GYRO:
233 case GyroType::IMU_Z_GYRO:
234 case GyroType::FLIPPED_IMU_Z_GYRO:
235 ready_ = imu_zeroer_.Zeroed();
236 break;
237 }
James Kuszmaulddc69702021-03-24 21:55:03 -0700238
239 // TODO(james): How aggressively can we fault here? If we fault to
240 // aggressively, we might have issues during startup if wpilib_interface takes
241 // too long to start publishing IMU measurements.
Austin Schuh9993fb32017-03-15 20:17:46 -0700242 if (monotonic_now > last_gyro_time_ + chrono::milliseconds(20)) {
243 last_gyro_rate_ = 0.0;
244 }
245
James Kuszmaul1798c072022-02-13 15:32:11 -0800246 if (imu_values_fetcher_.valid()) {
247 localizer_->Update(
248 {last_last_voltage_(kLeftVoltage), last_last_voltage_(kRightVoltage)},
249 monotonic_now, position->left_encoder(), position->right_encoder(),
250 down_estimator_.avg_recent_yaw_rates(),
251 down_estimator_.avg_recent_accel());
252 } else {
253 localizer_->Update(
254 {last_last_voltage_(kLeftVoltage), last_last_voltage_(kRightVoltage)},
255 monotonic_now, position->left_encoder(), position->right_encoder(),
256 last_gyro_rate_, Eigen::Vector3d::Zero());
257 }
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800258
259 // If we get a new message setting the absolute position, then reset the
260 // localizer.
261 if (localizer_control_fetcher_.Fetch()) {
262 VLOG(1) << "localizer_control "
263 << aos::FlatbufferToJson(localizer_control_fetcher_.get());
264 localizer_->ResetPosition(
265 monotonic_now, localizer_control_fetcher_->x(),
266 localizer_control_fetcher_->y(), localizer_control_fetcher_->theta(),
267 localizer_control_fetcher_->theta_uncertainty(),
268 !localizer_control_fetcher_->keep_current_theta());
269 }
270
271 kf_.set_index(ControllerIndexFromGears());
272
Austin Schuh6613a072016-01-06 19:54:48 -0800273 {
Diana Burgessd0180f12018-03-21 21:24:17 -0700274 Eigen::Matrix<double, 4, 1> Y;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700275 Y << position->left_encoder(), position->right_encoder(), last_gyro_rate_,
Diana Burgessd0180f12018-03-21 21:24:17 -0700276 last_accel_;
Austin Schuh6613a072016-01-06 19:54:48 -0800277 kf_.Correct(Y);
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800278 }
279}
280
281Eigen::Matrix<double, 2, 1> DrivetrainFilters::VoltageError() const {
282 static_assert(kLeftError + 1 == kRightError);
283 Eigen::Matrix<double, 2, 2> error_K;
284 error_K << kf_.controller().K(kLeftVoltage, kLeftError), 0.0, 0.0,
285 kf_.controller().K(kRightVoltage, kRightError);
286 const Eigen::Matrix<double, 2, 1> voltage_error =
287 error_K * kf_.X_hat().block<2, 1>(kLeftError, 0);
288 return voltage_error;
289}
290
291void DrivetrainFilters::UpdateObserver(Eigen::Matrix<double, 2, 1> U) {
292 last_last_voltage_ = last_voltage_;
293
294 kf_.UpdateObserver(last_voltage_, dt_config_.dt);
295
296 last_voltage_ = U;
297}
298
299int DrivetrainFilters::ControllerIndexFromGears() const {
300 if (MaybeHigh(left_gear_)) {
301 if (MaybeHigh(right_gear_)) {
302 return 3;
303 } else {
304 return 2;
305 }
306 } else {
307 if (MaybeHigh(right_gear_)) {
308 return 1;
309 } else {
310 return 0;
James Kuszmaul891f4f12020-10-31 17:13:23 -0700311 }
Austin Schuh6613a072016-01-06 19:54:48 -0800312 }
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800313}
314flatbuffers::Offset<GearLogging> DrivetrainFilters::CreateGearLogging(
315 flatbuffers::FlatBufferBuilder *fbb) const {
316 GearLogging::Builder gear_logging_builder(*fbb);
317 gear_logging_builder.add_left_state(static_cast<uint32_t>(left_gear_));
318 gear_logging_builder.add_right_state(static_cast<uint32_t>(right_gear_));
319 gear_logging_builder.add_left_loop_high(MaybeHigh(left_gear_));
320 gear_logging_builder.add_right_loop_high(MaybeHigh(right_gear_));
321 gear_logging_builder.add_controller_index(ControllerIndexFromGears());
322 return gear_logging_builder.Finish();
323}
Austin Schuh6613a072016-01-06 19:54:48 -0800324
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800325Gear DrivetrainFilters::ComputeGear(
326 double shifter_position, const constants::ShifterHallEffect &shifter_config,
327 bool high_requested) const {
328 if (shifter_position < shifter_config.clear_low) {
329 return Gear::LOW;
330 } else if (shifter_position > shifter_config.clear_high) {
331 return Gear::HIGH;
332 } else {
333 if (high_requested) {
334 return Gear::SHIFTING_UP;
335 } else {
336 return Gear::SHIFTING_DOWN;
337 }
338 }
339}
340
341DrivetrainLoop::DrivetrainLoop(const DrivetrainConfig<double> &dt_config,
342 ::aos::EventLoop *event_loop,
343 LocalizerInterface *localizer,
344 const ::std::string &name)
James Kuszmaul61750662021-06-21 21:32:33 -0700345 : frc971::controls::ControlLoop<Goal, Position, Status, Output>(event_loop,
346 name),
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800347 dt_config_(dt_config),
348 filters_(dt_config, event_loop, localizer),
349 dt_openloop_(dt_config_, filters_.kf()),
350 dt_closedloop_(dt_config_, filters_.kf(), localizer),
351 dt_spline_(dt_config_),
352 dt_line_follow_(dt_config_, localizer->target_selector()) {
353 event_loop->SetRuntimeRealtimePriority(30);
James Kuszmaul75a18c52021-03-10 22:02:07 -0800354 for (size_t ii = 0; ii < trajectory_fetchers_.size(); ++ii) {
355 trajectory_fetchers_[ii].fetcher =
356 event_loop->MakeFetcher<fb::Trajectory>("/drivetrain");
357 }
358}
359
360void DrivetrainLoop::UpdateTrajectoryFetchers() {
James Kuszmaul99af8b52021-03-28 10:50:15 -0700361 if (dt_spline_.trajectory_count() >= trajectory_fetchers_.size()) {
362 aos::monotonic_clock::time_point min_time = aos::monotonic_clock::max_time;
363 size_t min_fetcher_index = 0;
364 size_t fetcher_index = 0;
365 // Find the oldest spline to forget.
366 for (auto &fetcher : trajectory_fetchers_) {
367 CHECK_NE(fetcher.fetcher.context().monotonic_event_time,
368 monotonic_clock::min_time);
369 if (fetcher.fetcher.context().monotonic_event_time < min_time &&
370 !dt_spline_.IsCurrentTrajectory(fetcher.fetcher.get())) {
371 min_time = fetcher.fetcher.context().monotonic_event_time;
372 min_fetcher_index = fetcher_index;
373 }
374 ++fetcher_index;
375 }
376
377 dt_spline_.DeleteTrajectory(
378 trajectory_fetchers_[min_fetcher_index].fetcher.get());
379 trajectory_fetchers_[min_fetcher_index].in_use = false;
380 }
381
James Kuszmaul75a18c52021-03-10 22:02:07 -0800382 for (auto &fetcher : trajectory_fetchers_) {
383 const fb::Trajectory *trajectory = fetcher.fetcher.get();
384 // If the current fetcher is already being used by the SplineDrivetrain,
385 // don't touch it.
386 // We have to check both in_use and HasTrajectory because if
387 // in_use is true and HasTrajectory() is false, that implies that the
388 // SplineDrivetrain has finished executing the trajectory and disposed of
389 // it; if in_use is false and HasTrajectory() is true, that implies that
390 // this fetcher is at the same point in the queue as another fetcher, and
391 // that the other fetcher is the one that we are using to keep the message
392 // pinned.
393 // TODO(james): Consider garbage-collecting splines once we run out of
394 // fetchers.
395 if (fetcher.in_use && dt_spline_.HasTrajectory(trajectory)) {
396 continue;
397 }
398 fetcher.in_use = false;
399 // Go through and find the next Trajectory that isn't already held by the
400 // SplineDrivetrain, and add it.
401 while (fetcher.fetcher.FetchNext()) {
402 trajectory = fetcher.fetcher.get();
403 if (!dt_spline_.HasTrajectory(trajectory)) {
404 fetcher.in_use = true;
405 dt_spline_.AddTrajectory(trajectory);
406 break;
407 }
408 }
409 }
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800410}
411
412void DrivetrainLoop::RunIteration(
413 const drivetrain::Goal *goal, const drivetrain::Position *position,
414 aos::Sender<drivetrain::Output>::Builder *output,
415 aos::Sender<drivetrain::Status>::Builder *status) {
416 const monotonic_clock::time_point monotonic_now =
417 event_loop()->monotonic_now();
418
419 if (!has_been_enabled_ && output) {
420 has_been_enabled_ = true;
421 }
422
423 if (WasReset()) {
424 filters_.Reset(monotonic_now, position);
425 }
426
James Kuszmaul75a18c52021-03-10 22:02:07 -0800427 UpdateTrajectoryFetchers();
428
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800429 filters_.Correct(monotonic_now, position);
430
431 // Set the gear-logging parts of the status
432 CHECK(status);
433 flatbuffers::Offset<GearLogging> gear_logging_offset =
434 filters_.CreateGearLogging(status->fbb());
435
436 dt_openloop_.SetPosition(position, filters_.left_gear(),
437 filters_.right_gear());
Austin Schuh093535c2016-03-05 23:21:00 -0800438
Austin Schuh872723c2019-12-25 14:38:09 -0800439 ControllerType controller_type = ControllerType::POLYDRIVE;
Brian Silverman17f503e2015-08-02 18:17:18 -0700440 if (goal) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700441 controller_type = goal->controller_type();
Brian Silverman17f503e2015-08-02 18:17:18 -0700442
Alex Perrycb7da4b2019-08-28 19:35:56 -0700443 dt_closedloop_.SetGoal(goal);
444 dt_openloop_.SetGoal(goal->wheel(), goal->throttle(), goal->quickturn(),
445 goal->highgear());
446 dt_spline_.SetGoal(goal);
447 dt_line_follow_.SetGoal(monotonic_now, goal);
Brian Silverman17f503e2015-08-02 18:17:18 -0700448 }
449
Alex Perrycb7da4b2019-08-28 19:35:56 -0700450 dt_openloop_.Update(robot_state().voltage_battery());
Brian Silverman17f503e2015-08-02 18:17:18 -0700451
Alex Perrycb7da4b2019-08-28 19:35:56 -0700452 dt_closedloop_.Update(output != nullptr &&
Austin Schuh872723c2019-12-25 14:38:09 -0800453 controller_type == ControllerType::MOTION_PROFILE);
Austin Schuh78379ea2019-01-04 20:39:45 -0800454
James Kuszmaule39cbcf2019-02-27 20:48:34 -0800455 const Eigen::Matrix<double, 5, 1> trajectory_state =
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800456 filters_.trajectory_state();
James Kuszmaule39cbcf2019-02-27 20:48:34 -0800457
James Kuszmaul897ef1a2020-10-25 17:51:10 -0700458 {
459 // TODO(james): The regular Kalman Filter's voltage error terms are
460 // currently unusable--either don't use voltage error at all for the spline
461 // following code, or use the EKF's voltage error estimates.
462 const Eigen::Matrix<double, 2, 1> voltage_error =
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800463 0 * filters_.VoltageError();
James Kuszmaul897ef1a2020-10-25 17:51:10 -0700464 dt_spline_.Update(
465 output != nullptr && controller_type == ControllerType::SPLINE_FOLLOWER,
466 trajectory_state, voltage_error);
467 }
James Kuszmaule39cbcf2019-02-27 20:48:34 -0800468
James Kuszmaul38e79642019-03-09 15:48:27 -0800469 dt_line_follow_.Update(monotonic_now, trajectory_state);
Alex Perrya71badb2019-02-06 19:40:41 -0800470
Alex Perrycb7da4b2019-08-28 19:35:56 -0700471 OutputT output_struct;
472
Austin Schuh78379ea2019-01-04 20:39:45 -0800473 switch (controller_type) {
Austin Schuh872723c2019-12-25 14:38:09 -0800474 case ControllerType::POLYDRIVE:
Alex Perrycb7da4b2019-08-28 19:35:56 -0700475 dt_openloop_.SetOutput(output != nullptr ? &output_struct : nullptr);
Austin Schuh78379ea2019-01-04 20:39:45 -0800476 break;
Austin Schuh872723c2019-12-25 14:38:09 -0800477 case ControllerType::MOTION_PROFILE:
Alex Perrycb7da4b2019-08-28 19:35:56 -0700478 dt_closedloop_.SetOutput(output != nullptr ? &output_struct : nullptr);
Austin Schuh78379ea2019-01-04 20:39:45 -0800479 break;
Austin Schuh872723c2019-12-25 14:38:09 -0800480 case ControllerType::SPLINE_FOLLOWER:
Alex Perrycb7da4b2019-08-28 19:35:56 -0700481 dt_spline_.SetOutput(output != nullptr ? &output_struct : nullptr);
Alex Perry731b4602019-02-02 22:13:01 -0800482 break;
Austin Schuh872723c2019-12-25 14:38:09 -0800483 case ControllerType::LINE_FOLLOWER:
Alex Perrycb7da4b2019-08-28 19:35:56 -0700484 if (!dt_line_follow_.SetOutput(output != nullptr ? &output_struct
485 : nullptr)) {
James Kuszmaul5bc6fc92019-03-01 21:50:06 -0800486 // If the line follow drivetrain was unable to execute (generally due to
487 // not having a target), execute the regular teleop drivetrain.
Alex Perrycb7da4b2019-08-28 19:35:56 -0700488 dt_openloop_.SetOutput(output != nullptr ? &output_struct : nullptr);
James Kuszmaul5bc6fc92019-03-01 21:50:06 -0800489 }
James Kuszmaule39cbcf2019-02-27 20:48:34 -0800490 break;
Brian Silverman17f503e2015-08-02 18:17:18 -0700491 }
492
Austin Schuh093535c2016-03-05 23:21:00 -0800493 // The output should now contain the shift request.
494
Brian Silverman17f503e2015-08-02 18:17:18 -0700495 // set the output status of the control loop state
496 if (status) {
Austin Schuh093535c2016-03-05 23:21:00 -0800497 Eigen::Matrix<double, 2, 1> linear =
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800498 dt_config_.LeftRightToLinear(filters_.DrivetrainXHat());
Austin Schuh093535c2016-03-05 23:21:00 -0800499 Eigen::Matrix<double, 2, 1> angular =
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800500 dt_config_.LeftRightToAngular(filters_.DrivetrainXHat());
Austin Schuh093535c2016-03-05 23:21:00 -0800501
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800502 angular(0, 0) = filters_.localizer_theta();
Austin Schuh093535c2016-03-05 23:21:00 -0800503
504 Eigen::Matrix<double, 4, 1> gyro_left_right =
Austin Schuhd91c0d22016-10-15 21:24:28 -0700505 dt_config_.AngularLinearToLeftRight(linear, angular);
Austin Schuh093535c2016-03-05 23:21:00 -0800506
Alex Perrycb7da4b2019-08-28 19:35:56 -0700507 const flatbuffers::Offset<CIMLogging> cim_logging_offset =
James Kuszmaulaf5dfad2020-01-03 20:02:54 -0800508 dt_openloop_.PopulateShiftingStatus(status->fbb());
509
510 const flatbuffers::Offset<PolyDriveLogging> poly_drive_logging_offset =
Alex Perrycb7da4b2019-08-28 19:35:56 -0700511 dt_openloop_.PopulateStatus(status->fbb());
Austin Schuh093535c2016-03-05 23:21:00 -0800512
James Kuszmaul3e1bb272020-01-17 18:38:19 -0800513 const flatbuffers::Offset<DownEstimatorState> down_estimator_state_offset =
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800514 filters_.PopulateDownEstimatorState(status->fbb(), monotonic_now);
James Kuszmaul2215d922020-02-11 17:17:26 -0800515
James Kuszmaul3c5b4d32020-02-11 17:22:14 -0800516 const flatbuffers::Offset<LocalizerState> localizer_offset =
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800517 filters_.PopulateLocalizerState(status->fbb());
James Kuszmaul3c5b4d32020-02-11 17:22:14 -0800518
James Kuszmaul2215d922020-02-11 17:17:26 -0800519 const flatbuffers::Offset<ImuZeroerState> zeroer_offset =
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800520 filters_.PopulateImuZeroerState(status->fbb());
James Kuszmaul3e1bb272020-01-17 18:38:19 -0800521
Alex Perrycb7da4b2019-08-28 19:35:56 -0700522 flatbuffers::Offset<LineFollowLogging> line_follow_logging_offset =
523 dt_line_follow_.PopulateStatus(status);
524 flatbuffers::Offset<TrajectoryLogging> trajectory_logging_offset =
525 dt_spline_.MakeTrajectoryLogging(status);
Austin Schuh093535c2016-03-05 23:21:00 -0800526
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800527 Status::Builder builder = status->MakeBuilder<Status>();
Austin Schuh3a378462019-01-04 21:48:04 -0800528
Alex Perrycb7da4b2019-08-28 19:35:56 -0700529 dt_closedloop_.PopulateStatus(&builder);
Austin Schuh3a378462019-01-04 21:48:04 -0800530
Austin Schuh95771d92021-01-23 14:42:25 -0800531 builder.add_estimated_left_position(gyro_left_right(kLeftPosition));
532 builder.add_estimated_right_position(gyro_left_right(kRightPosition));
Austin Schuh41565602016-02-28 20:10:49 -0800533
Austin Schuh95771d92021-01-23 14:42:25 -0800534 builder.add_estimated_left_velocity(gyro_left_right(kLeftVelocity));
535 builder.add_estimated_right_velocity(gyro_left_right(kRightVelocity));
Alex Perrycb7da4b2019-08-28 19:35:56 -0700536
537 if (dt_spline_.enable()) {
538 dt_spline_.PopulateStatus(&builder);
539 } else {
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800540 builder.add_robot_speed((filters_.DrivetrainXHat(kLeftVelocity) +
541 filters_.DrivetrainXHat(kRightVelocity)) /
542 2.0);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700543 builder.add_output_was_capped(dt_closedloop_.output_was_capped());
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800544 builder.add_uncapped_left_voltage(
545 filters_.DrivetrainUUncapped(kLeftVoltage));
546 builder.add_uncapped_right_voltage(
547 filters_.DrivetrainUUncapped(kRightVoltage));
Alex Perrycb7da4b2019-08-28 19:35:56 -0700548 }
549
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800550 builder.add_left_voltage_error(filters_.DrivetrainXHat(kLeftError));
551 builder.add_right_voltage_error(filters_.DrivetrainXHat(kRightError));
552 builder.add_estimated_angular_velocity_error(
553 filters_.DrivetrainXHat(kAngularError));
554 builder.add_estimated_heading(filters_.localizer_theta());
Alex Perrycb7da4b2019-08-28 19:35:56 -0700555
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800556 builder.add_x(filters_.x());
557 builder.add_y(filters_.y());
558 builder.add_theta(::aos::math::NormalizeAngle(filters_.localizer_theta()));
Alex Perrycb7da4b2019-08-28 19:35:56 -0700559
Alex Perrycb7da4b2019-08-28 19:35:56 -0700560 builder.add_cim_logging(cim_logging_offset);
James Kuszmaulaf5dfad2020-01-03 20:02:54 -0800561 builder.add_poly_drive_logging(poly_drive_logging_offset);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700562 builder.add_gear_logging(gear_logging_offset);
563 builder.add_line_follow_logging(line_follow_logging_offset);
564 builder.add_trajectory_logging(trajectory_logging_offset);
James Kuszmaul3e1bb272020-01-17 18:38:19 -0800565 builder.add_down_estimator(down_estimator_state_offset);
James Kuszmaul3c5b4d32020-02-11 17:22:14 -0800566 builder.add_localizer(localizer_offset);
James Kuszmaul2215d922020-02-11 17:17:26 -0800567 builder.add_zeroing(zeroer_offset);
milind1f1dca32021-07-03 13:50:07 -0700568
569 builder.add_send_failures(status_failure_counter_.failures());
570
571 status_failure_counter_.Count(status->Send(builder.Finish()));
Brian Silverman17f503e2015-08-02 18:17:18 -0700572 }
Austin Schuh209f1702015-11-29 17:03:00 -0800573
James Kuszmaulddc69702021-03-24 21:55:03 -0700574 // If the filters aren't ready/valid, then disable all outputs (currently,
575 // this only happens if the IMU is faulted or has not zeroed).
576 // TODO(james): Add exceptions so that during competitive play the driver
577 // can retain minimal control of the robot.
578 if (!filters_.Ready()) {
579 output_struct.left_voltage = 0.0;
580 output_struct.right_voltage = 0.0;
581 }
582
Austin Schuh209f1702015-11-29 17:03:00 -0800583 double left_voltage = 0.0;
584 double right_voltage = 0.0;
585 if (output) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700586 left_voltage = output_struct.left_voltage;
587 right_voltage = output_struct.right_voltage;
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800588 filters_.set_left_high_requested(output_struct.left_high);
589 filters_.set_right_high_requested(output_struct.right_high);
Austin Schuh209f1702015-11-29 17:03:00 -0800590 }
591
Alex Perrycb7da4b2019-08-28 19:35:56 -0700592 const double scalar = robot_state().voltage_battery() / 12.0;
Austin Schuh209f1702015-11-29 17:03:00 -0800593
594 left_voltage *= scalar;
595 right_voltage *= scalar;
596
Austin Schuh209f1702015-11-29 17:03:00 -0800597 // To validate, look at the following:
598
599 // Observed - dx/dt velocity for left, right.
600
601 // Angular velocity error compared to the gyro
602 // Gyro heading vs left-right
603 // Voltage error.
604
Austin Schuhfb0f35c2021-02-14 21:25:29 -0800605 {
606 Eigen::Matrix<double, 2, 1> U;
607 U(kLeftVoltage) = left_voltage;
608 U(kRightVoltage) = right_voltage;
609 filters_.UpdateObserver(U);
610 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700611
612 if (output) {
milind1f1dca32021-07-03 13:50:07 -0700613 output->CheckOk(output->Send(Output::Pack(*output->fbb(), &output_struct)));
Alex Perrycb7da4b2019-08-28 19:35:56 -0700614 }
Brian Silverman17f503e2015-08-02 18:17:18 -0700615}
616
Alex Perrycb7da4b2019-08-28 19:35:56 -0700617flatbuffers::Offset<Output> DrivetrainLoop::Zero(
618 aos::Sender<Output>::Builder *output) {
619 Output::Builder builder = output->MakeBuilder<Output>();
620 builder.add_left_voltage(0);
621 builder.add_right_voltage(0);
622 builder.add_left_high(dt_config_.default_high_gear);
623 builder.add_right_high(dt_config_.default_high_gear);
624 return builder.Finish();
Adam Snaiderbc918b62016-02-27 21:03:39 -0800625}
626
Austin Schuh6197a182015-11-28 16:04:40 -0800627} // namespace drivetrain
Brian Silverman17f503e2015-08-02 18:17:18 -0700628} // namespace control_loops
Comran Morshed5323ecb2015-12-26 20:50:55 +0000629} // namespace frc971