power_limit.h

Go to the documentation of this file.

/*******************************************************************************
 * BSD 3-Clause License
 *
 * Copyright (c) 2021, Qiayuan Liao
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * * Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *******************************************************************************/
 
//
// Created by bruce on 2021/7/28.
//
 
#pragma once
 
#include <algorithm>
#include <cmath>
 
#include <ros/ros.h>
#include <rm_msgs/ChassisCmd.h>
#include <rm_msgs/GameStatus.h>
#include <rm_msgs/GameRobotStatus.h>
#include <rm_msgs/PowerHeatData.h>
#include <rm_msgs/PowerManagementSampleAndStatusData.h>
 
namespace rm_common
{
class PowerLimit
{
public:
  PowerLimit(ros::NodeHandle& nh)
 
  {
    if (!nh.getParam("safety_power", safety_power_))
      ROS_ERROR("Safety power no defined (namespace: %s)", nh.getNamespace().c_str());
    if (!nh.getParam("capacitor_threshold", capacitor_threshold_))
      ROS_ERROR("Capacitor threshold no defined (namespace: %s)", nh.getNamespace().c_str());
    if (!nh.getParam("disable_burst_cap_threshold", disable_burst_cap_threshold_))
      ROS_ERROR("Disable burst cap threshold no defined (namespace: %s)", nh.getNamespace().c_str());
    if (!nh.getParam("enable_burst_cap_threshold", enable_burst_cap_threshold_))
      ROS_ERROR("Enable burst cap threshold no defined (namespace: %s)", nh.getNamespace().c_str());
    if (!nh.getParam("disable_normal_cap_threshold", disable_normal_cap_threshold_))
      ROS_ERROR("Disable normal cap threshold no defined (namespace: %s)", nh.getNamespace().c_str());
    if (!nh.getParam("enable_gyro_cap_threshold", enable_gyro_cap_threshold_))
      ROS_ERROR("Enable gyro cap threshold no defined (namespace: %s)", nh.getNamespace().c_str());
    if (!nh.getParam("disable_gyro_cap_threshold", disable_gyro_cap_threshold_))
      ROS_ERROR("Disable gyro cap threshold no defined (namespace: %s)", nh.getNamespace().c_str());
    if (!nh.getParam("extra_power", extra_power_))
      ROS_ERROR("Extra power no defined (namespace: %s)", nh.getNamespace().c_str());
    if (!nh.getParam("burst_power", burst_power_))
      ROS_ERROR("Burst power no defined (namespace: %s)", nh.getNamespace().c_str());
    if (!nh.getParam("gyro_power", gyro_power_))
      ROS_ERROR("Gyro power no defined (namespace: %s)", nh.getNamespace().c_str());
    if (!nh.getParam("upstairs_power", upstairs_power_))
      ROS_ERROR("Upstairs power no defined (namespace: %s)", nh.getNamespace().c_str());
    if (!nh.getParam("max_power_limit", max_power_limit_))
      ROS_ERROR("max power limit no defined (namespace: %s)", nh.getNamespace().c_str());
    if (!nh.getParam("power_gain", power_gain_))
      ROS_ERROR("power gain no defined (namespace: %s)", nh.getNamespace().c_str());
    if (!nh.getParam("total_burst_time", total_burst_time_))
      ROS_ERROR("total burst time no defined (namespace: %s)", nh.getNamespace().c_str());
    default_max_power_limit_ = max_power_limit_;
    default_burst_power_ = burst_power_;
  }
  typedef enum
  {
    CHARGE = 0,
    BURST = 1,
    NORMAL = 2,
    ALLOFF = 3,
    TEST = 4,
  } Mode;
 
  void updateSafetyPower(int safety_power)
  {
    if (safety_power > 0)
      safety_power_ = safety_power;
    ROS_INFO("update safety power: %d", safety_power);
  }
  void updateState(uint8_t state)
  {
    expect_state_ = state;
  }
  void setGameRobotData(const rm_msgs::GameRobotStatus data)
  {
    robot_id_ = data.robot_id;
    chassis_power_limit_ = data.chassis_power_limit;
  }
  void setChassisPowerBuffer(const rm_msgs::PowerHeatData data)
  {
    chassis_power_buffer_ = data.chassis_power_buffer;
  }
  void setCapacityData(const rm_msgs::PowerManagementSampleAndStatusData data)
  {
    capacity_is_online_ = ros::Time::now() - data.stamp < ros::Duration(0.3);
    cap_energy_ = data.capacity_remain_charge;
    cap_state_ = data.state_machine_running_state;
  }
  void setRefereeStatus(bool status)
  {
    referee_is_online_ = status;
  }
  void setStartBurstTime(const ros::Time start_burst_time)
  {
    start_burst_time_ = start_burst_time;
  }
  ros::Time getStartBurstTime() const
  {
    return start_burst_time_;
  }
  inline void setBurstPowerLimit(const double& burst_power_limit)
  {
    burst_power_ = burst_power_limit;
  }
  uint8_t getState()
  {
    return expect_state_;
  }
 
