Program Listing for File imu_interface.hpp

Return to documentation for file (src/tap/communication/sensors/imu/imu_interface.hpp)

/*
 * Copyright (c) 2022 Advanced Robotics at the University of Washington <robomstr@uw.edu>
 *
 * This file is part of Taproot.
 *
 * Taproot is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Taproot is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Taproot.  If not, see <https://www.gnu.org/licenses/>.
 */

#ifndef TAPROOT_IMU_INTERFACE_HPP_
#define TAPROOT_IMU_INTERFACE_HPP_

namespace tap::communication::sensors::imu
{
class ImuInterface
{
public:
    enum class ImuState
    {
        IMU_NOT_CONNECTED,
        IMU_NOT_CALIBRATED,
        IMU_CALIBRATING,
        IMU_CALIBRATED,
    };

    virtual inline const char *getName() const = 0;

    virtual inline float getAx() = 0;

    virtual inline float getAy() = 0;

    virtual inline float getAz() = 0;

    virtual inline float getGx() = 0;

    virtual inline float getGy() = 0;

    virtual inline float getGz() = 0;

    virtual inline float getTemp() = 0;

    virtual inline float getYaw() = 0;

    virtual inline float getPitch() = 0;

    virtual inline float getRoll() = 0;
};
}  // namespace tap::communication::sensors::imu

#endif  // IMU_INTERFACE_HPP_