[ { "path": ".github/ISSUE_TEMPLATE/bug_report.md", "content": "---\nname: Bug report\nabout: Create a report to help us improve\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n**Context**\n- Which example sketch are you using?\n- Which changes to the code did you make (if any)?\n- Which sensor are you using?\n\n**Describe the bug**\nA clear and concise description of what the bug is.\n\n**To Reproduce**\nSteps to reproduce the behavior:\n1. Step1 '...'\n2. Step2 '....'\n3. Step3 '....'\n4. See error\n\n**Expected behavior**\nA clear and concise description of what you expected to happen.\n\n**Debug Log**\nIf applicable, add log file to help explain your problem.\n - Build log file (enable verbose output in the Arduino IDE: File->Preferences - \"Show verbose output during: compile\")\n - Serial console log file (see [Debug Output Configuration in Arduino IDE](https://github.com/matthias-bs/BresserWeatherSensorReceiver/blob/main/DEBUG_OUTPUT.md))\n\n**Embedded Device (please complete the following information):**\n - Arduino IDE Version: [e.g. 1.8.19]\n - ESP32/ESP8266 Board Support Package Version: [e.g. ESP32 2.0.7]\n - Library Version [e.g. 0.6.1]\n - Your Board: [brand/model/version] (if unsure, attach a photo)\n - Selected Board in the Arduino IDE: [brand/model/version]\n - Your Radio Transceiver Module (if external): [brand/model/chipset/frequency] \n - **Pinning/Wiring**\n\n**Additional context**\nAdd any other context about the problem here.\n" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.md", "content": "---\nname: Feature request\nabout: Suggest an idea for this project\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n\n**Is your feature request related to a problem? Please describe.**\nA clear and concise description of what the problem is. Ex. I'm always frustrated when [...]\n\n**Describe the solution you'd like**\nA clear and concise description of what you want to happen.\n\n**Describe alternatives you've considered**\nA clear and concise description of any alternative solutions or features you've considered.\n\n**Additional context**\nAdd any other context or screenshots about the feature request here.\n" }, { "path": ".github/dependabot.yml", "content": "# To get started with Dependabot version updates, you'll need to specify which\n# package ecosystems to update and where the package manifests are located.\n# Please see the documentation for all configuration options:\n# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates\n\n# Note: package.json is a PlatformIO/Arduino library manifest, not an npm package.\n# The npm ecosystem is intentionally omitted to avoid Dependabot trying to resolve\n# Arduino library names (which may contain spaces) as npm packages.\n\nversion: 2\nupdates:\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n" }, { "path": ".github/workflows/CI.yml", "content": "name: CI\n\non:\n push:\n branches: [ \"main\" ]\n pull_request:\n branches: [ \"main\" ]\n workflow_dispatch:\n\njobs:\n\n build:\n strategy:\n matrix:\n board:\n - esp32:esp32:esp32:DebugLevel=none\n - esp32:esp32:esp32:PartitionScheme=huge_app,DebugLevel=verbose\n - esp32:esp32:firebeetle32\n #- esp32:esp32:ttgo-lora32:Revision=TTGO_LoRa32_V1\n #- esp32:esp32:ttgo-lora32:Revision=TTGO_LoRa32_V2\n - esp32:esp32:ttgo-lora32:Revision=TTGO_LoRa32_v21new\n - esp32:esp32:lilygo_t3s3:Revision=Radio_SX1262\n - esp32:esp32:lilygo_t3s3:Revision=Radio_SX1276\n - esp32:esp32:lilygo_t3s3:Revision=Radio_LR1121\n #- esp32:esp32:heltec_wireless_stick\n #- esp32:esp32:heltec_wifi_lora_32_V2\n - esp32:esp32:heltec_wifi_lora_32_V3\n - esp32:esp32:adafruit_feather_esp32s2\n - esp32:esp32:featheresp32\n - esp32:esp32:esp32s3_powerfeather\n - esp32:esp32:XIAO_ESP32S3\n - esp8266:esp8266:generic:dbg=Disabled\n - esp8266:esp8266:generic:dbg=Serial\n - rp2040:rp2040:adafruit_feather:dbgport=Serial\n \n\n\n runs-on: ubuntu-latest\n name: ${{ matrix.board }}\n env:\n run-build: ${{ contains(matrix.board, 'esp32:esp32') || contains(matrix.board, 'esp8266:esp8266') || contains(matrix.board, 'rp2040:rp2040') || contains(github.event.head_commit.message, 'CI_BUILD_ALL') || contains(github.event.head_commit.message, 'Bump version to') || contains(github.event.head_commit.message, format('{0}', matrix.board)) }}\n\n steps:\n - name: Install arduino-cli\n if: ${{ env.run-build == 'true' }}\n run:\n |\n mkdir -p ~/.local/bin\n echo \"~/.local/bin\" >> $GITHUB_PATH\n curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=~/.local/bin sh\n\n - name: Get platform name\n if: ${{ env.run-build == 'true' }}\n uses: jungwinter/split@v2\n id: split\n with:\n msg: ${{ matrix.board }}\n separator: ':'\n\n - name: Prepare platform-specific settings\n if: ${{ env.run-build == 'true' }}\n id: prep\n run:\n |\n # common settings - no extra options, skip nothing, all warnings\n echo \"options=''\" >> $GITHUB_OUTPUT\n echo \"logdef=''\" >> $GITHUB_OUTPUT\n echo \"skip-pattern=(Feather32u4).*ino\" >> $GITHUB_OUTPUT\n echo \"warnings='all'\" >> $GITHUB_OUTPUT\n \n #if [[ \"${{ contains(matrix.loglevel, 'LOG_LEVEL_NONE') }}\" == \"true\" ]]; then\n # echo \"logdef=--build-property \"build.extra_flags=\\\"-DCORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_NONE\\\" >> $GITHUB_OUTPUT\n #\n #elif [[ \"${{ contains(matrix.loglevel, 'LOG_LEVEL_VERBOSE') }}\" == \"true\" ]]; then\n # echo \"logdef=--build-property \"build.extra_flags=\\\"-DCORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_VERBOSE\\\" >> $GITHUB_OUTPUT\n #fi\n\n # platform-dependent settings - extra board options, board index URLs, skip patterns etc.\n if [[ \"${{ contains(matrix.board, 'esp32:esp32') }}\" == \"true\" ]]; then\n # ESP32\n python -m pip install pyserial\n echo \"index-url=--additional-urls https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json\" >> $GITHUB_OUTPUT\n skip_patterns=()\n if [[ ! \"${{ contains(matrix.board, 'esp32:esp32:m5stack') }}\" == \"true\" ]]; then\n skip_patterns+=(\"(M5Core2).*ino\")\n fi\n if [[ ! \"${{ contains(matrix.board, 'ttgo') || contains(matrix.board, 'lilygo_t3s3') }}\" == \"true\" ]]; then\n skip_patterns+=(\"BresserWeatherSensorOLED.ino\")\n fi\n if [[ ! \"${{ contains(matrix.board, 'TTGO_LoRa32_V2') || contains(matrix.board, 'TTGO_LoRa32_v21new') || contains(matrix.board, 'lilygo_t3s3') }}\" == \"true\" ]]; then\n skip_patterns+=(\"BresserWeatherSensorSDCard.ino\")\n fi\n echo \"skip-pattern=$(IFS='|'; echo \"${skip_patterns[*]}\")\" >> $GITHUB_OUTPUT\n elif [[ \"${{ contains(matrix.board, 'esp8266:esp8266') }}\" == \"true\" ]]; then\n # ESP8266\n echo \"options=,xtal=80,ResetMethod=ck,CrystalFreq=26,FlashFreq=40,FlashMode=qio,eesz=512K\" >> $GITHUB_OUTPUT\n echo \"index-url=--additional-urls http://arduino.esp8266.com/stable/package_esp8266com_index.json\" >> $GITHUB_OUTPUT\n echo \"skip-pattern=(M5Core2|OLED|SDCard).*ino\" >> $GITHUB_OUTPUT\n \n elif [[ \"${{ contains(matrix.board, 'rp2040:rp2040') }}\" == \"true\" ]]; then\n # RP2040\n #echo \"options=,xtal=80,ResetMethod=ck,CrystalFreq=26,FlashFreq=40,FlashMode=qio,eesz=512K\" >> $GITHUB_OUTPUT\n echo \"index-url=--additional-urls https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json\" >> $GITHUB_OUTPUT\n echo \"skip-pattern=(M5Core2|MQTT|Domoticz|CanvasGauges|OLED|SDCard).*ino\" >> $GITHUB_OUTPUT\n \n fi\n\n - name: Install libraries\n if: ${{ env.run-build == 'true' }}\n run:\n |\n ps -p \"$$\"\n arduino-cli lib install RadioLib@7.6.0\n arduino-cli lib install MQTT@2.5.3\n arduino-cli lib install ArduinoJson@7.4.3\n arduino-cli lib install WiFiManager@2.0.17\n arduino-cli lib install ESP_DoubleResetDetector@1.3.2\n arduino-cli lib install Preferences@2.2.2\n arduino-cli lib install \"ESP Async TCP\"@2.0.0\n arduino-cli lib install \"Async TCP\"@3.4.10\n arduino-cli lib install \"ESP Async WebServer\"@3.10.3\n arduino-cli lib install \"Adafruit SSD1306\"@2.5.16\n arduino-cli lib install \"RTClib@2.1.4\"\n # The following libs are only needed for M5Stack Core2\n #arduino-cli lib install M5Unified@0.2.11\n #arduino-cli lib install M5GFX@0.2.18\n # Only ESP32-S3 PowerFeather\n arduino-cli lib install powerfeather-sdk@1.1.1\n\n - name: Install platform\n if: ${{ env.run-build == 'true' }}\n run:\n |\n arduino-cli core update-index ${{ format('{0}', steps.prep.outputs.index-url) }}\n arduino-cli core install ${{ format('{0}:{1} {2}', steps.split.outputs._0, steps.split.outputs._1, steps.prep.outputs.index-url) }}\n \n - name: Checkout repository\n if: ${{ env.run-build == 'true' }}\n uses: actions/checkout@v6\n\n - name: Build examples\n if: ${{ env.run-build == 'true' }}\n run:\n |\n for example in $(find $PWD/examples -name '*.ino' | sort); do\n # check whether to skip this sketch\n if [ ! -z '${{ steps.prep.outputs.skip-pattern }}' ] && [[ ${example} =~ ${{ steps.prep.outputs.skip-pattern }} ]]; then\n # skip sketch\n echo -e \"\\n\\033[1;33mSkipped ${example##*/} (matched with ${{ steps.prep.outputs.skip-pattern }})\\033[0m\";\n else\n # build sketch\n echo -e \"\\n\\033[1;33mBuilding ${example##*/} ... \\033[0m\";\n arduino-cli compile --libraries /home/runner/work/BresserWeatherSensorReceiver --fqbn ${{ matrix.board }}${{ steps.prep.outputs.options }} $example --warnings=${{ steps.prep.outputs.warnings }}\n if [ $? -ne 0 ]; then\n echo -e \"\\033[1;31m${example##*/} build FAILED\\033[0m\\n\";\n exit 1;\n else\n echo -e \"\\033[1;32m${example##*/} build PASSED\\033[0m\\n\";\n fi\n fi\n done\n" }, { "path": ".github/workflows/CppUTest.yml", "content": "# Unit testing with CppUTest (including code coverage)\n\nname: CppUTest\n\n# Controls when the workflow will run\non:\n # Triggers the workflow on push or pull request events but only for the \"main\" branch\n push:\n branches: [ \"main\" ]\n pull_request:\n branches: [ \"main\" ]\n\n # Allows you to run this workflow manually from the Actions tab\n workflow_dispatch:\n\n# A workflow run is made up of one or more jobs that can run sequentially or in parallel\njobs:\n # This workflow contains a single job called \"build\"\n build:\n # The type of runner that the job will run on\n runs-on: ubuntu-latest\n\n # Steps represent a sequence of tasks that will be executed as part of the job\n steps:\n # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it\n - uses: actions/checkout@v6\n\n - name: Preparing Build System\n run: | # define a custom multi-line command (instead of a reusable action) for this step\n sudo apt-get update\n sudo apt-get install cpputest lcov\n \n ## Runs all unit tests\n #- name: Run unit tests\n # run: |\n # cd test\n # make\n\n # Runs all units tests with coverage report\n - name: Run unit tests with coverage report\n run: |\n cd test\n make lcov\n #- name: Where are we?\n # run: pwd\n - name: Coveralls\n uses: coverallsapp/github-action@v2\n with:\n file: test/build/lcov.info\n github-token: ${{ secrets.GITHUB_TOKEN }}\n \n" }, { "path": ".github/workflows/arduino-lint.yml", "content": "name: Arduino-lint\n\non: [push, pull_request]\njobs:\n lint:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n - uses: arduino/arduino-lint-action@v2\n with:\n library-manager: update\n # compliance: strict\n \n" }, { "path": ".github/workflows/doxygen.yml", "content": "name: Doxygen\n\non:\n push:\n branches: [ \"main\" ]\n workflow_dispatch:\n\njobs:\n doxygen:\n runs-on: ubuntu-latest\n steps:\n - name: Install Doxygen and Xsltproc\n run: |\n sudo apt-get update\n sudo apt-get install -y doxygen\n sudo apt-get install xsltproc\n - uses: actions/checkout@v6\n\n - name: Generate docs\n run: doxygen Doxyfile\n\n - name: Generate keywords.txt\n run: |\n xsltproc doxygen2keywords.xsl docs/xml/index.xml >keywords.txt\n echo \"-----------------------------------------------------------\"\n cat keywords.txt\n echo \"-----------------------------------------------------------\"\n\n - name: Deploy to GitHub Pages\n uses: JamesIves/github-pages-deploy-action@releases/v4\n with:\n BRANCH: gh-pages\n FOLDER: docs/html\n \n" }, { "path": ".github/workflows/spell-check-exclude.txt", "content": " * Die Berechnung des Taupunktes erfolgt aus den Messwerten Temperatur (°C) und Luftfeuchtigkeit (%).\n" }, { "path": ".github/workflows/spell-check.yml", "content": "name: Spell Check\n\non:\n workflow_dispatch:\n push:\n branches:\n - main\n pull_request:\n branches:\n - main\n\njobs:\n spell-check:\n runs-on: ubuntu-latest\n\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n\n - name: Set up Python\n uses: actions/setup-python@v6\n with:\n python-version: '3.x'\n\n - name: Install codespell\n run: |\n python -m pip install --upgrade pip\n pip install codespell\n\n - name: Run codespell\n run: |\n codespell --ignore-words-list=\"accCount,ser\" --skip=\"*.pdf,*.js\" --exclude-file=.github/workflows/spell-check-exclude.txt .\n" }, { "path": ".gitignore", "content": "# Prerequisites\n*.d\n\n# Object files\n*.o\n*.ko\n*.obj\n*.elf\n\n# Linker output\n*.ilk\n*.map\n*.exp\n\n# Precompiled Headers\n*.gch\n*.pch\n\n# Libraries\n*.lib\n*.a\n*.la\n*.lo\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n*.i*86\n*.x86_64\n*.hex\n\n# Debug files\n*.dSYM/\n*.su\n*.idb\n*.pdb\n\n# Kernel Module Compile Results\n*.mod*\n*.cmd\n.tmp_versions/\nmodules.order\nModule.symvers\nMkfile.old\ndkms.conf\n\n.idea/\n\n# arduino_ci stuff\n/.bundle/\n/.yardoc\nGemfile.lock\n/_yardoc/\n/coverage/\n/pkg/\n/spec/reports/\nvendor\n*.gem\n\n# credentials\nsecrets.h\n\n\n# rspec failure tracking\n.rspec_status\n\n# C++ stuff\n*.bin\n*.bin.dSYM\n\n# Other\n_codeql_detected_source_root\n**/build/\n**/c_cpp_properties.json\n.vscode/arduino.json\n\n# Coverage output\n*.gcov" }, { "path": ".vscode/arduino-cli-wrapper.sh", "content": "#!/usr/bin/env bash\n# arduino-cli-wrapper.sh — wrapper to locate and run Arduino CLI from VS Code\n#\n# Purpose:\n# - Prefer using the `VSCODE_ARDUINO_CLI` environment variable when set.\n# - Search for a bundled Arduino CLI inside the VS Code extensions directories.\n# - Fall back to the system `arduino-cli` if available in PATH.\n# - Print a helpful message and exit non-zero if no CLI is found.\n#\n# Usage:\n# - ./arduino-cli-wrapper.sh compile --fqbn ... path/to/sketch\n# - Export `VSCODE_ARDUINO_CLI=/path/to/arduino-cli` to force a specific binary.\n#\n# Notes:\n# - This script defaults to `linux-x64` under `platform_dir`; change it for other OSes.\n# - It is intended to be called by VS Code tasks or manually from shell.\nset -euo pipefail\n\nif [[ -n \"${VSCODE_ARDUINO_CLI:-}\" && -x \"${VSCODE_ARDUINO_CLI}\" ]]; then\n exec \"${VSCODE_ARDUINO_CLI}\" \"$@\"\nfi\n\nresolve_bundled_cli() {\n local extension_root=\"$1\"\n local platform_dir=\"$2\"\n local pattern=\"${extension_root}/vscode-arduino.vscode-arduino-community-*-${platform_dir}\"\n local candidates=()\n\n shopt -s nullglob\n candidates=(${pattern})\n shopt -u nullglob\n\n if [[ ${#candidates[@]} -eq 0 ]]; then\n return 1\n fi\n\n local newest\n newest=$(printf '%s\\n' \"${candidates[@]}\" | sort -V | tail -n 1)\n local cli=\"${newest}/assets/platform/${platform_dir}/arduino-cli/arduino-cli.app\"\n\n if [[ -x \"${cli}\" ]]; then\n printf '%s\\n' \"${cli}\"\n return 0\n fi\n\n return 1\n}\n\nplatform_dir=\"linux-x64\"\nbundled_cli=\"\"\n\nif [[ -n \"${HOME:-}\" ]]; then\n bundled_cli=$(resolve_bundled_cli \"${HOME}/.vscode/extensions\" \"${platform_dir}\" || true)\n if [[ -z \"${bundled_cli}\" ]]; then\n bundled_cli=$(resolve_bundled_cli \"${HOME}/.vscode-insiders/extensions\" \"${platform_dir}\" || true)\n fi\nfi\n\nif [[ -n \"${bundled_cli}\" ]]; then\n exec \"${bundled_cli}\" \"$@\"\nfi\n\nif command -v arduino-cli >/dev/null 2>&1; then\n exec arduino-cli \"$@\"\nfi\n\necho \"No Arduino CLI found. Install vscode-arduino-community extension or set VSCODE_ARDUINO_CLI.\" >&2\nexit 1\n" }, { "path": ".vscode/arduino-compile-runner.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\nSCRIPT_DIR=\"$(cd \"$(dirname \"${BASH_SOURCE[0]}\")\" && pwd)\"\nPY=\"$SCRIPT_DIR/arduino_compile_helper.py\"\n\nif [ ! -f \"$PY\" ]; then\n echo \"Error: helper not found at $PY\" >&2\n exit 2\nfi\n\nif [ ! -x \"$PY\" ]; then\n chmod +x \"$PY\" 2>/dev/null || true\nfi\n\n# Allow overriding workspace path\nexport WORKSPACE_FOLDER=\"${WORKSPACE_FOLDER:-$PWD}\"\n\n# Run the helper with an explicit Python interpreter to avoid executing\n# the helper via its shebang on filesystems mounted noexec (pCloud/FUSE).\nPY_CMD=\"$(command -v python3 || command -v python || true)\"\nif [ -z \"$PY_CMD\" ]; then\n echo \"Error: python3 or python not found in PATH\" >&2\n exit 3\nfi\n\nexec \"$PY_CMD\" \"$PY\" \"$@\"\n" }, { "path": ".vscode/arduino_compile_helper.py", "content": "#!/usr/bin/env python3\n\"\"\"\narduino_compile_helper.py\n\nHelper to determine `fqbn` and sketch path and invoke arduino-cli (or the repo wrapper).\n\nBehavior:\n- Reads `.vscode/sketch.json` for `fqbn` and `sketch` when present.\n- If `--fqbn` is provided it overrides sketch.json.\n- If `--active` is provided, it will search upwards for the nearest `.ino` file and use that sketch's folder.\n- Falls back to `examples/BresserWeatherSensorMQTT` when no sketch can be deduced.\n\"\"\"\nimport argparse\nimport json\nimport os\nimport subprocess\nimport sys\nfrom pathlib import Path\n\n\ndef read_arduino_json(workspace):\n path = Path(workspace) / '.vscode' / 'sketch.json'\n if not path.exists():\n return {}\n try:\n return json.loads(path.read_text())\n except Exception:\n return {}\n\n\ndef find_nearest_ino(active_path: Path, workspace: Path):\n # Walk up from active_path directory and look for any .ino file,\n # stopping at workspace boundary.\n p = active_path if active_path.is_dir() else active_path.parent\n while True:\n inos = list(p.glob('*.ino'))\n if inos:\n return p\n if p == workspace or p.parent == p:\n break\n p = p.parent\n # No .ino found upward — return None so callers can try other strategies\n return None\n\n\ndef find_wrapper(workspace: Path):\n w = workspace / '.vscode' / 'arduino-cli-wrapper.sh'\n if w.exists() and os.access(str(w), os.X_OK):\n return str(w)\n if w.exists():\n return str(w)\n return None\n\n\ndef write_arduino_json(workspace: Path, data: dict) -> None:\n \"\"\"Persist updated fields back to .vscode/sketch.json.\"\"\"\n path = Path(workspace) / '.vscode' / 'sketch.json'\n path.parent.mkdir(parents=True, exist_ok=True)\n path.write_text(json.dumps(data, indent=2) + '\\n')\n\n\ndef detect_upload_ports() -> list[str]:\n \"\"\"Return serial port candidates sorted by most-recently modified first.\"\"\"\n import glob as _glob\n candidates = _glob.glob('/dev/ttyACM*') + _glob.glob('/dev/ttyUSB*')\n candidates.sort(key=lambda p: os.path.getmtime(p), reverse=True)\n return candidates\n\n\ndef try_upload(wrapper: str | None, fqbn: str | None, port: str, sketch: str,\n extra: list[str]) -> int:\n \"\"\"Attempt a single upload and return the process exit code.\"\"\"\n if wrapper:\n cmd = ['bash', wrapper, 'upload']\n else:\n cmd = ['arduino-cli', 'upload']\n if fqbn:\n cmd += ['--fqbn', fqbn]\n cmd += ['--port', port]\n cmd.append(sketch)\n if extra:\n cmd += [e for e in extra if e != '--']\n try:\n return subprocess.run(cmd).returncode\n except FileNotFoundError:\n print('arduino-cli or wrapper not found.', file=sys.stderr)\n return 2\n\n\ndef main():\n parser = argparse.ArgumentParser()\n parser.add_argument('action', choices=['compile', 'upload', 'monitor'])\n parser.add_argument('--fqbn', help='Override fqbn', default=None)\n parser.add_argument('--port', help='Serial port', default=None)\n parser.add_argument('--config', help='Extra config', default=None)\n parser.add_argument('--active', help='Active file path (to deduce sketch)', default=None)\n # parse_known_args() is used instead of parse_args() + REMAINDER because\n # argparse.REMAINDER eagerly captures all tokens after the first positional,\n # including named flags like --active, so they never reach their definition.\n args, extras = parser.parse_known_args()\n\n workspace = Path(os.environ.get('WORKSPACE_FOLDER', os.getcwd())).resolve()\n arduino_cfg = read_arduino_json(workspace)\n\n fqbn = args.fqbn or arduino_cfg.get('fqbn') or arduino_cfg.get('board')\n\n sketch_dir = None\n\n # Priority 1: --active → walk upward to nearest .ino\n if args.active:\n active = Path(args.active).resolve()\n sketch_dir = find_nearest_ino(active, workspace)\n\n # Priority 2: arduino.json 'sketch' entry\n if not sketch_dir:\n sketch_entry = arduino_cfg.get('sketch')\n if sketch_entry:\n cand = (workspace / sketch_entry).resolve()\n if cand.exists():\n sketch_dir = cand if cand.is_dir() else cand.parent\n\n # Priority 3: fallback to default example\n if not sketch_dir:\n sketch_dir = workspace / 'examples' / 'BresserWeatherSensorMQTT'\n\n sketch_path = str(sketch_dir)\n\n wrapper = find_wrapper(workspace)\n extras = [e for e in extras if e != '--']\n\n # ── Compile / Monitor: straightforward single-shot execution ─────────────\n if args.action in ('compile', 'monitor'):\n if wrapper:\n cmd = ['bash', wrapper, args.action]\n else:\n cmd = ['arduino-cli', args.action]\n if fqbn:\n cmd += ['--fqbn', fqbn]\n if args.port:\n cmd += ['--port', args.port]\n if args.config:\n cmd += ['--config', args.config]\n if args.action == 'compile':\n cmd.append(sketch_path)\n if extras:\n cmd += extras\n try:\n sys.exit(subprocess.run(cmd).returncode)\n except FileNotFoundError:\n print('arduino-cli or wrapper not found.', file=sys.stderr)\n sys.exit(2)\n\n # ── Upload: smart port detection with retry logic ──────────────────────\n # Port priority: CLI arg → arduino.json 'port' → auto-detect\n port_override = args.port or arduino_cfg.get('port')\n upload_mode = arduino_cfg.get('uploadMode', 'auto') # 'auto' or 'manual'\n\n def _try_all_ports(port_list: list[str]) -> int:\n for port in port_list:\n print(f'--- Trying port: {port} ---')\n rc = try_upload(wrapper, fqbn, port, sketch_path, extras)\n if rc == 0:\n # Remember the working port in arduino.json\n arduino_cfg['port'] = port\n write_arduino_json(workspace, arduino_cfg)\n print(f'Upload succeeded on {port}')\n return 0\n print(f'Upload failed on {port} (exit {rc})')\n return 1\n\n # Build candidate list\n if port_override:\n candidates = [port_override] + [p for p in detect_upload_ports() if p != port_override]\n else:\n candidates = detect_upload_ports()\n\n if not candidates:\n print('No serial ports detected (/dev/ttyACM* or /dev/ttyUSB*).', file=sys.stderr)\n if upload_mode != 'manual':\n print('Hint: if your board requires manual upload mode, set '\n '\"uploadMode\": \"manual\" in .vscode/arduino.json', file=sys.stderr)\n sys.exit(1)\n\n # First attempt\n rc = _try_all_ports(candidates)\n if rc == 0:\n sys.exit(0)\n\n # If manual upload mode is known, prompt and retry once\n if upload_mode == 'manual':\n print()\n print('Board requires manual upload mode.')\n print('Please put the board into upload mode now (e.g. hold BOOT/double-press RESET),')\n input('then press ENTER to retry upload... ')\n # Re-detect ports: board may enumerate on a new tty after reset\n fresh = detect_upload_ports()\n rc = _try_all_ports(fresh)\n sys.exit(rc)\n else:\n print()\n print('All ports tried — upload did not succeed.')\n print('If your board needs manual upload mode (e.g. ESP32-S3 requires double-pressing RESET),')\n print('set \"uploadMode\": \"manual\" in .vscode/arduino.json and retry.')\n sys.exit(1)\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": ".vscode/serial_logger.py", "content": "#!/usr/bin/env python3\n\"\"\"\nserial_logger.py — Serial monitor with timestamped logging.\n\nOpens a serial port, optionally resets the board via DTR, then streams\nserial output to both stdout and a log file in extras/logs/.\n\nLog file name format (compatible with read_serial_log.py):\n _.txt\n e.g. devttyUSB0_2026_03_13.12.33.38.000.txt\n\nEach log line is prefixed with a timestamp:\n HH:MM:SS:mmm \n e.g. 12:33:38:152 Hello, world!\n\nBoard/port/baud defaults are read from .vscode/arduino.json when present.\n\nUsage:\n serial_logger.py [--port PORT] [--baud BAUD] [--reset] [--log-dir DIR]\n\nOptions:\n --port Serial port (e.g. /dev/ttyUSB0). Defaults to arduino.json 'port'.\n --baud Baud rate. Defaults to arduino.json 'baudRate' or 115200.\n --reset Toggle DTR to reset the board before monitoring.\n --log-dir Directory for log files. Defaults to /extras/logs/.\n --timeout Stop automatically after this many seconds (0 = run until Ctrl-C).\n --stop-on Stop when a line matches this Python regex (e.g. \"PASS|FAIL|DONE\").\n\nExit codes:\n 0 Clean exit (Ctrl-C) or sentinel matched\n 1 Serial port error\n 2 Missing or invalid arguments\n 3 Could not create log directory\n 4 Timeout reached without finding the sentinel pattern\n\"\"\"\nimport argparse\nimport json\nimport os\nimport signal\nimport sys\nimport time\nfrom datetime import datetime\nfrom pathlib import Path\n\ntry:\n import serial\nexcept ImportError:\n print(\"Error: pyserial is required. Install with: pip install pyserial\",\n file=sys.stderr)\n sys.exit(2)\n\n\n# ---------------------------------------------------------------------------\n# Configuration helpers\n# ---------------------------------------------------------------------------\n\ndef _workspace() -> Path:\n ws = os.environ.get('WORKSPACE_FOLDER')\n if ws:\n return Path(ws).resolve()\n # Script lives in /.vscode/\n return Path(__file__).resolve().parent.parent\n\n\ndef _read_arduino_json() -> dict:\n path = _workspace() / '.vscode' / 'arduino.json'\n try:\n return json.loads(path.read_text())\n except Exception:\n return {}\n\n\n# ---------------------------------------------------------------------------\n# Log path helpers\n# ---------------------------------------------------------------------------\n\ndef _port_stem(port: str) -> str:\n \"\"\"'/dev/ttyUSB0' -> 'devttyUSB0'\"\"\"\n return port.lstrip('/').replace('/', '')\n\n\ndef _log_filename(port: str) -> str:\n now = datetime.now()\n ts = now.strftime('%Y_%m_%d.%H.%M.%S') + f'.{now.microsecond // 1000:03d}'\n return f'{_port_stem(port)}_{ts}.txt'\n\n\ndef _ts_prefix() -> str:\n \"\"\"Return 'HH:MM:SS:mmm ' for the current moment.\"\"\"\n now = datetime.now()\n ms = now.microsecond // 1000\n return f'{now.hour:02d}:{now.minute:02d}:{now.second:02d}:{ms:03d} '\n\n\n# ---------------------------------------------------------------------------\n# Main monitor loop\n# ---------------------------------------------------------------------------\n\ndef run(port: str, baud: int, reset: bool, log_dir: Path,\n timeout: float = 0.0, stop_on: str | None = None) -> int:\n # Ensure log directory exists\n try:\n log_dir.mkdir(parents=True, exist_ok=True)\n except OSError as e:\n print(f'Error: cannot create log directory {log_dir}: {e}', file=sys.stderr)\n return 3\n\n log_path = log_dir / _log_filename(port)\n\n print(f'Opening {port} @ {baud} baud')\n print(f'Log file: {log_path}')\n print('Press Ctrl-C to stop.\\n')\n\n try:\n ser = serial.Serial(port, baud, timeout=0.1)\n except serial.SerialException as e:\n print(f'Error: cannot open {port}: {e}', file=sys.stderr)\n return 1\n\n if reset:\n print('Resetting board via DTR ...')\n ser.setDTR(False)\n time.sleep(0.1)\n ser.setDTR(True)\n time.sleep(0.1)\n print('Reset complete.\\n')\n\n # Handle Ctrl-C gracefully via flag\n _stop = [False]\n\n def _sigint(sig, frame):\n _stop[0] = True\n\n signal.signal(signal.SIGINT, _sigint)\n\n import re as _re\n stop_re = _re.compile(stop_on) if stop_on else None\n start_time = time.monotonic()\n exit_code = 0\n\n buf = b''\n with open(log_path, 'w', encoding='utf-8', errors='replace') as logf:\n while not _stop[0]:\n # ── Timeout check ──────────────────────────────────────────────\n if timeout > 0 and (time.monotonic() - start_time) >= timeout:\n suffix = f' (sentinel \"{stop_on}\" not found)' if stop_on else ''\n marker = _ts_prefix() + f'[LOGGER] Stopped: timeout after {timeout:.0f}s{suffix}'\n print(marker)\n logf.write(marker + '\\n')\n exit_code = 4\n break\n\n try:\n chunk = ser.read(256)\n except serial.SerialException as e:\n print(f'\\nSerial error: {e}', file=sys.stderr)\n exit_code = 1\n break\n\n if not chunk:\n continue\n\n buf += chunk\n sentinel_matched = False\n while b'\\n' in buf:\n line_bytes, buf = buf.split(b'\\n', 1)\n line = line_bytes.decode('utf-8', errors='replace').rstrip('\\r')\n entry = _ts_prefix() + line\n print(entry)\n logf.write(entry + '\\n')\n logf.flush()\n # ── Sentinel check ─────────────────────────────────────────\n if stop_re and stop_re.search(line):\n marker = _ts_prefix() + f'[LOGGER] Stopped: sentinel matched \"{stop_on}\"'\n print(marker)\n logf.write(marker + '\\n')\n logf.flush()\n sentinel_matched = True\n break\n if sentinel_matched:\n break\n\n # Flush any incomplete line remaining in the buffer\n if buf:\n line = buf.decode('utf-8', errors='replace').rstrip('\\r\\n')\n if line:\n entry = _ts_prefix() + line\n print(entry)\n with open(log_path, 'a', encoding='utf-8', errors='replace') as logf:\n logf.write(entry + '\\n')\n\n try:\n ser.close()\n except Exception:\n pass\n\n print(f'\\nLog saved to: {log_path}')\n return exit_code\n\n\n# ---------------------------------------------------------------------------\n# Entry point\n# ---------------------------------------------------------------------------\n\ndef main():\n cfg = _read_arduino_json()\n ws = _workspace()\n\n parser = argparse.ArgumentParser(\n description='Serial monitor with timestamped logging.')\n parser.add_argument(\n '--port', default=cfg.get('port') or '',\n help='Serial port (e.g. /dev/ttyUSB0)')\n parser.add_argument(\n '--baud', type=int, default=cfg.get('baudRate', 115200),\n help='Baud rate (default: from arduino.json or 115200)')\n parser.add_argument(\n '--reset', action='store_true',\n help='Toggle DTR to reset the board before monitoring')\n parser.add_argument(\n '--log-dir', default=str(ws / 'extras' / 'logs'),\n help='Log output directory (default: /extras/logs/)')\n parser.add_argument(\n '--timeout', type=float, default=0.0, metavar='SECONDS',\n help='Stop after this many seconds (0 = run until Ctrl-C)')\n parser.add_argument(\n '--stop-on', default='', metavar='REGEX',\n help='Stop when a line matches this Python regex (e.g. \"PASS|FAIL|DONE\")')\n args = parser.parse_args()\n\n if not args.port:\n # Auto-detect: pick most-recently-modified tty\n import glob as _glob\n candidates = sorted(\n _glob.glob('/dev/ttyACM*') + _glob.glob('/dev/ttyUSB*'),\n key=os.path.getmtime, reverse=True)\n if not candidates:\n print('Error: no serial port specified and none auto-detected.',\n file=sys.stderr)\n print('Use --port /dev/ttyUSB0 or set \"port\" in .vscode/arduino.json',\n file=sys.stderr)\n sys.exit(2)\n args.port = candidates[0]\n print(f'Auto-detected port: {args.port}')\n\n sys.exit(run(args.port, args.baud, args.reset, Path(args.log_dir),\n args.timeout, args.stop_on or None))\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": ".vscode/serial_reset_monitor.py", "content": "#!/usr/bin/env python3\n\"\"\"\nserial_reset_monitor.py — Toggle DTR to reset an Arduino/ESP32 board.\n\nMonitoring and log-file creation are handled by serial_logger.py.\nThis script only performs the hardware reset.\n\nUsage:\n serial_reset_monitor.py [baud]\n\nThe baud rate is required to open the serial port; it does not affect the\nDTR-toggle reset but must match what the device expects (default: 115200).\n\"\"\"\nimport argparse\nimport sys\nimport time\n\ntry:\n import serial\nexcept ImportError:\n print(\"Error: pyserial is required. Install with: pip install pyserial\")\n sys.exit(1)\n\n\ndef reset_board(port: str, baud: int) -> int:\n print(f\"Opening {port} @ {baud} baud ...\")\n try:\n s = serial.Serial(port, baud, timeout=1)\n except Exception as e:\n print(f\"Error: cannot open {port}: {e}\")\n return 1\n try:\n print(\"Toggling DTR to reset the board ...\")\n s.setDTR(False)\n time.sleep(0.1)\n s.setDTR(True)\n time.sleep(0.1)\n print(\"Reset complete.\")\n finally:\n try:\n s.close()\n except Exception:\n pass\n return 0\n\n\ndef main():\n p = argparse.ArgumentParser(\n description='Toggle DTR to reset an Arduino/ESP32 board.')\n p.add_argument('port', help='Serial port, e.g. /dev/ttyACM0')\n p.add_argument('baud', nargs='?', type=int, default=115200,\n help='Baud rate used to open the port (default: 115200)')\n args = p.parse_args()\n sys.exit(reset_board(args.port, args.baud))\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": ".vscode/settings.json", "content": "{\n \"cmake.configureOnOpen\": false\n}" }, { "path": ".vscode/tasks.json", "content": "{\n \"version\": \"2.0.0\",\n \"tasks\": [\n {\n \"label\": \"Compile Arduino Sketch\",\n \"type\": \"shell\",\n \"command\": \"bash\",\n \"args\": [\n \"${workspaceFolder}/.vscode/arduino-compile-runner.sh\",\n \"compile\"\n ],\n \"isBackground\": true,\n \"group\": {\n \"kind\": \"build\",\n \"isDefault\": true\n },\n \"problemMatcher\": [\n {\n \"owner\": \"arduino\",\n \"background\": {\n \"activeOnStart\": true,\n \"beginsPattern\": \"^Sketch uses\",\n \"endsPattern\": \"^(Used library|Compilation complete|Error)\"\n },\n \"fileLocation\": [\n \"relative\",\n \"${workspaceFolder}\"\n ],\n \"pattern\": {\n \"regexp\": \"^(.*):(\\\\d+):(\\\\d+):\\\\s+(error|warning):\\\\s+(.*)$\",\n \"file\": 1,\n \"line\": 2,\n \"column\": 3,\n \"severity\": 4,\n \"message\": 5\n }\n }\n ],\n \"detail\": \"Compile current sketch (fqbn read from .vscode/arduino.json or autodetected).\"\n },\n {\n \"label\": \"Upload Arduino Sketch\",\n \"type\": \"shell\",\n \"command\": \"bash\",\n \"args\": [\n \"${workspaceFolder}/.vscode/arduino-compile-runner.sh\",\n \"upload\",\n \"--port\",\n \"${input:serialPort}\"\n ],\n \"isBackground\": true,\n \"group\": \"build\",\n \"problemMatcher\": [\n {\n \"owner\": \"arduino\",\n \"background\": {\n \"activeOnStart\": true,\n \"beginsPattern\": \"^Uploading\",\n \"endsPattern\": \"^(Upload complete|Error)\"\n },\n \"fileLocation\": [\"relative\", \"${workspaceFolder}\"],\n \"pattern\": {\n \"regexp\": \"^(.*):(\\\\d+):(\\\\d+):\\\\s+(error|warning):\\\\s+(.*)$\",\n \"file\": 1,\n \"line\": 2,\n \"column\": 3,\n \"severity\": 4,\n \"message\": 5\n }\n }\n ],\n \"detail\": \"Upload sketch to board (fqbn and sketch read from .vscode/sketch.json).\"\n },\n {\n \"label\": \"Serial Reset (DTR)\",\n \"type\": \"shell\",\n \"command\": \"python3\",\n \"args\": [\n \"${workspaceFolder}/.vscode/serial_reset_monitor.py\",\n \"${input:serialPort}\"\n ],\n \"isBackground\": false,\n \"presentation\": {\n \"echo\": true,\n \"reveal\": \"always\",\n \"focus\": true,\n \"panel\": \"shared\"\n },\n \"detail\": \"Toggle DTR to reset the board only (no monitoring). For monitoring+logging use the Serial Logger tasks.\"\n },\n {\n \"label\": \"Serial Logger (monitor + log to extras/logs/)\",\n \"type\": \"shell\",\n \"command\": \"python3\",\n \"args\": [\n \"${workspaceFolder}/.vscode/serial_logger.py\",\n \"--port\",\n \"${input:serialPort}\",\n \"--baud\",\n \"${input:serialBaud}\",\n \"--timeout\",\n \"${input:loggerTimeout}\",\n \"--stop-on\",\n \"${input:stopPattern}\"\n ],\n \"isBackground\": false,\n \"presentation\": {\n \"echo\": true,\n \"reveal\": \"always\",\n \"focus\": true,\n \"panel\": \"shared\"\n },\n \"detail\": \"Monitor serial port and write timestamped log to extras/logs/ (compatible with read_serial_log.py).\"\n },\n {\n \"label\": \"Serial Logger with Reset (monitor + log to extras/logs/)\",\n \"type\": \"shell\",\n \"command\": \"python3\",\n \"args\": [\n \"${workspaceFolder}/.vscode/serial_logger.py\",\n \"--port\",\n \"${input:serialPort}\",\n \"--baud\",\n \"${input:serialBaud}\",\n \"--reset\",\n \"--timeout\",\n \"${input:loggerTimeout}\",\n \"--stop-on\",\n \"${input:stopPattern}\"\n ],\n \"isBackground\": false,\n \"presentation\": {\n \"echo\": true,\n \"reveal\": \"always\",\n \"focus\": true,\n \"panel\": \"shared\"\n },\n \"detail\": \"Reset board via DTR, then monitor and log to extras/logs/.\"\n }\n ],\n \"inputs\": [\n {\n \"id\": \"serialPort\",\n \"type\": \"promptString\",\n \"description\": \"Enter the serial port (e.g., /dev/ttyACM0 or /dev/ttyUSB0)\",\n \"default\": \"/dev/ttyACM0\"\n },\n {\n \"id\": \"serialBaud\",\n \"type\": \"promptString\",\n \"description\": \"Enter baud rate for serial monitor\",\n \"default\": \"115200\"\n },\n {\n \"id\": \"loggerTimeout\",\n \"type\": \"promptString\",\n \"description\": \"Serial logger timeout in seconds (0 = run until Ctrl-C; agent sessions: use max_expected_duration × 3, min 30)\",\n \"default\": \"0\"\n },\n {\n \"id\": \"stopPattern\",\n \"type\": \"promptString\",\n \"description\": \"Stop logging when a line matches this Python regex (e.g. PASS|FAIL|DONE); leave empty to disable\",\n \"default\": \"\"\n }\n ]\n}" }, { "path": "BUILD.md", "content": "# SW Build\n\nTested with Arduino 1.8.19 and an empty Arduino library directory.\n\n1. Check that the required Board Manager URL is in the Preferences (e.g. the one for ESP8266):\n\n![00-board-manager](https://user-images.githubusercontent.com/83612361/196784057-5d0a4494-f6d2-4723-881b-0e1de74a7fd9.png)\n\n2. Select **BresserWeatherSensorReceiver** in the Library Manager - **please use the latest version**:\n \n![01-library-manager](https://user-images.githubusercontent.com/83612361/196784440-13c60b00-e336-4259-876c-a1025bee7ce8.png)\n\n3. The Library Manager will ask if to install the **library dependencies** - select **\"Install all\"**:\n\n![2-dependencies](https://user-images.githubusercontent.com/83612361/196784660-dbf38a22-d156-4444-a3bf-affdb2d06ac9.png)\n\n4. From the **File** Menu, select **Examples->BresserWeatherSensorReceiver->BresserWeatherSensorMQTT**:\n\n![3-Examples-BresserWeatherSensorReceiver-BresserWeatherSensorMQTT](https://user-images.githubusercontent.com/83612361/196785302-3c46eed5-3656-46cc-a426-017197f67089.png)\n\n5. Select your board:\n\n![04-board](https://user-images.githubusercontent.com/83612361/196785701-72692d15-167a-41f4-a586-59c38fa6e049.png)\n\n6. Modify `BresserWeatherSensorCfg.h` as required, typically:\n```\n// Number of sensors to be received\n#define NUM_SENSORS 1\n```\n```\n// Select type of receiver module\n#define USE_CC1101\n//#define USE_SX1276\n```\nPlease use **either** one of the pre-defined pinnings:\n```\n// Use pinning for LoRaWAN Node \n#define LORAWAN_NODE\n\n// Use pinning for TTGO ESP32 boards with integrated RF transceiver (SX1276)\n// https://github.com/espressif/arduino-esp32/tree/master/variants/ttgo-lora32-*\n//#define TTGO_LORA32\n\n// Use pinning for Adafruit Feather ESP32S2 with RFM95W \"FeatherWing\" ADA3232\n//#define ADAFRUIT_FEATHER_ESP32S2\n```\n**or** check that your pinning matches the default for the selected MCU:\n```\n[...]\n#elif defined(ESP32)\n #define PIN_RECEIVER_CS 27\n \n // CC1101: GDO0 / RFM95W/SX127x: G0\n #define PIN_RECEIVER_IRQ 21 \n \n // CC1101: GDO2 / RFM95W/SX127x: G1\n #define PIN_RECEIVER_GPIO 33\n \n // RFM95W/SX127x - GPIOxx / CC1101 - RADIOLIB_NC\n #define PIN_RECEIVER_RST 32\n\n#elif defined(ESP8266)\n #define PIN_RECEIVER_CS 15\n \n // CC1101: GDO0 / RFM95W/SX127x: G0\n #define PIN_RECEIVER_IRQ 4 \n \n // CC1101: GDO2 / RFM95W/SX127x: \n #define PIN_RECEIVER_GPIO 5 \n \n // RFM95W/SX127x - GPIOxx / CC1101 - RADIOLIB_NC\n #define PIN_RECEIVER_RST 2\n#endif\n``` \n7. Edit the mandatory settings in `BresserWeatherSensorMQTT.ino`:\n```\n#define USE_SECUREWIFI // use secure WIFI\n//#define USE_WIFI // use non-secure WIFI\n...\n// Map sensor IDs to Names - the number of entries must match NUM_SENSORS\nSensorMap sensor_map[NUM_SENSORS] = {\n {0x39582376, \"WeatherSensor\"}\n};\n...\n#ifndef SECRETS\n const char ssid[] = \"WiFiSSID\";\n const char pass[] = \"WiFiPassword\";\n ...\n\n #define MQTT_PORT 8883\n const char MQTT_HOST[] = \"xxx.yyy.zzz.com\";\n const char MQTT_USER[] = \"\"; // leave blank if no credentials used\n const char MQTT_PASS[] = \"\"; // leave blank if no credentials used\n...\n```\n\n- Set the WiFi settings (ssid/pass) according to your Access Point\n- Set `USE_SECUREWIFI`/`USE_WIFI`, `MQTT_PORT`, `MQTT_HOST`, `MQTT_USER` and `MQTT_PASS` according to your MQTT broker's IP address and configuration\n - for a non-secure setup: `USE_WIFI` and typically `MQTT_PORT` 1883\n - for a secure-setup: `USE_SECUREWIFI` and typically `MQTT_PORT` 8883 (and other security measures as needed)\n - set `MQTT_USER` and `MQTT_PASS` as required by the MQTT broker\n - SensorMap is just for your convenience - if you do not know your sensor's ID yet, leave it as it is. Just change the number of entries to match `NUM_SENSORS`.\n\nYou can of course copy the **secrets** to `secrets.h` and make your changes there instead of modifying the template in the sketch. In this case, do not forget to add the following in `secrets.h`:\n```\n#define SECRETS\n```\n**Note:** The define `SECRET` has been renamed to `SECRETS` for consistency.\n\n8. Now you want to save your changes. You will be asked to select a new directory, because the example resides in the Arduino/libraries folder which is treated as read-only:\n\n![5-modified-sketch](https://user-images.githubusercontent.com/83612361/196790621-31fbb28a-2d49-4e38-be3e-75ed513332bc.png)\n\n9. Finally you should be able to compile your sketch without any errors or warnings:\n\n![06-compiler-result](https://user-images.githubusercontent.com/83612361/196790812-d0ab3066-d82e-495e-a15f-0dfb2334a393.png)\n" }, { "path": "Bresser_HA_MQTT_custom_config.yaml", "content": "mqtt:\r\n sensor:\r\n - name: \"Temperatuur\"\r\n unique_id: \"Bresstat_temp\"\r\n state_topic: \"ESPWeather/961c/data\"\r\n value_template: \"{{ value_json.temp_c }}\"\r\n device_class: \"temperature\"\r\n unit_of_measurement: \"°C\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Dauwpunt\"\r\n unique_id: \"Bresstat_dew\"\r\n state_topic: \"ESPWeather/extra\"\r\n value_template: \"{{ value_json.dewpoint_c }}\"\r\n device_class: \"Temperature\"\r\n unit_of_measurement: \"°C\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Gevoelstemperatuur\"\r\n unique_id: \"Bresstat_feel\"\r\n state_topic: \"ESPWeather/extra\"\r\n value_template: \"{{ value_json.perceived_temp_c }}\"\r\n device_class: \"Temperature\"\r\n unit_of_measurement: \"°C\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Luchtvochtigheid\"\r\n unique_id: \"Bresstat_humi\"\r\n state_topic: \"ESPWeather/961c/data\"\r\n value_template: \"{{ value_json.humidity }}\"\r\n device_class: \"humidity\"\r\n unit_of_measurement: \"%\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"ID\"\r\n unique_id: \"Bresstat_id\"\r\n state_topic: \"ESPWeather/961c/data\"\r\n value_template: \"{{ value_json.id }}\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Kanaal\"\r\n unique_id: \"Bresstat_ch\"\r\n state_topic: \"ESPWeather/961c/data\"\r\n value_template: \"{{ value_json.ch }}\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Batterij\"\r\n unique_id: \"Bresstat_batt\"\r\n state_topic: \"ESPWeather/961c/data\"\r\n value_template: \"{{ value_json.battery_ok }}\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Windvlaag\"\r\n unique_id: \"Bresstat_gust\"\r\n state_topic: \"ESPWeather/961c/data\"\r\n value_template: \"{{ value_json.wind_gust }}\"\r\n device_class: \"wind_speed\"\r\n unit_of_measurement: \"km/h\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Windsnelheid\"\r\n unique_id: \"Bresstat_wind\"\r\n state_topic: \"ESPWeather/961c/data\"\r\n value_template: \"{{ value_json.wind_avg }}\"\r\n device_class: \"wind_speed\"\r\n unit_of_measurement: \"km/h\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Windhoek\"\r\n unique_id: \"Bresstat_dirdeg\"\r\n state_topic: \"ESPWeather/961c/data\"\r\n value_template: \"{{ value_json.wind_dir }}\"\r\n unit_of_measurement: \"Graden\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Windrichting\"\r\n unique_id: \"Bresstat_dircar\"\r\n state_topic: \"ESPWeather/extra\"\r\n value_template: \"{{ value_json.wind_dir_txt }}\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Windvlaag bft\"\r\n unique_id: \"Bresstat_gust_bft\"\r\n state_topic: \"ESPWeather/extra\"\r\n value_template: \"{{ value_json.wind_gust_bft }}\"\r\n device_class: \"wind_speed\"\r\n unit_of_measurement: \"Beaufort\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Windsnelheid bft\"\r\n unique_id: \"Bresstat_avg_bft\"\r\n state_topic: \"ESPWeather/extra\"\r\n value_template: \"{{ value_json.wind_avg_bft }}\"\r\n device_class: \"wind_speed\"\r\n unit_of_measurement: \"Beaufort\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"UV-index\"\r\n unique_id: \"Bresstat_UV\"\r\n state_topic: \"ESPWeather/961c/data\"\r\n value_template: \"{{ value_json.uv }}\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Lichtintensiteit\"\r\n unique_id: \"Bresstat_light\"\r\n state_topic: \"ESPWeather/961c/data\"\r\n value_template: \"{{ value_json.wind_gust }}\"\r\n unit_of_measurement: \"kLux\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Neerslag totaal\"\r\n unique_id: \"Bresstat_rain\"\r\n state_topic: \"ESPWeather/961c/data\"\r\n value_template: \"{{ value_json.rain }}\"\r\n device_class: \"precipitation\"\r\n unit_of_measurement: \"mm\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Neerslag vandaag\"\r\n unique_id: \"Bresstat_rain_d\"\r\n state_topic: \"ESPWeather/961c/data\"\r\n value_template: \"{{ value_json.rain_d }}\"\r\n device_class: \"precipitation\"\r\n unit_of_measurement: \"mm\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Neerslag laatste uur\"\r\n unique_id: \"Bresstat_rain_h\"\r\n state_topic: \"ESPWeather/961c/data\"\r\n value_template: \"{{ value_json.rain_h }}\"\r\n device_class: \"precipitation\"\r\n unit_of_measurement: \"mm\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Neerslag deze week\"\r\n unique_id: \"Bresstat_rain_w\"\r\n state_topic: \"ESPWeather/961c/data\"\r\n value_template: \"{{ value_json.rain_w }}\"\r\n device_class: \"precipitation\"\r\n unit_of_measurement: \"mm\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Neerslag deze maand\"\r\n unique_id: \"Bresstat_rain_m\"\r\n state_topic: \"ESPWeather/961c/data\"\r\n value_template: \"{{ value_json.rain_m }}\"\r\n device_class: \"precipitation\"\r\n unit_of_measurement: \"mm\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Signaal\"\r\n unique_id: \"Bresstat_signal\"\r\n state_topic: \"ESPWeather/961c/rssi\"\r\n device_class: \"signal_strength\"\r\n unit_of_measurement: \"dB\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"\r\n - name: \"Status\"\r\n unique_id: \"Bresstat_stat\"\r\n state_topic: \"ESPWeather/status\"\r\n device:\r\n name: \"Weerstation\"\r\n identifiers: \"Bresser\"\r\n manufacturer: \"Chris\"\r\n model: \"Bresser MQTT\"" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, religion, or sexual identity\nand orientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.\n\n## Our Standards\n\nExamples of behavior that contributes to a positive environment for our\ncommunity include:\n\n* Demonstrating empathy and kindness toward other people\n* Being respectful of differing opinions, viewpoints, and experiences\n* Giving and gracefully accepting constructive feedback\n* Accepting responsibility and apologizing to those affected by our mistakes,\n and learning from the experience\n* Focusing on what is best not just for us as individuals, but for the\n overall community\n\nExamples of unacceptable behavior include:\n\n* The use of sexualized language or imagery, and sexual attention or\n advances of any kind\n* Trolling, insulting or derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or email\n address, without their explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Enforcement Responsibilities\n\nCommunity leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.\n\n## Scope\n\nThis Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at\nopensource@github.com.\nAll complaints will be reviewed and investigated promptly and fairly.\n\nAll community leaders are obligated to respect the privacy and security of the\nreporter of any incident.\n\n## Enforcement Guidelines\n\nCommunity leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:\n\n### 1. Correction\n\n**Community Impact**: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.\n\n### 2. Warning\n\n**Community Impact**: A violation through a single incident or series\nof actions.\n\n**Consequence**: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or\npermanent ban.\n\n### 3. Temporary Ban\n\n**Community Impact**: A serious violation of community standards, including\nsustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.\n\n### 4. Permanent Ban\n\n**Community Impact**: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within\nthe community.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage],\nversion 2.0, available at\nhttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.\n\nCommunity Impact Guidelines were inspired by [Mozilla's code of conduct\nenforcement ladder](https://github.com/mozilla/diversity).\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see the FAQ at\nhttps://www.contributor-covenant.org/faq. Translations are available at\nhttps://www.contributor-covenant.org/translations.\n" }, { "path": "DEBUG_OUTPUT.md", "content": "# Debug Output Configuration in Arduino IDE\n\n## ESP32\n\n1. Select appropriate (USB-)serial port for your board\n \n ![Arduino_IDE-Tools_Port](https://github.com/matthias-bs/BresserWeatherSensorTTN/assets/83612361/be496bf8-89ce-4db5-b1bf-c88a7f5e99cb)\n\n**or**\n\n ![Arduino_IDE-Select_Other_Board_and_Port](https://github.com/matthias-bs/BresserWeatherSensorTTN/assets/83612361/ac847f23-4fe6-4111-929f-ac6d36cb8a53)\n \n2. Select desired debug level\n\n ![Arduino_IDE-Tools_CoreDebugLevel](https://github.com/matthias-bs/BresserWeatherSensorTTN/assets/83612361/72a8b1d9-8d39-41fc-9658-78b432b73d56)\n\n This passes the define `CORE_DEBUG_LEVEL`to the compiler accordingly.\n\nRefer to the following for some background information\n* https://thingpulse.com/esp32-logging/\n* https://www.mischianti.org/2020/09/20/esp32-manage-multiple-serial-and-logging-for-debugging-3/\n* https://github.com/espressif/arduino-esp32/blob/master/cores/esp32/esp32-hal-log.h\n\n\n## ESP8266\n\n1. Select appropriate (USB-)serial port for your board\n\n ![Arduino_IDE-Tools_Port_ESP8266](https://github.com/matthias-bs/BresserWeatherSensorReceiver/assets/83612361/dafbdd33-244f-44b3-b3f4-da854633f634)\n\n2. Select the appropriate Debug Port (MCU serial interface) of your board\n \n ![Arduino_IDE-Tools_Debug_Port_ESP8266](https://github.com/matthias-bs/BresserWeatherSensorReceiver/assets/83612361/7d7fdc96-2abd-4f55-9203-595f08eb7f06)\n\n3. If needed, change the debug level in `WeatherSensorCfg.h`\n```\n #define CORE_DEBUG_LEVEL ARDUHAL_LOG_LEVEL_VERBOSE\n```\n\n (Options: `ARDUHAL_LOG_LEVEL_`)\n" }, { "path": "Doxyfile", "content": "# Doxyfile 1.8.15\n\n# This file describes the settings to be used by the documentation system\n# doxygen (www.doxygen.org) for a project.\n#\n# All text after a double hash (##) is considered a comment and is placed in\n# front of the TAG it is preceding.\n#\n# All text after a single hash (#) is considered a comment and will be ignored.\n# The format is:\n# TAG = value [value, ...]\n# For lists, items can also be appended using:\n# TAG += value [value, ...]\n# Values that contain spaces should be placed between quotes (\\\" \\\").\n\n#---------------------------------------------------------------------------\n# Project related configuration options\n#---------------------------------------------------------------------------\n\n# This tag specifies the encoding used for all characters in the configuration\n# file that follow. The default is UTF-8 which is also the encoding used for all\n# text before the first occurrence of this tag. Doxygen uses libiconv (or the\n# iconv built into libc) for the transcoding. See\n# https://www.gnu.org/software/libiconv/ for the list of possible encodings.\n# The default value is: UTF-8.\n\nDOXYFILE_ENCODING = UTF-8\n\n# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by\n# double-quotes, unless you are using Doxywizard) that should identify the\n# project for which the documentation is generated. This name is used in the\n# title of most generated pages and in a few other places.\n# The default value is: My Project.\n\nPROJECT_NAME = BresserWeatherSensorReceiver\n\n# The PROJECT_NUMBER tag can be used to enter a project or revision number. This\n# could be handy for archiving the generated documentation or if some version\n# control system is used.\n\nPROJECT_NUMBER =\n\n# Using the PROJECT_BRIEF tag one can provide an optional one line description\n# for a project that appears at the top of each page and should give viewer a\n# quick idea about the purpose of the project. Keep the description short.\n\nPROJECT_BRIEF = \"Bresser 5-in-1/6-in-1/7-in-1 868 MHz Weather Sensor Radio Receiver for Arduino based on CC1101 or SX1276/RFM95W\"\n\n# With the PROJECT_LOGO tag one can specify a logo or an icon that is included\n# in the documentation. The maximum height of the logo should not exceed 55\n# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy\n# the logo to the output directory.\n\nPROJECT_LOGO =\n\n# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path\n# into which the generated documentation will be written. If a relative path is\n# entered, it will be relative to the location where doxygen was started. If\n# left blank the current directory will be used.\n\nOUTPUT_DIRECTORY = docs\n\n# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-\n# directories (in 2 levels) under the output directory of each output format and\n# will distribute the generated files over these directories. Enabling this\n# option can be useful when feeding doxygen a huge amount of source files, where\n# putting all generated files in the same directory would otherwise causes\n# performance problems for the file system.\n# The default value is: NO.\n\nCREATE_SUBDIRS = NO\n\n# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII\n# characters to appear in the names of generated files. If set to NO, non-ASCII\n# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode\n# U+3044.\n# The default value is: NO.\n\nALLOW_UNICODE_NAMES = NO\n\n# The OUTPUT_LANGUAGE tag is used to specify the language in which all\n# documentation generated by doxygen is written. Doxygen will use this\n# information to generate all constant output in the proper language.\n# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,\n# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),\n# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,\n# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),\n# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,\n# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,\n# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,\n# Ukrainian and Vietnamese.\n# The default value is: English.\n\nOUTPUT_LANGUAGE = English\n\n# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all\n# documentation generated by doxygen is written. Doxygen will use this\n# information to generate all generated output in the proper direction.\n# Possible values are: None, LTR, RTL and Context.\n# The default value is: None.\n\nOUTPUT_TEXT_DIRECTION = None\n\n# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member\n# descriptions after the members that are listed in the file and class\n# documentation (similar to Javadoc). Set to NO to disable this.\n# The default value is: YES.\n\nBRIEF_MEMBER_DESC = YES\n\n# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief\n# description of a member or function before the detailed description\n#\n# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the\n# brief descriptions will be completely suppressed.\n# The default value is: YES.\n\nREPEAT_BRIEF = YES\n\n# This tag implements a quasi-intelligent brief description abbreviator that is\n# used to form the text in various listings. Each string in this list, if found\n# as the leading text of the brief description, will be stripped from the text\n# and the result, after processing the whole list, is used as the annotated\n# text. Otherwise, the brief description is used as-is. If left blank, the\n# following values are used ($name is automatically replaced with the name of\n# the entity):The $name class, The $name widget, The $name file, is, provides,\n# specifies, contains, represents, a, an and the.\n\nABBREVIATE_BRIEF = \"The $name class\" \\\n \"The $name widget\" \\\n \"The $name file\" \\\n is \\\n provides \\\n specifies \\\n contains \\\n represents \\\n a \\\n an \\\n the\n\n# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then\n# doxygen will generate a detailed section even if there is only a brief\n# description.\n# The default value is: NO.\n\nALWAYS_DETAILED_SEC = NO\n\n# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all\n# inherited members of a class in the documentation of that class as if those\n# members were ordinary class members. Constructors, destructors and assignment\n# operators of the base classes will not be shown.\n# The default value is: NO.\n\nINLINE_INHERITED_MEMB = NO\n\n# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path\n# before files name in the file list and in the header files. If set to NO the\n# shortest path that makes the file name unique will be used\n# The default value is: YES.\n\nFULL_PATH_NAMES = YES\n\n# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.\n# Stripping is only done if one of the specified strings matches the left-hand\n# part of the path. The tag can be used to show relative paths in the file list.\n# If left blank the directory from which doxygen is run is used as the path to\n# strip.\n#\n# Note that you can specify absolute paths here, but also relative paths, which\n# will be relative from the directory where doxygen is started.\n# This tag requires that the tag FULL_PATH_NAMES is set to YES.\n\nSTRIP_FROM_PATH =\n\n# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the\n# path mentioned in the documentation of a class, which tells the reader which\n# header file to include in order to use a class. If left blank only the name of\n# the header file containing the class definition is used. Otherwise one should\n# specify the list of include paths that are normally passed to the compiler\n# using the -I flag.\n\nSTRIP_FROM_INC_PATH =\n\n# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but\n# less readable) file names. This can be useful is your file systems doesn't\n# support long names like on DOS, Mac, or CD-ROM.\n# The default value is: NO.\n\nSHORT_NAMES = NO\n\n# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the\n# first line (until the first dot) of a Javadoc-style comment as the brief\n# description. If set to NO, the Javadoc-style will behave just like regular Qt-\n# style comments (thus requiring an explicit @brief command for a brief\n# description.)\n# The default value is: NO.\n\nJAVADOC_AUTOBRIEF = NO\n\n# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first\n# line (until the first dot) of a Qt-style comment as the brief description. If\n# set to NO, the Qt-style will behave just like regular Qt-style comments (thus\n# requiring an explicit \\brief command for a brief description.)\n# The default value is: NO.\n\nQT_AUTOBRIEF = NO\n\n# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a\n# multi-line C++ special comment block (i.e. a block of //! or /// comments) as\n# a brief description. This used to be the default behavior. The new default is\n# to treat a multi-line C++ comment block as a detailed description. Set this\n# tag to YES if you prefer the old behavior instead.\n#\n# Note that setting this tag to YES also means that rational rose comments are\n# not recognized any more.\n# The default value is: NO.\n\nMULTILINE_CPP_IS_BRIEF = NO\n\n# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the\n# documentation from any documented member that it re-implements.\n# The default value is: YES.\n\nINHERIT_DOCS = YES\n\n# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new\n# page for each member. If set to NO, the documentation of a member will be part\n# of the file/class/namespace that contains it.\n# The default value is: NO.\n\nSEPARATE_MEMBER_PAGES = NO\n\n# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen\n# uses this value to replace tabs by spaces in code fragments.\n# Minimum value: 1, maximum value: 16, default value: 4.\n\nTAB_SIZE = 4\n\n# This tag can be used to specify a number of aliases that act as commands in\n# the documentation. An alias has the form:\n# name=value\n# For example adding\n# \"sideeffect=@par Side Effects:\\n\"\n# will allow you to put the command \\sideeffect (or @sideeffect) in the\n# documentation, which will result in a user-defined paragraph with heading\n# \"Side Effects:\". You can put \\n's in the value part of an alias to insert\n# newlines (in the resulting output). You can put ^^ in the value part of an\n# alias to insert a newline as if a physical newline was in the original file.\n# When you need a literal { or } or , in the value part of an alias you have to\n# escape them by means of a backslash (\\), this can lead to conflicts with the\n# commands \\{ and \\} for these it is advised to use the version @{ and @} or use\n# a double escape (\\\\{ and \\\\})\n\nALIASES =\n\n# This tag can be used to specify a number of word-keyword mappings (TCL only).\n# A mapping has the form \"name=value\". For example adding \"class=itcl::class\"\n# will allow you to use the command class in the itcl::class meaning.\n\nTCL_SUBST =\n\n# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources\n# only. Doxygen will then generate output that is more tailored for C. For\n# instance, some of the names that are used will be different. The list of all\n# members will be omitted, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_FOR_C = NO\n\n# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or\n# Python sources only. Doxygen will then generate output that is more tailored\n# for that language. For instance, namespaces will be presented as packages,\n# qualified scopes will look different, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_JAVA = NO\n\n# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran\n# sources. Doxygen will then generate output that is tailored for Fortran.\n# The default value is: NO.\n\nOPTIMIZE_FOR_FORTRAN = NO\n\n# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL\n# sources. Doxygen will then generate output that is tailored for VHDL.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_VHDL = NO\n\n# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice\n# sources only. Doxygen will then generate output that is more tailored for that\n# language. For instance, namespaces will be presented as modules, types will be\n# separated into more groups, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_SLICE = NO\n\n# Doxygen selects the parser to use depending on the extension of the files it\n# parses. With this tag you can assign which parser to use for a given\n# extension. Doxygen has a built-in mapping, but you can override or extend it\n# using this tag. The format is ext=language, where ext is a file extension, and\n# language is one of the parsers supported by doxygen: IDL, Java, Javascript,\n# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,\n# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:\n# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser\n# tries to guess whether the code is fixed or free formatted code, this is the\n# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat\n# .inc files as Fortran files (default is PHP), and .f files as C (default is\n# Fortran), use: inc=Fortran f=C.\n#\n# Note: For files without extension you can use no_extension as a placeholder.\n#\n# Note that for custom extensions you also need to set FILE_PATTERNS otherwise\n# the files are not read by doxygen.\n\nEXTENSION_MAPPING =\n\n# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments\n# according to the Markdown format, which allows for more readable\n# documentation. See https://daringfireball.net/projects/markdown/ for details.\n# The output of markdown processing is further processed by doxygen, so you can\n# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in\n# case of backward compatibilities issues.\n# The default value is: YES.\n\nMARKDOWN_SUPPORT = YES\n\n# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up\n# to that level are automatically included in the table of contents, even if\n# they do not have an id attribute.\n# Note: This feature currently applies only to Markdown headings.\n# Minimum value: 0, maximum value: 99, default value: 0.\n# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.\n\nTOC_INCLUDE_HEADINGS = 0\n\n# When enabled doxygen tries to link words that correspond to documented\n# classes, or namespaces to their corresponding documentation. Such a link can\n# be prevented in individual cases by putting a % sign in front of the word or\n# globally by setting AUTOLINK_SUPPORT to NO.\n# The default value is: YES.\n\nAUTOLINK_SUPPORT = YES\n\n# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want\n# to include (a tag file for) the STL sources as input, then you should set this\n# tag to YES in order to let doxygen match functions declarations and\n# definitions whose arguments contain STL classes (e.g. func(std::string);\n# versus func(std::string) {}). This also make the inheritance and collaboration\n# diagrams that involve STL classes more complete and accurate.\n# The default value is: NO.\n\nBUILTIN_STL_SUPPORT = NO\n\n# If you use Microsoft's C++/CLI language, you should set this option to YES to\n# enable parsing support.\n# The default value is: NO.\n\nCPP_CLI_SUPPORT = NO\n\n# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:\n# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen\n# will parse them like normal C++ but will assume all classes use public instead\n# of private inheritance when no explicit protection keyword is present.\n# The default value is: NO.\n\nSIP_SUPPORT = NO\n\n# For Microsoft's IDL there are propget and propput attributes to indicate\n# getter and setter methods for a property. Setting this option to YES will make\n# doxygen to replace the get and set methods by a property in the documentation.\n# This will only work if the methods are indeed getting or setting a simple\n# type. If this is not the case, or you want to show the methods anyway, you\n# should set this option to NO.\n# The default value is: YES.\n\nIDL_PROPERTY_SUPPORT = YES\n\n# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC\n# tag is set to YES then doxygen will reuse the documentation of the first\n# member in the group (if any) for the other members of the group. By default\n# all members of a group must be documented explicitly.\n# The default value is: NO.\n\nDISTRIBUTE_GROUP_DOC = NO\n\n# If one adds a struct or class to a group and this option is enabled, then also\n# any nested class or struct is added to the same group. By default this option\n# is disabled and one has to add nested compounds explicitly via \\ingroup.\n# The default value is: NO.\n\nGROUP_NESTED_COMPOUNDS = NO\n\n# Set the SUBGROUPING tag to YES to allow class member groups of the same type\n# (for instance a group of public functions) to be put as a subgroup of that\n# type (e.g. under the Public Functions section). Set it to NO to prevent\n# subgrouping. Alternatively, this can be done per class using the\n# \\nosubgrouping command.\n# The default value is: YES.\n\nSUBGROUPING = YES\n\n# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions\n# are shown inside the group in which they are included (e.g. using \\ingroup)\n# instead of on a separate page (for HTML and Man pages) or section (for LaTeX\n# and RTF).\n#\n# Note that this feature does not work in combination with\n# SEPARATE_MEMBER_PAGES.\n# The default value is: NO.\n\nINLINE_GROUPED_CLASSES = NO\n\n# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions\n# with only public data fields or simple typedef fields will be shown inline in\n# the documentation of the scope in which they are defined (i.e. file,\n# namespace, or group documentation), provided this scope is documented. If set\n# to NO, structs, classes, and unions are shown on a separate page (for HTML and\n# Man pages) or section (for LaTeX and RTF).\n# The default value is: NO.\n\nINLINE_SIMPLE_STRUCTS = NO\n\n# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or\n# enum is documented as struct, union, or enum with the name of the typedef. So\n# typedef struct TypeS {} TypeT, will appear in the documentation as a struct\n# with name TypeT. When disabled the typedef will appear as a member of a file,\n# namespace, or class. And the struct will be named TypeS. This can typically be\n# useful for C code in case the coding convention dictates that all compound\n# types are typedef'ed and only the typedef is referenced, never the tag name.\n# The default value is: NO.\n\nTYPEDEF_HIDES_STRUCT = NO\n\n# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This\n# cache is used to resolve symbols given their name and scope. Since this can be\n# an expensive process and often the same symbol appears multiple times in the\n# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small\n# doxygen will become slower. If the cache is too large, memory is wasted. The\n# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range\n# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536\n# symbols. At the end of a run doxygen will report the cache usage and suggest\n# the optimal cache size from a speed point of view.\n# Minimum value: 0, maximum value: 9, default value: 0.\n\nLOOKUP_CACHE_SIZE = 0\n\n#---------------------------------------------------------------------------\n# Build related configuration options\n#---------------------------------------------------------------------------\n\n# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in\n# documentation are documented, even if no documentation was available. Private\n# class members and static file members will be hidden unless the\n# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.\n# Note: This will also disable the warnings about undocumented members that are\n# normally produced when WARNINGS is set to YES.\n# The default value is: NO.\n\nEXTRACT_ALL = NO\n\n# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will\n# be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PRIVATE = NO\n\n# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal\n# scope will be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PACKAGE = NO\n\n# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be\n# included in the documentation.\n# The default value is: NO.\n\nEXTRACT_STATIC = NO\n\n# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined\n# locally in source files will be included in the documentation. If set to NO,\n# only classes defined in header files are included. Does not have any effect\n# for Java sources.\n# The default value is: YES.\n\nEXTRACT_LOCAL_CLASSES = YES\n\n# This flag is only useful for Objective-C code. If set to YES, local methods,\n# which are defined in the implementation section but not in the interface are\n# included in the documentation. If set to NO, only methods in the interface are\n# included.\n# The default value is: NO.\n\nEXTRACT_LOCAL_METHODS = NO\n\n# If this flag is set to YES, the members of anonymous namespaces will be\n# extracted and appear in the documentation as a namespace called\n# 'anonymous_namespace{file}', where file will be replaced with the base name of\n# the file that contains the anonymous namespace. By default anonymous namespace\n# are hidden.\n# The default value is: NO.\n\nEXTRACT_ANON_NSPACES = NO\n\n# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all\n# undocumented members inside documented classes or files. If set to NO these\n# members will be included in the various overviews, but no documentation\n# section is generated. This option has no effect if EXTRACT_ALL is enabled.\n# The default value is: NO.\n\nHIDE_UNDOC_MEMBERS = NO\n\n# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all\n# undocumented classes that are normally visible in the class hierarchy. If set\n# to NO, these classes will be included in the various overviews. This option\n# has no effect if EXTRACT_ALL is enabled.\n# The default value is: NO.\n\nHIDE_UNDOC_CLASSES = NO\n\n# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend\n# (class|struct|union) declarations. If set to NO, these declarations will be\n# included in the documentation.\n# The default value is: NO.\n\nHIDE_FRIEND_COMPOUNDS = NO\n\n# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any\n# documentation blocks found inside the body of a function. If set to NO, these\n# blocks will be appended to the function's detailed documentation block.\n# The default value is: NO.\n\nHIDE_IN_BODY_DOCS = NO\n\n# The INTERNAL_DOCS tag determines if documentation that is typed after a\n# \\internal command is included. If the tag is set to NO then the documentation\n# will be excluded. Set it to YES to include the internal documentation.\n# The default value is: NO.\n\nINTERNAL_DOCS = NO\n\n# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file\n# names in lower-case letters. If set to YES, upper-case letters are also\n# allowed. This is useful if you have classes or files whose names only differ\n# in case and if your file system supports case sensitive file names. Windows\n# and Mac users are advised to set this option to NO.\n# The default value is: system dependent.\n\nCASE_SENSE_NAMES = NO\n\n# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with\n# their full class and namespace scopes in the documentation. If set to YES, the\n# scope will be hidden.\n# The default value is: NO.\n\nHIDE_SCOPE_NAMES = NO\n\n# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will\n# append additional text to a page's title, such as Class Reference. If set to\n# YES the compound reference will be hidden.\n# The default value is: NO.\n\nHIDE_COMPOUND_REFERENCE= NO\n\n# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of\n# the files that are included by a file in the documentation of that file.\n# The default value is: YES.\n\nSHOW_INCLUDE_FILES = YES\n\n# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each\n# grouped member an include statement to the documentation, telling the reader\n# which file to include in order to use the member.\n# The default value is: NO.\n\nSHOW_GROUPED_MEMB_INC = NO\n\n# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include\n# files with double quotes in the documentation rather than with sharp brackets.\n# The default value is: NO.\n\nFORCE_LOCAL_INCLUDES = NO\n\n# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the\n# documentation for inline members.\n# The default value is: YES.\n\nINLINE_INFO = YES\n\n# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the\n# (detailed) documentation of file and class members alphabetically by member\n# name. If set to NO, the members will appear in declaration order.\n# The default value is: YES.\n\nSORT_MEMBER_DOCS = YES\n\n# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief\n# descriptions of file, namespace and class members alphabetically by member\n# name. If set to NO, the members will appear in declaration order. Note that\n# this will also influence the order of the classes in the class list.\n# The default value is: NO.\n\nSORT_BRIEF_DOCS = NO\n\n# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the\n# (brief and detailed) documentation of class members so that constructors and\n# destructors are listed first. If set to NO the constructors will appear in the\n# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.\n# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief\n# member documentation.\n# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting\n# detailed member documentation.\n# The default value is: NO.\n\nSORT_MEMBERS_CTORS_1ST = NO\n\n# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy\n# of group names into alphabetical order. If set to NO the group names will\n# appear in their defined order.\n# The default value is: NO.\n\nSORT_GROUP_NAMES = NO\n\n# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by\n# fully-qualified names, including namespaces. If set to NO, the class list will\n# be sorted only by class name, not including the namespace part.\n# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.\n# Note: This option applies only to the class list, not to the alphabetical\n# list.\n# The default value is: NO.\n\nSORT_BY_SCOPE_NAME = NO\n\n# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper\n# type resolution of all parameters of a function it will reject a match between\n# the prototype and the implementation of a member function even if there is\n# only one candidate or it is obvious which candidate to choose by doing a\n# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still\n# accept a match between prototype and implementation in such cases.\n# The default value is: NO.\n\nSTRICT_PROTO_MATCHING = NO\n\n# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo\n# list. This list is created by putting \\todo commands in the documentation.\n# The default value is: YES.\n\nGENERATE_TODOLIST = YES\n\n# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test\n# list. This list is created by putting \\test commands in the documentation.\n# The default value is: YES.\n\nGENERATE_TESTLIST = YES\n\n# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug\n# list. This list is created by putting \\bug commands in the documentation.\n# The default value is: YES.\n\nGENERATE_BUGLIST = YES\n\n# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)\n# the deprecated list. This list is created by putting \\deprecated commands in\n# the documentation.\n# The default value is: YES.\n\nGENERATE_DEPRECATEDLIST= YES\n\n# The ENABLED_SECTIONS tag can be used to enable conditional documentation\n# sections, marked by \\if ... \\endif and \\cond \n# ... \\endcond blocks.\n\nENABLED_SECTIONS =\n\n# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the\n# initial value of a variable or macro / define can have for it to appear in the\n# documentation. If the initializer consists of more lines than specified here\n# it will be hidden. Use a value of 0 to hide initializers completely. The\n# appearance of the value of individual variables and macros / defines can be\n# controlled using \\showinitializer or \\hideinitializer command in the\n# documentation regardless of this setting.\n# Minimum value: 0, maximum value: 10000, default value: 30.\n\nMAX_INITIALIZER_LINES = 30\n\n# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at\n# the bottom of the documentation of classes and structs. If set to YES, the\n# list will mention the files that were used to generate the documentation.\n# The default value is: YES.\n\nSHOW_USED_FILES = YES\n\n# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This\n# will remove the Files entry from the Quick Index and from the Folder Tree View\n# (if specified).\n# The default value is: YES.\n\nSHOW_FILES = YES\n\n# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces\n# page. This will remove the Namespaces entry from the Quick Index and from the\n# Folder Tree View (if specified).\n# The default value is: YES.\n\nSHOW_NAMESPACES = YES\n\n# The FILE_VERSION_FILTER tag can be used to specify a program or script that\n# doxygen should invoke to get the current version for each file (typically from\n# the version control system). Doxygen will invoke the program by executing (via\n# popen()) the command command input-file, where command is the value of the\n# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided\n# by doxygen. Whatever the program writes to standard output is used as the file\n# version. For an example see the documentation.\n\nFILE_VERSION_FILTER =\n\n# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed\n# by doxygen. The layout file controls the global structure of the generated\n# output files in an output format independent way. To create the layout file\n# that represents doxygen's defaults, run doxygen with the -l option. You can\n# optionally specify a file name after the option, if omitted DoxygenLayout.xml\n# will be used as the name of the layout file.\n#\n# Note that if you run doxygen from a directory containing a file called\n# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE\n# tag is left empty.\n\nLAYOUT_FILE =\n\n# The CITE_BIB_FILES tag can be used to specify one or more bib files containing\n# the reference definitions. This must be a list of .bib files. The .bib\n# extension is automatically appended if omitted. This requires the bibtex tool\n# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.\n# For LaTeX the style of the bibliography can be controlled using\n# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the\n# search path. See also \\cite for info how to create references.\n\nCITE_BIB_FILES =\n\n#---------------------------------------------------------------------------\n# Configuration options related to warning and progress messages\n#---------------------------------------------------------------------------\n\n# The QUIET tag can be used to turn on/off the messages that are generated to\n# standard output by doxygen. If QUIET is set to YES this implies that the\n# messages are off.\n# The default value is: NO.\n\nQUIET = NO\n\n# The WARNINGS tag can be used to turn on/off the warning messages that are\n# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES\n# this implies that the warnings are on.\n#\n# Tip: Turn warnings on while writing the documentation.\n# The default value is: YES.\n\nWARNINGS = YES\n\n# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate\n# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag\n# will automatically be disabled.\n# The default value is: YES.\n\nWARN_IF_UNDOCUMENTED = YES\n\n# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for\n# potential errors in the documentation, such as not documenting some parameters\n# in a documented function, or documenting parameters that don't exist or using\n# markup commands wrongly.\n# The default value is: YES.\n\nWARN_IF_DOC_ERROR = YES\n\n# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that\n# are documented, but have no documentation for their parameters or return\n# value. If set to NO, doxygen will only warn about wrong or incomplete\n# parameter documentation, but not about the absence of documentation. If\n# EXTRACT_ALL is set to YES then this flag will automatically be disabled.\n# The default value is: NO.\n\nWARN_NO_PARAMDOC = NO\n\n# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when\n# a warning is encountered.\n# The default value is: NO.\n\nWARN_AS_ERROR = NO\n\n# The WARN_FORMAT tag determines the format of the warning messages that doxygen\n# can produce. The string should contain the $file, $line, and $text tags, which\n# will be replaced by the file and line number from which the warning originated\n# and the warning text. Optionally the format may contain $version, which will\n# be replaced by the version of the file (if it could be obtained via\n# FILE_VERSION_FILTER)\n# The default value is: $file:$line: $text.\n\nWARN_FORMAT = \"$file:$line: $text\"\n\n# The WARN_LOGFILE tag can be used to specify a file to which warning and error\n# messages should be written. If left blank the output is written to standard\n# error (stderr).\n\nWARN_LOGFILE =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the input files\n#---------------------------------------------------------------------------\n\n# The INPUT tag is used to specify the files and/or directories that contain\n# documented source files. You may enter file names like myfile.cpp or\n# directories like /usr/src/myproject. Separate the files or directories with\n# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING\n# Note: If this tag is empty the current directory is searched.\n\nINPUT = src\n\n# This tag can be used to specify the character encoding of the source files\n# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses\n# libiconv (or the iconv built into libc) for the transcoding. See the libiconv\n# documentation (see: https://www.gnu.org/software/libiconv/) for the list of\n# possible encodings.\n# The default value is: UTF-8.\n\nINPUT_ENCODING = UTF-8\n\n# If the value of the INPUT tag contains directories, you can use the\n# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and\n# *.h) to filter out the source-files in the directories.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# read by doxygen.\n#\n# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,\n# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,\n# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,\n# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,\n# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.\n\nFILE_PATTERNS = *.c \\\n *.cc \\\n *.cxx \\\n *.cpp \\\n *.c++ \\\n *.java \\\n *.ii \\\n *.ixx \\\n *.ipp \\\n *.i++ \\\n *.inl \\\n *.idl \\\n *.ddl \\\n *.odl \\\n *.h \\\n *.hh \\\n *.hxx \\\n *.hpp \\\n *.h++ \\\n *.cs \\\n *.d \\\n *.php \\\n *.php4 \\\n *.php5 \\\n *.phtml \\\n *.inc \\\n *.m \\\n *.markdown \\\n *.md \\\n *.mm \\\n *.dox \\\n *.py \\\n *.pyw \\\n *.f90 \\\n *.f95 \\\n *.f03 \\\n *.f08 \\\n *.f \\\n *.for \\\n *.tcl \\\n *.vhd \\\n *.vhdl \\\n *.ucf \\\n *.qsf \\\n *.ice\n\n# The RECURSIVE tag can be used to specify whether or not subdirectories should\n# be searched for input files as well.\n# The default value is: NO.\n\nRECURSIVE = YES\n\n# The EXCLUDE tag can be used to specify files and/or directories that should be\n# excluded from the INPUT source files. This way you can easily exclude a\n# subdirectory from a directory tree whose root is specified with the INPUT tag.\n#\n# Note that relative paths are relative to the directory from which doxygen is\n# run.\n\nEXCLUDE =\n\n# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or\n# directories that are symbolic links (a Unix file system feature) are excluded\n# from the input.\n# The default value is: NO.\n\nEXCLUDE_SYMLINKS = NO\n\n# If the value of the INPUT tag contains directories, you can use the\n# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude\n# certain files from those directories.\n#\n# Note that the wildcards are matched against the file with absolute path, so to\n# exclude all test directories for example use the pattern */test/*\n\nEXCLUDE_PATTERNS =\n\n# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names\n# (namespaces, classes, functions, etc.) that should be excluded from the\n# output. The symbol name can be a fully qualified name, a word, or if the\n# wildcard * is used, a substring. Examples: ANamespace, AClass,\n# AClass::ANamespace, ANamespace::*Test\n#\n# Note that the wildcards are matched against the file with absolute path, so to\n# exclude all test directories use the pattern */test/*\n\nEXCLUDE_SYMBOLS =\n\n# The EXAMPLE_PATH tag can be used to specify one or more files or directories\n# that contain example code fragments that are included (see the \\include\n# command).\n\nEXAMPLE_PATH =\n\n# If the value of the EXAMPLE_PATH tag contains directories, you can use the\n# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and\n# *.h) to filter out the source-files in the directories. If left blank all\n# files are included.\n\nEXAMPLE_PATTERNS = *\n\n# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be\n# searched for input files to be used with the \\include or \\dontinclude commands\n# irrespective of the value of the RECURSIVE tag.\n# The default value is: NO.\n\nEXAMPLE_RECURSIVE = NO\n\n# The IMAGE_PATH tag can be used to specify one or more files or directories\n# that contain images that are to be included in the documentation (see the\n# \\image command).\n\nIMAGE_PATH =\n\n# The INPUT_FILTER tag can be used to specify a program that doxygen should\n# invoke to filter for each input file. Doxygen will invoke the filter program\n# by executing (via popen()) the command:\n#\n# \n#\n# where is the value of the INPUT_FILTER tag, and is the\n# name of an input file. Doxygen will then use the output that the filter\n# program writes to standard output. If FILTER_PATTERNS is specified, this tag\n# will be ignored.\n#\n# Note that the filter must not add or remove lines; it is applied before the\n# code is scanned, but not when the output code is generated. If lines are added\n# or removed, the anchors will not be placed correctly.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# properly processed by doxygen.\n\nINPUT_FILTER =\n\n# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern\n# basis. Doxygen will compare the file name with each pattern and apply the\n# filter if there is a match. The filters are a list of the form: pattern=filter\n# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how\n# filters are used. If the FILTER_PATTERNS tag is empty or if none of the\n# patterns match the file name, INPUT_FILTER is applied.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# properly processed by doxygen.\n\nFILTER_PATTERNS =\n\n# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using\n# INPUT_FILTER) will also be used to filter the input files that are used for\n# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).\n# The default value is: NO.\n\nFILTER_SOURCE_FILES = NO\n\n# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file\n# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and\n# it is also possible to disable source filtering for a specific pattern using\n# *.ext= (so without naming a filter).\n# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.\n\nFILTER_SOURCE_PATTERNS =\n\n# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that\n# is part of the input, its contents will be placed on the main page\n# (index.html). This can be useful if you have a project on for instance GitHub\n# and want to reuse the introduction page also for the doxygen output.\n\nUSE_MDFILE_AS_MAINPAGE =\n\n#---------------------------------------------------------------------------\n# Configuration options related to source browsing\n#---------------------------------------------------------------------------\n\n# If the SOURCE_BROWSER tag is set to YES then a list of source files will be\n# generated. Documented entities will be cross-referenced with these sources.\n#\n# Note: To get rid of all source code in the generated output, make sure that\n# also VERBATIM_HEADERS is set to NO.\n# The default value is: NO.\n\nSOURCE_BROWSER = NO\n\n# Setting the INLINE_SOURCES tag to YES will include the body of functions,\n# classes and enums directly into the documentation.\n# The default value is: NO.\n\nINLINE_SOURCES = NO\n\n# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any\n# special comment blocks from generated source code fragments. Normal C, C++ and\n# Fortran comments will always remain visible.\n# The default value is: YES.\n\nSTRIP_CODE_COMMENTS = YES\n\n# If the REFERENCED_BY_RELATION tag is set to YES then for each documented\n# entity all documented functions referencing it will be listed.\n# The default value is: NO.\n\nREFERENCED_BY_RELATION = NO\n\n# If the REFERENCES_RELATION tag is set to YES then for each documented function\n# all documented entities called/used by that function will be listed.\n# The default value is: NO.\n\nREFERENCES_RELATION = NO\n\n# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set\n# to YES then the hyperlinks from functions in REFERENCES_RELATION and\n# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will\n# link to the documentation.\n# The default value is: YES.\n\nREFERENCES_LINK_SOURCE = YES\n\n# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the\n# source code will show a tooltip with additional information such as prototype,\n# brief description and links to the definition and documentation. Since this\n# will make the HTML file larger and loading of large files a bit slower, you\n# can opt to disable this feature.\n# The default value is: YES.\n# This tag requires that the tag SOURCE_BROWSER is set to YES.\n\nSOURCE_TOOLTIPS = YES\n\n# If the USE_HTAGS tag is set to YES then the references to source code will\n# point to the HTML generated by the htags(1) tool instead of doxygen built-in\n# source browser. The htags tool is part of GNU's global source tagging system\n# (see https://www.gnu.org/software/global/global.html). You will need version\n# 4.8.6 or higher.\n#\n# To use it do the following:\n# - Install the latest version of global\n# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file\n# - Make sure the INPUT points to the root of the source tree\n# - Run doxygen as normal\n#\n# Doxygen will invoke htags (and that will in turn invoke gtags), so these\n# tools must be available from the command line (i.e. in the search path).\n#\n# The result: instead of the source browser generated by doxygen, the links to\n# source code will now point to the output of htags.\n# The default value is: NO.\n# This tag requires that the tag SOURCE_BROWSER is set to YES.\n\nUSE_HTAGS = NO\n\n# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a\n# verbatim copy of the header file for each class for which an include is\n# specified. Set to NO to disable this.\n# See also: Section \\class.\n# The default value is: YES.\n\nVERBATIM_HEADERS = YES\n\n# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the\n# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the\n# cost of reduced performance. This can be particularly helpful with template\n# rich C++ code for which doxygen's built-in parser lacks the necessary type\n# information.\n# Note: The availability of this option depends on whether or not doxygen was\n# generated with the -Duse_libclang=ON option for CMake.\n# The default value is: NO.\n\nCLANG_ASSISTED_PARSING = NO\n\n# If clang assisted parsing is enabled you can provide the compiler with command\n# line options that you would normally use when invoking the compiler. Note that\n# the include paths will already be set by doxygen for the files and directories\n# specified with INPUT and INCLUDE_PATH.\n# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.\n\nCLANG_OPTIONS =\n\n# If clang assisted parsing is enabled you can provide the clang parser with the\n# path to the compilation database (see:\n# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files\n# were built. This is equivalent to specifying the \"-p\" option to a clang tool,\n# such as clang-check. These options will then be passed to the parser.\n# Note: The availability of this option depends on whether or not doxygen was\n# generated with the -Duse_libclang=ON option for CMake.\n\nCLANG_DATABASE_PATH =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the alphabetical class index\n#---------------------------------------------------------------------------\n\n# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all\n# compounds will be generated. Enable this if the project contains a lot of\n# classes, structs, unions or interfaces.\n# The default value is: YES.\n\nALPHABETICAL_INDEX = YES\n\n# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in\n# which the alphabetical index list will be split.\n# Minimum value: 1, maximum value: 20, default value: 5.\n# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.\n\nCOLS_IN_ALPHA_INDEX = 5\n\n# In case all classes in a project start with a common prefix, all classes will\n# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag\n# can be used to specify a prefix (or a list of prefixes) that should be ignored\n# while generating the index headers.\n# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.\n\nIGNORE_PREFIX =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the HTML output\n#---------------------------------------------------------------------------\n\n# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output\n# The default value is: YES.\n\nGENERATE_HTML = YES\n\n# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a\n# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\n# it.\n# The default directory is: html.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_OUTPUT = html\n\n# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each\n# generated HTML page (for example: .htm, .php, .asp).\n# The default value is: .html.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FILE_EXTENSION = .html\n\n# The HTML_HEADER tag can be used to specify a user-defined HTML header file for\n# each generated HTML page. If the tag is left blank doxygen will generate a\n# standard header.\n#\n# To get valid HTML the header file that includes any scripts and style sheets\n# that doxygen needs, which is dependent on the configuration options used (e.g.\n# the setting GENERATE_TREEVIEW). It is highly recommended to start with a\n# default header using\n# doxygen -w html new_header.html new_footer.html new_stylesheet.css\n# YourConfigFile\n# and then modify the file new_header.html. See also section \"Doxygen usage\"\n# for information on how to generate the default header that doxygen normally\n# uses.\n# Note: The header is subject to change so you typically have to regenerate the\n# default header when upgrading to a newer version of doxygen. For a description\n# of the possible markers and block names see the documentation.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_HEADER =\n\n# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each\n# generated HTML page. If the tag is left blank doxygen will generate a standard\n# footer. See HTML_HEADER for more information on how to generate a default\n# footer and what special commands can be used inside the footer. See also\n# section \"Doxygen usage\" for information on how to generate the default footer\n# that doxygen normally uses.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FOOTER =\n\n# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style\n# sheet that is used by each HTML page. It can be used to fine-tune the look of\n# the HTML output. If left blank doxygen will generate a default style sheet.\n# See also section \"Doxygen usage\" for information on how to generate the style\n# sheet that doxygen normally uses.\n# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as\n# it is more robust and this tag (HTML_STYLESHEET) will in the future become\n# obsolete.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_STYLESHEET =\n\n# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined\n# cascading style sheets that are included after the standard style sheets\n# created by doxygen. Using this option one can overrule certain style aspects.\n# This is preferred over using HTML_STYLESHEET since it does not replace the\n# standard style sheet and is therefore more robust against future updates.\n# Doxygen will copy the style sheet files to the output directory.\n# Note: The order of the extra style sheet files is of importance (e.g. the last\n# style sheet in the list overrules the setting of the previous ones in the\n# list). For an example see the documentation.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_EXTRA_STYLESHEET =\n\n# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or\n# other source files which should be copied to the HTML output directory. Note\n# that these files will be copied to the base HTML output directory. Use the\n# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these\n# files. In the HTML_STYLESHEET file, use the file name only. Also note that the\n# files will be copied as-is; there are no commands or markers available.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_EXTRA_FILES =\n\n# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen\n# will adjust the colors in the style sheet and background images according to\n# this color. Hue is specified as an angle on a colorwheel, see\n# https://en.wikipedia.org/wiki/Hue for more information. For instance the value\n# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300\n# purple, and 360 is red again.\n# Minimum value: 0, maximum value: 359, default value: 220.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_HUE = 220\n\n# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors\n# in the HTML output. For a value of 0 the output will use grayscales only. A\n# value of 255 will produce the most vivid colors.\n# Minimum value: 0, maximum value: 255, default value: 100.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_SAT = 100\n\n# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the\n# luminance component of the colors in the HTML output. Values below 100\n# gradually make the output lighter, whereas values above 100 make the output\n# darker. The value divided by 100 is the actual gamma applied, so 80 represents\n# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not\n# change the gamma.\n# Minimum value: 40, maximum value: 240, default value: 80.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_GAMMA = 80\n\n# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML\n# page will contain the date and time when the page was generated. Setting this\n# to YES can help to show when doxygen was last run and thus if the\n# documentation is up to date.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_TIMESTAMP = NO\n\n# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML\n# documentation will contain a main index with vertical navigation menus that\n# are dynamically created via Javascript. If disabled, the navigation index will\n# consists of multiple levels of tabs that are statically embedded in every HTML\n# page. Disable this option to support browsers that do not have Javascript,\n# like the Qt help browser.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_DYNAMIC_MENUS = YES\n\n# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML\n# documentation will contain sections that can be hidden and shown after the\n# page has loaded.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_DYNAMIC_SECTIONS = NO\n\n# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries\n# shown in the various tree structured indices initially; the user can expand\n# and collapse entries dynamically later on. Doxygen will expand the tree to\n# such a level that at most the specified number of entries are visible (unless\n# a fully collapsed tree already exceeds this amount). So setting the number of\n# entries 1 will produce a full collapsed tree by default. 0 is a special value\n# representing an infinite number of entries and will result in a full expanded\n# tree by default.\n# Minimum value: 0, maximum value: 9999, default value: 100.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_INDEX_NUM_ENTRIES = 100\n\n# If the GENERATE_DOCSET tag is set to YES, additional index files will be\n# generated that can be used as input for Apple's Xcode 3 integrated development\n# environment (see: https://developer.apple.com/xcode/), introduced with OSX\n# 10.5 (Leopard). To create a documentation set, doxygen will generate a\n# Makefile in the HTML output directory. Running make will produce the docset in\n# that directory and running make install will install the docset in\n# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at\n# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy\n# genXcode/_index.html for more information.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_DOCSET = NO\n\n# This tag determines the name of the docset feed. A documentation feed provides\n# an umbrella under which multiple documentation sets from a single provider\n# (such as a company or product suite) can be grouped.\n# The default value is: Doxygen generated docs.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_FEEDNAME = \"Doxygen generated docs\"\n\n# This tag specifies a string that should uniquely identify the documentation\n# set bundle. This should be a reverse domain-name style string, e.g.\n# com.mycompany.MyDocSet. Doxygen will append .docset to the name.\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_BUNDLE_ID = org.doxygen.Project\n\n# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify\n# the documentation publisher. This should be a reverse domain-name style\n# string, e.g. com.mycompany.MyDocSet.documentation.\n# The default value is: org.doxygen.Publisher.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_PUBLISHER_ID = org.doxygen.Publisher\n\n# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.\n# The default value is: Publisher.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_PUBLISHER_NAME = Publisher\n\n# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three\n# additional HTML index files: index.hhp, index.hhc, and index.hhk. The\n# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop\n# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on\n# Windows.\n#\n# The HTML Help Workshop contains a compiler that can convert all HTML output\n# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML\n# files are now used as the Windows 98 help format, and will replace the old\n# Windows help format (.hlp) on all Windows platforms in the future. Compressed\n# HTML files also contain an index, a table of contents, and you can search for\n# words in the documentation. The HTML workshop also contains a viewer for\n# compressed HTML files.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_HTMLHELP = NO\n\n# The CHM_FILE tag can be used to specify the file name of the resulting .chm\n# file. You can add a path in front of the file if the result should not be\n# written to the html output directory.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nCHM_FILE =\n\n# The HHC_LOCATION tag can be used to specify the location (absolute path\n# including file name) of the HTML help compiler (hhc.exe). If non-empty,\n# doxygen will try to run the HTML help compiler on the generated index.hhp.\n# The file has to be specified with full path.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nHHC_LOCATION =\n\n# The GENERATE_CHI flag controls if a separate .chi index file is generated\n# (YES) or that it should be included in the master .chm file (NO).\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nGENERATE_CHI = NO\n\n# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)\n# and project file content.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nCHM_INDEX_ENCODING =\n\n# The BINARY_TOC flag controls whether a binary table of contents is generated\n# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it\n# enables the Previous and Next buttons.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nBINARY_TOC = NO\n\n# The TOC_EXPAND flag can be set to YES to add extra items for group members to\n# the table of contents of the HTML help documentation and to the tree view.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nTOC_EXPAND = NO\n\n# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and\n# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that\n# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help\n# (.qch) of the generated HTML documentation.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_QHP = NO\n\n# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify\n# the file name of the resulting .qch file. The path specified is relative to\n# the HTML output folder.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQCH_FILE =\n\n# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help\n# Project output. For more information please see Qt Help Project / Namespace\n# (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_NAMESPACE = org.doxygen.Project\n\n# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt\n# Help Project output. For more information please see Qt Help Project / Virtual\n# Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-\n# folders).\n# The default value is: doc.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_VIRTUAL_FOLDER = doc\n\n# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom\n# filter to add. For more information please see Qt Help Project / Custom\n# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-\n# filters).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_CUST_FILTER_NAME =\n\n# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the\n# custom filter to add. For more information please see Qt Help Project / Custom\n# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-\n# filters).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_CUST_FILTER_ATTRS =\n\n# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this\n# project's filter section matches. Qt Help Project / Filter Attributes (see:\n# http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_SECT_FILTER_ATTRS =\n\n# The QHG_LOCATION tag can be used to specify the location of Qt's\n# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the\n# generated .qhp file.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHG_LOCATION =\n\n# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be\n# generated, together with the HTML files, they form an Eclipse help plugin. To\n# install this plugin and make it available under the help contents menu in\n# Eclipse, the contents of the directory containing the HTML and XML files needs\n# to be copied into the plugins directory of eclipse. The name of the directory\n# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.\n# After copying Eclipse needs to be restarted before the help appears.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_ECLIPSEHELP = NO\n\n# A unique identifier for the Eclipse help plugin. When installing the plugin\n# the directory name containing the HTML and XML files should also have this\n# name. Each documentation set should have its own identifier.\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.\n\nECLIPSE_DOC_ID = org.doxygen.Project\n\n# If you want full control over the layout of the generated HTML pages it might\n# be necessary to disable the index and replace it with your own. The\n# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top\n# of each HTML page. A value of NO enables the index and the value YES disables\n# it. Since the tabs in the index contain the same information as the navigation\n# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nDISABLE_INDEX = NO\n\n# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index\n# structure should be generated to display hierarchical information. If the tag\n# value is set to YES, a side panel will be generated containing a tree-like\n# index structure (just like the one that is generated for HTML Help). For this\n# to work a browser that supports JavaScript, DHTML, CSS and frames is required\n# (i.e. any modern browser). Windows users are probably better off using the\n# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can\n# further fine-tune the look of the index. As an example, the default style\n# sheet generated by doxygen has an example that shows how to put an image at\n# the root of the tree instead of the PROJECT_NAME. Since the tree basically has\n# the same information as the tab index, you could consider setting\n# DISABLE_INDEX to YES when enabling this option.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_TREEVIEW = YES\n\n# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that\n# doxygen will group on one line in the generated HTML documentation.\n#\n# Note that a value of 0 will completely suppress the enum values from appearing\n# in the overview section.\n# Minimum value: 0, maximum value: 20, default value: 4.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nENUM_VALUES_PER_LINE = 4\n\n# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used\n# to set the initial width (in pixels) of the frame in which the tree is shown.\n# Minimum value: 0, maximum value: 1500, default value: 250.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nTREEVIEW_WIDTH = 250\n\n# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to\n# external symbols imported via tag files in a separate window.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nEXT_LINKS_IN_WINDOW = NO\n\n# Use this tag to change the font size of LaTeX formulas included as images in\n# the HTML documentation. When you change the font size after a successful\n# doxygen run you need to manually remove any form_*.png images from the HTML\n# output directory to force them to be regenerated.\n# Minimum value: 8, maximum value: 50, default value: 10.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFORMULA_FONTSIZE = 10\n\n# Use the FORMULA_TRANSPARENT tag to determine whether or not the images\n# generated for formulas are transparent PNGs. Transparent PNGs are not\n# supported properly for IE 6.0, but are supported on all modern browsers.\n#\n# Note that when changing this option you need to delete any form_*.png files in\n# the HTML output directory before the changes have effect.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFORMULA_TRANSPARENT = YES\n\n# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see\n# https://www.mathjax.org) which uses client side Javascript for the rendering\n# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX\n# installed or if you want to formulas look prettier in the HTML output. When\n# enabled you may also need to install MathJax separately and configure the path\n# to it using the MATHJAX_RELPATH option.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nUSE_MATHJAX = NO\n\n# When MathJax is enabled you can set the default output format to be used for\n# the MathJax output. See the MathJax site (see:\n# http://docs.mathjax.org/en/latest/output.html) for more details.\n# Possible values are: HTML-CSS (which is slower, but has the best\n# compatibility), NativeMML (i.e. MathML) and SVG.\n# The default value is: HTML-CSS.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_FORMAT = HTML-CSS\n\n# When MathJax is enabled you need to specify the location relative to the HTML\n# output directory using the MATHJAX_RELPATH option. The destination directory\n# should contain the MathJax.js script. For instance, if the mathjax directory\n# is located at the same level as the HTML output directory, then\n# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax\n# Content Delivery Network so you can quickly see the result without installing\n# MathJax. However, it is strongly recommended to install a local copy of\n# MathJax from https://www.mathjax.org before deployment.\n# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/\n\n# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax\n# extension names that should be enabled during MathJax rendering. For example\n# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_EXTENSIONS =\n\n# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces\n# of code that will be used on startup of the MathJax code. See the MathJax site\n# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an\n# example see the documentation.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_CODEFILE =\n\n# When the SEARCHENGINE tag is enabled doxygen will generate a search box for\n# the HTML output. The underlying search engine uses javascript and DHTML and\n# should work on any modern browser. Note that when using HTML help\n# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)\n# there is already a search function so this one should typically be disabled.\n# For large projects the javascript based search engine can be slow, then\n# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to\n# search using the keyboard; to jump to the search box use + S\n# (what the is depends on the OS and browser, but it is typically\n# , /