antenna.hpp

Go to the documentation of this file.

/*
 *  SatNOGS-COMMS control library
 *
 *  Copyright (C) 2024-2025, Libre Space Foundation <http://libre.space>
 *
 *  This program 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.
 *
 *  This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  SPDX-License-Identifier: GNU General Public License v3.0 or later
 */
 
#pragma once
 
#include <cstdint>
#include <satnogs-comms-lib/bsp/chrono.hpp>
#include <satnogs-comms-lib/bsp/gpio.hpp>
#include <satnogs-comms-lib/bsp/i2c.hpp>
#include <satnogs-comms-lib/exception.hpp>
#include <satnogs-comms-lib/radio.hpp>
 
namespace satnogs::comms::lib
{

class antenna
{
public:
  enum class tlm : uint8_t
  {
    DEPLOYED,
    UPTIME,
    TEMPERATURE,
    VOLTAGE,
    CURRENT
  };
 
  antenna(const char *name, uint32_t nelems);
 
  virtual void
  enable(bool en);
 
  virtual bool
  detect(uint32_t idx);
 
  virtual void
  deploy(uint32_t idx, bool en);
 
  virtual void
  deploy_backup(uint32_t idx, bool en);
 
  const char *
  name() const;
 
  uint32_t
  nelems() const;
 
  virtual void
  telemetry(tlm t, float &res);
 
  virtual void
  telemetry(tlm t, uint32_t &res);
 
  virtual void
  telemetry(tlm t, bool &res);
 
  virtual void
  telemetry(tlm t, uint32_t idx, float &res);
 
  virtual void
  telemetry(tlm t, uint32_t idx, uint32_t &res);
 
  virtual void
  telemetry(tlm t, uint32_t idx, bool &res);
 
protected:
  const etl::string<32> m_name;
  const uint32_t        m_nelems;
};

 
} // namespace satnogs::comms::lib