From 388f618b59bbfc2cdead2f5b8eb28559ae0b85b0 Mon Sep 17 00:00:00 2001 From: Tinyu Date: Sun, 19 Dec 2021 15:00:27 +0800 Subject: [PATCH 01/27] Update library.json --- library.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.json b/library.json index ff85e8b..fbcca49 100644 --- a/library.json +++ b/library.json @@ -11,6 +11,6 @@ "url": "https://github.com/m5stack/M5_BM8563.git" }, "version": "0.0.1", - "framework": "arduino", + "frameworks": "arduino", "platforms": "espressif32" } From ec5c1373938647d820ad850d5df04b1b20515e58 Mon Sep 17 00:00:00 2001 From: Tinyu Date: Sun, 9 Jan 2022 17:03:54 +0800 Subject: [PATCH 02/27] Restricted time and date input --- examples/set_date/set_date.ino | 51 ++++---- src/M5_BM8563.cpp | 227 ++++++++++++--------------------- src/M5_BM8563.h | 148 ++++++++++----------- 3 files changed, 176 insertions(+), 250 deletions(-) diff --git a/examples/set_date/set_date.ino b/examples/set_date/set_date.ino index e23fb70..8206d9a 100644 --- a/examples/set_date/set_date.ino +++ b/examples/set_date/set_date.ino @@ -8,38 +8,35 @@ rtc_date_type rtc_date_unit; char str_buffer[64]; void showlog(rtc_time_type *rtc_time, rtc_date_type *rtc_date) { - sprintf(str_buffer,"RTC Time Now is %02d:%02d:%02d", - rtc_time->Hours, rtc_time->Minutes, rtc_time->Seconds); + sprintf(str_buffer, "RTC Time Now is %02d:%02d:%02d", rtc_time->Hours, + rtc_time->Minutes, rtc_time->Seconds); Serial.println(str_buffer); - sprintf(str_buffer,"RTC Date Now is %02d:%02d:%02d WeekDay:%02d", - rtc_date->Year, rtc_date->Month, rtc_date->Date, rtc_date->WeekDay); + sprintf(str_buffer, "RTC Date Now is %02d:%02d:%02d WeekDay:%02d", + rtc_date->Year, rtc_date->Month, rtc_date->Date, rtc_date->WeekDay); Serial.println(str_buffer); } -void setup() -{ - RTC.begin(); - Serial.begin(115200); - delay(10); - rtc_time_unit.Hours = 14; - rtc_time_unit.Minutes = 40; - rtc_time_unit.Seconds = 5; - - rtc_date_unit.WeekDay = 4; - rtc_date_unit.Month = 7; - rtc_date_unit.Date = 15; - rtc_date_unit.Year = 2021; - - RTC.setTime(&rtc_time_unit); - RTC.setDate(&rtc_date_unit); +void setup() { + RTC.begin(); + Serial.begin(115200); + delay(10); + rtc_time_unit.Hours = 14; + rtc_time_unit.Minutes = 40; + rtc_time_unit.Seconds = 5; + + rtc_date_unit.WeekDay = 4; + rtc_date_unit.Month = 7; + rtc_date_unit.Date = 15; + rtc_date_unit.Year = 2021; + + RTC.setTime(&rtc_time_unit); + RTC.setDate(&rtc_date_unit); } -void loop() -{ +void loop() { + RTC.getTime(&rtc_time_unit); + RTC.getDate(&rtc_date_unit); - RTC.getTime(&rtc_time_unit); - RTC.getDate(&rtc_date_unit); - - showlog(&rtc_time_unit, &rtc_date_unit); - delay(300); + showlog(&rtc_time_unit, &rtc_date_unit); + delay(300); } diff --git a/src/M5_BM8563.cpp b/src/M5_BM8563.cpp index ae9ab1b..20acfa3 100644 --- a/src/M5_BM8563.cpp +++ b/src/M5_BM8563.cpp @@ -1,52 +1,41 @@ #include "M5_BM8563.h" -BM8563::BM8563() -{ - _addr = DEVICE_ADDR; -} +BM8563::BM8563() { _addr = DEVICE_ADDR; } -BM8563::BM8563(uint8_t addr) -{ - _addr = addr; -} +BM8563::BM8563(uint8_t addr) { _addr = addr; } -void BM8563::begin() -{ +void BM8563::begin() { _wire = &Wire; _wire->begin(); - writeReg(0x00,0x00); - writeReg(0x01,0x00); - writeReg(0x0D,0x00); + writeReg(0x00, 0x00); + writeReg(0x01, 0x00); + writeReg(0x0D, 0x00); } -void BM8563::begin(TwoWire *wire) -{ +void BM8563::begin(TwoWire *wire) { _wire = wire; _wire->begin(); - writeReg(0x00,0x00); - writeReg(0x01,0x00); - writeReg(0x0D,0x00); + writeReg(0x00, 0x00); + writeReg(0x01, 0x00); + writeReg(0x0D, 0x00); } -void BM8563::begin(TwoWire *wire, uint8_t scl, uint8_t sda, uint32_t i2c_freq) -{ +void BM8563::begin(TwoWire *wire, uint8_t scl, uint8_t sda, uint32_t i2c_freq) { _wire = wire; _wire->begin(sda, scl, i2c_freq); - writeReg(0x00,0x00); - writeReg(0x01,0x00); - writeReg(0x0D,0x00); + writeReg(0x00, 0x00); + writeReg(0x01, 0x00); + writeReg(0x0D, 0x00); } -void BM8563::writeReg(uint8_t reg, uint8_t data) -{ +void BM8563::writeReg(uint8_t reg, uint8_t data) { _wire->beginTransmission(0x51); _wire->write(reg); _wire->write(data); _wire->endTransmission(); } -uint8_t BM8563::ReadReg(uint8_t reg) -{ +uint8_t BM8563::ReadReg(uint8_t reg) { _wire->beginTransmission(0x51); _wire->write(reg); _wire->endTransmission(false); @@ -54,15 +43,12 @@ uint8_t BM8563::ReadReg(uint8_t reg) return _wire->read(); } -void BM8563::getBm8563Time(void) -{ +void BM8563::getBm8563Time(void) { _wire->beginTransmission(0x51); _wire->write(0x02); _wire->endTransmission(false); _wire->requestFrom(0x51, 7); - while (_wire->available()) - { - + while (_wire->available()) { _trdata[0] = _wire->read(); _trdata[1] = _wire->read(); _trdata[2] = _wire->read(); @@ -77,12 +63,10 @@ void BM8563::getBm8563Time(void) Str2Time(); } -void BM8563::Str2Time(void) -{ - +void BM8563::Str2Time(void) { Second = (asc[0] - 0x30) * 10 + asc[1] - 0x30; Minute = (asc[2] - 0x30) * 10 + asc[3] - 0x30; - Hour = (asc[4] - 0x30) * 10 + asc[5] - 0x30; + Hour = (asc[4] - 0x30) * 10 + asc[5] - 0x30; /* uint8_t Hour; uint8_t Week; @@ -92,18 +76,16 @@ void BM8563::Str2Time(void) */ } -void BM8563::DataMask() -{ - - _trdata[0] = _trdata[0] & 0x7f; //秒 - _trdata[1] = _trdata[1] & 0x7f; //分 - _trdata[2] = _trdata[2] & 0x3f; //时 +void BM8563::DataMask() { + _trdata[0] = _trdata[0] & 0x7f; //秒 + _trdata[1] = _trdata[1] & 0x7f; //分 + _trdata[2] = _trdata[2] & 0x3f; //时 - _trdata[3] = _trdata[3] & 0x3f; //日 - _trdata[4] = _trdata[4] & 0x07; //星期 - _trdata[5] = _trdata[5] & 0x1f; //月 + _trdata[3] = _trdata[3] & 0x3f; //日 + _trdata[4] = _trdata[4] & 0x07; //星期 + _trdata[5] = _trdata[5] & 0x1f; //月 - _trdata[6] = _trdata[6] & 0xff; //年 + _trdata[6] = _trdata[6] & 0xff; //年 } /******************************************************************** 函 数 名： void Bcd2asc(void) @@ -113,29 +95,25 @@ void BM8563::DataMask() 入口参数： 返 回 值：无 ***********************************************************************/ -void BM8563::Bcd2asc(void) -{ +void BM8563::Bcd2asc(void) { uint8_t i, j; - for (j = 0, i = 0; i < 7; i++) - { - asc[j++] = (_trdata[i] & 0xf0) >> 4 | 0x30; /*格式为: 秒 分 时 日 月 星期 年 */ + for (j = 0, i = 0; i < 7; i++) { + asc[j++] = + (_trdata[i] & 0xf0) >> 4 | 0x30; /*格式为: 秒 分 时 日 月 星期 年 */ asc[j++] = (_trdata[i] & 0x0f) | 0x30; } } -uint8_t BM8563::Bcd2ToByte(uint8_t Value) -{ +uint8_t BM8563::Bcd2ToByte(uint8_t Value) { uint8_t tmp = 0; - tmp = ((uint8_t)(Value & (uint8_t)0xF0) >> (uint8_t)0x4) * 10; + tmp = ((uint8_t)(Value & (uint8_t)0xF0) >> (uint8_t)0x4) * 10; return (tmp + (Value & (uint8_t)0x0F)); } -uint8_t BM8563::ByteToBcd2(uint8_t Value) -{ +uint8_t BM8563::ByteToBcd2(uint8_t Value) { uint8_t bcdhigh = 0; - while (Value >= 10) - { + while (Value >= 10) { bcdhigh++; Value -= 10; } @@ -143,10 +121,8 @@ uint8_t BM8563::ByteToBcd2(uint8_t Value) return ((uint8_t)(bcdhigh << 4) | Value); } -void BM8563::getTime(rtc_time_type *RTC_TimeStruct) -{ - - //if() +void BM8563::getTime(rtc_time_type *RTC_TimeStruct) { + // if() uint8_t buf[3] = {0}; _wire->beginTransmission(0x51); @@ -154,24 +130,21 @@ void BM8563::getTime(rtc_time_type *RTC_TimeStruct) _wire->endTransmission(false); _wire->requestFrom(0x51, 3); - while (_wire->available()) - { - + while (_wire->available()) { buf[0] = _wire->read(); buf[1] = _wire->read(); buf[2] = _wire->read(); } - RTC_TimeStruct->Seconds = Bcd2ToByte(buf[0] & 0x7f); //秒 - RTC_TimeStruct->Minutes = Bcd2ToByte(buf[1] & 0x7f); //分 - RTC_TimeStruct->Hours = Bcd2ToByte(buf[2] & 0x3f); //时 + RTC_TimeStruct->Seconds = Bcd2ToByte(buf[0] & 0x7f); //秒 + RTC_TimeStruct->Minutes = Bcd2ToByte(buf[1] & 0x7f); //分 + RTC_TimeStruct->Hours = Bcd2ToByte(buf[2] & 0x3f); //时 } -void BM8563::setTime(rtc_time_type *RTC_TimeStruct) -{ - - if (RTC_TimeStruct == NULL) - return; +int BM8563::setTime(rtc_time_type *RTC_TimeStruct) { + if (RTC_TimeStruct == NULL || RTC_TimeStruct->Hours > 24 || + RTC_TimeStruct->Minutes > 60 || RTC_TimeStruct->Seconds > 60) + return 0; _wire->beginTransmission(0x51); _wire->write(0x02); @@ -179,11 +152,10 @@ void BM8563::setTime(rtc_time_type *RTC_TimeStruct) _wire->write(ByteToBcd2(RTC_TimeStruct->Minutes)); _wire->write(ByteToBcd2(RTC_TimeStruct->Hours)); _wire->endTransmission(); + return 1; } -void BM8563::getDate(rtc_date_type *RTC_DateStruct) -{ - +void BM8563::getDate(rtc_date_type *RTC_DateStruct) { uint8_t buf[4] = {0}; _wire->beginTransmission(0x51); @@ -191,62 +163,51 @@ void BM8563::getDate(rtc_date_type *RTC_DateStruct) _wire->endTransmission(false); _wire->requestFrom(0x51, 4); - while (_wire->available()) - { - + while (_wire->available()) { buf[0] = _wire->read(); buf[1] = _wire->read(); buf[2] = _wire->read(); buf[3] = _wire->read(); } - RTC_DateStruct->Date = Bcd2ToByte(buf[0] & 0x3f); + RTC_DateStruct->Date = Bcd2ToByte(buf[0] & 0x3f); RTC_DateStruct->WeekDay = Bcd2ToByte(buf[1] & 0x07); - RTC_DateStruct->Month = Bcd2ToByte(buf[2] & 0x1f); + RTC_DateStruct->Month = Bcd2ToByte(buf[2] & 0x1f); - if (buf[2] & 0x80) - { + if (buf[2] & 0x80) { RTC_DateStruct->Year = 1900 + Bcd2ToByte(buf[3] & 0xff); - } - else - { + } else { RTC_DateStruct->Year = 2000 + Bcd2ToByte(buf[3] & 0xff); } } -void BM8563::setDate(rtc_date_type *RTC_DateStruct) -{ - - if (RTC_DateStruct == NULL) - return; +int BM8563::setDate(rtc_date_type *RTC_DateStruct) { + if (RTC_DateStruct == NULL || RTC_DateStruct->WeekDay > 7 || + RTC_DateStruct->Date > 31 || RTC_DateStruct->Month > 12) + return 0; _wire->beginTransmission(0x51); _wire->write(0x05); _wire->write(ByteToBcd2(RTC_DateStruct->Date)); _wire->write(ByteToBcd2(RTC_DateStruct->WeekDay)); - if (RTC_DateStruct->Year < 2000) - { - + if (RTC_DateStruct->Year < 2000) { _wire->write(ByteToBcd2(RTC_DateStruct->Month) | 0x80); _wire->write(ByteToBcd2((uint8_t)(RTC_DateStruct->Year % 100))); - } - else - { + } else { /* code */ _wire->write(ByteToBcd2(RTC_DateStruct->Month) | 0x00); _wire->write(ByteToBcd2((uint8_t)(RTC_DateStruct->Year % 100))); } _wire->endTransmission(); + return 1; } -int BM8563::setAlarmIRQ(int afterSeconds) -{ +int BM8563::setAlarmIRQ(int afterSeconds) { uint8_t reg_value = 0; - reg_value = ReadReg(0x01); + reg_value = ReadReg(0x01); - if (afterSeconds < 0) - { + if (afterSeconds < 0) { reg_value &= ~(1 << 0); writeReg(0x01, reg_value); reg_value = 0x03; @@ -255,14 +216,11 @@ int BM8563::setAlarmIRQ(int afterSeconds) } uint8_t type_value = 2; - uint8_t div = 1; - if (afterSeconds > 255) - { - div = 60; + uint8_t div = 1; + if (afterSeconds > 255) { + div = 60; type_value = 0x83; - } - else - { + } else { type_value = 0x82; } @@ -276,19 +234,16 @@ int BM8563::setAlarmIRQ(int afterSeconds) return afterSeconds * div; } -int BM8563::setAlarmIRQ(const rtc_time_type &RTC_TimeStruct) -{ +int BM8563::setAlarmIRQ(const rtc_time_type &RTC_TimeStruct) { uint8_t irq_enable = false; uint8_t out_buf[4] = {0x80, 0x80, 0x80, 0x80}; - if (RTC_TimeStruct.Minutes >= 0) - { + if (RTC_TimeStruct.Minutes >= 0) { irq_enable = true; out_buf[0] = ByteToBcd2(RTC_TimeStruct.Minutes) & 0x7f; } - if (RTC_TimeStruct.Hours >= 0) - { + if (RTC_TimeStruct.Hours >= 0) { irq_enable = true; out_buf[1] = ByteToBcd2(RTC_TimeStruct.Hours) & 0x3f; } @@ -298,17 +253,13 @@ int BM8563::setAlarmIRQ(const rtc_time_type &RTC_TimeStruct) uint8_t reg_value = ReadReg(0x01); - if (irq_enable) - { + if (irq_enable) { reg_value |= (1 << 1); - } - else - { + } else { reg_value &= ~(1 << 1); } - for (int i = 0; i < 4; i++) - { + for (int i = 0; i < 4; i++) { writeReg(0x09 + i, out_buf[i]); } writeReg(0x01, reg_value); @@ -316,48 +267,40 @@ int BM8563::setAlarmIRQ(const rtc_time_type &RTC_TimeStruct) return irq_enable ? 1 : 0; } -int BM8563::setAlarmIRQ(const rtc_date_type &RTC_DateStruct, const rtc_time_type &RTC_TimeStruct) -{ +int BM8563::setAlarmIRQ(const rtc_date_type &RTC_DateStruct, + const rtc_time_type &RTC_TimeStruct) { uint8_t irq_enable = false; uint8_t out_buf[4] = {0x80, 0x80, 0x80, 0x80}; - if (RTC_TimeStruct.Minutes >= 0) - { + if (RTC_TimeStruct.Minutes >= 0) { irq_enable = true; out_buf[0] = ByteToBcd2(RTC_TimeStruct.Minutes) & 0x7f; } - if (RTC_TimeStruct.Hours >= 0) - { + if (RTC_TimeStruct.Hours >= 0) { irq_enable = true; out_buf[1] = ByteToBcd2(RTC_TimeStruct.Hours) & 0x3f; } - if (RTC_DateStruct.Date >= 0) - { + if (RTC_DateStruct.Date >= 0) { irq_enable = true; out_buf[2] = ByteToBcd2(RTC_DateStruct.Date) & 0x3f; } - if (RTC_DateStruct.WeekDay >= 0) - { + if (RTC_DateStruct.WeekDay >= 0) { irq_enable = true; out_buf[3] = ByteToBcd2(RTC_DateStruct.WeekDay) & 0x07; } uint8_t reg_value = ReadReg(0x01); - if (irq_enable) - { + if (irq_enable) { reg_value |= (1 << 1); - } - else - { + } else { reg_value &= ~(1 << 1); } - for (int i = 0; i < 4; i++) - { + for (int i = 0; i < 4; i++) { writeReg(0x09 + i, out_buf[i]); } writeReg(0x01, reg_value); @@ -365,13 +308,11 @@ int BM8563::setAlarmIRQ(const rtc_date_type &RTC_DateStruct, const rtc_time_type return irq_enable ? 1 : 0; } -void BM8563::clearIRQ() -{ +void BM8563::clearIRQ() { uint8_t data = ReadReg(0x01); writeReg(0x01, data & 0xf3); } -void BM8563::disableIRQ() -{ +void BM8563::disableIRQ() { clearIRQ(); uint8_t data = ReadReg(0x01); writeReg(0x01, data & 0xfC); diff --git a/src/M5_BM8563.h b/src/M5_BM8563.h index 372061d..7f5cba5 100644 --- a/src/M5_BM8563.h +++ b/src/M5_BM8563.h @@ -1,94 +1,82 @@ #ifndef __M5_BM8563_RTC_H__ #define __M5_BM8563_RTC_H__ -#include "Arduino.h" #include +#include "Arduino.h" + #define DEVICE_ADDR 0x51 -struct rtc_time_type -{ - uint8_t Hours; - uint8_t Minutes; - uint8_t Seconds; - rtc_time_type(uint8_t hours = 0, uint8_t minutes = 0, uint8_t seconds = 0) - : Hours { hours } - , Minutes { minutes } - , Seconds { seconds } - {} +struct rtc_time_type { + uint8_t Hours; + uint8_t Minutes; + uint8_t Seconds; + rtc_time_type(uint8_t hours = 0, uint8_t minutes = 0, uint8_t seconds = 0) + : Hours{hours}, Minutes{minutes}, Seconds{seconds} {} }; -struct rtc_date_type -{ - uint16_t Year; - uint8_t Month; - uint8_t Date; - uint8_t WeekDay; - rtc_date_type(uint16_t year = 2000, uint8_t month = 0, uint8_t date = 0, uint8_t weekDay = 0) - : Year { year } - , Month { month } - , Date { date } - , WeekDay { weekDay } - {} +struct rtc_date_type { + uint16_t Year; + uint8_t Month; + uint8_t Date; + uint8_t WeekDay; + rtc_date_type(uint16_t year = 2000, uint8_t month = 0, uint8_t date = 0, + uint8_t weekDay = 0) + : Year{year}, Month{month}, Date{date}, WeekDay{weekDay} {} }; - -class BM8563 { - -private: - void Bcd2asc(void); - void DataMask(); - void Str2Time(void); - void writeReg(uint8_t reg, uint8_t data); - uint8_t ReadReg(uint8_t reg); - uint8_t Bcd2ToByte(uint8_t Value); - uint8_t ByteToBcd2(uint8_t Value); - - -private: - - /*定义数组用来存储读取的时间数据 */ - uint8_t _trdata[7]; - /*定义数组用来存储转换的 asc 码时间数据*/ - //uint8_t asc[14]; - uint8_t _addr; - TwoWire *_wire; - -public: - - BM8563(); - BM8563(uint8_t addr); - void begin(); - void begin(TwoWire *wire); - void begin(TwoWire *wire, uint8_t scl, uint8_t sda, uint32_t i2c_freq); - void getBm8563Time(void); - - void setTime(rtc_time_type* RTC_TimeStruct); - void setDate(rtc_date_type* RTC_DateStruct); - - void getTime(rtc_time_type* RTC_TimeStruct); - void getDate(rtc_date_type* RTC_DateStruct); - - int setAlarmIRQ(int afterSeconds); - int setAlarmIRQ( const rtc_time_type &RTC_TimeStruct); - int setAlarmIRQ( const rtc_date_type &RTC_DateStruct, const rtc_time_type &RTC_TimeStruct); - - void clearIRQ(); - void disableIRQ(); - -public: - uint8_t Second; - uint8_t Minute; - uint8_t Hour; - uint8_t Week; - uint8_t Day; - uint8_t Month; - uint8_t Year; - uint8_t DateString[9]; - uint8_t TimeString[9]; - - uint8_t asc[14]; - +class BM8563 { + private: + void Bcd2asc(void); + void DataMask(); + void Str2Time(void); + void writeReg(uint8_t reg, uint8_t data); + uint8_t ReadReg(uint8_t reg); + uint8_t Bcd2ToByte(uint8_t Value); + uint8_t ByteToBcd2(uint8_t Value); + + private: + /*定义数组用来存储读取的时间数据 */ + uint8_t _trdata[7]; + /*定义数组用来存储转换的 asc 码时间数据*/ + // uint8_t asc[14]; + uint8_t _addr; + TwoWire *_wire; + + public: + BM8563(); + BM8563(uint8_t addr); + void begin(); + void begin(TwoWire *wire); + void begin(TwoWire *wire, uint8_t scl, uint8_t sda, uint32_t i2c_freq); + void getBm8563Time(void); + + int setTime(rtc_time_type *RTC_TimeStruct); + int setDate(rtc_date_type *RTC_DateStruct); + + void getTime(rtc_time_type *RTC_TimeStruct); + void getDate(rtc_date_type *RTC_DateStruct); + + int setAlarmIRQ(int afterSeconds); + int setAlarmIRQ(const rtc_time_type &RTC_TimeStruct); + int setAlarmIRQ(const rtc_date_type &RTC_DateStruct, + const rtc_time_type &RTC_TimeStruct); + + void clearIRQ(); + void disableIRQ(); + + public: + uint8_t Second; + uint8_t Minute; + uint8_t Hour; + uint8_t Week; + uint8_t Day; + uint8_t Month; + uint8_t Year; + uint8_t DateString[9]; + uint8_t TimeString[9]; + + uint8_t asc[14]; }; #endif From 1c8f37329f1d1879c47469c0b545bd87215921ef Mon Sep 17 00:00:00 2001 From: Tinyu Date: Mon, 16 May 2022 13:57:39 +0800 Subject: [PATCH 03/27] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 55e1bb5..c478142 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ M5Stack-**UNIT RTC** related programs.compatible with BM8563 and HYM8563. ## Related Link -[Docment & Datasheet](https://docs.m5stack.com/en/unit/rtc) +[Document & Datasheet](https://docs.m5stack.com/en/unit/rtc) ## License From 57b060c1f470f1444dabe775a4af40dad7b7803a Mon Sep 17 00:00:00 2001 From: Tinyu Date: Fri, 15 Jul 2022 17:13:24 +0800 Subject: [PATCH 04/27] Init --- README.md | 8 +- .../Unit_RTC_M5Series/Unit_RTC_M5Series.ino | 56 +++++++++++ examples/set_date/set_date.ino | 42 -------- library.json | 10 +- library.properties | 12 +-- src/{M5_BM8563.cpp => Unit_RTC.cpp} | 96 +++++++++---------- src/{M5_BM8563.h => Unit_RTC.h} | 25 +++-- 7 files changed, 132 insertions(+), 117 deletions(-) create mode 100644 examples/Unit_RTC_M5Series/Unit_RTC_M5Series.ino delete mode 100644 examples/set_date/set_date.ino rename src/{M5_BM8563.cpp => Unit_RTC.cpp} (77%) rename src/{M5_BM8563.h => Unit_RTC.h} (81%) diff --git a/README.md b/README.md index c478142..a30e429 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ -# M5_BM8563 +# M5Unit-RTC ## Overview +### SKU:U126 + M5Stack-**UNIT RTC** related programs.compatible with BM8563 and HYM8563. ## Related Link -[Document & Datasheet](https://docs.m5stack.com/en/unit/rtc) +[Document & Datasheet - M5Unit-RTC](https://docs.m5stack.com/en/unit/rtc) ## License -[UNIT_ENV - MIT](LICENSE) +[M5Unit-RTC - MIT](LICENSE) diff --git a/examples/Unit_RTC_M5Series/Unit_RTC_M5Series.ino b/examples/Unit_RTC_M5Series/Unit_RTC_M5Series.ino new file mode 100644 index 0000000..4520ae9 --- /dev/null +++ b/examples/Unit_RTC_M5Series/Unit_RTC_M5Series.ino @@ -0,0 +1,56 @@ +/* +******************************************************************************* +* Copyright (c) 2021 by M5Stack +* Equipped with M5Series sample source code +* 配套 M5Series 示例源代码 +* Visit for more information: https://docs.m5stack.com/en/unit/rtc +* 获取更多资料请访问: https://docs.m5stack.com/zh_CN/unit/rtc +* +* Describe: Unit RTC. +* Date: 2022/7/15 +******************************************************************************* + Real-time time output on serial port every one second + 每个一秒在串口输出实时时间 +*/ +#include "Unit_RTC.h" + +Unit_RTC RTC; + +rtc_time_type rtc_time; +rtc_date_type rtc_date; + +char str_buffer[64]; + +void showlog(rtc_time_type *rtc_time, rtc_date_type *rtc_date) { + sprintf(str_buffer, "RTC Time Now is %02d:%02d:%02d", rtc_time->Hours, + rtc_time->Minutes, rtc_time->Seconds); + Serial.println(str_buffer); + sprintf(str_buffer, "RTC Date Now is %02d:%02d:%02d WeekDay:%02d", + rtc_date->Year, rtc_date->Month, rtc_date->Date, rtc_date->WeekDay); + Serial.println(str_buffer); +} + +void setup() { + RTC.begin(); + Serial.begin(115200); + delay(10); + rtc_time.Hours = 14; + rtc_time.Minutes = 40; + rtc_time.Seconds = 5; + + rtc_date.WeekDay = 4; + rtc_date.Month = 7; + rtc_date.Date = 15; + rtc_date.Year = 2021; + + RTC.setTime(&rtc_time); + RTC.setDate(&rtc_date); +} + +void loop() { + RTC.getTime(&rtc_time); + RTC.getDate(&rtc_date); + + showlog(&rtc_time, &rtc_date); + delay(300); +} diff --git a/examples/set_date/set_date.ino b/examples/set_date/set_date.ino deleted file mode 100644 index 8206d9a..0000000 --- a/examples/set_date/set_date.ino +++ /dev/null @@ -1,42 +0,0 @@ -#include "M5_BM8563.h" - -BM8563 RTC; - -rtc_time_type rtc_time_unit; -rtc_date_type rtc_date_unit; - -char str_buffer[64]; - -void showlog(rtc_time_type *rtc_time, rtc_date_type *rtc_date) { - sprintf(str_buffer, "RTC Time Now is %02d:%02d:%02d", rtc_time->Hours, - rtc_time->Minutes, rtc_time->Seconds); - Serial.println(str_buffer); - sprintf(str_buffer, "RTC Date Now is %02d:%02d:%02d WeekDay:%02d", - rtc_date->Year, rtc_date->Month, rtc_date->Date, rtc_date->WeekDay); - Serial.println(str_buffer); -} - -void setup() { - RTC.begin(); - Serial.begin(115200); - delay(10); - rtc_time_unit.Hours = 14; - rtc_time_unit.Minutes = 40; - rtc_time_unit.Seconds = 5; - - rtc_date_unit.WeekDay = 4; - rtc_date_unit.Month = 7; - rtc_date_unit.Date = 15; - rtc_date_unit.Year = 2021; - - RTC.setTime(&rtc_time_unit); - RTC.setDate(&rtc_date_unit); -} - -void loop() { - RTC.getTime(&rtc_time_unit); - RTC.getDate(&rtc_date_unit); - - showlog(&rtc_time_unit, &rtc_date_unit); - delay(300); -} diff --git a/library.json b/library.json index fbcca49..7126325 100644 --- a/library.json +++ b/library.json @@ -1,16 +1,16 @@ { - "name": "M5_BM8563", - "description": "Library for M5_BM8563 RTC", - "keywords": "BM8563 RTC", + "name": "M5Unit-RTC", + "description": "Library for M5Stack Unit RTC", + "keywords": "M5Stack Unit BM8563 RTC", "authors": { "name": "M5Stack", "url": "http://www.m5stack.com" }, "repository": { "type": "git", - "url": "https://github.com/m5stack/M5_BM8563.git" + "url": "https://github.com/m5stack/M5Unit-RTC.git" }, "version": "0.0.1", "frameworks": "arduino", "platforms": "espressif32" -} +} \ No newline at end of file diff --git a/library.properties b/library.properties index e6016e5..46a2844 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=M5_BM8563 +name=M5Unit-RTC version=0.0.1 author=M5Stack -maintainer=M5Stack,Sean -sentence=Library for M5_BM8563 RTC -paragraph=See more on http://M5Stack.com +maintainer=M5Stack +sentence=Library for BM8563 RTC +paragraph=See more on https://docs.m5stack.com/en/unit/rtc category=Device Control -url=https://github.com/m5stack/M5_BM8563 +url=https://github.com/m5stack/M5Unit-RTC architectures=esp32 -includes=M5_BM8563.h +includes=Unit_RTC.h diff --git a/src/M5_BM8563.cpp b/src/Unit_RTC.cpp similarity index 77% rename from src/M5_BM8563.cpp rename to src/Unit_RTC.cpp index 20acfa3..7091a6c 100644 --- a/src/M5_BM8563.cpp +++ b/src/Unit_RTC.cpp @@ -1,10 +1,15 @@ -#include "M5_BM8563.h" +#include "Unit_RTC.h" -BM8563::BM8563() { _addr = DEVICE_ADDR; } +Unit_RTC::Unit_RTC() { + _addr = DEVICE_ADDR; +} -BM8563::BM8563(uint8_t addr) { _addr = addr; } +Unit_RTC::Unit_RTC(uint8_t addr) { + _addr = addr; +} -void BM8563::begin() { +/*! @brief Initialize the RTC. */ +void Unit_RTC::begin() { _wire = &Wire; _wire->begin(); writeReg(0x00, 0x00); @@ -12,7 +17,8 @@ void BM8563::begin() { writeReg(0x0D, 0x00); } -void BM8563::begin(TwoWire *wire) { +/*! @brief Initialize the RTC. */ +void Unit_RTC::begin(TwoWire *wire) { _wire = wire; _wire->begin(); writeReg(0x00, 0x00); @@ -20,50 +26,34 @@ void BM8563::begin(TwoWire *wire) { writeReg(0x0D, 0x00); } -void BM8563::begin(TwoWire *wire, uint8_t scl, uint8_t sda, uint32_t i2c_freq) { +/*! @brief Initialize the RTC. */ +void Unit_RTC::begin(TwoWire *wire, uint8_t scl, uint8_t sda, + uint32_t i2c_freq) { _wire = wire; - _wire->begin(sda, scl, i2c_freq); + _wire->begin(DEVICE_ADDR, sda, scl, i2c_freq); writeReg(0x00, 0x00); writeReg(0x01, 0x00); writeReg(0x0D, 0x00); } -void BM8563::writeReg(uint8_t reg, uint8_t data) { - _wire->beginTransmission(0x51); +/*! @brief Write data to register. */ +void Unit_RTC::writeReg(uint8_t reg, uint8_t data) { + _wire->beginTransmission(DEVICE_ADDR); _wire->write(reg); _wire->write(data); _wire->endTransmission(); } -uint8_t BM8563::ReadReg(uint8_t reg) { - _wire->beginTransmission(0x51); +/*! @brief Read data from register. */ +uint8_t Unit_RTC::ReadReg(uint8_t reg) { + _wire->beginTransmission(DEVICE_ADDR); _wire->write(reg); _wire->endTransmission(false); - _wire->requestFrom(0x51, 1); + _wire->requestFrom(DEVICE_ADDR, 1); return _wire->read(); } -void BM8563::getBm8563Time(void) { - _wire->beginTransmission(0x51); - _wire->write(0x02); - _wire->endTransmission(false); - _wire->requestFrom(0x51, 7); - while (_wire->available()) { - _trdata[0] = _wire->read(); - _trdata[1] = _wire->read(); - _trdata[2] = _wire->read(); - _trdata[3] = _wire->read(); - _trdata[4] = _wire->read(); - _trdata[5] = _wire->read(); - _trdata[6] = _wire->read(); - } - - DataMask(); - Bcd2asc(); - Str2Time(); -} - -void BM8563::Str2Time(void) { +void Unit_RTC::Str2Time(void) { Second = (asc[0] - 0x30) * 10 + asc[1] - 0x30; Minute = (asc[2] - 0x30) * 10 + asc[3] - 0x30; Hour = (asc[4] - 0x30) * 10 + asc[5] - 0x30; @@ -76,7 +66,7 @@ void BM8563::Str2Time(void) { */ } -void BM8563::DataMask() { +void Unit_RTC::DataMask() { _trdata[0] = _trdata[0] & 0x7f; //秒 _trdata[1] = _trdata[1] & 0x7f; //分 _trdata[2] = _trdata[2] & 0x3f; //时 @@ -95,7 +85,7 @@ void BM8563::DataMask() { 入口参数： 返 回 值：无 ***********************************************************************/ -void BM8563::Bcd2asc(void) { +void Unit_RTC::Bcd2asc(void) { uint8_t i, j; for (j = 0, i = 0; i < 7; i++) { asc[j++] = @@ -104,13 +94,13 @@ void BM8563::Bcd2asc(void) { } } -uint8_t BM8563::Bcd2ToByte(uint8_t Value) { +uint8_t Unit_RTC::Bcd2ToByte(uint8_t Value) { uint8_t tmp = 0; tmp = ((uint8_t)(Value & (uint8_t)0xF0) >> (uint8_t)0x4) * 10; return (tmp + (Value & (uint8_t)0x0F)); } -uint8_t BM8563::ByteToBcd2(uint8_t Value) { +uint8_t Unit_RTC::ByteToBcd2(uint8_t Value) { uint8_t bcdhigh = 0; while (Value >= 10) { @@ -121,14 +111,14 @@ uint8_t BM8563::ByteToBcd2(uint8_t Value) { return ((uint8_t)(bcdhigh << 4) | Value); } -void BM8563::getTime(rtc_time_type *RTC_TimeStruct) { +void Unit_RTC::getTime(rtc_time_type *RTC_TimeStruct) { // if() uint8_t buf[3] = {0}; - _wire->beginTransmission(0x51); + _wire->beginTransmission(DEVICE_ADDR); _wire->write(0x02); _wire->endTransmission(false); - _wire->requestFrom(0x51, 3); + _wire->requestFrom(DEVICE_ADDR, 3); while (_wire->available()) { buf[0] = _wire->read(); @@ -141,12 +131,12 @@ void BM8563::getTime(rtc_time_type *RTC_TimeStruct) { RTC_TimeStruct->Hours = Bcd2ToByte(buf[2] & 0x3f); //时 } -int BM8563::setTime(rtc_time_type *RTC_TimeStruct) { +int Unit_RTC::setTime(rtc_time_type *RTC_TimeStruct) { if (RTC_TimeStruct == NULL || RTC_TimeStruct->Hours > 24 || RTC_TimeStruct->Minutes > 60 || RTC_TimeStruct->Seconds > 60) return 0; - _wire->beginTransmission(0x51); + _wire->beginTransmission(DEVICE_ADDR); _wire->write(0x02); _wire->write(ByteToBcd2(RTC_TimeStruct->Seconds)); _wire->write(ByteToBcd2(RTC_TimeStruct->Minutes)); @@ -155,13 +145,13 @@ int BM8563::setTime(rtc_time_type *RTC_TimeStruct) { return 1; } -void BM8563::getDate(rtc_date_type *RTC_DateStruct) { +void Unit_RTC::getDate(rtc_date_type *RTC_DateStruct) { uint8_t buf[4] = {0}; - _wire->beginTransmission(0x51); + _wire->beginTransmission(DEVICE_ADDR); _wire->write(0x05); _wire->endTransmission(false); - _wire->requestFrom(0x51, 4); + _wire->requestFrom(DEVICE_ADDR, 4); while (_wire->available()) { buf[0] = _wire->read(); @@ -181,11 +171,11 @@ void BM8563::getDate(rtc_date_type *RTC_DateStruct) { } } -int BM8563::setDate(rtc_date_type *RTC_DateStruct) { +int Unit_RTC::setDate(rtc_date_type *RTC_DateStruct) { if (RTC_DateStruct == NULL || RTC_DateStruct->WeekDay > 7 || RTC_DateStruct->Date > 31 || RTC_DateStruct->Month > 12) return 0; - _wire->beginTransmission(0x51); + _wire->beginTransmission(DEVICE_ADDR); _wire->write(0x05); _wire->write(ByteToBcd2(RTC_DateStruct->Date)); _wire->write(ByteToBcd2(RTC_DateStruct->WeekDay)); @@ -203,7 +193,7 @@ int BM8563::setDate(rtc_date_type *RTC_DateStruct) { return 1; } -int BM8563::setAlarmIRQ(int afterSeconds) { +int Unit_RTC::setAlarmIRQ(int afterSeconds) { uint8_t reg_value = 0; reg_value = ReadReg(0x01); @@ -234,7 +224,7 @@ int BM8563::setAlarmIRQ(int afterSeconds) { return afterSeconds * div; } -int BM8563::setAlarmIRQ(const rtc_time_type &RTC_TimeStruct) { +int Unit_RTC::setAlarmIRQ(const rtc_time_type &RTC_TimeStruct) { uint8_t irq_enable = false; uint8_t out_buf[4] = {0x80, 0x80, 0x80, 0x80}; @@ -267,8 +257,8 @@ int BM8563::setAlarmIRQ(const rtc_time_type &RTC_TimeStruct) { return irq_enable ? 1 : 0; } -int BM8563::setAlarmIRQ(const rtc_date_type &RTC_DateStruct, - const rtc_time_type &RTC_TimeStruct) { +int Unit_RTC::setAlarmIRQ(const rtc_date_type &RTC_DateStruct, + const rtc_time_type &RTC_TimeStruct) { uint8_t irq_enable = false; uint8_t out_buf[4] = {0x80, 0x80, 0x80, 0x80}; @@ -308,11 +298,11 @@ int BM8563::setAlarmIRQ(const rtc_date_type &RTC_DateStruct, return irq_enable ? 1 : 0; } -void BM8563::clearIRQ() { +void Unit_RTC::clearIRQ() { uint8_t data = ReadReg(0x01); writeReg(0x01, data & 0xf3); } -void BM8563::disableIRQ() { +void Unit_RTC::disableIRQ() { clearIRQ(); uint8_t data = ReadReg(0x01); writeReg(0x01, data & 0xfC); diff --git a/src/M5_BM8563.h b/src/Unit_RTC.h similarity index 81% rename from src/M5_BM8563.h rename to src/Unit_RTC.h index 7f5cba5..fd062fd 100644 --- a/src/M5_BM8563.h +++ b/src/Unit_RTC.h @@ -1,8 +1,15 @@ -#ifndef __M5_BM8563_RTC_H__ -#define __M5_BM8563_RTC_H__ +/*! + * @brief A programmable real-time clock module From M5Stack + * @copyright Copyright (c) 2022 by M5Stack[https://m5stack.com] + * + * @Links [Unit RTC](https://docs.m5stack.com/en/unit/rtc) + * @version V0.0.1 + * @date 2022-07-15 + */ +#ifndef _Unit_RTC_H__ +#define _Unit_RTC_H__ #include - #include "Arduino.h" #define DEVICE_ADDR 0x51 @@ -12,7 +19,8 @@ struct rtc_time_type { uint8_t Minutes; uint8_t Seconds; rtc_time_type(uint8_t hours = 0, uint8_t minutes = 0, uint8_t seconds = 0) - : Hours{hours}, Minutes{minutes}, Seconds{seconds} {} + : Hours{hours}, Minutes{minutes}, Seconds{seconds} { + } }; struct rtc_date_type { @@ -22,10 +30,11 @@ struct rtc_date_type { uint8_t WeekDay; rtc_date_type(uint16_t year = 2000, uint8_t month = 0, uint8_t date = 0, uint8_t weekDay = 0) - : Year{year}, Month{month}, Date{date}, WeekDay{weekDay} {} + : Year{year}, Month{month}, Date{date}, WeekDay{weekDay} { + } }; -class BM8563 { +class Unit_RTC { private: void Bcd2asc(void); void DataMask(); @@ -44,8 +53,8 @@ class BM8563 { TwoWire *_wire; public: - BM8563(); - BM8563(uint8_t addr); + Unit_RTC(); + Unit_RTC(uint8_t addr); void begin(); void begin(TwoWire *wire); void begin(TwoWire *wire, uint8_t scl, uint8_t sda, uint32_t i2c_freq); From 7c90ec308eec0a2d1fe2a2b700b4f1c8e9d44789 Mon Sep 17 00:00:00 2001 From: Tinyu Date: Fri, 29 Jul 2022 16:32:56 +0800 Subject: [PATCH 05/27] Add more examples --- examples/Unit_RTC_M5Atom/Unit_RTC_M5Atom.ino | 54 ++++++++++++++++++ examples/Unit_RTC_M5Core/Unit_RTC_M5Core.ino | 57 +++++++++++++++++++ .../Unit_RTC_M5Core2/Unit_RTC_M5Core2.ino | 56 ++++++++++++++++++ .../Unit_RTC_M5StickC/Unit_RTC_M5StickC.ino | 56 ++++++++++++++++++ .../Unit_RTC_M5StickCPlus.ino | 57 +++++++++++++++++++ library.json | 4 +- library.properties | 2 +- src/Unit_RTC.h | 4 +- 8 files changed, 285 insertions(+), 5 deletions(-) create mode 100644 examples/Unit_RTC_M5Atom/Unit_RTC_M5Atom.ino create mode 100644 examples/Unit_RTC_M5Core/Unit_RTC_M5Core.ino create mode 100644 examples/Unit_RTC_M5Core2/Unit_RTC_M5Core2.ino create mode 100644 examples/Unit_RTC_M5StickC/Unit_RTC_M5StickC.ino create mode 100644 examples/Unit_RTC_M5StickCPlus/Unit_RTC_M5StickCPlus.ino diff --git a/examples/Unit_RTC_M5Atom/Unit_RTC_M5Atom.ino b/examples/Unit_RTC_M5Atom/Unit_RTC_M5Atom.ino new file mode 100644 index 0000000..8373690 --- /dev/null +++ b/examples/Unit_RTC_M5Atom/Unit_RTC_M5Atom.ino @@ -0,0 +1,54 @@ +/* +******************************************************************************* +* Copyright (c) 2022 by M5Stack +* Equipped with Atom-Lite/Matrix sample source code +* 配套 Atom-Lite/Matrix 示例源代码 +* Visit for more information: https://docs.m5stack.com/en/unit/rtc +* 获取更多资料请访问: https://docs.m5stack.com/zh_CN/unit/rtc +* +* Product: RTC. 实时时钟 +* Date: 2022/7/29 +******************************************************************************* + Please connect to Port A,The time is displayed on the screen. + 请连接端口A,屏幕上显示时间。 +*/ + +#include "M5Atom.h" +#include "Unit_RTC.h" + +Unit_RTC RTC; + +rtc_time_type RTCtime; +rtc_date_type RTCdate; + +char str_buffer[64]; + +void setup() { + M5.begin(true, false, true); // Init M5Atom. 初始化M5Atom + Serial.print("RTC"); + RTC.begin(); // Example Initialize the RTC clock. 初始化RTC时钟 + RTCtime.Hours = 14; // Set the RTC clock time. 设置RTC时钟时间 + RTCtime.Minutes = 40; + RTCtime.Seconds = 5; + + RTCdate.WeekDay = 4; // Set the RTC clock date. 设置RTC时钟日期 + RTCdate.Month = 7; + RTCdate.Date = 15; + RTCdate.Year = 2021; + + RTC.setTime(&RTCtime); // Example Synchronize the set time to the RTC. + // 将设置的时间同步至RTC + RTC.setDate(&RTCdate); // Synchronize the set date to the RTC. + // 将设置的日期同步至RTC + M5.dis.fillpix(0x00ff00); +} + +void loop() { + RTC.getTime(&RTCtime); // To get the time. 获取时间 + RTC.getDate(&RTCdate); // Get the date. 获取日期 + Serial.printf("RTC Time Now is \n%02d:%02d:%02d\n", RTCtime.Hours, + RTCtime.Minutes, RTCtime.Seconds); + Serial.printf("RTC Date Now is \n%02d:%02d:%02d WeekDay:%02d\n", + RTCdate.Year, RTCdate.Month, RTCdate.Date, RTCdate.WeekDay); + delay(1000); +} diff --git a/examples/Unit_RTC_M5Core/Unit_RTC_M5Core.ino b/examples/Unit_RTC_M5Core/Unit_RTC_M5Core.ino new file mode 100644 index 0000000..1817220 --- /dev/null +++ b/examples/Unit_RTC_M5Core/Unit_RTC_M5Core.ino @@ -0,0 +1,57 @@ +/* +******************************************************************************* +* Copyright (c) 2022 by M5Stack +* Equipped with M5Core sample source code +* 配套 M5Core 示例源代码 +* Visit for more information: https://docs.m5stack.com/en/unit/rtc +* 获取更多资料请访问: https://docs.m5stack.com/zh_CN/unit/rtc +* +* Product: RTC. 实时时钟 +* Date: 2022/7/29 +******************************************************************************* + Please connect to Port A,The time is displayed on the screen. + 请连接端口A,屏幕上显示时间。 +*/ + +#include "M5Stack.h" +#include "Unit_RTC.h" + +Unit_RTC RTC; + +rtc_time_type RTCtime; +rtc_date_type RTCdate; + +char str_buffer[64]; + +void setup() { + M5.begin(); // Init M5Stack. 初始化M5Stack + M5.Power.begin(); // Init power 初始化电源模块 + M5.lcd.setTextSize(2); // Set the text size to 2. 设置文字大小为2 + M5.Lcd.print(" RTC"); + RTC.begin(); // Example Initialize the RTC clock. 初始化RTC时钟 + RTCtime.Hours = 14; // Set the RTC clock time. 设置RTC时钟时间 + RTCtime.Minutes = 40; + RTCtime.Seconds = 5; + + RTCdate.WeekDay = 4; // Set the RTC clock date. 设置RTC时钟日期 + RTCdate.Month = 7; + RTCdate.Date = 15; + RTCdate.Year = 2021; + + RTC.setTime(&RTCtime); // Example Synchronize the set time to the RTC. + // 将设置的时间同步至RTC + RTC.setDate(&RTCdate); // Synchronize the set date to the RTC. + // 将设置的日期同步至RTC +} + +void loop() { + M5.Lcd.fillRect(0, 20, 320, 140, BLACK); + RTC.getTime(&RTCtime); // To get the time. 获取时间 + RTC.getDate(&RTCdate); // Get the date. 获取日期 + M5.Lcd.setCursor(0, 20); + M5.Lcd.printf("RTC Time Now is \n%02d:%02d:%02d\n", RTCtime.Hours, + RTCtime.Minutes, RTCtime.Seconds); + M5.Lcd.printf("RTC Date Now is \n%02d:%02d:%02d WeekDay:%02d\n", + RTCdate.Year, RTCdate.Month, RTCdate.Date, RTCdate.WeekDay); + delay(1000); +} diff --git a/examples/Unit_RTC_M5Core2/Unit_RTC_M5Core2.ino b/examples/Unit_RTC_M5Core2/Unit_RTC_M5Core2.ino new file mode 100644 index 0000000..5b9e22b --- /dev/null +++ b/examples/Unit_RTC_M5Core2/Unit_RTC_M5Core2.ino @@ -0,0 +1,56 @@ +/* +******************************************************************************* +* Copyright (c) 2021 by M5Stack +* Equipped with M5Core2 sample source code +* 配套 M5Core2 示例源代码 +* Visit for more information: https://docs.m5stack.com/en/unit/rtc +* 获取更多资料请访问: https://docs.m5stack.com/zh_CN/unit/rtc +* +* Product: RTC. 实时时钟 +* Date: 2021/8/18 +******************************************************************************* + Please connect to Port A,The time is displayed on the screen. + 请连接端口A,屏幕上显示时间。 +*/ + +#include "M5Core2.h" +#include "M5_BM8563.h" + +BM8563 RTC; + +rtc_time_type RTCtime; +rtc_date_type RTCdate; + +char str_buffer[64]; + +void setup() { + M5.begin(); //Init M5Core2. 初始化M5Core2 + M5.lcd.setTextSize(2); //Set the text size to 2. 设置文字大小为2 + M5.Lcd.print(" RTC"); + RTC.begin(); //Example Initialize the RTC clock. 初始化RTC时钟 + RTCtime.Hours = 14; //Set the RTC clock time. 设置RTC时钟时间 + RTCtime.Minutes = 40; + RTCtime.Seconds = 5; + + RTCdate.WeekDay = 4; //Set the RTC clock date. 设置RTC时钟日期 + RTCdate.Month = 7; + RTCdate.Date = 15; + RTCdate.Year = 2021; + + RTC.setTime( + &RTCtime); //Example Synchronize the set time to the RTC. 将设置的时间同步至RTC + RTC.setDate( + &RTCdate); //Synchronize the set date to the RTC. 将设置的日期同步至RTC +} + +void loop() { + RTC.getTime(&RTCtime); //To get the time. 获取时间 + RTC.getDate(&RTCdate); //Get the date. 获取日期 + M5.Lcd.setCursor(0, 20); + M5.Lcd.printf("RTC Time Now is \n%02d:%02d:%02d\n", RTCtime.Hours, + RTCtime.Minutes, RTCtime.Seconds); + M5.Lcd.printf("RTC Date Now is \n%02d:%02d:%02d WeekDay:%02d\n", RTCdate.Year, + RTCdate.Month, RTCdate.Date, RTCdate.WeekDay); + delay(1000); + M5.Lcd.fillRect(0, 20, 320, 140, BLACK); +} diff --git a/examples/Unit_RTC_M5StickC/Unit_RTC_M5StickC.ino b/examples/Unit_RTC_M5StickC/Unit_RTC_M5StickC.ino new file mode 100644 index 0000000..fc33838 --- /dev/null +++ b/examples/Unit_RTC_M5StickC/Unit_RTC_M5StickC.ino @@ -0,0 +1,56 @@ +/* +******************************************************************************* +* Copyright (c) 2021 by M5Stack +* Equipped with M5StickC sample source code +* 配套 M5StickC 示例源代码 +* Visit for more information: https://docs.m5stack.com/en/unit/rtc +* 获取更多资料请访问: https://docs.m5stack.com/zh_CN/unit/rtc +* +* Product: RTC. 实时时钟 +* Date: 2022/7/29 +******************************************************************************* + Please connect to Port,The time is displayed on the screen. + 请连接端口,屏幕上显示时间。 +*/ + +#include "M5StickC.h" +#include "Unit_RTC.h" + +Unit_RTC RTC; + +rtc_time_type RTCtime; +rtc_date_type RTCdate; + +char str_buffer[64]; + +void setup() { + M5.begin(); // Init M5StickC. 初始化M5StickC + M5.Lcd.setRotation(3); // Rotating display. 旋转显示屏 + M5.Lcd.print(" RTC"); + RTC.begin(); // Example Initialize the RTC clock. 初始化RTC时钟 + RTCtime.Hours = 14; // Set the RTC clock time. 设置RTC时钟时间 + RTCtime.Minutes = 40; + RTCtime.Seconds = 5; + + RTCdate.WeekDay = 4; // Set the RTC clock date. 设置RTC时钟日期 + RTCdate.Month = 7; + RTCdate.Date = 15; + RTCdate.Year = 2021; + + RTC.setTime(&RTCtime); // Example Synchronize the set time to the RTC. + // 将设置的时间同步至RTC + RTC.setDate(&RTCdate); // Synchronize the set date to the RTC. + // 将设置的日期同步至RTC +} + +void loop() { + RTC.getTime(&RTCtime); // To get the time. 获取时间 + RTC.getDate(&RTCdate); // Get the date. 获取日期 + M5.Lcd.setCursor(0, 20); + M5.Lcd.printf("RTC Time Now is \n%02d:%02d:%02d\n", RTCtime.Hours, + RTCtime.Minutes, RTCtime.Seconds); + M5.Lcd.printf("RTC Date Now is \n%02d:%02d:%02d WeekDay:%02d\n", + RTCdate.Year, RTCdate.Month, RTCdate.Date, RTCdate.WeekDay); + delay(1000); + M5.Lcd.fillRect(0, 20, 320, 140, BLACK); +} diff --git a/examples/Unit_RTC_M5StickCPlus/Unit_RTC_M5StickCPlus.ino b/examples/Unit_RTC_M5StickCPlus/Unit_RTC_M5StickCPlus.ino new file mode 100644 index 0000000..effd998 --- /dev/null +++ b/examples/Unit_RTC_M5StickCPlus/Unit_RTC_M5StickCPlus.ino @@ -0,0 +1,57 @@ +/* +******************************************************************************* +* Copyright (c) 2021 by M5Stack +* Equipped with M5StickCPlus sample source code +* 配套 M5StickCPlus 示例源代码 +* Visit for more information: https://docs.m5stack.com/en/unit/rtc +* 获取更多资料请访问: https://docs.m5stack.com/zh_CN/unit/rtc +* +* Product: RTC. 实时时钟 +* Date: 2022/7/29 +******************************************************************************* + Please connect to Port,The time is displayed on the screen. + 请连接端口,屏幕上显示时间。 +*/ + +#include "M5StickCPlus.h" +#include "Unit_RTC.h" + +Unit_RTC RTC; + +rtc_time_type RTCtime; +rtc_date_type RTCdate; + +char str_buffer[64]; + +void setup() { + M5.begin(); // Init M5StickCPlus. 初始化M5StickCPlus + M5.Lcd.setRotation(3); // Rotating display. 旋转显示屏 + M5.Lcd.setTextSize(2); // Rotating display. 旋转显示屏 + M5.Lcd.print(" RTC"); + RTC.begin(); // Example Initialize the RTC clock. 初始化RTC时钟 + RTCtime.Hours = 14; // Set the RTC clock time. 设置RTC时钟时间 + RTCtime.Minutes = 40; + RTCtime.Seconds = 5; + + RTCdate.WeekDay = 4; // Set the RTC clock date. 设置RTC时钟日期 + RTCdate.Month = 7; + RTCdate.Date = 15; + RTCdate.Year = 2021; + + RTC.setTime(&RTCtime); // Example Synchronize the set time to the RTC. + // 将设置的时间同步至RTC + RTC.setDate(&RTCdate); // Synchronize the set date to the RTC. + // 将设置的日期同步至RTC +} + +void loop() { + RTC.getTime(&RTCtime); // To get the time. 获取时间 + RTC.getDate(&RTCdate); // Get the date. 获取日期 + M5.Lcd.setCursor(0, 20); + M5.Lcd.printf("RTC Time Now is \n%02d:%02d:%02d\n", RTCtime.Hours, + RTCtime.Minutes, RTCtime.Seconds); + M5.Lcd.printf("RTC Date Now is \n%02d:%02d:%02d WeekDay:%02d\n", + RTCdate.Year, RTCdate.Month, RTCdate.Date, RTCdate.WeekDay); + delay(1000); + M5.Lcd.fillRect(0, 20, 320, 140, BLACK); +} diff --git a/library.json b/library.json index 7126325..7fa7046 100644 --- a/library.json +++ b/library.json @@ -1,6 +1,6 @@ { "name": "M5Unit-RTC", - "description": "Library for M5Stack Unit RTC", + "description": "Library for M5Stack Unit RTC(SKU:U126)", "keywords": "M5Stack Unit BM8563 RTC", "authors": { "name": "M5Stack", @@ -10,7 +10,7 @@ "type": "git", "url": "https://github.com/m5stack/M5Unit-RTC.git" }, - "version": "0.0.1", + "version": "0.0.2", "frameworks": "arduino", "platforms": "espressif32" } \ No newline at end of file diff --git a/library.properties b/library.properties index 46a2844..0f3e4d6 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=M5Unit-RTC -version=0.0.1 +version=0.0.2 author=M5Stack maintainer=M5Stack sentence=Library for BM8563 RTC diff --git a/src/Unit_RTC.h b/src/Unit_RTC.h index fd062fd..49bd32f 100644 --- a/src/Unit_RTC.h +++ b/src/Unit_RTC.h @@ -3,8 +3,8 @@ * @copyright Copyright (c) 2022 by M5Stack[https://m5stack.com] * * @Links [Unit RTC](https://docs.m5stack.com/en/unit/rtc) - * @version V0.0.1 - * @date 2022-07-15 + * @version V0.0.2 + * @date 2022-07-29 */ #ifndef _Unit_RTC_H__ #define _Unit_RTC_H__ From 31978669209e795f85b4f1a2d5ec3c158f04edf3 Mon Sep 17 00:00:00 2001 From: Pandian Nano Date: Fri, 24 May 2024 11:17:06 +0800 Subject: [PATCH 06/27] Bug fixed [incorrect header file and object] --- examples/Unit_RTC_M5Core2/Unit_RTC_M5Core2.ino | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/Unit_RTC_M5Core2/Unit_RTC_M5Core2.ino b/examples/Unit_RTC_M5Core2/Unit_RTC_M5Core2.ino index 5b9e22b..4911f5e 100644 --- a/examples/Unit_RTC_M5Core2/Unit_RTC_M5Core2.ino +++ b/examples/Unit_RTC_M5Core2/Unit_RTC_M5Core2.ino @@ -14,9 +14,9 @@ */ #include "M5Core2.h" -#include "M5_BM8563.h" +#include "Unit_RTC.h" -BM8563 RTC; +Unit_RTC RTC; rtc_time_type RTCtime; rtc_date_type RTCdate; From 292f348591b6d31ec076d50b080a9180e201a6ac Mon Sep 17 00:00:00 2001 From: GOB Date: Thu, 26 Feb 2026 19:54:07 +0900 Subject: [PATCH 07/27] Add UnitRTC using M5UnitUnified --- boards/m5stack-atoms3r.json | 41 + boards/m5stack-nanoc6.json | 33 + boards/m5stick-cplus2.json | 40 + docs/Doxyfile | 2600 +++++++++++++++++ docs/doxy.sh | 11 + .../UnitRTC/AlarmNotify/AlarmNotify.ino | 10 + .../UnitRTC/AlarmNotify/main/AlarmNotify.cpp | 242 ++ .../UnitRTC/PeriodicTimer/PeriodicTimer.ino | 10 + .../PeriodicTimer/main/PeriodicTimer.cpp | 235 ++ .../UnitRTC/PlotToSerial/PlotToSerial.ino | 9 + .../PlotToSerial/main/PlotToSerial.cpp | 303 ++ src/M5UnitUnifiedRTC.h | 17 + src/M5UnitUnifiedRTC.hpp | 27 + src/Unit_RTC.h | 4 + src/unit/unit_PCF8563.cpp | 615 ++++ src/unit/unit_PCF8563.hpp | 519 ++++ src/unit/unit_PCF8563_types.hpp | 256 ++ test/common_main.cpp | 60 + test/embedded/embedded_main.cpp | 63 + test/embedded/test_pcf8563/pcf8563_test.cpp | 819 ++++++ test/native/test_dummy/.keep | 0 test/pcf8563_types_test.cpp | 479 +++ 22 files changed, 6393 insertions(+) create mode 100644 boards/m5stack-atoms3r.json create mode 100644 boards/m5stack-nanoc6.json create mode 100644 boards/m5stick-cplus2.json create mode 100644 docs/Doxyfile create mode 100755 docs/doxy.sh create mode 100644 examples/UnitUnified/UnitRTC/AlarmNotify/AlarmNotify.ino create mode 100644 examples/UnitUnified/UnitRTC/AlarmNotify/main/AlarmNotify.cpp create mode 100644 examples/UnitUnified/UnitRTC/PeriodicTimer/PeriodicTimer.ino create mode 100644 examples/UnitUnified/UnitRTC/PeriodicTimer/main/PeriodicTimer.cpp create mode 100644 examples/UnitUnified/UnitRTC/PlotToSerial/PlotToSerial.ino create mode 100644 examples/UnitUnified/UnitRTC/PlotToSerial/main/PlotToSerial.cpp create mode 100644 src/M5UnitUnifiedRTC.h create mode 100644 src/M5UnitUnifiedRTC.hpp create mode 100644 src/unit/unit_PCF8563.cpp create mode 100644 src/unit/unit_PCF8563.hpp create mode 100644 src/unit/unit_PCF8563_types.hpp create mode 100644 test/common_main.cpp create mode 100644 test/embedded/embedded_main.cpp create mode 100644 test/embedded/test_pcf8563/pcf8563_test.cpp create mode 100644 test/native/test_dummy/.keep create mode 100644 test/pcf8563_types_test.cpp diff --git a/boards/m5stack-atoms3r.json b/boards/m5stack-atoms3r.json new file mode 100644 index 0000000..1c9ecce --- /dev/null +++ b/boards/m5stack-atoms3r.json @@ -0,0 +1,41 @@ +{ + "build": { + "arduino": { + "memory_type": "qio_opi", + "ldscript": "esp32s3_out.ld", + "partitions": "default_8MB.csv" + }, + "core": "esp32", + "extra_flags": [ + "-DARDUINO_M5STACK_ATOMS3R", + "-DBOARD_HAS_PSRAM", + "-DARDUINO_USB_MODE=1", + "-DARDUINO_USB_CDC_ON_BOOT=1", + "-DARDUINO_RUNNING_CORE=1", + "-DARDUINO_EVENT_RUNNING_CORE=1" + ], + "f_cpu": "240000000L", + "f_flash": "80000000L", + "flash_mode": "dio", + "mcu": "esp32s3", + "variant": "m5stack_atoms3" + }, + "connectivity": [ + "bluetooth", + "wifi" + ], + "frameworks": [ + "arduino", + "espidf" + ], + "name": "M5Stack AtomS3R", + "upload": { + "flash_size": "8MB", + "maximum_ram_size": 327680, + "maximum_size": 8388608, + "require_upload_port": true, + "speed": 460800 + }, + "url": "https://docs.m5stack.com/en/core/AtomS3R", + "vendor": "M5Stack" +} diff --git a/boards/m5stack-nanoc6.json b/boards/m5stack-nanoc6.json new file mode 100644 index 0000000..ddaad65 --- /dev/null +++ b/boards/m5stack-nanoc6.json @@ -0,0 +1,33 @@ +{ + "build": { + "core": "esp32", + "extra_flags": [ + "-DARDUINO_M5STACK_NANOC6" + ], + "f_cpu": "160000000L", + "f_flash": "80000000L", + "flash_mode": "qio", + "mcu": "esp32c6", + "variant": "esp32c6" + }, + "connectivity": [ + "wifi" + ], + "debug": { + "openocd_target": "esp32c6.cfg" + }, + "frameworks": [ + "arduino", + "espidf" + ], + "name": "M5Stack NanoC6", + "upload": { + "flash_size": "4MB", + "maximum_ram_size": 327680, + "maximum_size": 4194384, + "require_upload_port": true, + "speed": 460800 + }, + "url": "https://docs.m5stack.com/en/core/M5NanoC6", + "vendor": "M5Stack" +} diff --git a/boards/m5stick-cplus2.json b/boards/m5stick-cplus2.json new file mode 100644 index 0000000..91fa2ca --- /dev/null +++ b/boards/m5stick-cplus2.json @@ -0,0 +1,40 @@ +{ + "build": { + "arduino":{ + "ldscript": "esp32_out.ld", + "partitions": "default_8MB.csv" + }, + "core": "esp32", + "extra_flags": [ + "-DM5STACK_M5STICK_CPLUS2", + "-DBOARD_HAS_PSRAM", + "-mfix-esp32-psram-cache-issue", + "-mfix-esp32-psram-cache-strategy=memw", + "-DARDUINO_RUNNING_CORE=1", + "-DARDUINO_EVENT_RUNNING_CORE=1" + ], + "f_cpu": "240000000L", + "f_flash": "80000000L", + "flash_mode": "dio", + "mcu": "esp32", + "variant": "m5stick_c" + }, + "connectivity": [ + "wifi", + "bluetooth" + ], + "frameworks": [ + "arduino", + "espidf" + ], + "name": "M5Stick-CPlus2", + "upload": { + "flash_size": "8MB", + "maximum_ram_size": 327680, + "maximum_size": 8388608, + "require_upload_port": true, + "speed": 1500000 + }, + "url": "https://docs.m5stack.com/en/core/M5StickC%20PLUS2", + "vendor": "M5Stack" +} diff --git a/docs/Doxyfile b/docs/Doxyfile new file mode 100644 index 0000000..a8d5e98 --- /dev/null +++ b/docs/Doxyfile @@ -0,0 +1,2600 @@ +# Doxyfile 1.9.2 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "M5Unit-RTC" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = $(DOXYGEN_PROJECT_NUMBER) + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = ./docs + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = license="\par License^^" \ + "weak=@xrefitem weak \"This function can override the behaviour.\" \"Weak symbols\"" \ + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = YES + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = YES + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = YES + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = ./src + + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.hpp \ + *.cpp + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = ./ + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATOR_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/ + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see https://docs.mathjax.org/en/v2.7-latest/tex.html +# #tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /