time.hpp

Go to the documentation of this file.

/*
 *  SatNOGS-COMMS MCU software
 *
 *  Copyright (C) 2024, 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 "bsp/bsp.hpp"
#include <etl/string.h>
#include <time.h>
#include <zephyr/device.h>
#include <zephyr/drivers/gnss.h>
#include <zephyr/drivers/rtc.h>
#include <zephyr/drivers/uart.h>
#include <zephyr/kernel.h>
#include <zephyr/logging/log.h>
#include <zephyr/sys/timeutil.h>
 
namespace satnogs::comms
{

class time
{
public:
  static time &
  get_instance()
  {
    static time instance;
    return instance;
  }

  enum class time_src : uint8_t
  {
    GNSS_ASSISTED_RTC = 0, 
    GNSS_ONLY =
        1, 
    UPTIME =
        2, 
  };
 
  static constexpr size_t to_string_max_size = 20;
  enum class time_granularity
  {
    YEAR,
    MONTH,
    DAY,
    HOUR,
    MIN,
    SEC
  };
 
  /* Singleton */
  time(time const &) = delete;
 
  void
  operator=(time const &) = delete;
 
  void
  gnss_data_cb(const struct device *dev, const struct gnss_data *data);
 
  time_src
  get(uint64_t &t);
 
  time_src
  get(struct tm &t);
 
  void
  set(const struct tm &t);
 
  void
  gnss(struct gnss_data &data);
 
  uint64_t
  uptime();
 
  uint64_t
  last_gnss_update_uptime();
 
  uint64_t
  last_nmea_update_uptime();
 
  size_t
  to_string(const struct tm &tm, etl::istring &s,
            time::time_granularity granularity) const;
  size_t
  to_string(const struct tm &tm, etl::istring &s) const;
 
  class to_string_exception : public lib::exception
  {
  public:
    to_string_exception(const char *file_name, int line)
        : exception(exception::severity::MINOR, file_name, line,
                    error_msg{"Convertion of date to string failed", "tmtostr",
                              ENOTSUP})
    {
    }
  };
 
private:
  /* Milliseconds Since Epoch (January 1, 1970, UTC.) */
  uint64_t               m_millis_since_epoch_gnss;
  bool                   m_gnss_received_fix;
  int64_t                m_last_gnss_update_uptime;
  int64_t                m_last_nmea_update_uptime;
  const struct device   *m_rtc;
  bool                   m_init;
  mutable struct k_mutex m_mtx;
  struct gnss_data       m_gnss_data;
 
  time();
};
 
} // namespace satnogs::comms