cs_SystemTime.h

Go to the documentation of this file.

 
#pragma once
 
#include <drivers/cs_Timer.h>
#include <events/cs_EventListener.h>
#include <protocol/cs_Typedefs.h>
#include <stdint.h>
#include <test/cs_TestAccess.h>
#include <time/cs_Time.h>
#include <time/cs_TimeOfDay.h>
#include <time/cs_TimeSyncMessage.h>
#include <util/cs_Coroutine.h>
 
class SystemTime : public EventListener {
    friend class TestAccess<SystemTime>;
 
public:
    void init();
 
    virtual void handleEvent(event_t& event);
    virtual ~SystemTime() = default;
 
    // ======================== Utility functions ========================
 
    static uint32_t posix();
 
    static Time now();
 
    static DayOfWeek day();
 
    static uint32_t up();
 
    static high_resolution_time_stamp_t getSynchronizedStamp();
 
    // ======================== Setters ========================
 
    static cs_ret_code_t setTime(uint32_t time, bool throttled, bool sendToMesh);
 
    static cs_ret_code_t setSunTimes(const sun_time_t& sunTimes, bool throttled = true);
 
private:
    // ========================== Run time data and constants ============================
    // state data
    static uint32_t upTimeSec;
 
    // throttling: when not 0, block command
    static uint16_t throttleSetTimeCountdownTicks;
    static uint16_t throttleSetSunTimesCountdownTicks;
 
    // settings
    static constexpr auto TICK_TIME_MS                     = 500;
 
    // Time stamp will be updated at a low rate, to maintain precision. Must be lower than RTC overflow time.
    static constexpr uint16_t TIME_UPDATE_PERIOD_MS        = (60 * 1000);
 
    // Time shouldn't differ more than 1 minute.
    static constexpr uint16_t THROTTLE_SET_TIME_TICKS      = (60 * 1000 / TICK_TIME_MS);
 
    // Sun time shouldn't differ more than 30 minutes.
    static constexpr uint16_t THROTTLE_SET_SUN_TIMES_TICKS = (30 * 60 * 1000 / TICK_TIME_MS);
 
    // timing features
    static app_timer_t appTimerData;
    static app_timer_id_t appTimerId;
 
    static void scheduleNextTick();
 
    static void tick(void* unused);
 
    // ===================== mesh posix time sync implementation =====================
 
    // ---------------- constants ----------------
 
    static constexpr uint32_t reboot_sync_timeout_ms();
 
    static constexpr uint32_t root_clock_update_period_ms();
 
    static constexpr uint32_t root_clock_reelection_timeout_ms();
 
    static constexpr stone_id_t stone_id_init();
 
    static constexpr uint8_t timestamp_version_lollipop_max();
 
    static constexpr uint8_t timestamp_version_min_valid();
 
    // -------------- runtime variables ----------------
 
    static uint32_t rtcCountOfLastSecondIncrement;
 
    static stone_id_t myId;
 
    static high_resolution_time_stamp_t rootTime;
 
    static uint32_t rtcCountOfLastRootTimeUpdate;
 
    static uint32_t uptimeOfLastTimeSyncMessage;
 
    static stone_id_t rootClockId;
 
    static Coroutine syncTimeCoroutine;
 
    // ------------------ Method definitions ------------------
 
    static uint32_t syncTimeCoroutineAction();
 
    static uint8_t timeStampVersion();
 
    static void onTimeSyncMessageReceive(time_sync_message_t syncmessage);
    static void setRootTimeStamp(high_resolution_time_stamp_t stamp, stone_id_t id, uint32_t rtcCount);
 
    static void updateRootTimeStamp(uint32_t rtcCount);
 
    static void sendTimeSyncMessage(high_resolution_time_stamp_t stamp, stone_id_t id, bool reliable = false);
 
    static bool meIsRootClock();
 
    static bool isRootClock(stone_id_t candidate);
 
    bool isOnlyReceiveByThisDevice(cmd_source_with_counter_t counted_source);
 
    static bool reelectionPeriodTimedOut();
 
    static bool rebootTimedOut();
 
    // ==========================================
    // =========== Debug functions ==============
    // ==========================================
 
    static constexpr uint32_t debugSyncTimeMessagePeriodMs();
    static Coroutine debugSyncTimeCoroutine;
 
    static void initDebug();
 
    static void publishSyncMessageForTesting();
    static void pushSyncMessageToTestSuite(time_sync_message_t& syncmessage);
};