info.hpp

Go to the documentation of this file.

#pragma once

#include "hebi.h"

#include <string>

#include "color.hpp"
#include "gains.hpp"
#include "ip_address.hpp"
#include "message_helpers.hpp"
#include "util.hpp"

namespace hebi {

class Info final {
public:
  enum class ControlStrategy {
    Off,
    DirectPWM,
    Strategy2,
    Strategy3,
    Strategy4,
  };

  enum class CalibrationState {
    Normal,
    UncalibratedCurrent,
    UncalibratedPosition,
    UncalibratedEffort,
  };

  enum class MstopStrategy {
    Disabled,
    MotorOff,
    HoldPosition,
  };

  enum class PositionLimitStrategy {
    HoldPosition,
    DampedSpring,
    MotorOff,
    Disabled,
  };

protected:
  class FloatField final {
  public:
#ifndef DOXYGEN_OMIT_INTERNAL
    FloatField(const HebiInfoRef& internal, HebiInfoFloatField field);
#endif // DOXYGEN_OMIT_INTERNAL
    explicit operator bool() const { return has(); }
    bool has() const;
    float get() const;

    HEBI_DISABLE_COPY_MOVE(FloatField)
  private:
    const HebiInfoRef& internal_;
    HebiInfoFloatField const field_;
  };

  class HighResAngleField final {
  public:
#ifndef DOXYGEN_OMIT_INTERNAL
    HighResAngleField(const HebiInfoRef& internal, HebiInfoHighResAngleField field);
#endif // DOXYGEN_OMIT_INTERNAL
    explicit operator bool() const { return has(); }
    bool has() const;
    double get() const;
    void get(int64_t* revolutions, float* radian_offset) const;

    HEBI_DISABLE_COPY_MOVE(HighResAngleField)
  private:
    const HebiInfoRef& internal_;
    HebiInfoHighResAngleField const field_;
  };

  class IpAddressField final {
  public:
#ifndef DOXYGEN_OMIT_INTERNAL
    IpAddressField(const HebiInfoRef& internal, HebiInfoUInt64Field field);
#endif // DOXYGEN_OMIT_INTERNAL
    explicit operator bool() const { return has(); }
    bool has() const;
    IpAddress get() const;

    HEBI_DISABLE_COPY_MOVE(IpAddressField)
  private:
    const HebiInfoRef& internal_;
    HebiInfoUInt64Field const field_;
  };

  class BoolField final {
  public:
#ifndef DOXYGEN_OMIT_INTERNAL
    BoolField(const HebiInfoRef& internal, HebiInfoBoolField field);
#endif // DOXYGEN_OMIT_INTERNAL
    bool has() const;
    bool get() const;

    HEBI_DISABLE_COPY_MOVE(BoolField)
  private:
    const HebiInfoRef& internal_;
    HebiInfoBoolField const field_;
  };

  class StringField final {
  public:
#ifndef DOXYGEN_OMIT_INTERNAL
    StringField(HebiInfoPtr internal, HebiInfoStringField field);
#endif // DOXYGEN_OMIT_INTERNAL
    explicit operator bool() const { return has(); }
    bool has() const;
    std::string get() const;

    HEBI_DISABLE_COPY_MOVE(StringField)
  private:
    HebiInfoPtr const internal_;
    HebiInfoStringField const field_;
  };

  class FlagField final {
  public:
#ifndef DOXYGEN_OMIT_INTERNAL
    FlagField(const HebiInfoRef& internal, HebiInfoFlagField field);
#endif // DOXYGEN_OMIT_INTERNAL
    explicit operator bool() const { return has(); }
    bool has() const;

    HEBI_DISABLE_COPY_MOVE(FlagField)
  private:
    const HebiInfoRef& internal_;
    HebiInfoFlagField const field_;
  };

  template<typename T>
  class EnumField final {
  public:
#ifndef DOXYGEN_OMIT_INTERNAL
    EnumField(const HebiInfoRef& internal, HebiInfoEnumField field) : internal_(internal), field_(field) {}
#endif // DOXYGEN_OMIT_INTERNAL
    explicit operator bool() const { return has(); }
    bool has() const {
      return (enumGetter(internal_, field_, nullptr) == HebiStatusSuccess);
    }
    T get() const {
      int32_t ret{};
      enumGetter(internal_, field_, &ret);
      return static_cast<T>(ret);
    }

    HEBI_DISABLE_COPY_MOVE(EnumField)
  private:
    const HebiInfoRef& internal_;
    HebiInfoEnumField const field_;
  };

  class IoBank final {
  public:
#ifndef DOXYGEN_OMIT_INTERNAL
    IoBank(HebiInfoPtr internal, HebiInfoRef& internal_ref, HebiInfoIoPinBank bank);
#endif // DOXYGEN_OMIT_INTERNAL
    bool hasLabel(size_t pinNumber) const;
    std::string getLabel(size_t pinNumber) const;

