supla-device/clock_8h_source.html

// SPDX-FileCopyrightText: AC SOFTWARE SP. Z O.O.

// SPDX-License-Identifier: GPL-2.0-or-later


#ifndef SRC_SUPLA_CLOCK_CLOCK_H_

#define SRC_SUPLA_CLOCK_CLOCK_H_


#include <supla-common/proto.h>

#include <supla/element.h>

#include <time.h>

#include <supla/control/hvac_base.h>


namespace Supla {


const char AutomaticTimeSyncCfgTag[] = "timesync_auto";


class Clock : public Element {

 public:

  static bool IsReady();


  static int GetYear();


  static int GetMonth();


  static int GetDay();


  static int GetDayOfWeek();


  static enum DayOfWeek GetHvacDayOfWeek();


  static int GetHour();


  static int GetQuarter();


  static int GetMin();


  static int GetSec();


  static time_t GetTimeStamp();

  static bool GetLocalTime(struct tm *timeInfo);


  static Clock* GetInstance();


  Clock();

  virtual ~Clock();


  virtual bool isReady();

  virtual int getYear();

  virtual int getMonth();

  virtual int getDay();

  virtual int getDayOfWeek();

  virtual enum DayOfWeek getHvacDayOfWeek();

  virtual int getHour();

  virtual int getQuarter();

  virtual int getMin();

  virtual int getSec();

  virtual time_t getTimeStamp();

  virtual bool getLocalTime(struct tm *timeInfo);


  void onTimer() override;

  bool iterateConnected() override;

  void onLoadConfig(SuplaDeviceClass *sdc) override;

  void onDeviceConfigChange(uint64_t fieldBit) override;


  virtual void parseLocaltimeFromServer(TSDC_UserLocalTimeResult *result);


  void setUseAutomaticTimeSyncRemoteConfig(bool value);

  void printCurrentTime(const char *prefix = nullptr);


  void setAutomaticTimeSync(bool value) { automaticTimeSync = value; }


 protected:

  void setSystemTime(time_t newTime);

  time_t localtime = {};

  uint32_t lastServerUpdate = 0;

  uint32_t lastMillis = 0;

  bool isClockReady = false;

  bool automaticTimeSync = true;

  bool useAutomaticTimeSyncRemoteConfig = true;

};


};  // namespace Supla


#endif  // SRC_SUPLA_CLOCK_CLOCK_H_

SuplaDeviceClass
Definition SuplaDevice.h:167

Supla::Clock
Definition clock.h:16

Supla::Clock::GetMonth
static int GetMonth()
Returns month from Clock (if is set and ready).
Definition clock.cpp:36

Supla::Clock::GetHvacDayOfWeek
static enum DayOfWeek GetHvacDayOfWeek()
Returns day of week from Clock to HVAC (if is set and ready).
Definition clock.cpp:57

Supla::Clock::iterateConnected
bool iterateConnected() override
Method called on each SuplaDevice iteration when device is connected and registered to Supla server o...
Definition clock.cpp:238

Supla::Clock::GetInstance
static Clock * GetInstance()
Returns pointer of Clock.
Definition clock.cpp:103

Supla::Clock::GetHour
static int GetHour()
Returns hour from Clock (if is set and ready).
Definition clock.cpp:64

Supla::Clock::GetYear
static int GetYear()
Returns year from Clock (if is set and ready).
Definition clock.cpp:29

Supla::Clock::GetDayOfWeek
static int GetDayOfWeek()
Returns day of week from Clock (if is set and ready).
Definition clock.cpp:50

Supla::Clock::IsReady
static bool IsReady()
Checks if Clock is set and ready.
Definition clock.cpp:22

Supla::Clock::onTimer
void onTimer() override
Method called on timer interupt.
Definition clock.cpp:222

Supla::Clock::GetDay
static int GetDay()
Returns day from Clock (if is set and ready).
Definition clock.cpp:43

Supla::Clock::onLoadConfig
void onLoadConfig(SuplaDeviceClass *sdc) override
First method called on element in SuplaDevice.begin().
Definition clock.cpp:255

Supla::Clock::GetSec
static int GetSec()
Returns seconds from Clock (if is set and ready).
Definition clock.cpp:85

Supla::Clock::onDeviceConfigChange
void onDeviceConfigChange(uint64_t fieldBit) override
Method called when device config is changed.
Definition clock.cpp:279

Supla::Clock::GetMin
static int GetMin()
Returns minutes from Clock (if is set and ready).
Definition clock.cpp:78

Supla::Clock::GetQuarter
static int GetQuarter()
Returns quarter from Clock (if is set and ready).
Definition clock.cpp:71

Supla::Element
Base class for all elements of SuplaDevice.
Definition element.h:30

TSDC_UserLocalTimeResult
Definition proto.h:2688