  void setUpstairsPower(bool upstairs)
  {
    if (upstairs)
    {
      max_power_limit_ = upstairs_power_;
      burst_power_ = upstairs_power_;
    }
    else
    {
      max_power_limit_ = default_max_power_limit_;
      burst_power_ = default_burst_power_;
    }
  }
 
  void setGyroPower(rm_msgs::ChassisCmd& chassis_cmd)
  {
    if (!allow_gyro_cap_ && cap_energy_ >= enable_gyro_cap_threshold_)
      allow_gyro_cap_ = true;
    if (allow_gyro_cap_ && cap_energy_ <= disable_gyro_cap_threshold_)
      allow_gyro_cap_ = false;
    if (allow_gyro_cap_)
    {
      chassis_cmd.power_limit = gyro_power_;
    }
    else
      expect_state_ = NORMAL;
  }
 
  void setBurstPower(rm_msgs::ChassisCmd& chassis_cmd)
  {
    if (!allow_use_cap_ && cap_energy_ >= enable_burst_cap_threshold_)
      allow_use_cap_ = true;
    if (allow_use_cap_ && cap_energy_ <= disable_burst_cap_threshold_)
      allow_use_cap_ = false;
    if (allow_use_cap_)
    {
      chassis_cmd.power_limit = burst_power_;
    }
    else
      expect_state_ = NORMAL;
  }
 
  void setLimitPower(rm_msgs::ChassisCmd& chassis_cmd, bool is_gyro)
  {
    if (robot_id_ == rm_msgs::GameRobotStatus::BLUE_ENGINEER || robot_id_ == rm_msgs::GameRobotStatus::RED_ENGINEER)
      chassis_cmd.power_limit = 400;
    else
    {  // standard and hero
      if (referee_is_online_)
      {
        if (capacity_is_online_ && expect_state_ != ALLOFF)
        {
          if (chassis_power_limit_ > burst_power_)
            chassis_cmd.power_limit = burst_power_;
          else
          {
            switch (expect_state_)
            {
              case NORMAL:
                normal(chassis_cmd);
                break;
              case BURST:
                burst(chassis_cmd, is_gyro);
                break;
              case CHARGE:
                charge(chassis_cmd);
                break;
              default:
                zero(chassis_cmd);
                break;
            }
          }
        }
        else
          normal(chassis_cmd);
      }
      else
        chassis_cmd.power_limit = safety_power_;
    }
    applyPosturePowerScale(chassis_cmd);
  }
 
private:
  void charge(rm_msgs::ChassisCmd& chassis_cmd)
  {
    allow_use_cap_ = false;
    chassis_cmd.power_limit = chassis_power_limit_ * 0.70;
  }
 
  void normal(rm_msgs::ChassisCmd& chassis_cmd)
  {
    allow_use_cap_ = false;
    if (cap_state_ != ALLOFF && cap_energy_ > disable_normal_cap_threshold_ &&
        chassis_power_buffer_ > power_buffer_threshold_)
    {
      chassis_cmd.power_limit = chassis_power_limit_ + extra_power_;
    }
    else
    {
      chassis_cmd.power_limit = chassis_power_limit_;
    }
    if (chassis_cmd.power_limit > max_power_limit_)
    {
      chassis_cmd.power_limit = max_power_limit_;
    }
  }
 
  void zero(rm_msgs::ChassisCmd& chassis_cmd)
  {
    chassis_cmd.power_limit = 0.0;
  }
 
  void burst(rm_msgs::ChassisCmd& chassis_cmd, bool is_gyro)
  {
    if (cap_state_ != ALLOFF && cap_energy_ > capacitor_threshold_ && chassis_power_buffer_ > power_buffer_threshold_)
    {
      if (is_gyro)
      {
        setGyroPower(chassis_cmd);
      }
      else
      {
        setBurstPower(chassis_cmd);
      }
    }
    else
      expect_state_ = NORMAL;
  }
 
  void applyPosturePowerScale(rm_msgs::ChassisCmd& chassis_cmd) const
  {
    if (std::abs(posture_power_scale_ - 1.0) < 1e-6)
      return;
    chassis_cmd.power_limit = std::max(0.0, std::floor(chassis_cmd.power_limit * posture_power_scale_));
  }
 
  uint8_t expect_state_{}, cap_state_{};
 
  int chassis_power_buffer_{};
  int robot_id_{}, chassis_power_limit_{};
  double max_power_limit_{ 70.0 };
  float cap_energy_{};
  double safety_power_{};
  double capacitor_threshold_{};
  double power_buffer_threshold_{ 50.0 };
  double enable_burst_cap_threshold_{}, disable_burst_cap_threshold_{};
  double enable_gyro_cap_threshold_{}, disable_gyro_cap_threshold_{};
  double disable_normal_cap_threshold_{};
  double extra_power_{}, burst_power_{}, gyro_power_{}, upstairs_power_{};
  double default_max_power_limit_{}, default_burst_power_{};
  double power_gain_{};
 
  bool allow_gyro_cap_{ false }, allow_use_cap_{ false };
  double posture_power_scale_{ 1.0 };
 
  ros::Time start_burst_time_{};
  int total_burst_time_{};
 
  bool referee_is_online_{ false };
  bool capacity_is_online_{ false };
};
}  // namespace rm_common