    HEBI_DISABLE_COPY_MOVE(IoBank)
  private:
    HebiInfoPtr internal_;
    HebiInfoRef& internal_ref_;
    HebiInfoIoPinBank const bank_;
  };
  class LedField final {
  public:
#ifndef DOXYGEN_OMIT_INTERNAL
    LedField(const HebiInfoRef& internal, HebiInfoLedField field);
#endif // DOXYGEN_OMIT_INTERNAL
    explicit operator bool() const { return hasColor(); }
    bool hasColor() const;
    Color getColor() const;

    HEBI_DISABLE_COPY_MOVE(LedField)
  private:
    const HebiInfoRef& internal_;
    HebiInfoLedField const field_;
  };

  class Io final {
  public:
#ifndef DOXYGEN_OMIT_INTERNAL
    Io(HebiInfoPtr internal, HebiInfoRef& internal_ref)
      : a_(internal, internal_ref, HebiInfoIoBankA),
        b_(internal, internal_ref, HebiInfoIoBankB),
        c_(internal, internal_ref, HebiInfoIoBankC),
        d_(internal, internal_ref, HebiInfoIoBankD),
        e_(internal, internal_ref, HebiInfoIoBankE),
        f_(internal, internal_ref, HebiInfoIoBankF) {}
#endif // DOXYGEN_OMIT_INTERNAL

    // With all submessage and field getters: Note that the returned reference
    // should not be used after the lifetime of this parent.

    // Subfields ----------------

    IoBank& a() { return a_; }
    const IoBank& a() const { return a_; }
    IoBank& b() { return b_; }
    const IoBank& b() const { return b_; }
    IoBank& c() { return c_; }
    const IoBank& c() const { return c_; }
    IoBank& d() { return d_; }
    const IoBank& d() const { return d_; }
    IoBank& e() { return e_; }
    const IoBank& e() const { return e_; }
    IoBank& f() { return f_; }
    const IoBank& f() const { return f_; }

    HEBI_DISABLE_COPY_MOVE(Io)
  private:
    IoBank a_;
    IoBank b_;
    IoBank c_;
    IoBank d_;
    IoBank e_;
    IoBank f_;
  };

  using InfoGains = Gains<HebiInfoRef, FloatField, BoolField, HebiInfoFloatField, HebiInfoBoolField>;

  class Settings final {
  protected:
    class Actuator final {
    public:
#ifndef DOXYGEN_OMIT_INTERNAL
      Actuator(const HebiInfoRef& internal)
        : position_gains_(internal, HebiInfoFloatPositionKp, HebiInfoBoolPositionDOnError),
          velocity_gains_(internal, HebiInfoFloatVelocityKp, HebiInfoBoolVelocityDOnError),
          effort_gains_(internal, HebiInfoFloatEffortKp, HebiInfoBoolEffortDOnError),
          spring_constant_(internal, HebiInfoFloatSpringConstant),
          velocity_limit_min_(internal, HebiInfoFloatVelocityLimitMin),
          velocity_limit_max_(internal, HebiInfoFloatVelocityLimitMax),
          effort_limit_min_(internal, HebiInfoFloatEffortLimitMin),
          effort_limit_max_(internal, HebiInfoFloatEffortLimitMax),
          position_limit_min_(internal, HebiInfoHighResAnglePositionLimitMin),
          position_limit_max_(internal, HebiInfoHighResAnglePositionLimitMax),
          control_strategy_(internal, HebiInfoEnumControlStrategy),
          mstop_strategy_(internal, HebiInfoEnumMstopStrategy),
          min_position_limit_strategy_(internal, HebiInfoEnumMinPositionLimitStrategy),
          max_position_limit_strategy_(internal, HebiInfoEnumMaxPositionLimitStrategy) {}
#endif // DOXYGEN_OMIT_INTERNAL

      // With all submessage and field getters: Note that the returned reference
      // should not be used after the lifetime of this parent.

      // Submessages ----------------

      const InfoGains& positionGains() const { return position_gains_; }
      const InfoGains& velocityGains() const { return velocity_gains_; }
      const InfoGains& effortGains() const { return effort_gains_; }

      // Subfields ----------------

      const FloatField& springConstant() const { return spring_constant_; }
      const FloatField& velocityLimitMin() const { return velocity_limit_min_; }
      const FloatField& velocityLimitMax() const { return velocity_limit_max_; }
      const FloatField& effortLimitMin() const { return effort_limit_min_; }
      const FloatField& effortLimitMax() const { return effort_limit_max_; }
      const HighResAngleField& positionLimitMin() const { return position_limit_min_; }
      const HighResAngleField& positionLimitMax() const { return position_limit_max_; }
      const EnumField<ControlStrategy>& controlStrategy() const { return control_strategy_; }
      const EnumField<MstopStrategy>& mstopStrategy() const { return mstop_strategy_; }
      const EnumField<PositionLimitStrategy>& minPositionLimitStrategy() const { return min_position_limit_strategy_; }
      const EnumField<PositionLimitStrategy>& maxPositionLimitStrategy() const { return max_position_limit_strategy_; }

      HEBI_DISABLE_COPY_MOVE(Actuator)
    private:
      InfoGains position_gains_;
      InfoGains velocity_gains_;
      InfoGains effort_gains_;

      FloatField spring_constant_;
      FloatField velocity_limit_min_;
      FloatField velocity_limit_max_;
      FloatField effort_limit_min_;
      FloatField effort_limit_max_;
      HighResAngleField position_limit_min_;
      HighResAngleField position_limit_max_;
      EnumField<ControlStrategy> control_strategy_;
      EnumField<MstopStrategy> mstop_strategy_;
      EnumField<PositionLimitStrategy> min_position_limit_strategy_;
      EnumField<PositionLimitStrategy> max_position_limit_strategy_;
    };

    class Imu final {
    public:
#ifndef DOXYGEN_OMIT_INTERNAL
      Imu(const HebiInfoRef& internal)
        : accel_includes_gravity_(internal, HebiInfoBoolAccelIncludesGravity) {}
#endif // DOXYGEN_OMIT_INTERNAL

      // With all submessage and field getters: Note that the returned reference
      // should not be used after the lifetime of this parent.

      // Subfields ----------------

      const BoolField& accelIncludesGravity() const { return accel_includes_gravity_; }

      HEBI_DISABLE_COPY_MOVE(Imu)
    private:
      BoolField accel_includes_gravity_;
    };

  public:
#ifndef DOXYGEN_OMIT_INTERNAL
    Settings(HebiInfoPtr internal_ptr, const HebiInfoRef& internal)
      : actuator_(internal),
        imu_(internal),
        name_(internal_ptr, HebiInfoStringName),
        family_(internal_ptr, HebiInfoStringFamily),
        electrical_type_(internal_ptr, HebiInfoStringElectricalType),
        electrical_revision_(internal_ptr, HebiInfoStringElectricalRevision),
        mechanical_type_(internal_ptr, HebiInfoStringMechanicalType),
        mechanical_revision_(internal_ptr, HebiInfoStringMechanicalRevision),
        firmware_type_(internal_ptr, HebiInfoStringFirmwareType),
        firmware_revision_(internal_ptr, HebiInfoStringFirmwareRevision),
        user_settings_bytes_1_(internal_ptr, HebiInfoStringUserSettingsBytes1),
        user_settings_bytes_2_(internal_ptr, HebiInfoStringUserSettingsBytes2),
        user_settings_bytes_3_(internal_ptr, HebiInfoStringUserSettingsBytes3),
        user_settings_bytes_4_(internal_ptr, HebiInfoStringUserSettingsBytes4),
        user_settings_bytes_5_(internal_ptr, HebiInfoStringUserSettingsBytes5),
        user_settings_bytes_6_(internal_ptr, HebiInfoStringUserSettingsBytes6),
        user_settings_bytes_7_(internal_ptr, HebiInfoStringUserSettingsBytes7),
        user_settings_bytes_8_(internal_ptr, HebiInfoStringUserSettingsBytes8),
        user_settings_float_1_(internal, HebiInfoFloatUserSettingsFloat1),
        user_settings_float_2_(internal, HebiInfoFloatUserSettingsFloat2),
        user_settings_float_3_(internal, HebiInfoFloatUserSettingsFloat3),
        user_settings_float_4_(internal, HebiInfoFloatUserSettingsFloat4),
        user_settings_float_5_(internal, HebiInfoFloatUserSettingsFloat5),
        user_settings_float_6_(internal, HebiInfoFloatUserSettingsFloat6),
        user_settings_float_7_(internal, HebiInfoFloatUserSettingsFloat7),
        user_settings_float_8_(internal, HebiInfoFloatUserSettingsFloat8),
        ip_address_(internal, HebiInfoUInt64IpAddress),
        subnet_mask_(internal, HebiInfoUInt64SubnetMask),
        default_gateway_(internal, HebiInfoUInt64DefaultGateway),
        save_current_settings_(internal, HebiInfoFlagSaveCurrentSettings) {}
#endif // DOXYGEN_OMIT_INTERNAL

    // With all submessage and field getters: Note that the returned reference
    // should not be used after the lifetime of this parent.

    // Submessages ----------------

