aos/common/control_loop/ControlLoop-tmpl.h

#include <stddef.h>

#include "aos/common/logging/logging.h"
#include "aos/common/control_loop/Timing.h"
#include "aos/common/messages/RobotState.q.h"
#include "aos/common/logging/queue_logging.h"

namespace aos {
namespace control_loops {

// TODO(aschuh): Tests.

template <class T, bool has_position, bool fail_no_position>
constexpr ::aos::time::Time
    ControlLoop<T, has_position, fail_no_position>::kStaleLogInterval;

template <class T, bool has_position, bool fail_no_position>
void ControlLoop<T, has_position, fail_no_position>::ZeroOutputs() {
  aos::ScopedMessagePtr<OutputType> output =
      control_loop_->output.MakeMessage();
  Zero(output.get());
  output.Send();
}

template <class T, bool has_position, bool fail_no_position>
void ControlLoop<T, has_position, fail_no_position>::Iterate() {
  // Fetch the latest control loop goal and position.  If there is no new
  // goal, we will just reuse the old one.
  // If there is no goal, we haven't started up fully.  It isn't worth
  // the added complexity for each loop implementation to handle that case.
  control_loop_->goal.FetchLatest();
  // TODO(aschuh): Check the age here if we want the loop to stop on old
  // goals.
  const GoalType *goal = control_loop_->goal.get();
  if (goal == NULL) {
    LOG_INTERVAL(no_prior_goal_);
    ZeroOutputs();
    return;
  }
  LOG_STRUCT(DEBUG, "goal", *goal);

  // Only pass in a position if we got one this cycle.
  const PositionType *position = NULL;

  // Only fetch the latest position if we have one.
  if (has_position) {
    // If the position is stale, this is really bad.  Try fetching a position
    // and check how fresh it is, and then take the appropriate action.
    if (control_loop_->position.FetchLatest()) {
      position = control_loop_->position.get();
    } else {
      if (control_loop_->position.get()) {
        int msec_age = control_loop_->position.Age().ToMSec();
        if (!control_loop_->position.IsNewerThanMS(kPositionTimeoutMs)) {
          LOG_INTERVAL(very_stale_position_);
          ZeroOutputs();
          return;
        } else {
          LOG(ERROR, "Stale position. %d ms (< %d ms)\n", msec_age,
              kPositionTimeoutMs);
        }
      } else {
        LOG_INTERVAL(no_prior_position_);
        if (fail_no_position) {
          ZeroOutputs();
          return;
        }
      }
    }
    if (position) {
      LOG_STRUCT(DEBUG, "position", *position);
    }
  }

  bool outputs_enabled = false;

  // Check to see if we got a driver station packet recently.
  if (aos::robot_state.FetchLatest()) {
    outputs_enabled = true;
  } else if (aos::robot_state.IsNewerThanMS(kDSPacketTimeoutMs)) {
    outputs_enabled = true;
  } else {
    if (aos::robot_state.get()) {
      LOG_INTERVAL(driver_station_old_);
    } else {
      LOG_INTERVAL(no_driver_station_);
    }
  }

  // Run the iteration.
  aos::ScopedMessagePtr<StatusType> status =
      control_loop_->status.MakeMessage();
  if (status.get() == NULL) {
    return;
  }

  if (outputs_enabled) {
    aos::ScopedMessagePtr<OutputType> output =
        control_loop_->output.MakeMessage();
    RunIteration(goal, position, output.get(), status.get());

    LOG_STRUCT(DEBUG, "output", *output);
    output.Send();
  } else {
    // The outputs are disabled, so pass NULL in for the output.
    RunIteration(goal, position, NULL, status.get());
    ZeroOutputs();
  }

  LOG_STRUCT(DEBUG, "status", *status);
  status.Send();
}

template <class T, bool has_position, bool fail_no_position>
void ControlLoop<T, has_position, fail_no_position>::Run() {
  while (true) {
    time::SleepUntil(NextLoopTime());
    Iterate();
  }
}

}  // namespace control_loops
}  // namespace aos