From ddaa1938215485aa040196ab61a79eac75a33b8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Hru=C5=A1ka?= Date: Sat, 15 Oct 2022 03:41:04 +0200 Subject: [PATCH] add code --- .gitignore | 3 + CMakeLists.txt | 6 + Makefile | 8 + components/common_utils/CMakeLists.txt | 8 + components/common_utils/README.txt | 2 + components/common_utils/component.mk | 3 + .../include/common_utils/base16.h | 75 + .../include/common_utils/datetime.h | 131 + .../include/common_utils/hexdump.h | 19 + .../common_utils/include/common_utils/utils.h | 80 + components/common_utils/src/base16.c | 62 + components/common_utils/src/common_utils.c | 52 + components/common_utils/src/datetime.c | 110 + components/common_utils/src/hexdump.c | 72 + components/dhcp_wd/CMakeLists.txt | 9 + components/dhcp_wd/Kconfig | 27 + components/dhcp_wd/README.txt | 5 + components/dhcp_wd/component.mk | 3 + components/dhcp_wd/include/dhcp_wd.h | 82 + components/dhcp_wd/src/dhcp_wd.c | 277 + components/esp32-ds18b20/.travis.yml | 39 + components/esp32-ds18b20/CMakeLists.txt | 6 + components/esp32-ds18b20/LICENSE | 21 + components/esp32-ds18b20/README.md | 98 + components/esp32-ds18b20/component.mk | 1 + components/esp32-ds18b20/doc/.gitignore | 3 + components/esp32-ds18b20/doc/Doxyfile | 2496 +++++++++ components/esp32-ds18b20/ds18b20.c | 614 ++ components/esp32-ds18b20/include/ds18b20.h | 206 + components/esp32-ds18b20/library.json | 26 + components/esp32-owb/.travis.yml | 39 + components/esp32-owb/CMakeLists.txt | 5 + components/esp32-owb/LICENSE | 21 + components/esp32-owb/README.md | 60 + components/esp32-owb/component.mk | 1 + components/esp32-owb/doc/.gitignore | 3 + components/esp32-owb/doc/Doxyfile | 2496 +++++++++ components/esp32-owb/include/owb.h | 336 ++ components/esp32-owb/include/owb_gpio.h | 70 + components/esp32-owb/include/owb_rmt.h | 75 + components/esp32-owb/library.json | 30 + components/esp32-owb/owb.c | 744 +++ components/esp32-owb/owb_gpio.c | 287 + components/esp32-owb/owb_rmt.c | 469 ++ components/modbus_slave/CMakeLists.txt | 7 + components/modbus_slave/README.txt | 1 + components/modbus_slave/component.mk | 3 + components/modbus_slave/include/modbus.h | 103 + .../modbus_slave/include/pp/payload_builder.h | 129 + .../modbus_slave/include/pp/payload_parser.h | 167 + .../modbus_slave/include/pp/type_coerce.h | 32 + components/modbus_slave/src/modbus.c | 475 ++ .../modbus_slave/src/pp/payload_builder.c | 87 + .../modbus_slave/src/pp/payload_parser.c | 104 + components/ping/CMakeLists.txt | 4 + components/ping/README.txt | 1 + components/ping/component.mk | 3 + components/ping/include/ping.h | 58 + components/ping/src/ping.c | 262 + components/socket_server/CMakeLists.txt | 4 + components/socket_server/README.txt | 1 + components/socket_server/component.mk | 3 + .../socket_server/include/socket_server.h | 282 + components/socket_server/src/socket_server.c | 1015 ++++ components/vconsole/CMakeLists.txt | 18 + components/vconsole/libconsole/.gitignore | 54 + components/vconsole/libconsole/CMakeLists.txt | 73 + components/vconsole/libconsole/LICENSE.txt | 1 + .../libconsole/include/console/cmddef.h | 24 + .../libconsole/include/console/config.h.in | 22 + .../libconsole/include/console/console.h | 362 ++ .../libconsole/include/console/console_io.h | 196 + .../libconsole/include/console/prefix_match.h | 94 + .../libconsole/include/console/utils.h | 213 + .../libconsole/lib/argtable3/CMakeLists.txt | 9 + .../libconsole/lib/argtable3/README.txt | 3 + .../libconsole/lib/argtable3/argtable3.c | 4969 +++++++++++++++++ .../libconsole/lib/argtable3/argtable3.h | 306 + components/vconsole/libconsole/src/console.c | 1824 ++++++ .../vconsole/libconsole/src/console_filecap.c | 42 + .../vconsole/libconsole/src/console_io.c | 194 + .../libconsole/src/console_linenoise.c | 1129 ++++ .../libconsole/src/console_linenoise.h | 248 + .../libconsole/src/console_prefix_match.c | 196 + .../libconsole/src/console_split_argv.c | 120 + .../libconsole/src/console_split_argv.h | 36 + .../vconsole/libconsole/src/console_utils.c | 204 + components/vconsole/libconsole/src/queue.h | 645 +++ main/CMakeLists.txt | 48 + main/Kconfig.projbuild | 27 + main/actuators.c | 194 + main/actuators.h | 29 + main/application.h | 26 + main/component.mk | 4 + main/console/cmd_common.h | 48 + main/console/commands/cmd_dump.c | 34 + main/console/commands/cmd_factory_reset.c | 50 + main/console/commands/cmd_heap.c | 38 + main/console/commands/cmd_ip.c | 341 ++ main/console/commands/cmd_pw.c | 52 + main/console/commands/cmd_pwm.c | 114 + main/console/commands/cmd_restart.c | 43 + main/console/commands/cmd_tasks.c | 51 + main/console/commands/cmd_version.c | 52 + main/console/commands/cmd_wifi.c | 360 ++ main/console/console_ioimpl.c | 418 ++ main/console/console_ioimpl.h | 77 + main/console/console_server.c | 155 + main/console/console_server.h | 29 + main/console/register_cmds.c | 32 + main/console/register_cmds.h | 6 + main/console/telnet_parser.c | 539 ++ main/console/telnet_parser.h | 47 + main/gitversion.h.in | 9 + main/mbiface.c | 212 + main/mbiface.h | 16 + main/settings.c | 160 + main/settings.h | 94 + main/shutdown_handlers.c | 31 + main/shutdown_handlers.h | 17 + main/sntp_cli.c | 63 + main/sntp_cli.h | 9 + main/tasks.h | 27 + main/user_main.c | 67 + main/utils.c | 71 + main/utils.h | 76 + main/wifi_conn.c | 190 + main/wifi_conn.h | 13 + sdkconfig | 1423 +++++ sdkconfig.old | 1262 +++++ 130 files changed, 29457 insertions(+) create mode 100644 .gitignore create mode 100644 CMakeLists.txt create mode 100644 Makefile create mode 100644 components/common_utils/CMakeLists.txt create mode 100644 components/common_utils/README.txt create mode 100644 components/common_utils/component.mk create mode 100644 components/common_utils/include/common_utils/base16.h create mode 100644 components/common_utils/include/common_utils/datetime.h create mode 100644 components/common_utils/include/common_utils/hexdump.h create mode 100644 components/common_utils/include/common_utils/utils.h create mode 100644 components/common_utils/src/base16.c create mode 100644 components/common_utils/src/common_utils.c create mode 100644 components/common_utils/src/datetime.c create mode 100644 components/common_utils/src/hexdump.c create mode 100644 components/dhcp_wd/CMakeLists.txt create mode 100644 components/dhcp_wd/Kconfig create mode 100644 components/dhcp_wd/README.txt create mode 100644 components/dhcp_wd/component.mk create mode 100644 components/dhcp_wd/include/dhcp_wd.h create mode 100644 components/dhcp_wd/src/dhcp_wd.c create mode 100644 components/esp32-ds18b20/.travis.yml create mode 100644 components/esp32-ds18b20/CMakeLists.txt create mode 100644 components/esp32-ds18b20/LICENSE create mode 100644 components/esp32-ds18b20/README.md create mode 100644 components/esp32-ds18b20/component.mk create mode 100644 components/esp32-ds18b20/doc/.gitignore create mode 100644 components/esp32-ds18b20/doc/Doxyfile create mode 100644 components/esp32-ds18b20/ds18b20.c create mode 100644 components/esp32-ds18b20/include/ds18b20.h create mode 100644 components/esp32-ds18b20/library.json create mode 100644 components/esp32-owb/.travis.yml create mode 100644 components/esp32-owb/CMakeLists.txt create mode 100644 components/esp32-owb/LICENSE create mode 100644 components/esp32-owb/README.md create mode 100644 components/esp32-owb/component.mk create mode 100644 components/esp32-owb/doc/.gitignore create mode 100644 components/esp32-owb/doc/Doxyfile create mode 100644 components/esp32-owb/include/owb.h create mode 100644 components/esp32-owb/include/owb_gpio.h create mode 100644 components/esp32-owb/include/owb_rmt.h create mode 100644 components/esp32-owb/library.json create mode 100644 components/esp32-owb/owb.c create mode 100644 components/esp32-owb/owb_gpio.c create mode 100644 components/esp32-owb/owb_rmt.c create mode 100644 components/modbus_slave/CMakeLists.txt create mode 100644 components/modbus_slave/README.txt create mode 100644 components/modbus_slave/component.mk create mode 100644 components/modbus_slave/include/modbus.h create mode 100644 components/modbus_slave/include/pp/payload_builder.h create mode 100644 components/modbus_slave/include/pp/payload_parser.h create mode 100644 components/modbus_slave/include/pp/type_coerce.h create mode 100644 components/modbus_slave/src/modbus.c create mode 100644 components/modbus_slave/src/pp/payload_builder.c create mode 100644 components/modbus_slave/src/pp/payload_parser.c create mode 100644 components/ping/CMakeLists.txt create mode 100644 components/ping/README.txt create mode 100644 components/ping/component.mk create mode 100644 components/ping/include/ping.h create mode 100644 components/ping/src/ping.c create mode 100644 components/socket_server/CMakeLists.txt create mode 100644 components/socket_server/README.txt create mode 100644 components/socket_server/component.mk create mode 100644 components/socket_server/include/socket_server.h create mode 100644 components/socket_server/src/socket_server.c create mode 100644 components/vconsole/CMakeLists.txt create mode 100644 components/vconsole/libconsole/.gitignore create mode 100644 components/vconsole/libconsole/CMakeLists.txt create mode 100644 components/vconsole/libconsole/LICENSE.txt create mode 100644 components/vconsole/libconsole/include/console/cmddef.h create mode 100644 components/vconsole/libconsole/include/console/config.h.in create mode 100644 components/vconsole/libconsole/include/console/console.h create mode 100644 components/vconsole/libconsole/include/console/console_io.h create mode 100644 components/vconsole/libconsole/include/console/prefix_match.h create mode 100644 components/vconsole/libconsole/include/console/utils.h create mode 100644 components/vconsole/libconsole/lib/argtable3/CMakeLists.txt create mode 100644 components/vconsole/libconsole/lib/argtable3/README.txt create mode 100644 components/vconsole/libconsole/lib/argtable3/argtable3.c create mode 100644 components/vconsole/libconsole/lib/argtable3/argtable3.h create mode 100644 components/vconsole/libconsole/src/console.c create mode 100644 components/vconsole/libconsole/src/console_filecap.c create mode 100644 components/vconsole/libconsole/src/console_io.c create mode 100644 components/vconsole/libconsole/src/console_linenoise.c create mode 100644 components/vconsole/libconsole/src/console_linenoise.h create mode 100644 components/vconsole/libconsole/src/console_prefix_match.c create mode 100644 components/vconsole/libconsole/src/console_split_argv.c create mode 100644 components/vconsole/libconsole/src/console_split_argv.h create mode 100644 components/vconsole/libconsole/src/console_utils.c create mode 100644 components/vconsole/libconsole/src/queue.h create mode 100644 main/CMakeLists.txt create mode 100644 main/Kconfig.projbuild create mode 100644 main/actuators.c create mode 100644 main/actuators.h create mode 100644 main/application.h create mode 100644 main/component.mk create mode 100644 main/console/cmd_common.h create mode 100644 main/console/commands/cmd_dump.c create mode 100644 main/console/commands/cmd_factory_reset.c create mode 100644 main/console/commands/cmd_heap.c create mode 100644 main/console/commands/cmd_ip.c create mode 100644 main/console/commands/cmd_pw.c create mode 100644 main/console/commands/cmd_pwm.c create mode 100644 main/console/commands/cmd_restart.c create mode 100644 main/console/commands/cmd_tasks.c create mode 100644 main/console/commands/cmd_version.c create mode 100644 main/console/commands/cmd_wifi.c create mode 100644 main/console/console_ioimpl.c create mode 100644 main/console/console_ioimpl.h create mode 100644 main/console/console_server.c create mode 100644 main/console/console_server.h create mode 100644 main/console/register_cmds.c create mode 100644 main/console/register_cmds.h create mode 100644 main/console/telnet_parser.c create mode 100644 main/console/telnet_parser.h create mode 100644 main/gitversion.h.in create mode 100644 main/mbiface.c create mode 100644 main/mbiface.h create mode 100644 main/settings.c create mode 100644 main/settings.h create mode 100644 main/shutdown_handlers.c create mode 100644 main/shutdown_handlers.h create mode 100644 main/sntp_cli.c create mode 100644 main/sntp_cli.h create mode 100644 main/tasks.h create mode 100644 main/user_main.c create mode 100644 main/utils.c create mode 100644 main/utils.h create mode 100644 main/wifi_conn.c create mode 100644 main/wifi_conn.h create mode 100644 sdkconfig create mode 100644 sdkconfig.old diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..657180e --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.idea/ +build +cmake-build-* diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..8a148c7 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,6 @@ +# The following lines of boilerplate have to be in your project's +# CMakeLists in this exact order for cmake to work correctly +cmake_minimum_required(VERSION 3.5) + +include($ENV{IDF_PATH}/tools/cmake/project.cmake) +project(geiger) diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..08f87c8 --- /dev/null +++ b/Makefile @@ -0,0 +1,8 @@ +# +# This is a project Makefile. It is assumed the directory this Makefile resides in is a +# project subdirectory. +# + +PROJECT_NAME := fanctl + +include $(IDF_PATH)/make/project.mk diff --git a/components/common_utils/CMakeLists.txt b/components/common_utils/CMakeLists.txt new file mode 100644 index 0000000..065ee43 --- /dev/null +++ b/components/common_utils/CMakeLists.txt @@ -0,0 +1,8 @@ +set(COMPONENT_ADD_INCLUDEDIRS include) + +set(COMPONENT_SRCDIRS + "src") + +#set(COMPONENT_REQUIRES) + +register_component() diff --git a/components/common_utils/README.txt b/components/common_utils/README.txt new file mode 100644 index 0000000..48f10c0 --- /dev/null +++ b/components/common_utils/README.txt @@ -0,0 +1,2 @@ +General purpose, mostly platofrm-idependent utilities +that may be used by other components. diff --git a/components/common_utils/component.mk b/components/common_utils/component.mk new file mode 100644 index 0000000..87ae05a --- /dev/null +++ b/components/common_utils/component.mk @@ -0,0 +1,3 @@ + +COMPONENT_SRCDIRS := src +COMPONENT_ADD_INCLUDEDIRS := include diff --git a/components/common_utils/include/common_utils/base16.h b/components/common_utils/include/common_utils/base16.h new file mode 100644 index 0000000..c3fc01d --- /dev/null +++ b/components/common_utils/include/common_utils/base16.h @@ -0,0 +1,75 @@ +/* + * Copyright (C) 2010 Michael Brown . + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License as + * published by the Free Software Foundation; either version 2 of the + * License, or any later version. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ + +#ifndef BASE16_H_ +#define BASE16_H_ + +#include +#include + +/** + * Calculate length of base16-encoded data + * @param raw_len Raw data length + * @return Encoded string length (excluding NUL) + */ +static inline size_t base16_encoded_len(size_t raw_len) { + return (2 * raw_len); +} + +/** + * Calculate maximum length of base16-decoded string + * @param encoded Encoded string + * @return Maximum length of raw data + */ +static inline size_t base16_decoded_max_len(const char *encoded) { + return ((strlen(encoded) + 1) / 2); +} + +/** + * Base16-encode data + * + * The buffer must be the correct length for the encoded string. Use + * something like + * + * char buf[ base16_encoded_len ( len ) + 1 ]; + * + * (the +1 is for the terminating NUL) to provide a buffer of the + * correct size. + * + * @param raw Raw data + * @param len Length of raw data + * @param encoded Buffer for encoded string + */ +extern void base16_encode(uint8_t *raw, size_t len, char *encoded); + +/** + * Base16-decode data + * + * The buffer must be large enough to contain the decoded data. Use + * something like + * + * char buf[ base16_decoded_max_len ( encoded ) ]; + * + * to provide a buffer of the correct size. + * @param encoded Encoded string + * @param raw Raw data + * @return Length of raw data, or negative error + */ +extern int base16_decode(const char *encoded, uint8_t *raw); + +#endif /* BASE16_H_ */ diff --git a/components/common_utils/include/common_utils/datetime.h b/components/common_utils/include/common_utils/datetime.h new file mode 100644 index 0000000..814b779 --- /dev/null +++ b/components/common_utils/include/common_utils/datetime.h @@ -0,0 +1,131 @@ +/** + * TODO file description + * + * Created on 2019/09/13. + */ + +#ifndef CSPEMU_DATETIME_H +#define CSPEMU_DATETIME_H + +#include +#include + +enum weekday { + MONDAY = 1, + TUESDAY, + WEDNESDAY, + THURSDAY, + FRIDAY, + SATURDAY, + SUNDAY +}; +_Static_assert(MONDAY==1, "enum weekday numbering Mon"); +_Static_assert(SUNDAY==7, "enum weekday numbering Sun"); + +enum month { + JANUARY = 1, + FEBRUARY, + MARCH, + APRIL, + MAY, + JUNE, + JULY, + AUGUST, + SEPTEMBER, + OCTOBER, + NOVEMBER, + DECEMBER +}; +_Static_assert(JANUARY==1, "enum month numbering Jan"); +_Static_assert(DECEMBER==12, "enum month numbering Dec"); + +/** Abbreviated weekday names */ +extern const char *DT_WKDAY_NAMES[]; +/** Full-length weekday names */ +extern const char *DT_WKDAY_NAMES_FULL[]; +/** Abbreviated month names */ +extern const char *DT_MONTH_NAMES[]; +/** Full-length month names */ +extern const char *DT_MONTH_NAMES_FULL[]; + +typedef struct datetime { + uint16_t year; + enum month month; + uint8_t day; + uint8_t hour; + uint8_t min; + uint8_t sec; + enum weekday wkday; // 1=monday +} datetime_t; + +// Templates for printf +#define DT_FORMAT_DATE "%d/%d/%d" +#define DT_SUBS_DATE(dt) (dt).year, (dt).month, (dt).day + +#define DT_FORMAT_TIME "%d:%02d:%02d" +#define DT_SUBS_TIME(dt) (dt).hour, (dt).min, (dt).sec + +#define DT_FORMAT_DATE_WK DT_FORMAT_WK " " DT_FORMAT_DATE +#define DT_SUBS_DATE_WK(dt) DT_SUBS_WK(dt), DT_SUBS_DATE(dt) + +#define DT_FORMAT_WK "%s" +#define DT_SUBS_WK(dt) DT_WKDAY_NAMES[(dt).wkday] + +#define DT_FORMAT_DATE_TIME DT_FORMAT_DATE " " DT_FORMAT_TIME +#define DT_SUBS_DATE_TIME(dt) DT_SUBS_DATE(dt), DT_SUBS_TIME(dt) + +#define DT_FORMAT DT_FORMAT_DATE_WK " " DT_FORMAT_TIME +#define DT_SUBS(dt) DT_SUBS_DATE_WK(dt), DT_SUBS_TIME(dt) + +// base century for two-digit year conversions +#define DT_CENTURY 2000 +// start year for weekday computation +#define DT_START_YEAR 2019 +// January 1st weekday of DT_START_YEAR +#define DT_START_WKDAY TUESDAY +// max date supported by 2-digit year RTC counters (it can't check Y%400==0 with only two digits) +#define DT_END_YEAR 2399 + +typedef union __attribute__((packed)) { + struct __attribute__((packed)) { + uint8_t ones : 4; + uint8_t tens : 4; + }; + uint8_t byte; +} bcd_t; +_Static_assert(sizeof(bcd_t) == 1, "Bad bcd_t len"); + +/** Check if a year is leap */ +static inline bool is_leap_year(int year) +{ + return year % 400 == 0 || (year % 4 == 0 && year % 100 != 0); +} + +/** + * Check if a datetime could be valid (ignores leap years) + * + * @param[in] dt + * @return basic validations passed + */ +bool datetime_is_valid(const datetime_t *dt); + +/** + * Set weekday based on a date in a given datetime + * + * @param[in,out] dt + * @return success + */ +bool datetime_set_weekday(datetime_t *dt); + +/** + * Get weekday for given a date + * + * @param year - year number + * @param month - 1-based month number + * @param day - 1-based day number + * @return weekday + */ +enum weekday date_weekday(uint16_t year, enum month month, uint8_t day); + + +#endif //CSPEMU_DATETIME_H diff --git a/components/common_utils/include/common_utils/hexdump.h b/components/common_utils/include/common_utils/hexdump.h new file mode 100644 index 0000000..1420de1 --- /dev/null +++ b/components/common_utils/include/common_utils/hexdump.h @@ -0,0 +1,19 @@ +/** + * @file + * @brief A simple way of dumping memory to a hex output + * + * \addtogroup Hexdump + * + * @{ + */ + + +#include + +#define HEX_DUMP_LINE_BUFF_SIZ 16 + +extern void hex_dump(FILE * fp,void *src, int len); +extern void hex_dump_buff_line(FILE *fp, int addr_size, unsigned pos, char *line, unsigned len); +/** + * }@ + */ diff --git a/components/common_utils/include/common_utils/utils.h b/components/common_utils/include/common_utils/utils.h new file mode 100644 index 0000000..5ab5514 --- /dev/null +++ b/components/common_utils/include/common_utils/utils.h @@ -0,0 +1,80 @@ +/** + * General purpose, platform agnostic, reusable utils + */ + +#ifndef COMMON_UTILS_UTILS_H +#define COMMON_UTILS_UTILS_H + +#include +#include + +#include "base16.h" +#include "datetime.h" +#include "hexdump.h" + +/** Convert a value to BCD struct */ +static inline bcd_t num2bcd(uint8_t value) +{ + return (bcd_t) {.ones=value % 10, .tens=value / 10}; +} + +/** Convert unpacked BCD to value */ +static inline uint8_t bcd2num(uint8_t tens, uint8_t ones) +{ + return tens * 10 + ones; +} + +/** + * Append to a buffer. + * + * In case the buffer capacity is reached, it stays unchanged (up to the terminator) and NULL is returned. + * + * @param buf - buffer position to append at; if NULL is given, the function immediately returns NULL. + * @param appended - string to append + * @param pcap - pointer to a capacity variable + * @return the new end of the string (null byte); use as 'buf' for following appends + */ +char *append(char *buf, const char *appended, size_t *pcap); + +/** + * Test if a file descriptor is valid (e.g. when cleaning up after a failed select) + * + * @param fd - file descriptor number + * @return is valid + */ +bool fd_is_valid(int fd); + +/** + * parse user-provided string as boolean + * + * @param str + * @return 0 false, 1 true, -1 invalid + */ +int parse_boolean_arg(const char *str); + +/** Check equality of two strings; returns bool */ +#define streq(a, b) (strcmp((const char*)(a), (const char*)(b)) == 0) + +/** Check prefix equality of two strings; returns bool */ +#define strneq(a, b, n) (strncmp((const char*)(a), (const char*)(b), (n)) == 0) + +/** Check if a string starts with a substring; returns bool */ +#define strstarts(a, b) strneq((a), (b), (int)strlen((b))) + +#ifndef MIN +/** Get min of two numbers */ +#define MIN(a, b) ((a) > (b) ? (b) : (a)) +#endif + +#ifndef MAX +/** Get max of two values */ +#define MAX(a, b) ((a) > (b) ? (a) : (b)) +#endif + +#ifndef STR +#define STR_HELPER(x) #x +/** Stringify a token */ +#define STR(x) STR_HELPER(x) +#endif + +#endif //COMMON_UTILS_UTILS_H diff --git a/components/common_utils/src/base16.c b/components/common_utils/src/base16.c new file mode 100644 index 0000000..6f13d0a --- /dev/null +++ b/components/common_utils/src/base16.c @@ -0,0 +1,62 @@ +/* + * Copyright (C) 2010 Michael Brown . + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License as + * published by the Free Software Foundation; either version 2 of the + * License, or any later version. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ + +#include +#include +#include +#include +#include + +static const char *TAG = "base16"; + +void base16_encode(uint8_t *raw, size_t len, char *encoded) { + uint8_t *raw_bytes = raw; + char *encoded_bytes = encoded; + size_t remaining = len; + + for (; remaining--; encoded_bytes += 2) + snprintf(encoded_bytes, 3, "%02X", *(raw_bytes++)); + +} + +int base16_decode(const char *encoded, uint8_t *raw) { + const char *encoded_bytes = encoded; + uint8_t *raw_bytes = raw; + char buf[3]; + char *endp; + size_t len; + + while (encoded_bytes[0]) { + if (!encoded_bytes[1]) { + ESP_LOGE(TAG, "Base16-encoded string \"%s\" has invalid length\n", + encoded); + return -22; + } + memcpy(buf, encoded_bytes, 2); + buf[2] = '\0'; + *(raw_bytes++) = strtoul(buf, &endp, 16); + if (*endp != '\0') { + ESP_LOGE(TAG,"Base16-encoded string \"%s\" has invalid byte \"%s\"\n", + encoded, buf); + return -22; + } + encoded_bytes += 2; + } + len = (raw_bytes - raw); + return (len); +} diff --git a/components/common_utils/src/common_utils.c b/components/common_utils/src/common_utils.c new file mode 100644 index 0000000..f5a7b6a --- /dev/null +++ b/components/common_utils/src/common_utils.c @@ -0,0 +1,52 @@ +#include +#include +#include +#include +#include + +#include "common_utils/utils.h" + +char *append(char *buf, const char *appended, size_t *pcap) +{ + char c; + char *buf0 = buf; + size_t cap = *pcap; + + if (buf0 == NULL) return NULL; + if (appended == NULL || appended[0] == 0) return buf0; + + while (cap > 1 && 0 != (c = *appended++)) { + *buf++ = c; + cap--; + } + if (cap == 0) { + *buf0 = '\0'; + return NULL; + } + + *pcap = cap; + *buf = 0; + return buf; +} + +bool fd_is_valid(int fd) +{ + return fcntl(fd, F_GETFD) != -1 || errno != EBADF; +} + +int parse_boolean_arg(const char *str) +{ + if (0 == strcasecmp(str, "on")) return 1; + if (strstarts(str, "en")) return 1; + if (strstarts(str, "y")) return 1; + if (0 == strcmp(str, "1")) return 1; + if (0 == strcasecmp(str, "a")) return 1; + + if (0 == strcasecmp(str, "off")) return 0; + if (0 == strcmp(str, "0")) return 0; + if (strstarts(str, "dis")) return 0; + if (strstarts(str, "n")) return 0; + + return -1; +} + diff --git a/components/common_utils/src/datetime.c b/components/common_utils/src/datetime.c new file mode 100644 index 0000000..b2fede4 --- /dev/null +++ b/components/common_utils/src/datetime.c @@ -0,0 +1,110 @@ + +#include +#include +#include +#include "common_utils/datetime.h" + +const char *DT_WKDAY_NAMES[] = { + [MONDAY] = "Mon", + [TUESDAY] = "Tue", + [WEDNESDAY] = "Wed", + [THURSDAY] = "Thu", + [FRIDAY] = "Fri", + [SATURDAY] = "Sat", + [SUNDAY] = "Sun" +}; + +const char *DT_WKDAY_NAMES_FULL[] = { + [MONDAY] = "Monday", + [TUESDAY] = "Tuesday", + [WEDNESDAY] = "Wednesday", + [THURSDAY] = "Thursday", + [FRIDAY] = "Friday", + [SATURDAY] = "Saturday", + [SUNDAY] = "Sunday" +}; + +const char *DT_MONTH_NAMES[] = { + [JANUARY] = "Jan", + [FEBRUARY] = "Feb", + [MARCH] = "Mar", + [APRIL] = "Apr", + [MAY] = "May", + [JUNE] = "Jun", + [JULY] = "Jul", + [AUGUST] = "Aug", + [SEPTEMBER] = "Sep", + [OCTOBER] = "Oct", + [NOVEMBER] = "Nov", + [DECEMBER] = "Dec" +}; + +const char *DT_MONTH_NAMES_FULL[] = { + [JANUARY] = "January", + [FEBRUARY] = "February", + [MARCH] = "March", + [APRIL] = "April", + [MAY] = "May", + [JUNE] = "June", + [JULY] = "July", + [AUGUST] = "August", + [SEPTEMBER] = "September", + [OCTOBER] = "October", + [NOVEMBER] = "November", + [DECEMBER] = "December" +}; + +static const uint16_t MONTH_LENGTHS[] = { /* 1-based, normal year */ + [JANUARY]=31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 +}; +_Static_assert(sizeof(MONTH_LENGTHS) / sizeof(uint16_t) == 13, "Months array length"); + +static const uint16_t MONTH_YEARDAYS[] = { /* 1-based */ + [JANUARY]=0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334 // // days until 1st of month +}; +_Static_assert(sizeof(MONTH_YEARDAYS) / sizeof(uint16_t) == 13, "Months array length"); + +_Static_assert(MONDAY < SUNDAY, "Weekday ordering"); + +bool datetime_is_valid(const datetime_t *dt) +{ + if (dt == NULL) return false; + + // check month first to avoid out-of-bounds read from the MONTH_LENGTHS table + if (!(dt->month >= JANUARY && dt->month <= DECEMBER)) return false; + + int monthlen = MONTH_LENGTHS[dt->month]; + if (dt->month == FEBRUARY && is_leap_year(dt->year)) { + monthlen = 29; + } + + return dt->sec < 60 && + dt->min < 60 && + dt->hour < 24 && + dt->wkday >= MONDAY && + dt->wkday <= SUNDAY && + dt->year >= DT_START_YEAR && + dt->year <= DT_END_YEAR && + dt->day >= 1 && + dt->day <= monthlen; +} + +bool datetime_set_weekday(datetime_t *dt) +{ + dt->wkday = MONDAY; // prevent the validator func erroring out on invalid weekday + if (!datetime_is_valid(dt)) return false; + dt->wkday = date_weekday(dt->year, dt->month, dt->day); + return true; +} + +enum weekday date_weekday(uint16_t year, enum month month, uint8_t day) +{ + uint16_t days = (DT_START_WKDAY - MONDAY) + (year - DT_START_YEAR) * 365 + MONTH_YEARDAYS[month] + (day - 1); + + for (uint16_t i = DT_START_YEAR; i <= year; i++) { + if (is_leap_year(i) && (i < year || month > FEBRUARY)) days++; + } + + return MONDAY + days % 7; +} + diff --git a/components/common_utils/src/hexdump.c b/components/common_utils/src/hexdump.c new file mode 100644 index 0000000..cbf90c2 --- /dev/null +++ b/components/common_utils/src/hexdump.c @@ -0,0 +1,72 @@ +/* + * util.c + * + * Created on: Aug 12, 2009 + * Author: johan + */ + +// adapted from libgomspace + +#include +#include +#include "common_utils/hexdump.h" + + +//! Dump memory to debugging output +/** + * Dumps a chunk of memory to the screen + */ +void hex_dump(FILE * fp, void *src, int len) { + int i, j=0, k; + char text[17]; + + text[16] = '\0'; + //printf("Hex dump:\r\n"); + fprintf(fp, "%p : ", src); + for(i=0; i 126)) { + text[k] = '.'; + } + } + fprintf(fp, " |%s|\n\r", text); + if(i= 32 && line[i] <= 126) + fprintf(fp, "%c", (unsigned char)line[i]); + else + fputc('.', fp); + } + fputs("|\r\n", fp); +} diff --git a/components/dhcp_wd/CMakeLists.txt b/components/dhcp_wd/CMakeLists.txt new file mode 100644 index 0000000..b07fa18 --- /dev/null +++ b/components/dhcp_wd/CMakeLists.txt @@ -0,0 +1,9 @@ +set(COMPONENT_ADD_INCLUDEDIRS + "include") + +set(COMPONENT_SRCDIRS + "src") + +set(COMPONENT_REQUIRES ping tcpip_adapter) + +register_component() diff --git a/components/dhcp_wd/Kconfig b/components/dhcp_wd/Kconfig new file mode 100644 index 0000000..c701475 --- /dev/null +++ b/components/dhcp_wd/Kconfig @@ -0,0 +1,27 @@ +menu "DHCP watchdog" + +config DHCPWD_PERIOD_GW_PING_S + int "Connectivity test interval (s)" + default 60 + help + Time between two connectivity tests (gateway ping) + +config DHCPWD_GETIP_TIMEOUT_S + int "Timeout to get IP (s)" + default 10 + help + Timeout after establishing connection to get an IP address from the DHCP server. + +config DHCPWD_TASK_STACK_SIZE + int "Task stack size (bytes)" + default 4096 + help + DHCP watchdog task stack size + +config DHCPWD_TASK_PRIORITY + int "Task priority" + default 3 + help + DHCP watchdog task priority + +endmenu diff --git a/components/dhcp_wd/README.txt b/components/dhcp_wd/README.txt new file mode 100644 index 0000000..a1a414f --- /dev/null +++ b/components/dhcp_wd/README.txt @@ -0,0 +1,5 @@ +DHCP ping watchdog. + +ESP32 sometimes loses wireless connectivity (expiring lease that fails to renew, +AP rebooting and forgetting us, etc). This module periodically pings the gateway +and triggers reconnect if the ping fails. diff --git a/components/dhcp_wd/component.mk b/components/dhcp_wd/component.mk new file mode 100644 index 0000000..87ae05a --- /dev/null +++ b/components/dhcp_wd/component.mk @@ -0,0 +1,3 @@ + +COMPONENT_SRCDIRS := src +COMPONENT_ADD_INCLUDEDIRS := include diff --git a/components/dhcp_wd/include/dhcp_wd.h b/components/dhcp_wd/include/dhcp_wd.h new file mode 100644 index 0000000..b301085 --- /dev/null +++ b/components/dhcp_wd/include/dhcp_wd.h @@ -0,0 +1,82 @@ +/** + * DHCP watchdog + * + * This is a workaround for a rare case where we don't get + * any IP after connecting with STA. If it takes too long, + * try power-cycling the DHCP client. If that fails too, + * try cycling the WiFi stack too. + * + * This does not try to reboot, as there are valid cases when this + * can happen - e.g. no DHCP on the network + no static IP configured yet. + * + * The ping component is used as a dependency. + */ + +#ifndef _DHCP_WD_H_ +#define _DHCP_WD_H_ + +#include "esp_netif.h" +#include "esp_event.h" +#include "freertos/FreeRTOS.h" +#include "freertos/task.h" + +typedef struct dhcp_wd_instance * dhcp_wd_handle_t; + +/** + * Start the watchdog. Handle must remain valid until the task is deleted. + * + * @param[in] iface + * @param[out] handle - pointer to a handle variable (will be written to it) + * @return success + */ +esp_err_t dhcp_watchdog_start(esp_netif_t * netif, bool is_wifi, dhcp_wd_handle_t *pHandle); + +/** + * Check if a watchdog is running + * + * @param[in] handle + * @return is running + */ +bool dhcp_watchdog_is_running(dhcp_wd_handle_t handle); + +/** + * Stop the watchdog and free resources. + * The handle becomes invalid and is set to NULL. + * + * @param[in] handle + * @return success + */ +esp_err_t dhcp_watchdog_stop(dhcp_wd_handle_t *pHandle); + +enum dhcp_wd_event { + DHCP_WD_NOTIFY_CONNECTED, + DHCP_WD_NOTIFY_DISCONNECTED, + DHCP_WD_NOTIFY_GOT_IP, +}; + +/** + * @brief Notify the watchdog task about a wifi state change + * + * Call this from the WiFi event handler. + * + * @param[in] handle + * @param[in] event - detected event + */ +esp_err_t dhcp_watchdog_notify(dhcp_wd_handle_t handle, enum dhcp_wd_event); + +enum dhcp_wd_test_result { + DHCP_WD_RESULT_OK = 0, + DHCP_WD_RESULT_PING_LOST, + DHCP_WD_RESULT_NO_GATEWAY, +}; + +/** + * Manually trigger a connection test by pinging the gateway. + * This is independent on any watchdog tasks and can be run without starting the watchdog. + * + * @param[in] iface - network interface, typically TCPIP_ADAPTER_IF_STA + * @return test result + */ +enum dhcp_wd_test_result dhcp_wd_test_connection(esp_netif_t *iface); + +#endif //_DHCP_WD_H_ diff --git a/components/dhcp_wd/src/dhcp_wd.c b/components/dhcp_wd/src/dhcp_wd.c new file mode 100644 index 0000000..3281bba --- /dev/null +++ b/components/dhcp_wd/src/dhcp_wd.c @@ -0,0 +1,277 @@ +#include +#include "esp_log.h" +#include "dhcp_wd.h" +#include "esp_wifi.h" +//#include "esp_eth.h" +#include "ping.h" + +#define xstr(s) str(s) +#define str(s) #s + +#define PERIOD_GW_PING_S CONFIG_DHCPWD_PERIOD_GW_PING_S +#define GETIP_TIMEOUT_S CONFIG_DHCPWD_GETIP_TIMEOUT_S +#define TASK_STACK_SIZE CONFIG_DHCPWD_TASK_STACK_SIZE +#define TASK_PRIO CONFIG_DHCPWD_TASK_PRIORITY + +static const char *TAG = "dhcp_wd"; + +static void dhcp_watchdog_task(void *parm); + +struct dhcp_wd_instance { + TaskHandle_t task; + esp_netif_t * iface; + bool is_wifi; + bool running; +}; + +#define STATES_ENUM \ + X(DISCONECTED) \ + X(CONECTED_WAIT_IP) \ + X(CONECTED_WAIT_IP2) \ + X(CONECTED) + +enum dhcp_wd_state { +#undef X +#define X(s) STATE_##s, + STATES_ENUM +}; + +const char *state_names[] = { +#undef X +#define X(s) xstr(s), + STATES_ENUM +}; + +enum dhcp_wd_notify { + NOTIFY_CONNECTED = BIT0, + NOTIFY_DISCONNECTED = BIT1, + NOTIFY_GOT_IP = BIT2, + NOTIFY_SHUTDOWN = BIT3, // kills the task +}; + +/** Send a notification to the watchdog task */ +esp_err_t dhcp_watchdog_notify(dhcp_wd_handle_t handle, const enum dhcp_wd_event event) +{ + assert(handle != NULL); + assert(handle->task != NULL); + + uint32_t flag = 0; + + switch (event) { + case DHCP_WD_NOTIFY_CONNECTED: + flag = NOTIFY_CONNECTED; + break; + + case DHCP_WD_NOTIFY_DISCONNECTED: + flag = NOTIFY_DISCONNECTED; + break; + + case DHCP_WD_NOTIFY_GOT_IP: + flag = NOTIFY_GOT_IP; + break; + + default: + break; + } + + BaseType_t ret = pdPASS; + if (flag != 0) { + ret = xTaskNotify(handle->task, flag, eSetBits); + } + + return (pdPASS == ret) ? ESP_OK : ESP_FAIL; +} + +/** + * Start the watchdog + */ +esp_err_t dhcp_watchdog_start(esp_netif_t * netif, bool is_wifi, dhcp_wd_handle_t *pHandle) +{ + assert(pHandle != NULL); + + dhcp_wd_handle_t handle = calloc(1, sizeof(struct dhcp_wd_instance)); + if (!handle) return ESP_ERR_NO_MEM; + *pHandle = handle; + + handle->iface = netif; + handle->is_wifi = is_wifi; + + BaseType_t ret = xTaskCreate(dhcp_watchdog_task, "dhcp-wd", TASK_STACK_SIZE, (void *)handle, TASK_PRIO, &handle->task); + handle->running = true; + + return (pdPASS == ret) ? ESP_OK : ESP_FAIL; +} + +/** + * Check if a watchdog is still running + * + * @param handle + * @return is running + */ +bool dhcp_watchdog_is_running(dhcp_wd_handle_t handle) +{ + return handle->running; +} + +/** + * Stop the watchdog and free resources + */ +esp_err_t dhcp_watchdog_stop(dhcp_wd_handle_t *pHandle) +{ + assert(pHandle != NULL); + assert(*pHandle != NULL); + xTaskNotify((*pHandle)->task, NOTIFY_SHUTDOWN, eSetBits); + *pHandle = NULL; + return ESP_OK; +} + +/** + * @param parm - tcpip_adapter_if_t iface (cast to void *) - typically TCPIP_ADAPTER_IF_STA + */ +static void dhcp_watchdog_task(void *parm) +{ + enum dhcp_wd_state state = STATE_DISCONECTED; + + dhcp_wd_handle_t handle = parm; + assert(handle != NULL); + assert(handle->iface != NULL); + + ESP_LOGI(TAG, "Watchdog started"); + + while (1) { + uint32_t flags = 0; + uint32_t wait_s; + TickType_t waittime; + + switch (state) { + case STATE_DISCONECTED: + wait_s = waittime = portMAX_DELAY; + break; + + case STATE_CONECTED_WAIT_IP: + case STATE_CONECTED_WAIT_IP2: + wait_s = GETIP_TIMEOUT_S; + waittime = (GETIP_TIMEOUT_S * 1000) / portTICK_PERIOD_MS; + break; + + case STATE_CONECTED: + wait_s = PERIOD_GW_PING_S; + waittime = (PERIOD_GW_PING_S * 1000) / portTICK_PERIOD_MS; + break; + + default: + assert(0); + } + + ESP_LOGD(TAG, "State %s, wait %d s", state_names[state], wait_s); + BaseType_t rv = xTaskNotifyWait( + /* no clear on entry */ pdFALSE, + /* clear all on exit */ ULONG_MAX, + &flags, waittime); + + if (rv == pdPASS) { + // the order here is important in case we get multiple events at once + + if (flags & NOTIFY_DISCONNECTED) { + state = STATE_DISCONECTED; + } + + if (flags & NOTIFY_CONNECTED) { + state = STATE_CONECTED_WAIT_IP; + } + + if (flags & NOTIFY_GOT_IP) { + state = STATE_CONECTED; + } + + if (flags & NOTIFY_SHUTDOWN) { + // kill self + handle->running = false; + free(handle); + vTaskDelete(NULL); + return; + } + } else { + // a timeout occurred + + switch (state) { + case STATE_DISCONECTED: + // this shouldn't happen, we have infinite delay waiting for disconnected + ESP_LOGW(TAG, "dhcp_wd double discon evt"); + break; + + case STATE_CONECTED_WAIT_IP: + ESP_LOGW(TAG, "Get IP timeout, restarting DHCP client"); + // this is a bit suspicious + // try to restart the DHCPC client + ESP_ERROR_CHECK(esp_netif_dhcpc_stop(handle->iface)); + ESP_ERROR_CHECK(esp_netif_dhcpc_start(handle->iface)); + state = STATE_CONECTED_WAIT_IP2; + break; + + case STATE_CONECTED_WAIT_IP2: + ESP_LOGW(TAG, "Get IP timeout 2, restarting network stack"); + // well now this is weird. try flipping the whole WiFi/Eth stack + if (handle->is_wifi) { + ESP_ERROR_CHECK(esp_wifi_disconnect()); + } + // this will trigger the disconnected event and loop back into Disconnected + // the disconnect event handler calls connect again + state = STATE_DISCONECTED; + break; + + case STATE_CONECTED: { + // Ping gateway to check if we're still connected + enum dhcp_wd_test_result result = dhcp_wd_test_connection(handle->iface); + + if (result == DHCP_WD_RESULT_PING_LOST) { + // looks like the gateway silently dropped us + // try kicking the DHCP client, if it helps + ESP_ERROR_CHECK(esp_netif_dhcpc_stop(handle->iface)); + ESP_ERROR_CHECK(esp_netif_dhcpc_start(handle->iface)); + state = STATE_CONECTED_WAIT_IP2; + // if not, it'll flip the whole wifi stack + } else { + ESP_LOGD(TAG, "Gateway ping OK"); + } + break; + } + } + } + } +} + +enum dhcp_wd_test_result dhcp_wd_test_connection(esp_netif_t *iface) +{ + ESP_LOGD(TAG, "Ping Gateway to check if IP is valid"); + + ping_opts_t opts = PING_CONFIG_DEFAULT(); + opts.count = 3; + opts.interval_ms = 0; + opts.timeout_ms = 1000; + + esp_netif_ip_info_t ip_info = {}; + ESP_ERROR_CHECK(esp_netif_get_ip_info(iface, &ip_info)); + + opts.ip_addr.addr = ip_info.gw.addr; + + ping_result_t result = {}; + + if (ip_info.gw.addr != 0) { + esp_err_t ret = ping(&opts, &result); + if (ret != ESP_OK) { + ESP_LOGW(TAG, "Ping error"); + return DHCP_WD_RESULT_PING_LOST; + } + ESP_LOGD(TAG, "Ping result: %d tx, %d rx", result.sent, result.received); + if (result.received == 0) { + ESP_LOGW(TAG, "Failed to ping GW"); + return DHCP_WD_RESULT_PING_LOST; + } else { + return DHCP_WD_RESULT_OK; + } + } else { + ESP_LOGW(TAG, "No GW IP to ping"); + return DHCP_WD_RESULT_NO_GATEWAY; + } +} diff --git a/components/esp32-ds18b20/.travis.yml b/components/esp32-ds18b20/.travis.yml new file mode 100644 index 0000000..db67cc7 --- /dev/null +++ b/components/esp32-ds18b20/.travis.yml @@ -0,0 +1,39 @@ +# Build and deploy doxygen documention to GitHub Pages +sudo: false +dist: trusty + +# Blacklist +branches: + only: + - master + +# Environment variables +env: + global: + - GH_REPO_REF: github.com/DavidAntliff/esp32-ds18b20.git + +# Install dependencies +addons: + apt: + packages: + - doxygen + - doxygen-doc + - doxygen-latex + - doxygen-gui + - graphviz + +# Build the docs +script: + - cd doc + - doxygen + +# Deploy using Travis-CI/GitHub Pages integration support +deploy: + provider: pages + skip-cleanup: true + local-dir: doc/html + github-token: $GITHUB_TOKEN + on: + branch: master + target-branch: gh-pages + diff --git a/components/esp32-ds18b20/CMakeLists.txt b/components/esp32-ds18b20/CMakeLists.txt new file mode 100644 index 0000000..94bb004 --- /dev/null +++ b/components/esp32-ds18b20/CMakeLists.txt @@ -0,0 +1,6 @@ +set(COMPONENT_ADD_INCLUDEDIRS include) +set(COMPONENT_SRCS "ds18b20.c") +set(COMPONENT_PRIV_REQUIRES "esp32-owb") +register_component() + + diff --git a/components/esp32-ds18b20/LICENSE b/components/esp32-ds18b20/LICENSE new file mode 100644 index 0000000..441ee32 --- /dev/null +++ b/components/esp32-ds18b20/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 David Antliff + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/components/esp32-ds18b20/README.md b/components/esp32-ds18b20/README.md new file mode 100644 index 0000000..e60e0b3 --- /dev/null +++ b/components/esp32-ds18b20/README.md @@ -0,0 +1,98 @@ +# esp32-ds18b20 + +## Introduction + +This is a ESP32-compatible C component for the Maxim Integrated DS18B20 Programmable Resolution 1-Wire Digital +Thermometer device. + +It supports multiple devices on the same 1-Wire bus. + +It is written and tested for v2.1, v3.0-3.3 and v4.1-beta1 of the [ESP-IDF](https://github.com/espressif/esp-idf) +environment, using the xtensa-esp32-elf toolchain (gcc version 5.2.0). + +## Dependencies + +Requires [esp32-owb](https://github.com/DavidAntliff/esp32-owb). + +## Example + +See [esp32-ds18b20-example](https://github.com/DavidAntliff/esp32-ds18b20-example) for an example that supports single +and multiple devices on a single bus. + +## Features + +In cooperation with the underlying esp32-owb component, this component includes: + + * External power supply mode. + * Parasitic power mode (VDD and GND connected) - see notes below. + * Static (stack-based) or dynamic (malloc-based) memory model. + * No globals - support any number of DS18B20 devices on any number of 1-Wire buses simultaneously. + * 1-Wire device detection and validation, including search for multiple devices on a single bus. + * Addressing optimisation for a single (solo) device on a bus. + * CRC checks on temperature data. + * Programmable temperature measurement resolution (9, 10, 11 or 12-bit resolution). + * Temperature conversion and retrieval. + * Separation of conversion and temperature retrieval to allow for simultaneous conversion across multiple devices. + +## Parasitic Power Mode + +Consult the [datasheet](http://datasheets.maximintegrated.com/en/ds/DS18B20.pdf) for more detailed information about +Parasitic Power mode. + +Parasitic power operation can be detected by `ds18b20_check_for_parasite_power()` followed by a call to +`owb_use_parasitic_power()`, or simply set explicitly by a call to the latter. + +This library has been tested on the ESP32 with two parasitic-power configurations, with two DS18B20 devices at 3.3V: + +1. Disconnect power to each device's VDD pin, and connect that pin to GND for each device. Power is supplied to + each device through the OWB data line. +2. Connect the OWB data line to VCC via a P-channel MOSFET (e.g. BS250) and current-limiting resistor (e.g. 270 Ohm). + Ensure your code calls `owb_use_strong_pullup_gpio()` with the GPIO connected to the MOSFET Gate. The GPIO will go + high during temperature conversion, turning on the MOSFET and providing power from VCC to each device through the OWB + data line. + +If you set up configuration 1 and do not see CRC errors, but you get incorrect temperature readings around 80 - 85 +degrees C, then it is likely that your DS18B20 devices are running out of power during the temperature conversion. In +this case, consider reducing the value of the pull-up resistor. For example, I have had success obtaining correct +conversions from two parasitic DS18B20 devices by replacing the 4k7 Ohm pull-up resistor with a 1 kOhm resistor. + +Alternatively, consider using configuration 2. + +Note that use of parasitic power mode disables the ability for devices on the bus to signal that an operation has +completed. This means that DS18B20 devices in parasitic power mode are not able to communicate when they have completed +a temperature conversion. In this mode, a delay for a pre-calculated duration occurs, and then the conversion result is +read from the device(s). *If your ESP32 is not running on the correct clock rate, this duration may be too short!* + +## Documentation + +Automatically generated API documentation (doxygen) is available [here](https://davidantliff.github.io/esp32-ds18b20/index.html). + +## Source Code + +The source is available from [GitHub](https://www.github.com/DavidAntliff/esp32-ds18b20). + +## License + +The code in this project is licensed under the MIT license - see LICENSE for details. + +## Links + + * [DS18B20 Datasheet](http://datasheets.maximintegrated.com/en/ds/DS18B20.pdf) + * [1-Wire Communication Through Software](https://www.maximintegrated.com/en/app-notes/index.mvp/id/126) + * [1-Wire Search Algorithm](https://www.maximintegrated.com/en/app-notes/index.mvp/id/187) + * [Espressif IoT Development Framework for ESP32](https://github.com/espressif/esp-idf) + +## Acknowledgements + +Parts of this code are based on references provided to the public domain by Maxim Integrated. + +"1-Wire" is a registered trademark of Maxim Integrated. + +## Roadmap + +The following features are anticipated but not yet implemented: + + * Concurrency support (multiple tasks accessing devices on the same bus). + * Alarm support. + * EEPROM support. + * Parasitic power support. diff --git a/components/esp32-ds18b20/component.mk b/components/esp32-ds18b20/component.mk new file mode 100644 index 0000000..346dafd --- /dev/null +++ b/components/esp32-ds18b20/component.mk @@ -0,0 +1 @@ +# Use defaults diff --git a/components/esp32-ds18b20/doc/.gitignore b/components/esp32-ds18b20/doc/.gitignore new file mode 100644 index 0000000..34f5d30 --- /dev/null +++ b/components/esp32-ds18b20/doc/.gitignore @@ -0,0 +1,3 @@ +html/ +latex/ + diff --git a/components/esp32-ds18b20/doc/Doxyfile b/components/esp32-ds18b20/doc/Doxyfile new file mode 100644 index 0000000..a609c28 --- /dev/null +++ b/components/esp32-ds18b20/doc/Doxyfile @@ -0,0 +1,2496 @@ +# Doxyfile 1.8.13 + +# 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 config 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 http://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 = "esp32-ds18b20" + +# 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 = + +# 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 = "ESP32-compatible C library for Maxim Integrated DS18B20 Programmable Resolution 1-Wire Digital Thermometer." + +# 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 = + +# 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 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 + +# 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:\n" +# 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:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# 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 = YES + +# 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 + +# 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, +# C#, C, C++, D, PHP, Objective-C, Python, 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), VHDL. 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. + +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 http://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: 0. +# 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: +# http://www.riverbankcomputing.co.uk/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 = NO + +# 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 = NO + +# 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 = NO + +# 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 + +#--------------------------------------------------------------------------- +# 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_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 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 +# (class|struct|union) 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 + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# 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_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 = NO + +# 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 = YES + +# 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. +# +# 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 http://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 not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = 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 or incomplete +# parameter documentation, but not about the absence of documentation. +# 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. +# 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 = ../README.md \ + ../include \ + .. + +# 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: http://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. +# +# 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++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf + +# 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 = NO + +# 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 = ../README.md + +#--------------------------------------------------------------------------- +# 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 +# function 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 http://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 config 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 + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# 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 + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# 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 colorwheel, see +# http://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 grayscales 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_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: http://developer.apple.com/tools/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 http://developer.apple.com/tools/creatingdocsetswithdoxygen.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 +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# 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 master .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: http://qt-project.org/doc/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: http://qt-project.org/doc/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: http://qt-project.org/doc/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: http://qt-project.org/doc/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: +# http://qt-project.org/doc/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 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. 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 = 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 + +# 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_TRANPARENT 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 + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://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 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) 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 http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# 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/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 +# , /