    const Actuator& actuator() const { return actuator_; }
    const Imu& imu() const { return imu_; }

    // Subfields ----------------

    const StringField& name() const { return name_; }
    const StringField& family() const { return family_; }
    const StringField& electricalType() const { return electrical_type_; }
    const StringField& electricalRevision() const { return electrical_revision_; }
    const StringField& mechanicalType() const { return mechanical_type_; }
    const StringField& mechanicalRevision() const { return mechanical_revision_; }
    const StringField& firmwareType() const { return firmware_type_; }
    const StringField& firmwareRevision() const { return firmware_revision_; }
    const StringField& userSettingsBytes(size_t number) const
    {
      switch (number) {
        case 1: return user_settings_bytes_1_;
        case 2: return user_settings_bytes_2_;
        case 3: return user_settings_bytes_3_;
        case 4: return user_settings_bytes_4_;
        case 5: return user_settings_bytes_5_;
        case 6: return user_settings_bytes_6_;
        case 7: return user_settings_bytes_7_;
        case 8: return user_settings_bytes_8_;
      }
      throw std::out_of_range("Invalid option for bytes array user setting entry!");
    }
    const FloatField& userSettingsFloat(size_t number) const
    {
      switch (number) {
        case 1: return user_settings_float_1_;
        case 2: return user_settings_float_2_;
        case 3: return user_settings_float_3_;
        case 4: return user_settings_float_4_;
        case 5: return user_settings_float_5_;
        case 6: return user_settings_float_6_;
        case 7: return user_settings_float_7_;
        case 8: return user_settings_float_8_;
      }
      throw std::out_of_range("Invalid option for float user setting entry!");
    }
    const IpAddressField& ipAddress() const { return ip_address_; }
    const IpAddressField& subnetMask() const { return subnet_mask_; }
    const IpAddressField& defaultGateway() const { return default_gateway_; }
    const FlagField& saveCurrentSettings() const { return save_current_settings_; }

    HEBI_DISABLE_COPY_MOVE(Settings)
  private:
    Actuator actuator_;
    Imu imu_;
    StringField name_;
    StringField family_;
    StringField electrical_type_;
    StringField electrical_revision_;
    StringField mechanical_type_;
    StringField mechanical_revision_;
    StringField firmware_type_;
    StringField firmware_revision_;
    StringField user_settings_bytes_1_;
    StringField user_settings_bytes_2_;
    StringField user_settings_bytes_3_;
    StringField user_settings_bytes_4_;
    StringField user_settings_bytes_5_;
    StringField user_settings_bytes_6_;
    StringField user_settings_bytes_7_;
    StringField user_settings_bytes_8_;
    FloatField user_settings_float_1_;
    FloatField user_settings_float_2_;
    FloatField user_settings_float_3_;
    FloatField user_settings_float_4_;
    FloatField user_settings_float_5_;
    FloatField user_settings_float_6_;
    FloatField user_settings_float_7_;
    FloatField user_settings_float_8_;
    IpAddressField ip_address_;
    IpAddressField subnet_mask_;
    IpAddressField default_gateway_;
    FlagField save_current_settings_;
  };

  class Actuator final {
  public:
#ifndef DOXYGEN_OMIT_INTERNAL
    Actuator(const HebiInfoRef& internal) : calibration_state_(internal, HebiInfoEnumCalibrationState) {}
#endif // DOXYGEN_OMIT_INTERNAL

    // With all submessage and field getters: Note that the returned reference
    // should not be used after the lifetime of this parent.

    // Subfields ----------------

    const EnumField<CalibrationState>& calibrationState() const { return calibration_state_; }

    HEBI_DISABLE_COPY_MOVE(Actuator)
  private:
    EnumField<CalibrationState> calibration_state_;
  };

private:
  HebiInfoPtr internal_;
  HebiInfoRef internal_ref_;

public:
#ifndef DOXYGEN_OMIT_INTERNAL

  Info(HebiInfoPtr);
#endif // DOXYGEN_OMIT_INTERNAL

  Info(Info&& other);

  // With all submessage and field getters: Note that the returned reference
  // should not be used after the lifetime of this parent.

  // Submessages -------------------------------------------------------------

  Io& io() { return io_; }
  const Io& io() const { return io_; }
  const Settings& settings() const { return settings_; }
  const Actuator& actuator() const { return actuator_; }

  // Subfields -------------------------------------------------------------

  const StringField& serial() const { return serial_; }
  const LedField& led() const { return led_; }

  HEBI_DISABLE_COPY(Info)

  /* Disable move assigment operator. */
  Info& operator=(Info&& other) = delete;

private:
  Io io_;
  Settings settings_;
  Actuator actuator_;

  StringField serial_;
  LedField led_;
};

} // namespace hebi