gpio_power_iface.hpp

Go to the documentation of this file.

//
// Copyright 2021 Ettus Research, a National Instruments Brand
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#pragma once

#include <uhd/config.hpp>
#include <uhd/features/discoverable_feature.hpp>
#include <memory>
#include <string>
#include <vector>

namespace uhd { namespace features {

class UHD_API gpio_power_iface : public discoverable_feature
{
public:
    using sptr = std::shared_ptr<gpio_power_iface>;

    static discoverable_feature::feature_id_t get_feature_id()
    {
        return discoverable_feature::GPIO_POWER;
    }

    std::string get_feature_name() const
    {
        return "GPIO power configuration";
    }

    virtual ~gpio_power_iface() = default;

    virtual std::vector<std::string> get_supported_voltages(
        const std::string& port) const = 0;

    virtual void set_port_voltage(
        const std::string& port, const std::string& voltage) = 0;

    virtual std::string get_port_voltage(const std::string& port) const = 0;

    virtual void set_external_power(const std::string& port, bool enable) = 0;

    virtual std::string get_external_power_status(const std::string& port) const = 0;
};

}} // namespace uhd::features