ServoHub.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024-2025 REV Robotics
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. Neither the name of REV Robotics 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 OWNER 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.
 */
 
#pragma once
 
#include <stdint.h>
 
#include <vector>
 
#include "rev/ConfigureTypes.h"
#include "rev/REVLibError.h"
#include "rev/ServoChannel.h"
#include "rev/ServoHubLowLevel.h"
#include "rev/config/ServoHubConfig.h"
#include "rev/config/ServoHubConfigAccessor.h"
 
namespace rev::servohub {
 
class ServoHub : public ServoHubLowLevel {
    friend class ServoHubSim;
 
public:
    ServoHubConfigAccessor configAccessor;
 
public:
    explicit ServoHub(int deviceID);
 
    ~ServoHub() override;
 
    enum class ResetMode { kNoResetSafeParameters, kResetSafeParameters };
 
    [[deprecated(
        "Use Configure(rev::ResetMode) instead. This method will be removed in "
        "2027.")]]
    REVLibError Configure(
        ServoHubConfig& config,
        ResetMode resetMode = ResetMode::kNoResetSafeParameters);
 
    REVLibError Configure(
        ServoHubConfig& config,
        rev::ResetMode resetMode = rev::ResetMode::kNoResetSafeParameters);
 
    REVLibError ConfigureAsync(
        ServoHubConfig& config,
        ResetMode resetMode = ResetMode::kNoResetSafeParameters);
 
    REVLibError ConfigureAsync(
        ServoHubConfig& config,
        rev::ResetMode resetMode = rev::ResetMode::kNoResetSafeParameters);
 
    bool HasActiveFault() const;
 
    bool HasStickyFault() const;
 
    bool HasActiveWarning() const;
 
    bool HasStickyWarning() const;
 
    struct Faults {
        bool regulatorPowerGood;
        bool hardware;
        bool firmware;
        bool lowBattery;
        uint16_t rawBits;
 
        explicit Faults(uint16_t faults);
    };
 
    Faults GetFaults() const;
 
    Faults GetStickyFaults() const;
 
    struct Warnings {
        bool brownout;
        bool canWarning;
        bool canBusOff;
        bool hasReset;
        bool channel0Overcurrent;
        bool channel1Overcurrent;
        bool channel2Overcurrent;
        bool channel3Overcurrent;
        bool channel4Overcurrent;
        bool channel5Overcurrent;
        uint16_t rawBits;
 
        explicit Warnings(uint16_t warnings);
    };
 
    Warnings GetWarnings() const;
 
    Warnings GetStickyWarnings() const;
 
    REVLibError ClearFaults();
 
    double GetDeviceVoltage() const;
 
    double GetDeviceCurrent() const;
 
    double GetServoVoltage() const;
 
    ServoChannel& GetServoChannel(ServoChannel::ChannelId channelId);
 
    enum class Bank { kBank0_2 = 0, kBank3_5 = 1 };
 
    REVLibError SetBankPulsePeriod(Bank bank, int pulsePeriod_us);
 
private:
    std::vector<ServoChannel> m_servoChannels;
};
 
}  // namespace rev::servohub