Showing preview only (3,301K chars total). Download the full file or copy to clipboard to get everything.
Repository: matthias-bs/BresserWeatherSensorReceiver
Branch: main
Commit: 403ad7473ea5
Files: 149
Total size: 3.1 MB
Directory structure:
gitextract_4l_8lmjm/
├── .github/
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.md
│ │ └── feature_request.md
│ ├── dependabot.yml
│ └── workflows/
│ ├── CI.yml
│ ├── CppUTest.yml
│ ├── arduino-lint.yml
│ ├── doxygen.yml
│ ├── spell-check-exclude.txt
│ └── spell-check.yml
├── .gitignore
├── .vscode/
│ ├── arduino-cli-wrapper.sh
│ ├── arduino-compile-runner.sh
│ ├── arduino_compile_helper.py
│ ├── serial_logger.py
│ ├── serial_reset_monitor.py
│ ├── settings.json
│ └── tasks.json
├── BUILD.md
├── Bresser_HA_MQTT_custom_config.yaml
├── CODE_OF_CONDUCT.md
├── DEBUG_OUTPUT.md
├── Doxyfile
├── LICENSE
├── LICENSE.KeywordsTxtGenerator
├── README.md
├── copilot-instructions.md
├── docs/
│ ├── BUG_FIX_SIOF_SPICLASS.md
│ ├── MQTT_REFACTORING.md
│ ├── RollingCounter.md
│ ├── TEST_COVERAGE_SUMMARY.md
│ └── TEST_RAINGAUGE_COVERAGE.md
├── doxygen2keywords.xsl
├── examples/
│ ├── BresserWeatherSensorBasic/
│ │ ├── .gitkeep
│ │ ├── BresserWeatherSensorBasic.ino
│ │ └── example.log
│ ├── BresserWeatherSensorCallback/
│ │ ├── .gitkeep
│ │ ├── BresserWeatherSensorCallback.ino
│ │ └── example.log
│ ├── BresserWeatherSensorCanvasGauges/
│ │ ├── BresserWeatherSensorCanvasGauges.ino
│ │ ├── config.h
│ │ └── data/
│ │ ├── index.html
│ │ ├── script.js
│ │ └── style.css
│ ├── BresserWeatherSensorDomoticz/
│ │ ├── .gitkeep
│ │ ├── BresserWeatherSensorDomoticz.ino
│ │ └── example.log
│ ├── BresserWeatherSensorFreqTest/
│ │ ├── BresserWeatherSensorFreqTest.ino
│ │ ├── README.md
│ │ └── example_output.log
│ ├── BresserWeatherSensorM5Core2/
│ │ ├── BresserWeatherSensorM5Core2.ino
│ │ └── src/
│ │ ├── utils.cpp
│ │ └── utils.h
│ ├── BresserWeatherSensorMQTT/
│ │ ├── BresserWeatherSensorMQTT.ino
│ │ ├── example.log
│ │ └── src/
│ │ ├── mqtt_comm.cpp
│ │ └── mqtt_comm.h
│ ├── BresserWeatherSensorMQTTCustom/
│ │ ├── .gitkeep
│ │ ├── BresserWeatherSensorMQTTCustom.ino
│ │ ├── Readme.md
│ │ └── src/
│ │ ├── .gitkeep
│ │ ├── InitBoard.cpp
│ │ ├── InitBoard.h
│ │ ├── Lightning.cpp
│ │ ├── Lightning.h
│ │ ├── RainGauge.cpp
│ │ ├── RainGauge.h
│ │ ├── RollingCounter.cpp
│ │ ├── RollingCounter.h
│ │ ├── WeatherSensor.cpp
│ │ ├── WeatherSensor.h
│ │ ├── WeatherSensorCfg.h
│ │ ├── WeatherSensorConfig.cpp
│ │ ├── WeatherSensorDecoders.cpp
│ │ ├── WeatherUtils.cpp
│ │ ├── WeatherUtils.h
│ │ ├── mqtt_comm.cpp
│ │ └── mqtt_comm.h
│ ├── BresserWeatherSensorMQTTWifiMgr/
│ │ ├── BresserWeatherSensorMQTTWifiMgr.ino
│ │ └── src/
│ │ ├── mqtt_comm.cpp
│ │ └── mqtt_comm.h
│ ├── BresserWeatherSensorOLED/
│ │ └── BresserWeatherSensorOLED.ino
│ ├── BresserWeatherSensorOptions/
│ │ ├── .gitkeep
│ │ ├── BresserWeatherSensorOptions.ino
│ │ └── example.log
│ ├── BresserWeatherSensorSDCard/
│ │ ├── BresserWeatherSensorSDCard.ino
│ │ ├── config.h
│ │ └── src/
│ │ ├── utils.cpp
│ │ └── utils.h
│ ├── BresserWeatherSensorTest/
│ │ ├── BresserWeatherSensorTest.ino
│ │ └── example.log
│ ├── BresserWeatherSensorTestCfg/
│ │ └── BresserWeatherSensorTestCfg.ino
│ └── BresserWeatherSensorWaiting/
│ ├── .gitkeep
│ ├── BresserWeatherSensorWaiting.ino
│ └── example.log
├── extras/
│ └── hw_test/
│ ├── docs/
│ │ └── flowcharts/
│ │ ├── data_storage.txt
│ │ └── reception+filtering.txt
│ ├── find_transmitter/
│ │ └── find_transmitter.ino
│ ├── lightning/
│ │ └── lightning_tester/
│ │ ├── README.md
│ │ └── lightning_tester.ino
│ └── pm/
│ └── Python-Sensirion-SPS30/
│ ├── LICENSE
│ ├── README.md
│ ├── log_monitor.py
│ └── sps30.py
├── keywords.txt
├── library.properties
├── package.json
├── scripts/
│ ├── .gitkeep
│ ├── datacake_uplink_decoder.js
│ └── raindata2test.pl
├── src/
│ ├── .gitkeep
│ ├── InitBoard.cpp
│ ├── InitBoard.h
│ ├── Lightning.cpp
│ ├── Lightning.h
│ ├── RainGauge.cpp
│ ├── RainGauge.h
│ ├── RollingCounter.cpp
│ ├── RollingCounter.h
│ ├── WeatherSensor.cpp
│ ├── WeatherSensor.h
│ ├── WeatherSensorCfg.h
│ ├── WeatherSensorConfig.cpp
│ ├── WeatherSensorDecoders.cpp
│ ├── WeatherUtils.cpp
│ └── WeatherUtils.h
├── test/
│ ├── .gitignore
│ ├── .gitkeep
│ ├── Makefile
│ ├── MakefileWorker.mk
│ ├── MakefileWorkerOverrides.mk
│ ├── README.md
│ ├── header_overrides/
│ │ ├── Arduino.h
│ │ └── Preferences.h
│ ├── makefiles/
│ │ ├── .gitkeep
│ │ └── Makefile_Tests.mk
│ ├── mocks/
│ │ ├── WStringMock.cpp
│ │ ├── WStringMock.h
│ │ └── log_w_mock.h
│ ├── raindata2test.pl
│ ├── src/
│ │ ├── .gitkeep
│ │ ├── AllTests.cpp
│ │ ├── TestLightning.cpp
│ │ ├── TestRainGauge.cpp
│ │ ├── TestRainGaugeReal.cpp
│ │ ├── TestRainGaugeReal_head.txt
│ │ ├── TestRollingCounter.cpp
│ │ └── TestWeatherUtils.cpp
│ └── unit_test_001.cpp
└── weather_sensor_receiver_config.yaml
================================================
FILE CONTENTS
================================================
================================================
FILE: .github/ISSUE_TEMPLATE/bug_report.md
================================================
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
**Context**
- Which example sketch are you using?
- Which changes to the code did you make (if any)?
- Which sensor are you using?
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Step1 '...'
2. Step2 '....'
3. Step3 '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Debug Log**
If applicable, add log file to help explain your problem.
- Build log file (enable verbose output in the Arduino IDE: File->Preferences - "Show verbose output during: compile")
- Serial console log file (see [Debug Output Configuration in Arduino IDE](https://github.com/matthias-bs/BresserWeatherSensorReceiver/blob/main/DEBUG_OUTPUT.md))
**Embedded Device (please complete the following information):**
- Arduino IDE Version: [e.g. 1.8.19]
- ESP32/ESP8266 Board Support Package Version: [e.g. ESP32 2.0.7]
- Library Version [e.g. 0.6.1]
- Your Board: [brand/model/version] (if unsure, attach a photo)
- Selected Board in the Arduino IDE: [brand/model/version]
- Your Radio Transceiver Module (if external): [brand/model/chipset/frequency]
- **Pinning/Wiring**
**Additional context**
Add any other context about the problem here.
================================================
FILE: .github/ISSUE_TEMPLATE/feature_request.md
================================================
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.
================================================
FILE: .github/dependabot.yml
================================================
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
# Note: package.json is a PlatformIO/Arduino library manifest, not an npm package.
# The npm ecosystem is intentionally omitted to avoid Dependabot trying to resolve
# Arduino library names (which may contain spaces) as npm packages.
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
================================================
FILE: .github/workflows/CI.yml
================================================
name: CI
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
workflow_dispatch:
jobs:
build:
strategy:
matrix:
board:
- esp32:esp32:esp32:DebugLevel=none
- esp32:esp32:esp32:PartitionScheme=huge_app,DebugLevel=verbose
- esp32:esp32:firebeetle32
#- esp32:esp32:ttgo-lora32:Revision=TTGO_LoRa32_V1
#- esp32:esp32:ttgo-lora32:Revision=TTGO_LoRa32_V2
- esp32:esp32:ttgo-lora32:Revision=TTGO_LoRa32_v21new
- esp32:esp32:lilygo_t3s3:Revision=Radio_SX1262
- esp32:esp32:lilygo_t3s3:Revision=Radio_SX1276
- esp32:esp32:lilygo_t3s3:Revision=Radio_LR1121
#- esp32:esp32:heltec_wireless_stick
#- esp32:esp32:heltec_wifi_lora_32_V2
- esp32:esp32:heltec_wifi_lora_32_V3
- esp32:esp32:adafruit_feather_esp32s2
- esp32:esp32:featheresp32
- esp32:esp32:esp32s3_powerfeather
- esp32:esp32:XIAO_ESP32S3
- esp8266:esp8266:generic:dbg=Disabled
- esp8266:esp8266:generic:dbg=Serial
- rp2040:rp2040:adafruit_feather:dbgport=Serial
runs-on: ubuntu-latest
name: ${{ matrix.board }}
env:
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)) }}
steps:
- name: Install arduino-cli
if: ${{ env.run-build == 'true' }}
run:
|
mkdir -p ~/.local/bin
echo "~/.local/bin" >> $GITHUB_PATH
curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=~/.local/bin sh
- name: Get platform name
if: ${{ env.run-build == 'true' }}
uses: jungwinter/split@v2
id: split
with:
msg: ${{ matrix.board }}
separator: ':'
- name: Prepare platform-specific settings
if: ${{ env.run-build == 'true' }}
id: prep
run:
|
# common settings - no extra options, skip nothing, all warnings
echo "options=''" >> $GITHUB_OUTPUT
echo "logdef=''" >> $GITHUB_OUTPUT
echo "skip-pattern=(Feather32u4).*ino" >> $GITHUB_OUTPUT
echo "warnings='all'" >> $GITHUB_OUTPUT
#if [[ "${{ contains(matrix.loglevel, 'LOG_LEVEL_NONE') }}" == "true" ]]; then
# echo "logdef=--build-property "build.extra_flags=\"-DCORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_NONE\" >> $GITHUB_OUTPUT
#
#elif [[ "${{ contains(matrix.loglevel, 'LOG_LEVEL_VERBOSE') }}" == "true" ]]; then
# echo "logdef=--build-property "build.extra_flags=\"-DCORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_VERBOSE\" >> $GITHUB_OUTPUT
#fi
# platform-dependent settings - extra board options, board index URLs, skip patterns etc.
if [[ "${{ contains(matrix.board, 'esp32:esp32') }}" == "true" ]]; then
# ESP32
python -m pip install pyserial
echo "index-url=--additional-urls https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json" >> $GITHUB_OUTPUT
skip_patterns=()
if [[ ! "${{ contains(matrix.board, 'esp32:esp32:m5stack') }}" == "true" ]]; then
skip_patterns+=("(M5Core2).*ino")
fi
if [[ ! "${{ contains(matrix.board, 'ttgo') || contains(matrix.board, 'lilygo_t3s3') }}" == "true" ]]; then
skip_patterns+=("BresserWeatherSensorOLED.ino")
fi
if [[ ! "${{ contains(matrix.board, 'TTGO_LoRa32_V2') || contains(matrix.board, 'TTGO_LoRa32_v21new') || contains(matrix.board, 'lilygo_t3s3') }}" == "true" ]]; then
skip_patterns+=("BresserWeatherSensorSDCard.ino")
fi
echo "skip-pattern=$(IFS='|'; echo "${skip_patterns[*]}")" >> $GITHUB_OUTPUT
elif [[ "${{ contains(matrix.board, 'esp8266:esp8266') }}" == "true" ]]; then
# ESP8266
echo "options=,xtal=80,ResetMethod=ck,CrystalFreq=26,FlashFreq=40,FlashMode=qio,eesz=512K" >> $GITHUB_OUTPUT
echo "index-url=--additional-urls http://arduino.esp8266.com/stable/package_esp8266com_index.json" >> $GITHUB_OUTPUT
echo "skip-pattern=(M5Core2|OLED|SDCard).*ino" >> $GITHUB_OUTPUT
elif [[ "${{ contains(matrix.board, 'rp2040:rp2040') }}" == "true" ]]; then
# RP2040
#echo "options=,xtal=80,ResetMethod=ck,CrystalFreq=26,FlashFreq=40,FlashMode=qio,eesz=512K" >> $GITHUB_OUTPUT
echo "index-url=--additional-urls https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json" >> $GITHUB_OUTPUT
echo "skip-pattern=(M5Core2|MQTT|Domoticz|CanvasGauges|OLED|SDCard).*ino" >> $GITHUB_OUTPUT
fi
- name: Install libraries
if: ${{ env.run-build == 'true' }}
run:
|
ps -p "$$"
arduino-cli lib install RadioLib@7.6.0
arduino-cli lib install MQTT@2.5.3
arduino-cli lib install ArduinoJson@7.4.3
arduino-cli lib install WiFiManager@2.0.17
arduino-cli lib install ESP_DoubleResetDetector@1.3.2
arduino-cli lib install Preferences@2.2.2
arduino-cli lib install "ESP Async TCP"@2.0.0
arduino-cli lib install "Async TCP"@3.4.10
arduino-cli lib install "ESP Async WebServer"@3.10.3
arduino-cli lib install "Adafruit SSD1306"@2.5.16
arduino-cli lib install "RTClib@2.1.4"
# The following libs are only needed for M5Stack Core2
#arduino-cli lib install M5Unified@0.2.11
#arduino-cli lib install M5GFX@0.2.18
# Only ESP32-S3 PowerFeather
arduino-cli lib install powerfeather-sdk@1.1.1
- name: Install platform
if: ${{ env.run-build == 'true' }}
run:
|
arduino-cli core update-index ${{ format('{0}', steps.prep.outputs.index-url) }}
arduino-cli core install ${{ format('{0}:{1} {2}', steps.split.outputs._0, steps.split.outputs._1, steps.prep.outputs.index-url) }}
- name: Checkout repository
if: ${{ env.run-build == 'true' }}
uses: actions/checkout@v6
- name: Build examples
if: ${{ env.run-build == 'true' }}
run:
|
for example in $(find $PWD/examples -name '*.ino' | sort); do
# check whether to skip this sketch
if [ ! -z '${{ steps.prep.outputs.skip-pattern }}' ] && [[ ${example} =~ ${{ steps.prep.outputs.skip-pattern }} ]]; then
# skip sketch
echo -e "\n\033[1;33mSkipped ${example##*/} (matched with ${{ steps.prep.outputs.skip-pattern }})\033[0m";
else
# build sketch
echo -e "\n\033[1;33mBuilding ${example##*/} ... \033[0m";
arduino-cli compile --libraries /home/runner/work/BresserWeatherSensorReceiver --fqbn ${{ matrix.board }}${{ steps.prep.outputs.options }} $example --warnings=${{ steps.prep.outputs.warnings }}
if [ $? -ne 0 ]; then
echo -e "\033[1;31m${example##*/} build FAILED\033[0m\n";
exit 1;
else
echo -e "\033[1;32m${example##*/} build PASSED\033[0m\n";
fi
fi
done
================================================
FILE: .github/workflows/CppUTest.yml
================================================
# Unit testing with CppUTest (including code coverage)
name: CppUTest
# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the "main" branch
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v6
- name: Preparing Build System
run: | # define a custom multi-line command (instead of a reusable action) for this step
sudo apt-get update
sudo apt-get install cpputest lcov
## Runs all unit tests
#- name: Run unit tests
# run: |
# cd test
# make
# Runs all units tests with coverage report
- name: Run unit tests with coverage report
run: |
cd test
make lcov
#- name: Where are we?
# run: pwd
- name: Coveralls
uses: coverallsapp/github-action@v2
with:
file: test/build/lcov.info
github-token: ${{ secrets.GITHUB_TOKEN }}
================================================
FILE: .github/workflows/arduino-lint.yml
================================================
name: Arduino-lint
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: arduino/arduino-lint-action@v2
with:
library-manager: update
# compliance: strict
================================================
FILE: .github/workflows/doxygen.yml
================================================
name: Doxygen
on:
push:
branches: [ "main" ]
workflow_dispatch:
jobs:
doxygen:
runs-on: ubuntu-latest
steps:
- name: Install Doxygen and Xsltproc
run: |
sudo apt-get update
sudo apt-get install -y doxygen
sudo apt-get install xsltproc
- uses: actions/checkout@v6
- name: Generate docs
run: doxygen Doxyfile
- name: Generate keywords.txt
run: |
xsltproc doxygen2keywords.xsl docs/xml/index.xml >keywords.txt
echo "-----------------------------------------------------------"
cat keywords.txt
echo "-----------------------------------------------------------"
- name: Deploy to GitHub Pages
uses: JamesIves/github-pages-deploy-action@releases/v4
with:
BRANCH: gh-pages
FOLDER: docs/html
================================================
FILE: .github/workflows/spell-check-exclude.txt
================================================
* Die Berechnung des Taupunktes erfolgt aus den Messwerten Temperatur (°C) und Luftfeuchtigkeit (%).
================================================
FILE: .github/workflows/spell-check.yml
================================================
name: Spell Check
on:
workflow_dispatch:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
spell-check:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v6
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: '3.x'
- name: Install codespell
run: |
python -m pip install --upgrade pip
pip install codespell
- name: Run codespell
run: |
codespell --ignore-words-list="accCount,ser" --skip="*.pdf,*.js" --exclude-file=.github/workflows/spell-check-exclude.txt .
================================================
FILE: .gitignore
================================================
# Prerequisites
*.d
# Object files
*.o
*.ko
*.obj
*.elf
# Linker output
*.ilk
*.map
*.exp
# Precompiled Headers
*.gch
*.pch
# Libraries
*.lib
*.a
*.la
*.lo
# Shared objects (inc. Windows DLLs)
*.dll
*.so
*.so.*
*.dylib
# Executables
*.exe
*.out
*.app
*.i*86
*.x86_64
*.hex
# Debug files
*.dSYM/
*.su
*.idb
*.pdb
# Kernel Module Compile Results
*.mod*
*.cmd
.tmp_versions/
modules.order
Module.symvers
Mkfile.old
dkms.conf
.idea/
# arduino_ci stuff
/.bundle/
/.yardoc
Gemfile.lock
/_yardoc/
/coverage/
/pkg/
/spec/reports/
vendor
*.gem
# credentials
secrets.h
# rspec failure tracking
.rspec_status
# C++ stuff
*.bin
*.bin.dSYM
# Other
_codeql_detected_source_root
**/build/
**/c_cpp_properties.json
.vscode/arduino.json
# Coverage output
*.gcov
================================================
FILE: .vscode/arduino-cli-wrapper.sh
================================================
#!/usr/bin/env bash
# arduino-cli-wrapper.sh — wrapper to locate and run Arduino CLI from VS Code
#
# Purpose:
# - Prefer using the `VSCODE_ARDUINO_CLI` environment variable when set.
# - Search for a bundled Arduino CLI inside the VS Code extensions directories.
# - Fall back to the system `arduino-cli` if available in PATH.
# - Print a helpful message and exit non-zero if no CLI is found.
#
# Usage:
# - ./arduino-cli-wrapper.sh compile --fqbn ... path/to/sketch
# - Export `VSCODE_ARDUINO_CLI=/path/to/arduino-cli` to force a specific binary.
#
# Notes:
# - This script defaults to `linux-x64` under `platform_dir`; change it for other OSes.
# - It is intended to be called by VS Code tasks or manually from shell.
set -euo pipefail
if [[ -n "${VSCODE_ARDUINO_CLI:-}" && -x "${VSCODE_ARDUINO_CLI}" ]]; then
exec "${VSCODE_ARDUINO_CLI}" "$@"
fi
resolve_bundled_cli() {
local extension_root="$1"
local platform_dir="$2"
local pattern="${extension_root}/vscode-arduino.vscode-arduino-community-*-${platform_dir}"
local candidates=()
shopt -s nullglob
candidates=(${pattern})
shopt -u nullglob
if [[ ${#candidates[@]} -eq 0 ]]; then
return 1
fi
local newest
newest=$(printf '%s\n' "${candidates[@]}" | sort -V | tail -n 1)
local cli="${newest}/assets/platform/${platform_dir}/arduino-cli/arduino-cli.app"
if [[ -x "${cli}" ]]; then
printf '%s\n' "${cli}"
return 0
fi
return 1
}
platform_dir="linux-x64"
bundled_cli=""
if [[ -n "${HOME:-}" ]]; then
bundled_cli=$(resolve_bundled_cli "${HOME}/.vscode/extensions" "${platform_dir}" || true)
if [[ -z "${bundled_cli}" ]]; then
bundled_cli=$(resolve_bundled_cli "${HOME}/.vscode-insiders/extensions" "${platform_dir}" || true)
fi
fi
if [[ -n "${bundled_cli}" ]]; then
exec "${bundled_cli}" "$@"
fi
if command -v arduino-cli >/dev/null 2>&1; then
exec arduino-cli "$@"
fi
echo "No Arduino CLI found. Install vscode-arduino-community extension or set VSCODE_ARDUINO_CLI." >&2
exit 1
================================================
FILE: .vscode/arduino-compile-runner.sh
================================================
#!/usr/bin/env bash
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
PY="$SCRIPT_DIR/arduino_compile_helper.py"
if [ ! -f "$PY" ]; then
echo "Error: helper not found at $PY" >&2
exit 2
fi
if [ ! -x "$PY" ]; then
chmod +x "$PY" 2>/dev/null || true
fi
# Allow overriding workspace path
export WORKSPACE_FOLDER="${WORKSPACE_FOLDER:-$PWD}"
# Run the helper with an explicit Python interpreter to avoid executing
# the helper via its shebang on filesystems mounted noexec (pCloud/FUSE).
PY_CMD="$(command -v python3 || command -v python || true)"
if [ -z "$PY_CMD" ]; then
echo "Error: python3 or python not found in PATH" >&2
exit 3
fi
exec "$PY_CMD" "$PY" "$@"
================================================
FILE: .vscode/arduino_compile_helper.py
================================================
#!/usr/bin/env python3
"""
arduino_compile_helper.py
Helper to determine `fqbn` and sketch path and invoke arduino-cli (or the repo wrapper).
Behavior:
- Reads `.vscode/sketch.json` for `fqbn` and `sketch` when present.
- If `--fqbn` is provided it overrides sketch.json.
- If `--active` is provided, it will search upwards for the nearest `.ino` file and use that sketch's folder.
- Falls back to `examples/BresserWeatherSensorMQTT` when no sketch can be deduced.
"""
import argparse
import json
import os
import subprocess
import sys
from pathlib import Path
def read_arduino_json(workspace):
path = Path(workspace) / '.vscode' / 'sketch.json'
if not path.exists():
return {}
try:
return json.loads(path.read_text())
except Exception:
return {}
def find_nearest_ino(active_path: Path, workspace: Path):
# Walk up from active_path directory and look for any .ino file,
# stopping at workspace boundary.
p = active_path if active_path.is_dir() else active_path.parent
while True:
inos = list(p.glob('*.ino'))
if inos:
return p
if p == workspace or p.parent == p:
break
p = p.parent
# No .ino found upward — return None so callers can try other strategies
return None
def find_wrapper(workspace: Path):
w = workspace / '.vscode' / 'arduino-cli-wrapper.sh'
if w.exists() and os.access(str(w), os.X_OK):
return str(w)
if w.exists():
return str(w)
return None
def write_arduino_json(workspace: Path, data: dict) -> None:
"""Persist updated fields back to .vscode/sketch.json."""
path = Path(workspace) / '.vscode' / 'sketch.json'
path.parent.mkdir(parents=True, exist_ok=True)
path.write_text(json.dumps(data, indent=2) + '\n')
def detect_upload_ports() -> list[str]:
"""Return serial port candidates sorted by most-recently modified first."""
import glob as _glob
candidates = _glob.glob('/dev/ttyACM*') + _glob.glob('/dev/ttyUSB*')
candidates.sort(key=lambda p: os.path.getmtime(p), reverse=True)
return candidates
def try_upload(wrapper: str | None, fqbn: str | None, port: str, sketch: str,
extra: list[str]) -> int:
"""Attempt a single upload and return the process exit code."""
if wrapper:
cmd = ['bash', wrapper, 'upload']
else:
cmd = ['arduino-cli', 'upload']
if fqbn:
cmd += ['--fqbn', fqbn]
cmd += ['--port', port]
cmd.append(sketch)
if extra:
cmd += [e for e in extra if e != '--']
try:
return subprocess.run(cmd).returncode
except FileNotFoundError:
print('arduino-cli or wrapper not found.', file=sys.stderr)
return 2
def main():
parser = argparse.ArgumentParser()
parser.add_argument('action', choices=['compile', 'upload', 'monitor'])
parser.add_argument('--fqbn', help='Override fqbn', default=None)
parser.add_argument('--port', help='Serial port', default=None)
parser.add_argument('--config', help='Extra config', default=None)
parser.add_argument('--active', help='Active file path (to deduce sketch)', default=None)
# parse_known_args() is used instead of parse_args() + REMAINDER because
# argparse.REMAINDER eagerly captures all tokens after the first positional,
# including named flags like --active, so they never reach their definition.
args, extras = parser.parse_known_args()
workspace = Path(os.environ.get('WORKSPACE_FOLDER', os.getcwd())).resolve()
arduino_cfg = read_arduino_json(workspace)
fqbn = args.fqbn or arduino_cfg.get('fqbn') or arduino_cfg.get('board')
sketch_dir = None
# Priority 1: --active → walk upward to nearest .ino
if args.active:
active = Path(args.active).resolve()
sketch_dir = find_nearest_ino(active, workspace)
# Priority 2: arduino.json 'sketch' entry
if not sketch_dir:
sketch_entry = arduino_cfg.get('sketch')
if sketch_entry:
cand = (workspace / sketch_entry).resolve()
if cand.exists():
sketch_dir = cand if cand.is_dir() else cand.parent
# Priority 3: fallback to default example
if not sketch_dir:
sketch_dir = workspace / 'examples' / 'BresserWeatherSensorMQTT'
sketch_path = str(sketch_dir)
wrapper = find_wrapper(workspace)
extras = [e for e in extras if e != '--']
# ── Compile / Monitor: straightforward single-shot execution ─────────────
if args.action in ('compile', 'monitor'):
if wrapper:
cmd = ['bash', wrapper, args.action]
else:
cmd = ['arduino-cli', args.action]
if fqbn:
cmd += ['--fqbn', fqbn]
if args.port:
cmd += ['--port', args.port]
if args.config:
cmd += ['--config', args.config]
if args.action == 'compile':
cmd.append(sketch_path)
if extras:
cmd += extras
try:
sys.exit(subprocess.run(cmd).returncode)
except FileNotFoundError:
print('arduino-cli or wrapper not found.', file=sys.stderr)
sys.exit(2)
# ── Upload: smart port detection with retry logic ──────────────────────
# Port priority: CLI arg → arduino.json 'port' → auto-detect
port_override = args.port or arduino_cfg.get('port')
upload_mode = arduino_cfg.get('uploadMode', 'auto') # 'auto' or 'manual'
def _try_all_ports(port_list: list[str]) -> int:
for port in port_list:
print(f'--- Trying port: {port} ---')
rc = try_upload(wrapper, fqbn, port, sketch_path, extras)
if rc == 0:
# Remember the working port in arduino.json
arduino_cfg['port'] = port
write_arduino_json(workspace, arduino_cfg)
print(f'Upload succeeded on {port}')
return 0
print(f'Upload failed on {port} (exit {rc})')
return 1
# Build candidate list
if port_override:
candidates = [port_override] + [p for p in detect_upload_ports() if p != port_override]
else:
candidates = detect_upload_ports()
if not candidates:
print('No serial ports detected (/dev/ttyACM* or /dev/ttyUSB*).', file=sys.stderr)
if upload_mode != 'manual':
print('Hint: if your board requires manual upload mode, set '
'"uploadMode": "manual" in .vscode/arduino.json', file=sys.stderr)
sys.exit(1)
# First attempt
rc = _try_all_ports(candidates)
if rc == 0:
sys.exit(0)
# If manual upload mode is known, prompt and retry once
if upload_mode == 'manual':
print()
print('Board requires manual upload mode.')
print('Please put the board into upload mode now (e.g. hold BOOT/double-press RESET),')
input('then press ENTER to retry upload... ')
# Re-detect ports: board may enumerate on a new tty after reset
fresh = detect_upload_ports()
rc = _try_all_ports(fresh)
sys.exit(rc)
else:
print()
print('All ports tried — upload did not succeed.')
print('If your board needs manual upload mode (e.g. ESP32-S3 requires double-pressing RESET),')
print('set "uploadMode": "manual" in .vscode/arduino.json and retry.')
sys.exit(1)
if __name__ == '__main__':
main()
================================================
FILE: .vscode/serial_logger.py
================================================
#!/usr/bin/env python3
"""
serial_logger.py — Serial monitor with timestamped logging.
Opens a serial port, optionally resets the board via DTR, then streams
serial output to both stdout and a log file in extras/logs/.
Log file name format (compatible with read_serial_log.py):
<port>_<YYYY_MM_DD.HH.MM.SS.mmm>.txt
e.g. devttyUSB0_2026_03_13.12.33.38.000.txt
Each log line is prefixed with a timestamp:
HH:MM:SS:mmm <content>
e.g. 12:33:38:152 Hello, world!
Board/port/baud defaults are read from .vscode/arduino.json when present.
Usage:
serial_logger.py [--port PORT] [--baud BAUD] [--reset] [--log-dir DIR]
Options:
--port Serial port (e.g. /dev/ttyUSB0). Defaults to arduino.json 'port'.
--baud Baud rate. Defaults to arduino.json 'baudRate' or 115200.
--reset Toggle DTR to reset the board before monitoring.
--log-dir Directory for log files. Defaults to <workspace>/extras/logs/.
--timeout Stop automatically after this many seconds (0 = run until Ctrl-C).
--stop-on Stop when a line matches this Python regex (e.g. "PASS|FAIL|DONE").
Exit codes:
0 Clean exit (Ctrl-C) or sentinel matched
1 Serial port error
2 Missing or invalid arguments
3 Could not create log directory
4 Timeout reached without finding the sentinel pattern
"""
import argparse
import json
import os
import signal
import sys
import time
from datetime import datetime
from pathlib import Path
try:
import serial
except ImportError:
print("Error: pyserial is required. Install with: pip install pyserial",
file=sys.stderr)
sys.exit(2)
# ---------------------------------------------------------------------------
# Configuration helpers
# ---------------------------------------------------------------------------
def _workspace() -> Path:
ws = os.environ.get('WORKSPACE_FOLDER')
if ws:
return Path(ws).resolve()
# Script lives in <workspace>/.vscode/
return Path(__file__).resolve().parent.parent
def _read_arduino_json() -> dict:
path = _workspace() / '.vscode' / 'arduino.json'
try:
return json.loads(path.read_text())
except Exception:
return {}
# ---------------------------------------------------------------------------
# Log path helpers
# ---------------------------------------------------------------------------
def _port_stem(port: str) -> str:
"""'/dev/ttyUSB0' -> 'devttyUSB0'"""
return port.lstrip('/').replace('/', '')
def _log_filename(port: str) -> str:
now = datetime.now()
ts = now.strftime('%Y_%m_%d.%H.%M.%S') + f'.{now.microsecond // 1000:03d}'
return f'{_port_stem(port)}_{ts}.txt'
def _ts_prefix() -> str:
"""Return 'HH:MM:SS:mmm ' for the current moment."""
now = datetime.now()
ms = now.microsecond // 1000
return f'{now.hour:02d}:{now.minute:02d}:{now.second:02d}:{ms:03d} '
# ---------------------------------------------------------------------------
# Main monitor loop
# ---------------------------------------------------------------------------
def run(port: str, baud: int, reset: bool, log_dir: Path,
timeout: float = 0.0, stop_on: str | None = None) -> int:
# Ensure log directory exists
try:
log_dir.mkdir(parents=True, exist_ok=True)
except OSError as e:
print(f'Error: cannot create log directory {log_dir}: {e}', file=sys.stderr)
return 3
log_path = log_dir / _log_filename(port)
print(f'Opening {port} @ {baud} baud')
print(f'Log file: {log_path}')
print('Press Ctrl-C to stop.\n')
try:
ser = serial.Serial(port, baud, timeout=0.1)
except serial.SerialException as e:
print(f'Error: cannot open {port}: {e}', file=sys.stderr)
return 1
if reset:
print('Resetting board via DTR ...')
ser.setDTR(False)
time.sleep(0.1)
ser.setDTR(True)
time.sleep(0.1)
print('Reset complete.\n')
# Handle Ctrl-C gracefully via flag
_stop = [False]
def _sigint(sig, frame):
_stop[0] = True
signal.signal(signal.SIGINT, _sigint)
import re as _re
stop_re = _re.compile(stop_on) if stop_on else None
start_time = time.monotonic()
exit_code = 0
buf = b''
with open(log_path, 'w', encoding='utf-8', errors='replace') as logf:
while not _stop[0]:
# ── Timeout check ──────────────────────────────────────────────
if timeout > 0 and (time.monotonic() - start_time) >= timeout:
suffix = f' (sentinel "{stop_on}" not found)' if stop_on else ''
marker = _ts_prefix() + f'[LOGGER] Stopped: timeout after {timeout:.0f}s{suffix}'
print(marker)
logf.write(marker + '\n')
exit_code = 4
break
try:
chunk = ser.read(256)
except serial.SerialException as e:
print(f'\nSerial error: {e}', file=sys.stderr)
exit_code = 1
break
if not chunk:
continue
buf += chunk
sentinel_matched = False
while b'\n' in buf:
line_bytes, buf = buf.split(b'\n', 1)
line = line_bytes.decode('utf-8', errors='replace').rstrip('\r')
entry = _ts_prefix() + line
print(entry)
logf.write(entry + '\n')
logf.flush()
# ── Sentinel check ─────────────────────────────────────────
if stop_re and stop_re.search(line):
marker = _ts_prefix() + f'[LOGGER] Stopped: sentinel matched "{stop_on}"'
print(marker)
logf.write(marker + '\n')
logf.flush()
sentinel_matched = True
break
if sentinel_matched:
break
# Flush any incomplete line remaining in the buffer
if buf:
line = buf.decode('utf-8', errors='replace').rstrip('\r\n')
if line:
entry = _ts_prefix() + line
print(entry)
with open(log_path, 'a', encoding='utf-8', errors='replace') as logf:
logf.write(entry + '\n')
try:
ser.close()
except Exception:
pass
print(f'\nLog saved to: {log_path}')
return exit_code
# ---------------------------------------------------------------------------
# Entry point
# ---------------------------------------------------------------------------
def main():
cfg = _read_arduino_json()
ws = _workspace()
parser = argparse.ArgumentParser(
description='Serial monitor with timestamped logging.')
parser.add_argument(
'--port', default=cfg.get('port') or '',
help='Serial port (e.g. /dev/ttyUSB0)')
parser.add_argument(
'--baud', type=int, default=cfg.get('baudRate', 115200),
help='Baud rate (default: from arduino.json or 115200)')
parser.add_argument(
'--reset', action='store_true',
help='Toggle DTR to reset the board before monitoring')
parser.add_argument(
'--log-dir', default=str(ws / 'extras' / 'logs'),
help='Log output directory (default: <workspace>/extras/logs/)')
parser.add_argument(
'--timeout', type=float, default=0.0, metavar='SECONDS',
help='Stop after this many seconds (0 = run until Ctrl-C)')
parser.add_argument(
'--stop-on', default='', metavar='REGEX',
help='Stop when a line matches this Python regex (e.g. "PASS|FAIL|DONE")')
args = parser.parse_args()
if not args.port:
# Auto-detect: pick most-recently-modified tty
import glob as _glob
candidates = sorted(
_glob.glob('/dev/ttyACM*') + _glob.glob('/dev/ttyUSB*'),
key=os.path.getmtime, reverse=True)
if not candidates:
print('Error: no serial port specified and none auto-detected.',
file=sys.stderr)
print('Use --port /dev/ttyUSB0 or set "port" in .vscode/arduino.json',
file=sys.stderr)
sys.exit(2)
args.port = candidates[0]
print(f'Auto-detected port: {args.port}')
sys.exit(run(args.port, args.baud, args.reset, Path(args.log_dir),
args.timeout, args.stop_on or None))
if __name__ == '__main__':
main()
================================================
FILE: .vscode/serial_reset_monitor.py
================================================
#!/usr/bin/env python3
"""
serial_reset_monitor.py — Toggle DTR to reset an Arduino/ESP32 board.
Monitoring and log-file creation are handled by serial_logger.py.
This script only performs the hardware reset.
Usage:
serial_reset_monitor.py <port> [baud]
The baud rate is required to open the serial port; it does not affect the
DTR-toggle reset but must match what the device expects (default: 115200).
"""
import argparse
import sys
import time
try:
import serial
except ImportError:
print("Error: pyserial is required. Install with: pip install pyserial")
sys.exit(1)
def reset_board(port: str, baud: int) -> int:
print(f"Opening {port} @ {baud} baud ...")
try:
s = serial.Serial(port, baud, timeout=1)
except Exception as e:
print(f"Error: cannot open {port}: {e}")
return 1
try:
print("Toggling DTR to reset the board ...")
s.setDTR(False)
time.sleep(0.1)
s.setDTR(True)
time.sleep(0.1)
print("Reset complete.")
finally:
try:
s.close()
except Exception:
pass
return 0
def main():
p = argparse.ArgumentParser(
description='Toggle DTR to reset an Arduino/ESP32 board.')
p.add_argument('port', help='Serial port, e.g. /dev/ttyACM0')
p.add_argument('baud', nargs='?', type=int, default=115200,
help='Baud rate used to open the port (default: 115200)')
args = p.parse_args()
sys.exit(reset_board(args.port, args.baud))
if __name__ == '__main__':
main()
================================================
FILE: .vscode/settings.json
================================================
{
"cmake.configureOnOpen": false
}
================================================
FILE: .vscode/tasks.json
================================================
{
"version": "2.0.0",
"tasks": [
{
"label": "Compile Arduino Sketch",
"type": "shell",
"command": "bash",
"args": [
"${workspaceFolder}/.vscode/arduino-compile-runner.sh",
"compile"
],
"isBackground": true,
"group": {
"kind": "build",
"isDefault": true
},
"problemMatcher": [
{
"owner": "arduino",
"background": {
"activeOnStart": true,
"beginsPattern": "^Sketch uses",
"endsPattern": "^(Used library|Compilation complete|Error)"
},
"fileLocation": [
"relative",
"${workspaceFolder}"
],
"pattern": {
"regexp": "^(.*):(\\d+):(\\d+):\\s+(error|warning):\\s+(.*)$",
"file": 1,
"line": 2,
"column": 3,
"severity": 4,
"message": 5
}
}
],
"detail": "Compile current sketch (fqbn read from .vscode/arduino.json or autodetected)."
},
{
"label": "Upload Arduino Sketch",
"type": "shell",
"command": "bash",
"args": [
"${workspaceFolder}/.vscode/arduino-compile-runner.sh",
"upload",
"--port",
"${input:serialPort}"
],
"isBackground": true,
"group": "build",
"problemMatcher": [
{
"owner": "arduino",
"background": {
"activeOnStart": true,
"beginsPattern": "^Uploading",
"endsPattern": "^(Upload complete|Error)"
},
"fileLocation": ["relative", "${workspaceFolder}"],
"pattern": {
"regexp": "^(.*):(\\d+):(\\d+):\\s+(error|warning):\\s+(.*)$",
"file": 1,
"line": 2,
"column": 3,
"severity": 4,
"message": 5
}
}
],
"detail": "Upload sketch to board (fqbn and sketch read from .vscode/sketch.json)."
},
{
"label": "Serial Reset (DTR)",
"type": "shell",
"command": "python3",
"args": [
"${workspaceFolder}/.vscode/serial_reset_monitor.py",
"${input:serialPort}"
],
"isBackground": false,
"presentation": {
"echo": true,
"reveal": "always",
"focus": true,
"panel": "shared"
},
"detail": "Toggle DTR to reset the board only (no monitoring). For monitoring+logging use the Serial Logger tasks."
},
{
"label": "Serial Logger (monitor + log to extras/logs/)",
"type": "shell",
"command": "python3",
"args": [
"${workspaceFolder}/.vscode/serial_logger.py",
"--port",
"${input:serialPort}",
"--baud",
"${input:serialBaud}",
"--timeout",
"${input:loggerTimeout}",
"--stop-on",
"${input:stopPattern}"
],
"isBackground": false,
"presentation": {
"echo": true,
"reveal": "always",
"focus": true,
"panel": "shared"
},
"detail": "Monitor serial port and write timestamped log to extras/logs/ (compatible with read_serial_log.py)."
},
{
"label": "Serial Logger with Reset (monitor + log to extras/logs/)",
"type": "shell",
"command": "python3",
"args": [
"${workspaceFolder}/.vscode/serial_logger.py",
"--port",
"${input:serialPort}",
"--baud",
"${input:serialBaud}",
"--reset",
"--timeout",
"${input:loggerTimeout}",
"--stop-on",
"${input:stopPattern}"
],
"isBackground": false,
"presentation": {
"echo": true,
"reveal": "always",
"focus": true,
"panel": "shared"
},
"detail": "Reset board via DTR, then monitor and log to extras/logs/."
}
],
"inputs": [
{
"id": "serialPort",
"type": "promptString",
"description": "Enter the serial port (e.g., /dev/ttyACM0 or /dev/ttyUSB0)",
"default": "/dev/ttyACM0"
},
{
"id": "serialBaud",
"type": "promptString",
"description": "Enter baud rate for serial monitor",
"default": "115200"
},
{
"id": "loggerTimeout",
"type": "promptString",
"description": "Serial logger timeout in seconds (0 = run until Ctrl-C; agent sessions: use max_expected_duration × 3, min 30)",
"default": "0"
},
{
"id": "stopPattern",
"type": "promptString",
"description": "Stop logging when a line matches this Python regex (e.g. PASS|FAIL|DONE); leave empty to disable",
"default": ""
}
]
}
================================================
FILE: BUILD.md
================================================
# SW Build
Tested with Arduino 1.8.19 and an empty Arduino library directory.
1. Check that the required Board Manager URL is in the Preferences (e.g. the one for ESP8266):
2. Select **BresserWeatherSensorReceiver** in the Library Manager - **please use the latest version**:
3. The Library Manager will ask if to install the **library dependencies** - select **"Install all"**:
4. From the **File** Menu, select **Examples->BresserWeatherSensorReceiver->BresserWeatherSensorMQTT**:
5. Select your board:
6. Modify `BresserWeatherSensorCfg.h` as required, typically:
```
// Number of sensors to be received
#define NUM_SENSORS 1
```
```
// Select type of receiver module
#define USE_CC1101
//#define USE_SX1276
```
Please use **either** one of the pre-defined pinnings:
```
// Use pinning for LoRaWAN Node
#define LORAWAN_NODE
// Use pinning for TTGO ESP32 boards with integrated RF transceiver (SX1276)
// https://github.com/espressif/arduino-esp32/tree/master/variants/ttgo-lora32-*
//#define TTGO_LORA32
// Use pinning for Adafruit Feather ESP32S2 with RFM95W "FeatherWing" ADA3232
//#define ADAFRUIT_FEATHER_ESP32S2
```
**or** check that your pinning matches the default for the selected MCU:
```
[...]
#elif defined(ESP32)
#define PIN_RECEIVER_CS 27
// CC1101: GDO0 / RFM95W/SX127x: G0
#define PIN_RECEIVER_IRQ 21
// CC1101: GDO2 / RFM95W/SX127x: G1
#define PIN_RECEIVER_GPIO 33
// RFM95W/SX127x - GPIOxx / CC1101 - RADIOLIB_NC
#define PIN_RECEIVER_RST 32
#elif defined(ESP8266)
#define PIN_RECEIVER_CS 15
// CC1101: GDO0 / RFM95W/SX127x: G0
#define PIN_RECEIVER_IRQ 4
// CC1101: GDO2 / RFM95W/SX127x:
#define PIN_RECEIVER_GPIO 5
// RFM95W/SX127x - GPIOxx / CC1101 - RADIOLIB_NC
#define PIN_RECEIVER_RST 2
#endif
```
7. Edit the mandatory settings in `BresserWeatherSensorMQTT.ino`:
```
#define USE_SECUREWIFI // use secure WIFI
//#define USE_WIFI // use non-secure WIFI
...
// Map sensor IDs to Names - the number of entries must match NUM_SENSORS
SensorMap sensor_map[NUM_SENSORS] = {
{0x39582376, "WeatherSensor"}
};
...
#ifndef SECRETS
const char ssid[] = "WiFiSSID";
const char pass[] = "WiFiPassword";
...
#define MQTT_PORT 8883
const char MQTT_HOST[] = "xxx.yyy.zzz.com";
const char MQTT_USER[] = ""; // leave blank if no credentials used
const char MQTT_PASS[] = ""; // leave blank if no credentials used
...
```
- Set the WiFi settings (ssid/pass) according to your Access Point
- Set `USE_SECUREWIFI`/`USE_WIFI`, `MQTT_PORT`, `MQTT_HOST`, `MQTT_USER` and `MQTT_PASS` according to your MQTT broker's IP address and configuration
- for a non-secure setup: `USE_WIFI` and typically `MQTT_PORT` 1883
- for a secure-setup: `USE_SECUREWIFI` and typically `MQTT_PORT` 8883 (and other security measures as needed)
- set `MQTT_USER` and `MQTT_PASS` as required by the MQTT broker
- 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`.
You 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`:
```
#define SECRETS
```
**Note:** The define `SECRET` has been renamed to `SECRETS` for consistency.
8. 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:
9. Finally you should be able to compile your sketch without any errors or warnings:
================================================
FILE: Bresser_HA_MQTT_custom_config.yaml
================================================
mqtt:
sensor:
- name: "Temperatuur"
unique_id: "Bresstat_temp"
state_topic: "ESPWeather/961c/data"
value_template: "{{ value_json.temp_c }}"
device_class: "temperature"
unit_of_measurement: "°C"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Dauwpunt"
unique_id: "Bresstat_dew"
state_topic: "ESPWeather/extra"
value_template: "{{ value_json.dewpoint_c }}"
device_class: "Temperature"
unit_of_measurement: "°C"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Gevoelstemperatuur"
unique_id: "Bresstat_feel"
state_topic: "ESPWeather/extra"
value_template: "{{ value_json.perceived_temp_c }}"
device_class: "Temperature"
unit_of_measurement: "°C"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Luchtvochtigheid"
unique_id: "Bresstat_humi"
state_topic: "ESPWeather/961c/data"
value_template: "{{ value_json.humidity }}"
device_class: "humidity"
unit_of_measurement: "%"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "ID"
unique_id: "Bresstat_id"
state_topic: "ESPWeather/961c/data"
value_template: "{{ value_json.id }}"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Kanaal"
unique_id: "Bresstat_ch"
state_topic: "ESPWeather/961c/data"
value_template: "{{ value_json.ch }}"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Batterij"
unique_id: "Bresstat_batt"
state_topic: "ESPWeather/961c/data"
value_template: "{{ value_json.battery_ok }}"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Windvlaag"
unique_id: "Bresstat_gust"
state_topic: "ESPWeather/961c/data"
value_template: "{{ value_json.wind_gust }}"
device_class: "wind_speed"
unit_of_measurement: "km/h"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Windsnelheid"
unique_id: "Bresstat_wind"
state_topic: "ESPWeather/961c/data"
value_template: "{{ value_json.wind_avg }}"
device_class: "wind_speed"
unit_of_measurement: "km/h"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Windhoek"
unique_id: "Bresstat_dirdeg"
state_topic: "ESPWeather/961c/data"
value_template: "{{ value_json.wind_dir }}"
unit_of_measurement: "Graden"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Windrichting"
unique_id: "Bresstat_dircar"
state_topic: "ESPWeather/extra"
value_template: "{{ value_json.wind_dir_txt }}"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Windvlaag bft"
unique_id: "Bresstat_gust_bft"
state_topic: "ESPWeather/extra"
value_template: "{{ value_json.wind_gust_bft }}"
device_class: "wind_speed"
unit_of_measurement: "Beaufort"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Windsnelheid bft"
unique_id: "Bresstat_avg_bft"
state_topic: "ESPWeather/extra"
value_template: "{{ value_json.wind_avg_bft }}"
device_class: "wind_speed"
unit_of_measurement: "Beaufort"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "UV-index"
unique_id: "Bresstat_UV"
state_topic: "ESPWeather/961c/data"
value_template: "{{ value_json.uv }}"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Lichtintensiteit"
unique_id: "Bresstat_light"
state_topic: "ESPWeather/961c/data"
value_template: "{{ value_json.wind_gust }}"
unit_of_measurement: "kLux"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Neerslag totaal"
unique_id: "Bresstat_rain"
state_topic: "ESPWeather/961c/data"
value_template: "{{ value_json.rain }}"
device_class: "precipitation"
unit_of_measurement: "mm"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Neerslag vandaag"
unique_id: "Bresstat_rain_d"
state_topic: "ESPWeather/961c/data"
value_template: "{{ value_json.rain_d }}"
device_class: "precipitation"
unit_of_measurement: "mm"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Neerslag laatste uur"
unique_id: "Bresstat_rain_h"
state_topic: "ESPWeather/961c/data"
value_template: "{{ value_json.rain_h }}"
device_class: "precipitation"
unit_of_measurement: "mm"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Neerslag deze week"
unique_id: "Bresstat_rain_w"
state_topic: "ESPWeather/961c/data"
value_template: "{{ value_json.rain_w }}"
device_class: "precipitation"
unit_of_measurement: "mm"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Neerslag deze maand"
unique_id: "Bresstat_rain_m"
state_topic: "ESPWeather/961c/data"
value_template: "{{ value_json.rain_m }}"
device_class: "precipitation"
unit_of_measurement: "mm"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Signaal"
unique_id: "Bresstat_signal"
state_topic: "ESPWeather/961c/rssi"
device_class: "signal_strength"
unit_of_measurement: "dB"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
- name: "Status"
unique_id: "Bresstat_stat"
state_topic: "ESPWeather/status"
device:
name: "Weerstation"
identifiers: "Bresser"
manufacturer: "Chris"
model: "Bresser MQTT"
================================================
FILE: CODE_OF_CONDUCT.md
================================================
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
opensource@github.com.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
================================================
FILE: DEBUG_OUTPUT.md
================================================
# Debug Output Configuration in Arduino IDE
## ESP32
1. Select appropriate (USB-)serial port for your board
**or**
2. Select desired debug level
This passes the define `CORE_DEBUG_LEVEL`to the compiler accordingly.
Refer to the following for some background information
* https://thingpulse.com/esp32-logging/
* https://www.mischianti.org/2020/09/20/esp32-manage-multiple-serial-and-logging-for-debugging-3/
* https://github.com/espressif/arduino-esp32/blob/master/cores/esp32/esp32-hal-log.h
## ESP8266
1. Select appropriate (USB-)serial port for your board
2. Select the appropriate Debug Port (MCU serial interface) of your board
3. If needed, change the debug level in `WeatherSensorCfg.h`
```
#define CORE_DEBUG_LEVEL ARDUHAL_LOG_LEVEL_VERBOSE
```
(Options: `ARDUHAL_LOG_LEVEL_<NONE|ERROR|WARN|INFO|DEBUG|VERBOSE>`)
================================================
FILE: Doxyfile
================================================
# Doxyfile 1.8.15
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
#
# All text after a double hash (##) is considered a comment and is placed in
# front of the TAG it is preceding.
#
# All text after a single hash (#) is considered a comment and will be ignored.
# The format is:
# TAG = value [value, ...]
# For lists, items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (\" \").
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the configuration
# file that follow. The default is UTF-8 which is also the encoding used for all
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
# iconv built into libc) for the transcoding. See
# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
# The default value is: UTF-8.
DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
# double-quotes, unless you are using Doxywizard) that should identify the
# project for which the documentation is generated. This name is used in the
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME = BresserWeatherSensorReceiver
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER =
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = "Bresser 5-in-1/6-in-1/7-in-1 868 MHz Weather Sensor Radio Receiver for Arduino based on CC1101 or SX1276/RFM95W"
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.
PROJECT_LOGO =
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = docs
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
# will distribute the generated files over these directories. Enabling this
# option can be useful when feeding doxygen a huge amount of source files, where
# putting all generated files in the same directory would otherwise causes
# performance problems for the file system.
# The default value is: NO.
CREATE_SUBDIRS = NO
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
# characters to appear in the names of generated files. If set to NO, non-ASCII
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
# U+3044.
# The default value is: NO.
ALLOW_UNICODE_NAMES = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese.
# The default value is: English.
OUTPUT_LANGUAGE = English
# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all generated output in the proper direction.
# Possible values are: None, LTR, RTL and Context.
# The default value is: None.
OUTPUT_TEXT_DIRECTION = None
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
# descriptions after the members that are listed in the file and class
# documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.
BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
# description of a member or function before the detailed description
#
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
# The default value is: YES.
REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator that is
# used to form the text in various listings. Each string in this list, if found
# as the leading text of the brief description, will be stripped from the text
# and the result, after processing the whole list, is used as the annotated
# text. Otherwise, the brief description is used as-is. If left blank, the
# following values are used ($name is automatically replaced with the name of
# the entity):The $name class, The $name widget, The $name file, is, provides,
# specifies, contains, represents, a, an and the.
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# doxygen will generate a detailed section even if there is only a brief
# description.
# The default value is: NO.
ALWAYS_DETAILED_SEC = NO
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
# The default value is: NO.
INLINE_INHERITED_MEMB = NO
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
# before files name in the file list and in the header files. If set to NO the
# shortest path that makes the file name unique will be used
# The default value is: YES.
FULL_PATH_NAMES = YES
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
# part of the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the path to
# strip.
#
# Note that you can specify absolute paths here, but also relative paths, which
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
STRIP_FROM_PATH =
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
# header file to include in order to use a class. If left blank only the name of
# the header file containing the class definition is used. Otherwise one should
# specify the list of include paths that are normally passed to the compiler
# using the -I flag.
STRIP_FROM_INC_PATH =
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't
# support long names like on DOS, Mac, or CD-ROM.
# The default value is: NO.
SHORT_NAMES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
# first line (until the first dot) of a Javadoc-style comment as the brief
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
# style comments (thus requiring an explicit @brief command for a brief
# description.)
# The default value is: NO.
JAVADOC_AUTOBRIEF = NO
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
# requiring an explicit \brief command for a brief description.)
# The default value is: NO.
QT_AUTOBRIEF = NO
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
# a brief description. This used to be the default behavior. The new default is
# to treat a multi-line C++ comment block as a detailed description. Set this
# tag to YES if you prefer the old behavior instead.
#
# Note that setting this tag to YES also means that rational rose comments are
# not recognized any more.
# The default value is: NO.
MULTILINE_CPP_IS_BRIEF = NO
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.
INHERIT_DOCS = YES
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
# page for each member. If set to NO, the documentation of a member will be part
# of the file/class/namespace that contains it.
# The default value is: NO.
SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
# uses this value to replace tabs by spaces in code fragments.
# Minimum value: 1, maximum value: 16, default value: 4.
TAB_SIZE = 4
# This tag can be used to specify a number of aliases that act as commands in
# the documentation. An alias has the form:
# name=value
# For example adding
# "sideeffect=@par Side Effects:\n"
# will allow you to put the command \sideeffect (or @sideeffect) in the
# documentation, which will result in a user-defined paragraph with heading
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines (in the resulting output). You can put ^^ in the value part of an
# alias to insert a newline as if a physical newline was in the original file.
# When you need a literal { or } or , in the value part of an alias you have to
# escape them by means of a backslash (\), this can lead to conflicts with the
# commands \{ and \} for these it is advised to use the version @{ and @} or use
# a double escape (\\{ and \\})
ALIASES =
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
# will allow you to use the command class in the itcl::class meaning.
TCL_SUBST =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
# instance, some of the names that are used will be different. The list of all
# members will be omitted, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
# for that language. For instance, namespaces will be presented as packages,
# qualified scopes will look different, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources. Doxygen will then generate output that is tailored for Fortran.
# The default value is: NO.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for VHDL.
# The default value is: NO.
OPTIMIZE_OUTPUT_VHDL = NO
# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
# sources only. Doxygen will then generate output that is more tailored for that
# language. For instance, namespaces will be presented as modules, types will be
# separated into more groups, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_SLICE = NO
# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, and
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
# tries to guess whether the code is fixed or free formatted code, this is the
# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat
# .inc files as Fortran files (default is PHP), and .f files as C (default is
# Fortran), use: inc=Fortran f=C.
#
# Note: For files without extension you can use no_extension as a placeholder.
#
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.
EXTENSION_MAPPING =
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
# documentation. See https://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
# The default value is: YES.
MARKDOWN_SUPPORT = YES
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
# to that level are automatically included in the table of contents, even if
# they do not have an id attribute.
# Note: This feature currently applies only to Markdown headings.
# Minimum value: 0, maximum value: 99, default value: 0.
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
TOC_INCLUDE_HEADINGS = 0
# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
# be prevented in individual cases by putting a % sign in front of the word or
# globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.
AUTOLINK_SUPPORT = YES
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should set this
# tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string);
# versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
# The default value is: NO.
BUILTIN_STL_SUPPORT = NO
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
# The default value is: NO.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
# will parse them like normal C++ but will assume all classes use public instead
# of private inheritance when no explicit protection keyword is present.
# The default value is: NO.
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate
# getter and setter methods for a property. Setting this option to YES will make
# doxygen to replace the get and set methods by a property in the documentation.
# This will only work if the methods are indeed getting or setting a simple
# type. If this is not the case, or you want to show the methods anyway, you
# should set this option to NO.
# The default value is: YES.
IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
# The default value is: NO.
DISTRIBUTE_GROUP_DOC = NO
# If one adds a struct or class to a group and this option is enabled, then also
# any nested class or struct is added to the same group. By default this option
# is disabled and one has to add nested compounds explicitly via \ingroup.
# The default value is: NO.
GROUP_NESTED_COMPOUNDS = NO
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
# (for instance a group of public functions) to be put as a subgroup of that
# type (e.g. under the Public Functions section). Set it to NO to prevent
# subgrouping. Alternatively, this can be done per class using the
# \nosubgrouping command.
# The default value is: YES.
SUBGROUPING = YES
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
# are shown inside the group in which they are included (e.g. using \ingroup)
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
# and RTF).
#
# Note that this feature does not work in combination with
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.
INLINE_GROUPED_CLASSES = NO
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
# with only public data fields or simple typedef fields will be shown inline in
# the documentation of the scope in which they are defined (i.e. file,
# namespace, or group documentation), provided this scope is documented. If set
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
# Man pages) or section (for LaTeX and RTF).
# The default value is: NO.
INLINE_SIMPLE_STRUCTS = NO
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
# enum is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically be
# useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.
# The default value is: NO.
TYPEDEF_HIDES_STRUCT = NO
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
# cache is used to resolve symbols given their name and scope. Since this can be
# an expensive process and often the same symbol appears multiple times in the
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
# doxygen will become slower. If the cache is too large, memory is wasted. The
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
# symbols. At the end of a run doxygen will report the cache usage and suggest
# the optimal cache size from a speed point of view.
# Minimum value: 0, maximum value: 9, default value: 0.
LOOKUP_CACHE_SIZE = 0
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
# documentation are documented, even if no documentation was available. Private
# class members and static file members will be hidden unless the
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
# Note: This will also disable the warnings about undocumented members that are
# normally produced when WARNINGS is set to YES.
# The default value is: NO.
EXTRACT_ALL = NO
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
# The default value is: NO.
EXTRACT_PRIVATE = NO
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.
EXTRACT_PACKAGE = NO
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
# included in the documentation.
# The default value is: NO.
EXTRACT_STATIC = NO
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
# only classes defined in header files are included. Does not have any effect
# for Java sources.
# The default value is: YES.
EXTRACT_LOCAL_CLASSES = YES
# This flag is only useful for Objective-C code. If set to YES, local methods,
# which are defined in the implementation section but not in the interface are
# included in the documentation. If set to NO, only methods in the interface are
# included.
# The default value is: NO.
EXTRACT_LOCAL_METHODS = NO
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base name of
# the file that contains the anonymous namespace. By default anonymous namespace
# are hidden.
# The default value is: NO.
EXTRACT_ANON_NSPACES = NO
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
# members will be included in the various overviews, but no documentation
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_MEMBERS = NO
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. If set
# to NO, these classes will be included in the various overviews. This option
# has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_CLASSES = NO
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# (class|struct|union) declarations. If set to NO, these declarations will be
# included in the documentation.
# The default value is: NO.
HIDE_FRIEND_COMPOUNDS = NO
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
# documentation blocks found inside the body of a function. If set to NO, these
# blocks will be appended to the function's detailed documentation block.
# The default value is: NO.
HIDE_IN_BODY_DOCS = NO
# The INTERNAL_DOCS tag determines if documentation that is typed after a
# \internal command is included. If the tag is set to NO then the documentation
# will be excluded. Set it to YES to include the internal documentation.
# The default value is: NO.
INTERNAL_DOCS = NO
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
# names in lower-case letters. If set to YES, upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO.
# The default value is: system dependent.
CASE_SENSE_NAMES = NO
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
# their full class and namespace scopes in the documentation. If set to YES, the
# scope will be hidden.
# The default value is: NO.
HIDE_SCOPE_NAMES = NO
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
# append additional text to a page's title, such as Class Reference. If set to
# YES the compound reference will be hidden.
# The default value is: NO.
HIDE_COMPOUND_REFERENCE= NO
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
# the files that are included by a file in the documentation of that file.
# The default value is: YES.
SHOW_INCLUDE_FILES = YES
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
# grouped member an include statement to the documentation, telling the reader
# which file to include in order to use the member.
# The default value is: NO.
SHOW_GROUPED_MEMB_INC = NO
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
# files with double quotes in the documentation rather than with sharp brackets.
# The default value is: NO.
FORCE_LOCAL_INCLUDES = NO
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
# documentation for inline members.
# The default value is: YES.
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
# (detailed) documentation of file and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order.
# The default value is: YES.
SORT_MEMBER_DOCS = YES
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order. Note that
# this will also influence the order of the classes in the class list.
# The default value is: NO.
SORT_BRIEF_DOCS = NO
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
# (brief and detailed) documentation of class members so that constructors and
# destructors are listed first. If set to NO the constructors will appear in the
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
# member documentation.
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
# detailed member documentation.
# The default value is: NO.
SORT_MEMBERS_CTORS_1ST = NO
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
# of group names into alphabetical order. If set to NO the group names will
# appear in their defined order.
# The default value is: NO.
SORT_GROUP_NAMES = NO
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# fully-qualified names, including namespaces. If set to NO, the class list will
# be sorted only by class name, not including the namespace part.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the alphabetical
# list.
# The default value is: NO.
SORT_BY_SCOPE_NAME = NO
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
# type resolution of all parameters of a function it will reject a match between
# the prototype and the implementation of a member function even if there is
# only one candidate or it is obvious which candidate to choose by doing a
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
# accept a match between prototype and implementation in such cases.
# The default value is: NO.
STRICT_PROTO_MATCHING = NO
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
# list. This list is created by putting \todo commands in the documentation.
# The default value is: YES.
GENERATE_TODOLIST = YES
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
# list. This list is created by putting \test commands in the documentation.
# The default value is: YES.
GENERATE_TESTLIST = YES
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
# list. This list is created by putting \bug commands in the documentation.
# The default value is: YES.
GENERATE_BUGLIST = YES
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
# the deprecated list. This list is created by putting \deprecated commands in
# the documentation.
# The default value is: YES.
GENERATE_DEPRECATEDLIST= YES
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
# ... \endcond blocks.
ENABLED_SECTIONS =
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
# initial value of a variable or macro / define can have for it to appear in the
# documentation. If the initializer consists of more lines than specified here
# it will be hidden. Use a value of 0 to hide initializers completely. The
# appearance of the value of individual variables and macros / defines can be
# controlled using \showinitializer or \hideinitializer command in the
# documentation regardless of this setting.
# Minimum value: 0, maximum value: 10000, default value: 30.
MAX_INITIALIZER_LINES = 30
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
# the bottom of the documentation of classes and structs. If set to YES, the
# list will mention the files that were used to generate the documentation.
# The default value is: YES.
SHOW_USED_FILES = YES
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
# will remove the Files entry from the Quick Index and from the Folder Tree View
# (if specified).
# The default value is: YES.
SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
# page. This will remove the Namespaces entry from the Quick Index and from the
# Folder Tree View (if specified).
# The default value is: YES.
SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command command input-file, where command is the value of the
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
# by doxygen. Whatever the program writes to standard output is used as the file
# version. For an example see the documentation.
FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
# output files in an output format independent way. To create the layout file
# that represents doxygen's defaults, run doxygen with the -l option. You can
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
# will be used as the name of the layout file.
#
# Note that if you run doxygen from a directory containing a file called
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
LAYOUT_FILE =
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
# extension is automatically appended if omitted. This requires the bibtex tool
# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
# For LaTeX the style of the bibliography can be controlled using
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# search path. See also \cite for info how to create references.
CITE_BIB_FILES =
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
# The QUIET tag can be used to turn on/off the messages that are generated to
# standard output by doxygen. If QUIET is set to YES this implies that the
# messages are off.
# The default value is: NO.
QUIET = NO
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
# this implies that the warnings are on.
#
# Tip: Turn warnings on while writing the documentation.
# The default value is: YES.
WARNINGS = YES
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
# will automatically be disabled.
# The default value is: YES.
WARN_IF_UNDOCUMENTED = YES
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some parameters
# in a documented function, or documenting parameters that don't exist or using
# markup commands wrongly.
# The default value is: YES.
WARN_IF_DOC_ERROR = YES
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
# are documented, but have no documentation for their parameters or return
# value. If set to NO, doxygen will only warn about wrong or incomplete
# parameter documentation, but not about the absence of documentation. If
# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
# The default value is: NO.
WARN_NO_PARAMDOC = NO
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered.
# The default value is: NO.
WARN_AS_ERROR = NO
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which
# will be replaced by the file and line number from which the warning originated
# and the warning text. Optionally the format may contain $version, which will
# be replaced by the version of the file (if it could be obtained via
# FILE_VERSION_FILTER)
# The default value is: $file:$line: $text.
WARN_FORMAT = "$file:$line: $text"
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
# messages should be written. If left blank the output is written to standard
# error (stderr).
WARN_LOGFILE =
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
# The INPUT tag is used to specify the files and/or directories that contain
# documented source files. You may enter file names like myfile.cpp or
# directories like /usr/src/myproject. Separate the files or directories with
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = src
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
# possible encodings.
# The default value is: UTF-8.
INPUT_ENCODING = UTF-8
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
# *.h) to filter out the source-files in the directories.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# read by doxygen.
#
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
*.cpp \
*.c++ \
*.java \
*.ii \
*.ixx \
*.ipp \
*.i++ \
*.inl \
*.idl \
*.ddl \
*.odl \
*.h \
*.hh \
*.hxx \
*.hpp \
*.h++ \
*.cs \
*.d \
*.php \
*.php4 \
*.php5 \
*.phtml \
*.inc \
*.m \
*.markdown \
*.md \
*.mm \
*.dox \
*.py \
*.pyw \
*.f90 \
*.f95 \
*.f03 \
*.f08 \
*.f \
*.for \
*.tcl \
*.vhd \
*.vhdl \
*.ucf \
*.qsf \
*.ice
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.
RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
#
# Note that relative paths are relative to the directory from which doxygen is
# run.
EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
# from the input.
# The default value is: NO.
EXCLUDE_SYMLINKS = NO
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories.
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*
EXCLUDE_PATTERNS =
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*
EXCLUDE_SYMBOLS =
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include
# command).
EXAMPLE_PATH =
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank all
# files are included.
EXAMPLE_PATTERNS = *
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude commands
# irrespective of the value of the RECURSIVE tag.
# The default value is: NO.
EXAMPLE_RECURSIVE = NO
# The IMAGE_PATH tag can be used to specify one or more files or directories
# that contain images that are to be included in the documentation (see the
# \image command).
IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command:
#
# <filter> <input-file>
#
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
# name of an input file. Doxygen will then use the output that the filter
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
# will be ignored.
#
# Note that the filter must not add or remove lines; it is applied before the
# code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
INPUT_FILTER =
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
# filter if there is a match. The filters are a list of the form: pattern=filter
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
# patterns match the file name, INPUT_FILTER is applied.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
FILTER_PATTERNS =
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will also be used to filter the input files that are used for
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
# The default value is: NO.
FILTER_SOURCE_FILES = NO
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
# it is also possible to disable source filtering for a specific pattern using
# *.ext= (so without naming a filter).
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
FILTER_SOURCE_PATTERNS =
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
# is part of the input, its contents will be placed on the main page
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE =
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
# generated. Documented entities will be cross-referenced with these sources.
#
# Note: To get rid of all source code in the generated output, make sure that
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.
SOURCE_BROWSER = NO
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
# classes and enums directly into the documentation.
# The default value is: NO.
INLINE_SOURCES = NO
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
# special comment blocks from generated source code fragments. Normal C, C++ and
# Fortran comments will always remain visible.
# The default value is: YES.
STRIP_CODE_COMMENTS = YES
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
# entity all documented functions referencing it will be listed.
# The default value is: NO.
REFERENCED_BY_RELATION = NO
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
# The default value is: NO.
REFERENCES_RELATION = NO
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
# link to the documentation.
# The default value is: YES.
REFERENCES_LINK_SOURCE = YES
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
# source code will show a tooltip with additional information such as prototype,
# brief description and links to the definition and documentation. Since this
# will make the HTML file larger and loading of large files a bit slower, you
# can opt to disable this feature.
# The default value is: YES.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
SOURCE_TOOLTIPS = YES
# If the USE_HTAGS tag is set to YES then the references to source code will
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
# source browser. The htags tool is part of GNU's global source tagging system
# (see https://www.gnu.org/software/global/global.html). You will need version
# 4.8.6 or higher.
#
# To use it do the following:
# - Install the latest version of global
# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
# - Make sure the INPUT points to the root of the source tree
# - Run doxygen as normal
#
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
# tools must be available from the command line (i.e. in the search path).
#
# The result: instead of the source browser generated by doxygen, the links to
# source code will now point to the output of htags.
# The default value is: NO.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
USE_HTAGS = NO
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
# verbatim copy of the header file for each class for which an include is
# specified. Set to NO to disable this.
# See also: Section \class.
# The default value is: YES.
VERBATIM_HEADERS = YES
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
# cost of reduced performance. This can be particularly helpful with template
# rich C++ code for which doxygen's built-in parser lacks the necessary type
# information.
# Note: The availability of this option depends on whether or not doxygen was
# generated with the -Duse_libclang=ON option for CMake.
# The default value is: NO.
CLANG_ASSISTED_PARSING = NO
# If clang assisted parsing is enabled you can provide the compiler with command
# line options that you would normally use when invoking the compiler. Note that
# the include paths will already be set by doxygen for the files and directories
# specified with INPUT and INCLUDE_PATH.
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
CLANG_OPTIONS =
# If clang assisted parsing is enabled you can provide the clang parser with the
# path to the compilation database (see:
# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
# were built. This is equivalent to specifying the "-p" option to a clang tool,
# such as clang-check. These options will then be passed to the parser.
# Note: The availability of this option depends on whether or not doxygen was
# generated with the -Duse_libclang=ON option for CMake.
CLANG_DATABASE_PATH =
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
# compounds will be generated. Enable this if the project contains a lot of
# classes, structs, unions or interfaces.
# The default value is: YES.
ALPHABETICAL_INDEX = YES
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
# which the alphabetical index list will be split.
# Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all classes will
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
# can be used to specify a prefix (or a list of prefixes) that should be ignored
# while generating the index headers.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
# The default value is: YES.
GENERATE_HTML = YES
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
# The default value is: .html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FILE_EXTENSION = .html
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
# each generated HTML page. If the tag is left blank doxygen will generate a
# standard header.
#
# To get valid HTML the header file that includes any scripts and style sheets
# that doxygen needs, which is dependent on the configuration options used (e.g.
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
# default header using
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
# YourConfigFile
# and then modify the file new_header.html. See also section "Doxygen usage"
# for information on how to generate the default header that doxygen normally
# uses.
# Note: The header is subject to change so you typically have to regenerate the
# default header when upgrading to a newer version of doxygen. For a description
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
# footer. See HTML_HEADER for more information on how to generate a default
# footer and what special commands can be used inside the footer. See also
# section "Doxygen usage" for information on how to generate the default footer
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER =
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
# the HTML output. If left blank doxygen will generate a default style sheet.
# See also section "Doxygen usage" for information on how to generate the style
# sheet that doxygen normally uses.
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET =
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
# created by doxygen. Using this option one can overrule certain style aspects.
# This is preferred over using HTML_STYLESHEET since it does not replace the
# standard style sheet and is therefore more robust against future updates.
# Doxygen will copy the style sheet files to the output directory.
# Note: The order of the extra style sheet files is of importance (e.g. the last
# style sheet in the list overrules the setting of the previous ones in the
# list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_STYLESHEET =
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
# that these files will be copied to the base HTML output directory. Use the
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_FILES =
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# will adjust the colors in the style sheet and background images according to
# this color. Hue is specified as an angle on a colorwheel, see
# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
# purple, and 360 is red again.
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 220
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# in the HTML output. For a value of 0 the output will use grayscales only. A
# value of 255 will produce the most vivid colors.
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_SAT = 100
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
# gradually make the output lighter, whereas values above 100 make the output
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
# change the gamma.
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 80
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting this
# to YES can help to show when doxygen was last run and thus if the
# documentation is up to date.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_TIMESTAMP = NO
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
# documentation will contain a main index with vertical navigation menus that
# are dynamically created via Javascript. If disabled, the navigation index will
# consists of multiple levels of tabs that are statically embedded in every HTML
# page. Disable this option to support browsers that do not have Javascript,
# like the Qt help browser.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_MENUS = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_SECTIONS = NO
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand
# and collapse entries dynamically later on. Doxygen will expand the tree to
# such a level that at most the specified number of entries are visible (unless
# a fully collapsed tree already exceeds this amount). So setting the number of
# entries 1 will produce a full collapsed tree by default. 0 is a special value
# representing an infinite number of entries and will result in a full expanded
# tree by default.
# Minimum value: 0, maximum value: 9999, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_INDEX_NUM_ENTRIES = 100
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
# generated that can be used as input for Apple's Xcode 3 integrated development
# environment (see: https://developer.apple.com/xcode/), introduced with OSX
# 10.5 (Leopard). To create a documentation set, doxygen will generate a
# Makefile in the HTML output directory. Running make will produce the docset in
# that directory and running make install will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
# genXcode/_index.html for more information.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_DOCSET = NO
# This tag determines the name of the docset feed. A documentation feed provides
# an umbrella under which multiple documentation sets from a single provider
# (such as a company or product suite) can be grouped.
# The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_FEEDNAME = "Doxygen generated docs"
# This tag specifies a string that should uniquely identify the documentation
# set bundle. This should be a reverse domain-name style string, e.g.
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_BUNDLE_ID = org.doxygen.Project
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
# The default value is: org.doxygen.Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
# The default value is: Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_NAME = Publisher
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
# Windows.
#
# The HTML Help Workshop contains a compiler that can convert all HTML output
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
# files are now used as the Windows 98 help format, and will replace the old
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
# HTML files also contain an index, a table of contents, and you can search for
# words in the documentation. The HTML workshop also contains a viewer for
# compressed HTML files.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_HTMLHELP = NO
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
# file. You can add a path in front of the file if the result should not be
# written to the html output directory.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_FILE =
# The HHC_LOCATION tag can be used to specify the location (absolute path
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
# doxygen will try to run the HTML help compiler on the generated index.hhp.
# The file has to be specified with full path.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
HHC_LOCATION =
# The GENERATE_CHI flag controls if a separate .chi index file is generated
# (YES) or that it should be included in the master .chm file (NO).
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
GENERATE_CHI = NO
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
# and project file content.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_INDEX_ENCODING =
# The BINARY_TOC flag controls whether a binary table of contents is generated
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
# enables the Previous and Next buttons.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
# the table of contents of the HTML help documentation and to the tree view.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
# (.qch) of the generated HTML documentation.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
# the file name of the resulting .qch file. The path specified is relative to
# the HTML output folder.
# This tag requires that the tag GENERATE_QHP is set to YES.
QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
# Project output. For more information please see Qt Help Project / Namespace
# (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_NAMESPACE = org.doxygen.Project
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
# Help Project output. For more information please see Qt Help Project / Virtual
# Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
# folders).
# The default value is: doc.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_VIRTUAL_FOLDER = doc
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
# filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's filter section matches. Qt Help Project / Filter Attributes (see:
# http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_SECT_FILTER_ATTRS =
# The QHG_LOCATION tag can be used to specify the location of Qt's
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
# generated .qhp file.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHG_LOCATION =
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
# generated, together with the HTML files, they form an Eclipse help plugin. To
# install this plugin and make it available under the help contents menu in
# Eclipse, the contents of the directory containing the HTML and XML files needs
# to be copied into the plugins directory of eclipse. The name of the directory
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
# After copying Eclipse needs to be restarted before the help appears.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_ECLIPSEHELP = NO
# A unique identifier for the Eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have this
# name. Each documentation set should have its own identifier.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
ECLIPSE_DOC_ID = org.doxygen.Project
# If you want full control over the layout of the generated HTML pages it might
# be necessary to disable the index and replace it with your own. The
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
# of each HTML page. A value of NO enables the index and the value YES disables
# it. Since the tabs in the index contain the same information as the navigation
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
DISABLE_INDEX = NO
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. If the tag
# value is set to YES, a side panel will be generated containing a tree-like
# index structure (just like the one that is generated for HTML Help). For this
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
# (i.e. any modern browser). Windows users are probably better off using the
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
# further fine-tune the look of the index. As an example, the default style
# sheet generated by doxygen has an example that shows how to put an image at
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
# the same information as the tab index, you could consider setting
# DISABLE_INDEX to YES when enabling this option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_TREEVIEW = YES
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# doxygen will group on one line in the generated HTML documentation.
#
# Note that a value of 0 will completely suppress the enum values from appearing
# in the overview section.
# Minimum value: 0, maximum value: 20, default value: 4.
# This tag requires that the tag GENERATE_HTML is set to YES.
ENUM_VALUES_PER_LINE = 4
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
# to set the initial width (in pixels) of the frame in which the tree is shown.
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.
TREEVIEW_WIDTH = 250
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
# external symbols imported via tag files in a separate window.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
EXT_LINKS_IN_WINDOW = NO
# Use this tag to change the font size of LaTeX formulas included as images in
# the HTML documentation. When you change the font size after a successful
# doxygen run you need to manually remove any form_*.png images from the HTML
# output directory to force them to be regenerated.
# Minimum value: 8, maximum value: 50, default value: 10.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_FONTSIZE = 10
# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are not
# supported properly for IE 6.0, but are supported on all modern browsers.
#
# Note that when changing this option you need to delete any form_*.png files in
# the HTML output directory before the changes have effect.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_TRANSPARENT = YES
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
# https://www.mathjax.org) which uses client side Javascript for the rendering
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
# installed or if you want to formulas look prettier in the HTML output. When
# enabled you may also need to install MathJax separately and configure the path
# to it using the MATHJAX_RELPATH option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
USE_MATHJAX = NO
# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. See the MathJax site (see:
# http://docs.mathjax.org/en/latest/output.html) for more details.
# Possible values are: HTML-CSS (which is slower, but has the best
# compatibility), NativeMML (i.e. MathML) and SVG.
# The default value is: HTML-CSS.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_FORMAT = HTML-CSS
# When MathJax is enabled you need to specify the location relative to the HTML
# output directory using the MATHJAX_RELPATH option. The destination directory
# should contain the MathJax.js script. For instance, if the mathjax directory
# is located at the same level as the HTML output directory, then
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
# Content Delivery Network so you can quickly see the result without installing
# MathJax. However, it is strongly recommended to install a local copy of
# MathJax from https://www.mathjax.org before deployment.
# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# extension names that should be enabled during MathJax rendering. For example
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_EXTENSIONS =
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
# of code that will be used on startup of the MathJax code. See the MathJax site
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
# example see the documentation.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_CODEFILE =
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
# the HTML output. The underlying search engine uses javascript and DHTML and
# should work on any modern browser. Note that when using HTML help
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
# there is already a search function so this one should typically be disabled.
# For large projects the javascript based search engine can be slow, then
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
# search using the keyboard; to jump to the search box use <access key> + S
# (what the <access key> is depends on the OS and browser, but it is typically
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
# key> to jump into the search results window, the results can be navigated
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
# the search. The filter options can be selected when the cursor is inside the
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
# to select a filter and <Enter> or <escape> to activate or cancel the filter
# option.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
SEARCHENGINE = YES
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a web server instead of a web client using Javascript. There
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
# setting. When disabled, doxygen will generate a PHP script for searching and
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
# and searching needs to be provided by external tools. See the section
# "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
SERVER_BASED_SEARCH = NO
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
# script for searching. Instead the search results are written to an XML file
# which needs to be processed by an external indexer. Doxygen will invoke an
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
# search results.
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: https://xapian.org/).
#
# See the section "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH = NO
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
# which will return the search results when EXTERNAL_SEARCH is enabled.
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: https://xapian.org/). See the section "External Indexing and
# Searching" for details.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHENGINE_URL =
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
# search data is written to a file for indexing by an external tool. With the
# SEARCHDATA_FILE tag the name of this file can be specified.
# The default file is: searchdata.xml.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHDATA_FILE = searchdata.xml
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
# projects and redirect the results back to the right project.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH_ID =
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
# projects other than the one defined by this configuration file, but that are
# all added to the same external search index. Each project needs to have a
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
# to a relative location where the documentation can be found. The format is:
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTRA_SEARCH_MAPPINGS =
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked.
#
# Note that when not enabling USE_PDFLATEX the default is latex when enabling
# USE_PDFLATEX the default is pdflatex and when in the later case latex is
# chosen this is overwritten by pdflatex. For specific output languages the
# default can have been set differently, this depends on the implementation of
# the output language.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_CMD_NAME =
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
# index for LaTeX.
# Note: This tag is used in the Makefile / make.bat.
# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
# (.tex).
# The default file is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
MAKEINDEX_CMD_NAME = makeindex
# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
# generate index for LaTeX.
# Note: This tag is used in the generated output file (.tex).
# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
# The default value is: \makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_MAKEINDEX_CMD = \makeindex
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used by the
# printer.
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
# 14 inches) and executive (7.25 x 10.5 inches).
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. The package can be specified just
# by its name or with the correct syntax as to be used with the LaTeX
# \usepackage command. To get the times font for instance you can specify :
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
# To use the option intlimits with the amsmath package you can specify:
# EXTRA_PACKAGES=[intlimits]{amsmath}
# If left blank no extra packages will be included.
# This tag requires that the tag GENERATE_LATEX is set to YES.
EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
# generated LaTeX document. The header should contain everything until the first
# chapter. If it is left blank doxygen will generate a standard header. See
# section "Doxygen usage" for information on how to let doxygen write the
# default header to a separate file.
#
# Note: Only use a user-defined header if you know what you are doing! The
# following commands have a special meaning inside the header: $title,
# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
# string, for the replacement values of the other commands the user is referred
# to HTML_HEADER.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER =
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
# generated LaTeX document. The footer should contain everything after the last
# chapter. If it is left blank doxygen will generate a standard footer. See
# LATEX_HEADER for more information on how to generate a default footer and what
# special commands can be used inside the footer.
#
# Note: Only use a user-defined footer if you know what you are doing!
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_FOOTER =
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# LaTeX style sheets that are included after the standard style sheets created
# by doxygen. Using this option one can overrule certain style aspects. Doxygen
# will copy the style sheet files to the output directory.
# Note: The order of the extra style sheet files is of importance (e.g. the last
# style sheet in the list overrules the setting of the previous ones in the
# list).
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_STYLESHEET =
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the LATEX_OUTPUT output
# directory. Note that the files will be copied as-is; there are no commands or
# markers available.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_FILES =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
# contain links (just like the HTML output) instead of page references. This
# makes the output suitable for online browsing using a PDF viewer.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
# the PDF file directly from the LaTeX files. Set this option to YES, to get a
# higher quality PDF documentation.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
# command to the generated LaTeX files. This will instruct LaTeX to keep running
# if errors occur, instead of asking the user for help. This option is also used
# when generating formulas in HTML.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BATCHMODE = NO
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
# index chapters (such as File Index, Compound Index, etc.) in the output.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HIDE_INDICES = NO
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
# code with syntax highlighting in the LaTeX output.
#
# Note that which sources are shown also depends on other settings such as
# SOURCE_BROWSER.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_SOURCE_CODE = NO
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. See
# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
# The default value is: plain.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BIB_STYLE = plain
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
# page will contain the date and time when the page was generated. Setting this
# to NO can help when comparing the output of multiple runs.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_TIMESTAMP = NO
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
# path from which the emoji images will be read. If a relative path is entered,
# it will be relative to the LATEX_OUTPUT directory. If left blank the
# LATEX_OUTPUT directory will be used.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EMOJI_DIRECTORY =
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
# readers/editors.
# The default value is: NO.
GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: rtf.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
# contain hyperlink fields. The RTF file will contain links (just like the HTML
# output) instead of page references. This makes the output suitable for online
# browsing using Word or some other Word compatible readers that support those
# fields.
#
# Note: WordPad (write) and others do not support links.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# configuration file, i.e. a series of assignments. You only have to provide
# replacements, missing definitions are set to their default value.
#
# See also section "Doxygen usage" for information on how to generate the
# default style sheet that doxygen normally uses.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an RTF document. Syntax is
# similar to doxygen's configuration file. A template extensions file can be
# generated using doxygen -e rtf extensionFile.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_EXTENSIONS_FILE =
# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
# with syntax highlighting in the RTF output.
#
# Note that which sources are shown also depends on other settings such as
# SOURCE_BROWSER.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_SOURCE_CODE = NO
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
# classes and files.
# The default value is: NO.
GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it. A directory man3 will be created inside the directory specified by
# MAN_OUTPUT.
# The default directory is: man.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to the generated
# man pages. In case the manual section does not start with a number, the number
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
# optional.
# The default value is: .3.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_EXTENSION = .3
# The MAN_SUBDIR tag determines the name of the directory created within
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
# MAN_EXTENSION with the initial . removed.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_SUBDIR =
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
# will generate one additional man file for each entity documented in the real
# man page(s). These additional files only source the real man page, but without
# them the man command would be unable to find the correct page.
# The default value is: NO.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_LINKS = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
# captures the structure of the code including all documentation.
# The default value is: NO.
GENERATE_XML = YES
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: xml.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_OUTPUT = xml
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
# listings (including syntax highlighting and cross-referencing information) to
# the XML output. Note that enabling this will significantly increase the size
# of the XML output.
# The default value is: YES.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_PROGRAMLISTING = YES
# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
# namespace members in file scope as well, matching the HTML output.
# The default value is: NO.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_NS_MEMB_FILE_SCOPE = NO
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
# that can be used to generate PDF.
# The default value is: NO.
GENERATE_DOCBOOK = NO
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
# front of it.
# The default directory is: docbook.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_OUTPUT = docbook
# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
# program listings (including syntax highlighting and cross-referencing
# information) to the DOCBOOK output. Note that enabling this will significantly
# increase the size of the DOCBOOK output.
# The default value is: NO.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
# the structure of the code including all documentation. Note that this feature
# is still experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
# file that captures the structure of the code including all documentation.
#
# Note that this feature is still experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_PERLMOD = NO
# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
# output from the Perl module output.
# The default value is: NO.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_LATEX = NO
# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
# formatted so it can be parsed by a human reader. This is useful if you want to
# understand what is going on. On the other hand, if this tag is set to NO, the
# size of the Perl module output will be much smaller and Perl will parse it
# just the same.
# The default value is: YES.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_PRETTY = YES
# The names of the make variables in the generated doxyrules.make file are
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
# so different doxyrules.make files included by the same Makefile don't
# overwrite each other's variables.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
# C-preprocessor directives found in the sources and include files.
# The default value is: YES.
ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
# in the source code. If set to NO, only conditional compilation will be
# performed. Macro expansion can be done in a controlled way by setting
# EXPAND_ONLY_PREDEF to YES.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = YES
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# the macro expansion is limited to the macros specified with the PREDEFINED and
# EXPAND_AS_DEFINED tags.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_ONLY_PREDEF = YES
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
# INCLUDE_PATH will be searched if a #include is found.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by the
# preprocessor.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
INCLUDE_PATH =
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
# used.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that are
# defined before the preprocessor is started (similar to the -D option of e.g.
# gcc). The argument of the tag is a list of macros of the form: name or
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
# is assumed. To prevent a macro definition from being undefined via #undef or
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = protected=private
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
# macro definition that is found in the sources will be used. Use the PREDEFINED
# tag if you want to use a different macro definition that overrules the
# definition found in the source code.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
# remove all references to function-like macros that are alone on a line, have
# an all uppercase name, and do not end with a semicolon. Such function macros
# are typically used for boiler-plate code, and will confuse the parser if not
# removed.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration options related to external references
#---------------------------------------------------------------------------
# The TAGFILES tag can be used to specify one or more tag files. For each tag
# file the location of the external documentation should be added. The format of
# a tag file without this location is as follows:
# TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
# TAGFILES = file1=loc1 "file2 = loc2" ...
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
# section "Linking to external documentation" for more information about the use
# of tag files.
# Note: Each tag file must have a unique name (where the name does NOT include
# the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here.
TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
# the class index. If set to NO, only the inherited external classes will be
# listed.
# The default value is: NO.
ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
# in the modules index. If set to NO, only the current project's groups will be
# listed.
# The default value is: YES.
EXTERNAL_GROUPS = YES
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
# the related pages index. If set to NO, only the current project's pages will
# be listed.
# The default value is: YES.
EXTERNAL_PAGES = YES
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of 'which perl').
# The default file (with absolute path) is: /usr/bin/perl.
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
# disabled, but it is recommended to install and use dot, since it yields more
# powerful graphs.
# The default value is: YES.
CLASS_DIAGRAMS = YES
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see:
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.
MSCGEN_PATH =
# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
# If left empty dia is assumed to be found in the default search path.
DIA_PATH =
# If set to YES the inheritance and collaboration graphs will hide inheritance
# and usage relations if the target is undocumented or is not a class.
# The default value is: YES.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz (see:
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# Bell Labs. The other options in this section have no effect if this option is
# set to NO
# The default value is: NO.
HAVE_DOT = NO
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# to run in parallel. When set to 0 doxygen will base this on the number of
# processors available in the system. You can set it explicitly to a value
# larger than 0 to get control over the balance between CPU load and processing
# speed.
# Minimum value: 0, maximum value: 32, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_NUM_THREADS = 0
# When you want a differently looking font in the dot files that doxygen
# generates you can specify the font name using DOT_FONTNAME. You need to make
# sure dot is able to find the font, which can be done by putting it in a
# standard location or by setting the DOTFONTPATH environment variable or by
# setting DOT_FONTPATH to the directory containing the font.
# The default value is: Helvetica.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTNAME = Helvetica
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
# dot graphs.
# Minimum value: 4, maximum value: 24, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the default font as specified with
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
# the path where dot can find it using this tag.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTPATH =
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
# each documented class showing the direct and indirect inheritance relations.
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
# graph for each documented class showing the direct and indirect implementation
# dependencies (inheritance, containment, and class references variables) of the
# class with other documented classes.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
COLLABORATION_GRAPH = YES
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
# groups, showing the direct groups dependencies.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GROUP_GRAPHS = YES
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LOOK = NO
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
# class node. If there are many fields or methods and many nodes the graph may
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
# number of items for each type to make the size more manageable. Set this to 0
# for no limit. Note that the threshold may be exceeded by 50% before the limit
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
# but if the number exceeds 15, the total amount of fields shown is limited to
# 10.
# Minimum value: 0, maximum value: 100, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LIMIT_NUM_FIELDS = 10
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
# collaboration graphs will show the relations between templates and their
# instances.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
TEMPLATE_RELATIONS = NO
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
# YES then doxygen will generate a graph for each documented file showing the
# direct and indirect include dependencies of the file with other documented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDE_GRAPH = YES
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
# set to YES then doxygen will generate a graph for each documented file showing
# the direct and indirect include dependencies of the file with other documented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDED_BY_GRAPH = YES
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable call graphs for selected
# functions only using the \callgraph command. Disabling a call graph can be
# accomplished by means of the command \hidecallgraph.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALL_GRAPH = NO
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable caller graphs for selected
# functions only using the \callergraph command. Disabling a caller graph can be
# accomplished by means of the command \hidecallergraph.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
# hierarchy of all classes instead of a textual one.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GRAPHICAL_HIERARCHY = YES
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
# dependencies a directory has on other directories in a graphical way. The
# dependency relations are determined by the #include relations between the
# files in the directories.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DIRECTORY_GRAPH = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. For an explanation of the image formats see the section
# output formats in the documentation of the dot tool (Graphviz (see:
# http://www.graphviz.org/)).
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
# to make the SVG files visible in IE 9+ (other browsers do not have this
# requirement).
# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
# png:gdiplus:gdiplus.
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_IMAGE_FORMAT = png
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning.
#
# Note that this requires a modern browser other than Internet Explorer. Tested
# and working are Firefox, Chrome, Safari, and Opera.
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
# the SVG files visible. Older versions of IE do not have SVG support.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
INTERACTIVE_SVG = NO
# The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the \dotfile
# command).
# This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS =
# The MSCFILE_DIRS tag can be used to specify one or more directories that
# contain msc files that are included in the documentation (see the \mscfile
# command).
MSCFILE_DIRS =
# The DIAFILE_DIRS tag can be used to specify one or more directories that
# contain dia files that are included in the documentation (see the \diafile
# command).
DIAFILE_DIRS =
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
# path where java can find the plantuml.jar file. If left blank, it is assumed
# PlantUML is not used or called during a preprocessing step. Doxygen will
# generate a warning when it encounters a \startuml command in this case and
# will not generate output for the diagram.
PLANTUML_JAR_PATH =
# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
# configuration file for plantuml.
PLANTUML_CFG_FILE =
# When using plantuml, the specified paths are searched for files specified by
# the !include statement in a plantuml block.
PLANTUML_INCLUDE_PATH =
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
# that will be shown in the graph. If the number of nodes in a graph becomes
# larger than this value, doxygen will truncate the graph, which is visualized
# by representing a node as a red box. Note that doxygen if the number of direct
# children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_GRAPH_MAX_NODES = 50
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the
# root by following a path via at most 3 edges will be shown. Nodes that lay
# further from the root node will be omitted. Note that setting this option to 1
# or 2 may greatly reduce the computation time needed for large code bases. Also
# note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
# Minimum value: 0, maximum value: 1000, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not seem
# to support this out of the box.
#
# Warning: Depending on the platform used, enabling this option may lead to
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
# read).
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_TRANSPARENT = NO
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
# this, this feature is disabled by default.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_MULTI_TARGETS = NO
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
# explaining the meaning of the various boxes and arrows in the dot generated
# graphs.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
# files that are used to generate the various graphs.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_CLEANUP = YES
================================================
FILE: LICENSE
================================================
MIT License
Copyright (c) 2022 matthias-bs
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
================================================
FILE: LICENSE.KeywordsTxtGenerator
================================================
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT
PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT
CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES
THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO
WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION
OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES
RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR
WORKS PROVIDED HEREUNDER.
Statement of Purpose
The laws of most jurisdictions throughout the world automatically
confer exclusive Copyright and Related Rights (defined below) upon the
creator and subsequent owner(s) (each and all, an "owner") of an
original work of authorship and/or a database (each, a "Work").
Certain owners wish to permanently relinquish those rights to a Work
for the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without
fear of later claims of infringement build upon, modify, incorporate
in other works, reuse and redistribute as freely as possible in any
form whatsoever and for any purposes, including without limitation
commercial purposes. These owners may contribute to the Commons to
promote the ideal of a free culture and the further production of
creative, cultural and scientific works, or to gain reputation or
greater distribution for their Work in part through the use and
efforts of others.
For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or
she is an owner of Copyright and Related Rights in the Work,
voluntarily elects to apply CC0 to the Work and publicly distribute
the Work under its terms, with knowledge of his or her Copyright and
Related Rights in the Work and the meaning and intended legal effect
of CC0 on those rights.
1. Copyright and Related Rights. A Work made available under CC0 may
be protected by copyright and related or neighboring rights
("Copyright and Related Rights"). Copyright and Related Rights
include, but are not limited to, the following:
the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work; moral rights retained by the
original author(s) and/or performer(s); publicity and privacy
rights pertaining to a person's image or likeness depicted in a
Work; rights protecting against unfair competition in regards to a
Work, subject to the limitations in paragraph 4(a), below; rights
protecting the extraction, dissemination, use and reuse of data in
a Work; database rights (such as those arising under Directive
96/9/EC of the European Parliament and of the Council of 11 March
1996 on the legal protection of databases, and under any national
implementation thereof, including any amended or successor version
of such directive); and other similar, equivalent or corresponding
rights throughout the world based on applicable law or treaty, and
any national implementations thereof.
2. Waiver. To the greatest extent permitted by, but not in
contravention of, applicable law, Affirmer hereby overtly, fully,
permanently, irrevocably and unconditionally waives, abandons, and
surrenders all of Affirmer's Copyright and Related Rights and
associated claims and causes of action, whether now known or unknown
(including existing as well as future claims and causes of action), in
the Work (i) in all territories worldwide, (ii) for the maximum
duration provided by applicable law or treaty (including future time
extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"Waiver"). Affirmer makes the Waiver for the benefit of each member of
the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal
or equitable action to disrupt the quiet enjoyment of the Work by the
public as contemplated by Affirmer's express Statement of Purpose.
3. Public License Fallback. Should any part of the Waiver for any
reason be judged legally invalid or ineffective under applicable law,
then the Waiver shall be preserved to the maximum extent permitted
taking into account Affirmer's express Statement of Purpose. In
addition, to the extent the Waiver is so judged Affirmer hereby grants
to each affected person a royalty-free, non transferable, non
sublicensable, non exclusive, irrevocable and unconditional license to
exercise Affirmer's Copyright and Related Rights in the Work (i) in
all territories worldwide, (ii) for the maximum duration provided by
applicable law or treaty (including future time extensions), (iii) in
any current or future medium and for any number of copies, and (iv)
for any purpose whatsoever, including without limitation commercial,
advertising or promotional purposes (the "License"). The License shall
be deemed effective as of the date CC0 was applied by Affirmer to the
Work. Should any part of the License for any reason be judged legally
invalid or ineffective under applicable law, such partial invalidity
or ineffectiveness shall not invalidate the remainder of the License,
and in such case Affirmer hereby affirms that he or she will not (i)
exercise any of his or her remaining Copyright and Related Rights in
the Work or (ii) assert any associated claims and causes of action
with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.
4. Limitations and Disclaimers.
No trademark or patent rights held by Affirmer are waived,
abandoned, surrendered, licensed or otherwise affected by this
document. Affirmer offers the Work as-is and makes no
representations or warranties of any kind concerning the Work,
express, implied, statutory or otherwise, including without
limitation warranties of title, merchantability, fitness for a
particular purpose, non infringement, or the absence of latent or
other defects, accuracy, or the present or absence of errors,
whether or not discoverable, all to the greatest extent
permissible under applicable law. Affirmer disclaims
responsibility for clearing rights of other persons that may apply
to the Work or any use thereof, including without limitation any
person's Copyright and Related Rights in the Work. Further,
Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work. Affirmer understands and acknowledges that Creative Commons
is not a party to this document and has no duty or obligation with
respect to this CC0 or use of the Work.
================================================
FILE: README.md
================================================
# BresserWeatherSensorReceiver
[](https://github.com/matthias-bs/BresserWeatherSensorReceiver/actions/workflows/CI.yml)<!--[](https://app.travis-ci.com/matthias-bs/BresserWeatherSensorReceiver)-->
[](https://github.com/matthias-bs/BresserWeatherSensorReceiver/actions/workflows/CppUTest.yml)
[](https://github.com/matthias-bs/BresserWeatherSensorReceiver/releases)
[](https://github.com/matthias-bs/BresserWeatherSensorReceiver/blob/main/LICENSE)
<!--
Badge is not updated any more!
[](https://www.ardu-badge.com/BresserWeatherSensorReceiver)
-->
Bresser 5-in-1/6-in-1/7-in-1 868 MHz Weather Sensor Radio Receiver for Arduino based on [RadioLib](https://github.com/jgromes/RadioLib) using CC1101, SX1276/RFM95W, SX1262 or LR1121
**See the [Wiki](https://github.com/matthias-bs/BresserWeatherSensorReceiver/wiki) for additional information.**
To allow automatic handling of all Bresser weather station variants, the decoders are tried in the following order until decoding succeeded:
1. 7-in-1-Decoder
2. 6-in-1-Decoder
3. 5-in-1 Decoder
4. Lightning Sensor Decoder
5. Water Leakage Sensor Decoder
(The Bresser 5-in-1 Weather Stations seem to use two different protocols - 5-in-1 and 6-in-1.)
| Model | Type | Decoder Function |
| ------------- | ---- | ------------------------------- |
| 7002510..12, 9602510 | Weather Station | decodeBresser**5In1**Payload() |
| 7902510..12 | Weather Station (Base) | decodeBresser**5In1**Payload() |
| 7002530 | Professional Rain Gauge | decodeBresser**7In1**Payload() |
| 7002531 | 3-in-1 Professional Wind Gauge / Anemometer | decodeBresser**6In1**Payload() **1)** |
| 7002585 | Weather Station | decodeBresser**6In1**Payload() |
| 7009999 | Thermo-/Hygrometer Sensor | decodeBresser**6in1**Payload() |
| 7009970 | Air Quality Sensor PM 2.5 / PM 10 | decodeBresser**7In1**Payload() |
| 7009971 | High Precision Thermo Hygro Sensor | decodeBresser**6In1**Payload() |
| 7009972 | Soil Moisture/Temperature Sensor | decodeBresser**6In1**Payload() |
| 7009973 | Pool / Spa Thermometer | decodeBresser**6In1**Payload() |
| 7009975 | Water Leakage Sensor | decodeBresser**Leakage**Payload() |
| 7009976 | Lightning Sensor | decodeBresser**Lightning**Payload() |
| 7009977 | CO<sub>2</sub> Sensor | decodeBresser**7In1**Payload() **2)** |
| 7009978 | Air Quality Sensor HCHO / VOC | decodeBresser**7In1**Payload() **3)** |
| 7003600 and WSX3001 | Weather Station | decodeBresser**7In1**Payload() **4)** |
| 7003210 | Weather Station | decodeBresser**7In1**Payload() |
| 7803200 | Weather Sensor | decodeBresser**7In1**Payload() |
| 7003300 | Weather Station | decodeBresser**7In1**Payload() |
| 7803300 | Weather Sensor | decodeBresser**7In1**Payload() |
| 7003150 | 8-in-1 Weather Station | decodeBresser**7In1**Payload() **5)** |
Some guesswork:
| Numbering Scheme | Type |
| ---------------- | ---- |
| 700[25\|31\|32\|33\|36]* | Weather Station, Base + Sensor |
| 780[25\|31\|32\|33]* | Weather Station Sensor (Replacement) |
| 790* | Weather Station Base (Replacement) |
| 700[99]* | Accessory Sensor |
**1)** The flag `DATA_COMPLETE` must not be set in `getData()`, otherwise the return value would always indicate a timeout. (I.e. use `#define RX_STRATEGY 0` in some of the example sketches.)
**2)** Request for testing, see https://github.com/matthias-bs/BresserWeatherSensorReceiver/issues/138
**3)** Request for testing, see https://github.com/matthias-bs/BresserWeatherSensorReceiver/issues/139
**4)** The part number is specific to the actual variant, i.e. some more characters are appended
**5)** The value `tglobe_c` is preliminary, see https://github.com/matthias-bs/BresserWeatherSensorReceiver/issues/220
> [!NOTE]
> Weather sensors which are using the 6-in-1 protocol are actually transmitting two different kind of messages alternately:
> 1. Temperature, Humidity, Wind and Battery status
> 2. Wind and Rain
>
> All other sensors/protocols are transmitting a single type of message which contains a complete set of data.
>
> The behavior described above can be observed with [BresserWeatherSensorBasic](examples/BresserWeatherSensorBasic), which just shows each message as it is received by using the function [`getMessage()`](https://matthias-bs.github.io/BresserWeatherSensorReceiver/class_weather_sensor.html#a05fbfc16fb2e13543591cb0b3cd8baaf).
>
> The other examples are using the function [`getData()`](https://matthias-bs.github.io/BresserWeatherSensorReceiver/class_weather_sensor.html#a558191760f9d9b9bf12f79f6f3e5370a),
which buffers and combines messages from the 6-in-1 protocol until a complete set of data — with some configuration options regarding *completeness*, see [BresserWeatherSensorOptions](examples/BresserWeatherSensorOptions) — is available.
## Contents
* [Configuration](#configuration)
* [Predefined Board Configurations](#predefined-board-configurations)
* [User-Defined Configuration](#user-defined-configuration)
* [Rain Statistics](#rain-statistics)
* [Lightning Sensor Post-Processing](#lightning-Sensor-post-processing)
* [SW Examples](#sw-examples)
* [BresserWeatherSensorBasic](#bresserweathersensorbasic)
* [BresserWeatherSensorWaiting](#bresserweathersensorwaiting)
* [BresserWeatherSensorCallback](#bresserweathersensorcallback)
* [BresserWeatherSensorOptions](#bresserweathersensoroptions)
* [BresserWeatherSensorOLED](#bresserweathersensoroled)
* [BresserWeatherSensorMQTT](#bresserweathersensormqtt)
* [BresserWeatherSensorMQTTCustom](#bresserweathersensormqttcustom)
* [BresserWeatherSensorMQTTWiFiMgr](#bresserweathersensormqttwifimgr)
* [BresserWeatherSensorDomoticz](#bresserweathersensordomoticz)
* [BresserWeatherSensorM5Core2](#bresserweathersensorm5core2)
* [BresserWeatherSensorCanvasGauges](#bresserweathersensorcanvasgauges)
* [BresserWeatherSensorSDCard](#bresserweathersensorsdcard)
* [BresserWeatherSensorFreqTest](#bresserweathersensorfreqtest)
* [MQTT Integrations](#mqtt-integrations)
* [Home Assistant](#home-assistant)
* [Datacake](#datacake)
* [Debug Output Configuration](#debug-output-configuration)
* [HW Examples](#hw-examples)
* [ESP8266 D1 Mini with CC1101](#esp8266-d1-mini-with-cc1101)
* [Adafruit Feather ESP32S2 with Adafruit LoRa Radio FeatherWing](#adafruit-feather-esp32s2-with-adafruit-lora-radio-featherwing)
* [Adafruit Feather ESP32 or ThingPulse ePulse Feather with Adafruit LoRa Radio FeatherWing](#adafruit-feather-esp32-or-thingpulse-epulse-feather-with-adafruit-lora-radio-featherwing)
* [Adafruit RFM95W LoRa Radio Transceiver Breakout](#adafruit-rfm95w-lora-radio-transceiver-breakout)
* [DFRobot FireBeetle ESP32 with FireBeetle Cover LoRa Radio 868MHz](#dfrobot-firebeetle-esp32-with-firebeetle-cover-lora-radio-868mhz)
* [Antennas and RF Connectors](#antennas-and-rf-connectors)
* [Software Build Tutorial](#software-build-tutorial)
* [Source Documentation](#source-documentation)
* [Legal](#legal)
## Configuration
### Predefined Board Configurations
By selecting a Board and a Board Revision in the Arduino IDE, a define is passed to the preprocessor/compiler. For the boards in the table below, the default configuration is assumed based on this define. I.e. you could could use an Adafruit Feather ESP32-S2 with a CC1101 connected to the pins of your choice of course, but the code assumes you are using it with a LoRa Radio Featherwing with the wiring given below. In some cases (**bold** entries in the table below) an additional define has to be enabled manually in `WeatherSensorCfg.h`.
If you are not using the Arduino IDE, you can use the defines in the table below with your specific tool chain to get the same result.
If this is not what you need, you have to switch to **Manual Configuration**
| Setup | Board | Board Revision | Defines<br>bold: to be enabled manually in `WeatherSensorCfg.h` | Radio Module | Notes |
| -------------------------------------------------------------- | ------------------ | ---------------------------- | ---------------------- | -------- | ------- |
| [LILYGO®TTGO-LORA32 V1](https://github.com/Xinyuan-LilyGo/TTGO-LoRa-Series) | "TTGO LoRa32-OLED" | "TTGO LoRa32 V1 (No TFCard)" | ARDUINO_TTGO_LORA32_V1 | SX1276 (HPD13A) | - |
| [LILYGO®TTGO-LORA32 V2](https://github.com/LilyGO/TTGO-LORA32) | "TTGO LoRa32-OLED" | "TTGO LoRa32 V2" | ARDUINO_TTGO_LoRa32_V2 | SX1276 (HPD13A) | Only needed for LMIC: Wire DIO1 to GPIO33 |
| [LILYGO®TTGO-LORA32 V2.1](https://www.lilygo.cc/products/lora3?variant=42272562282677) | "TTGO LoRa32-OLED" | "TTGO LoRa32 V2.1 (1.6.1)" | ARDUINO_TTGO_LoRa32_v21new | SX1276 (HPD13A) | - |
| [LILYGO®T3 S3 SX1262](https://lilygo.cc/products/t3s3-v1-0?variant=42586879721653) | "LilyGo T3-S3" | "Radio-SX1262" | ARDUINO_LILYGO_T3S3_SX1262 | SX1262 | - |
| [LILYGO®T3 S3 LR1121](https://lilygo.cc/products/t3-s3-lr1121) | "LilyGo T3-S3" | "Radio-LR1121" | ARDUINO_LILYGO_T3S3_LR1121 | LR1121 | - |
| [Heltec Wireless Stick](https://heltec.org/project/wireless-stick/) | "Heltec Wireless Stick" | n.a. | ARDUINO_HELTEC_WIRELESS_STICK | SX1276 | - |
| [Heltec Wireless Stick V3](https://heltec.org/project/wireless-stick-v3/) | "Heltec Wireless Stick" | n.a. | ARDUINO_HELTEC_WIRELESS_STICK_V3 | SX1262 | - |
| [Heltec Wireless Stick **Lite** V3](https://heltec.org/project/wireless-stick-lite-v2/) | "Heltec Wireless Stick Lite(V3)" | n.a. | HELTEC_WIRELESS_STICK_LITE_V3 | SX1262 | - |
| [Heltec WiFi LoRa 32 V2](https://heltec.org/project/wifi-lora-32/) | "Heltec WiFi LoRa 32(V2)" | n.a. | ARDUINO_HELTEC_WIFI_LORA_32_V2 | SX1276 | - |
| [Heltec WiFi LoRa 32 V3](https://heltec.org/project/wifi-lora-32-v3/) | "Heltec WiFi LoRa 32(V3)" | n.a. | ARDUINO_HELTEC_WIFI_LORA_32_V3 | SX1262 | - |
| [Heltec WiFi LoRa 32 V4](https://heltec.org/project/wifi-lora-32-v4/) | "Heltec WiFi LoRa 32(V4)" | n.a. | ARDUINO_HELTEC_WIFI_LORA_32_V4 | SX1262 | - |
| [Adafruit Feather ESP32S2 with Adafruit LoRa Radio FeatherWing](https://github.com/matthias-bs/BresserWeatherSensorReceiver#adafruit-feather-esp32s2-with-adafruit-lora-radio-featherwing) | "Adafruit Feather ESP32-S2" | n.a. | ARDUINO_ADAFRUIT_FEATHER_ESP32S2 | SX1276 (RFM95W) | Wiring on the Featherwing:<br>E to IRQ<br>D to CS<br>C to RST<br>A to DI01 |
| [Adafruit Feather ESP32 or Adafruit Feather ESP32 V2 with Adafruit LoRa Radio FeatherWing](https://github.com/matthias-bs/BresserWeatherSensorReceiver/blob/main/README.md#adafruit-feather-esp32-or-thingpulse-epulse-feather-with-adafruit-lora-radio-featherwing) | "Adafruit ESP32 Feather"<br>"Adafruit Feather ESP32 V2" | n.a. | ARDUINO_FEATHER_ESP32 | SX1276 (RFM95W) | Wiring on the Featherwing:<br>A to RST<br>B to DIO1<br>D to IRQ<br>E to CS |
| [ThingPulse ePulse Feather with Adafruit LoRa Radio FeatherWing](https://github.com/matthias-bs/BresserWeatherSensorReceiver/blob/main/README.md#adafruit-feather-esp32-or-thingpulse-epulse-feather-with-adafruit-lora-radio-featherwing) | "Thingpulse ePulse Feather" | n.a. | ARDUINO_THINGPULSE_EPULSE_FEATHER | SX1276 (RFM95W) | Wiring on the Featherwing:<br>A to RST<br>B to DIO1<br>D to IRQ<br>E to CS |
| [DFRobot FireBeetle with FireBeetle Cover LoRa Radio 868MHz](https://github.com/matthias-bs/BresserWeatherSensorReceiver/blob/main/README.md#dfrobot-firebeetle-esp32-with-firebeetle-cover-lora-radio-868mhz) | "FireBeetle-ESP32" | n.a. | ARDUINO_DFROBOT_FIREBEETLE_ESP32 & **DFROBOT_COVER_LORA** | SX1276 (LoRa1276) | Wiring on the cover: <br>D2 to RESET<br>D3 to DIO0<br>D4 to CS<br>D5 to DIO1<br><br>Additional connections required for battery voltage measurement. |
| [M5Stack Core2](https://docs.m5stack.com/en/core/core2) with [M5Stack Module LoRa868](https://docs.m5stack.com/en/module/lora868) | "M5Core2" | n.a. | ARDUINO_M5STACK_CORE2 | SX1276<br>(RA-01H) | Only needed for LMIC - wiring on the LoRa868 Module: <br>DIO1 to GPIO35<br><br>"M5Unified" must be installed <br>`M5.begin()`is called to control power management |
| [ESP32-S3 PowerFeather](https://www.powerfeather.dev/) with [Adafruit LoRa Radio FeatherWing](https://www.adafruit.com/product/3231) | "ESP32-S3 PowerFeather" | n.a. | ARDUINO_ESP32S3_POWERFEATHER | SX1276 (RFM95W) | Wiring on the Featherwing:<br>A to RST<br>B to DIO1<br>D to IRQ<br>E to CS<br><br>"PowerFeather-SDK" must be installed<br>`Board.init();` is called to control power management |
| [Seeed Studio XIAO ESP32S3 & Wio-SX1262 Kit](https://wiki.seeedstudio.com/wio_sx1262_with_xiao_esp32s3_kit_class) | "XIAO_ESP32S3" | n.a. | ARDUINO_XIAO_ESP32S3 | SX1262 | (B2B connector) |
| [Adafruit Feather RP2040 with Adafruit LoRa Radio FeatherWing](https://www.adafruit.com/product/4884) | "Adafruit Feather RP2040" | n.a. | ARDUINO_ADAFRUIT_FEATHER_RP2040 | SX1276 (RFM95W) | Wiring on the Featherwing:<br>A to RST<br>B to DIO1<br>D to IRQ<br>E to CS<br><br>External voltage divider required for battery voltage measurement. |
The preprocessor will provide some output regarding the selected configuration if enabled in the Arduino IDE's Preferences ("Verbose Output"), e.g.
```
ARDUINO_ADAFRUIT_FEATHER_ESP32S2 defined; assuming RFM95W FeatherWing will be used
[...]
Receiver chip: [SX1276]
Pin config: RST->0 , CS->6 , GD0/G0/IRQ->5 , GDO2/G1/GPIO->11
```
> [!NOTE]
> The AVR architecture — including Adafruit Feather 32u4 RFM95 LoRa Radio — is no longer supported due to code size.
### User-Defined Configuration
See `WeatherSensorCfg.h` for configuration options.
* Set the desired radio module by (un-)commenting `USE_CC1101`, `USE_SX1262`, `USE_SX1276` or `LR1121`.
RFM95W, HPD13A and RA-01H are compatible with SX1276.
* Set the I/O pinning according to your hardware
| Define | Radio Module | Configuration |
| -------------------------- | --------------- | ---------------------------------------------------------------- |
| ESP32 | user-defined | generic, used for ESP32 boards if none of the above is defined |
| ESP8266 | user-defined | generic, used for ESP8266 boards if none of the above is defined |
* Data from multiple sensors can be received by setting `MAX_SENSORS_DEFAULT` to an appropriate value in `WeatherSensorCfg.h`.
e.g. `#define MAX_SENSORS_DEFAULT 1`
* The sensors to be handled can be configured by two ways:
* Add any unwanted sensor IDs to the exclude list `SENSOR_IDS_EXC`
e.g. `#define SENSOR_IDS_EXC { 0x39582376 }`
* Specify the wanted sensors explicitly in the include list `SENSOR_IDS_EXC` - if empty, all sensors will be used
e.g. `#define SENSOR_IDS_INC { 0x83750871 }`
* Unused decoders can be disabled to save computation time/power by commenting out:
e.g. `//#define BRESSER_LEAKAGE`
See [How Sensor Reception works](https://github.com/matthias-bs/BresserWeatherSensorReceiver/wiki/02.-How-Sensor-Reception-works) for a detailed description.
## Rain Statistics
The weather sensors transmit the accumulated rainfall since the last battery change or reset. This raw value is provided as `rain_mm`. To provide the same functionality as the original weather stations, the class `RainGauge` (see
[RainGauge.h](src/RainGauge.h))
is used to calculate
* hourly (past 60 minutes) rainfall,
* daily rainfall,
* weekly rainfall,
* and monthly rainfall.
These values are named `rain_h`, `rain_d`, `rain_w` and `rain_m` in the MQTT software examples.
> [!NOTE]
> Time and date must be set correctly in order to reset the daily, weekly and monthly rain values correctly.
> This is achieved by setting the real time clock (RTC) from an available time source, e.g. via SNTP from a network time server if the device has internet connection via WiFi.
> The user must set the appropriate time zone (`TZ_INFO`) in the sketch.
See
[Implementing Rain Gauge Statistics](https://github.com/matthias-bs/BresserWeatherSensorReceiver/wiki/04.-Implementing-Rain-Gauge-Statistics) for more details.
## Lightning Sensor Post-Processing
The lightning sensor transmits the accumul
gitextract_4l_8lmjm/ ├── .github/ │ ├── ISSUE_TEMPLATE/ │ │ ├── bug_report.md │ │ └── feature_request.md │ ├── dependabot.yml │ └── workflows/ │ ├── CI.yml │ ├── CppUTest.yml │ ├── arduino-lint.yml │ ├── doxygen.yml │ ├── spell-check-exclude.txt │ └── spell-check.yml ├── .gitignore ├── .vscode/ │ ├── arduino-cli-wrapper.sh │ ├── arduino-compile-runner.sh │ ├── arduino_compile_helper.py │ ├── serial_logger.py │ ├── serial_reset_monitor.py │ ├── settings.json │ └── tasks.json ├── BUILD.md ├── Bresser_HA_MQTT_custom_config.yaml ├── CODE_OF_CONDUCT.md ├── DEBUG_OUTPUT.md ├── Doxyfile ├── LICENSE ├── LICENSE.KeywordsTxtGenerator ├── README.md ├── copilot-instructions.md ├── docs/ │ ├── BUG_FIX_SIOF_SPICLASS.md │ ├── MQTT_REFACTORING.md │ ├── RollingCounter.md │ ├── TEST_COVERAGE_SUMMARY.md │ └── TEST_RAINGAUGE_COVERAGE.md ├── doxygen2keywords.xsl ├── examples/ │ ├── BresserWeatherSensorBasic/ │ │ ├── .gitkeep │ │ ├── BresserWeatherSensorBasic.ino │ │ └── example.log │ ├── BresserWeatherSensorCallback/ │ │ ├── .gitkeep │ │ ├── BresserWeatherSensorCallback.ino │ │ └── example.log │ ├── BresserWeatherSensorCanvasGauges/ │ │ ├── BresserWeatherSensorCanvasGauges.ino │ │ ├── config.h │ │ └── data/ │ │ ├── index.html │ │ ├── script.js │ │ └── style.css │ ├── BresserWeatherSensorDomoticz/ │ │ ├── .gitkeep │ │ ├── BresserWeatherSensorDomoticz.ino │ │ └── example.log │ ├── BresserWeatherSensorFreqTest/ │ │ ├── BresserWeatherSensorFreqTest.ino │ │ ├── README.md │ │ └── example_output.log │ ├── BresserWeatherSensorM5Core2/ │ │ ├── BresserWeatherSensorM5Core2.ino │ │ └── src/ │ │ ├── utils.cpp │ │ └── utils.h │ ├── BresserWeatherSensorMQTT/ │ │ ├── BresserWeatherSensorMQTT.ino │ │ ├── example.log │ │ └── src/ │ │ ├── mqtt_comm.cpp │ │ └── mqtt_comm.h │ ├── BresserWeatherSensorMQTTCustom/ │ │ ├── .gitkeep │ │ ├── BresserWeatherSensorMQTTCustom.ino │ │ ├── Readme.md │ │ └── src/ │ │ ├── .gitkeep │ │ ├── InitBoard.cpp │ │ ├── InitBoard.h │ │ ├── Lightning.cpp │ │ ├── Lightning.h │ │ ├── RainGauge.cpp │ │ ├── RainGauge.h │ │ ├── RollingCounter.cpp │ │ ├── RollingCounter.h │ │ ├── WeatherSensor.cpp │ │ ├── WeatherSensor.h │ │ ├── WeatherSensorCfg.h │ │ ├── WeatherSensorConfig.cpp │ │ ├── WeatherSensorDecoders.cpp │ │ ├── WeatherUtils.cpp │ │ ├── WeatherUtils.h │ │ ├── mqtt_comm.cpp │ │ └── mqtt_comm.h │ ├── BresserWeatherSensorMQTTWifiMgr/ │ │ ├── BresserWeatherSensorMQTTWifiMgr.ino │ │ └── src/ │ │ ├── mqtt_comm.cpp │ │ └── mqtt_comm.h │ ├── BresserWeatherSensorOLED/ │ │ └── BresserWeatherSensorOLED.ino │ ├── BresserWeatherSensorOptions/ │ │ ├── .gitkeep │ │ ├── BresserWeatherSensorOptions.ino │ │ └── example.log │ ├── BresserWeatherSensorSDCard/ │ │ ├── BresserWeatherSensorSDCard.ino │ │ ├── config.h │ │ └── src/ │ │ ├── utils.cpp │ │ └── utils.h │ ├── BresserWeatherSensorTest/ │ │ ├── BresserWeatherSensorTest.ino │ │ └── example.log │ ├── BresserWeatherSensorTestCfg/ │ │ └── BresserWeatherSensorTestCfg.ino │ └── BresserWeatherSensorWaiting/ │ ├── .gitkeep │ ├── BresserWeatherSensorWaiting.ino │ └── example.log ├── extras/ │ └── hw_test/ │ ├── docs/ │ │ └── flowcharts/ │ │ ├── data_storage.txt │ │ └── reception+filtering.txt │ ├── find_transmitter/ │ │ └── find_transmitter.ino │ ├── lightning/ │ │ └── lightning_tester/ │ │ ├── README.md │ │ └── lightning_tester.ino │ └── pm/ │ └── Python-Sensirion-SPS30/ │ ├── LICENSE │ ├── README.md │ ├── log_monitor.py │ └── sps30.py ├── keywords.txt ├── library.properties ├── package.json ├── scripts/ │ ├── .gitkeep │ ├── datacake_uplink_decoder.js │ └── raindata2test.pl ├── src/ │ ├── .gitkeep │ ├── InitBoard.cpp │ ├── InitBoard.h │ ├── Lightning.cpp │ ├── Lightning.h │ ├── RainGauge.cpp │ ├── RainGauge.h │ ├── RollingCounter.cpp │ ├── RollingCounter.h │ ├── WeatherSensor.cpp │ ├── WeatherSensor.h │ ├── WeatherSensorCfg.h │ ├── WeatherSensorConfig.cpp │ ├── WeatherSensorDecoders.cpp │ ├── WeatherUtils.cpp │ └── WeatherUtils.h ├── test/ │ ├── .gitignore │ ├── .gitkeep │ ├── Makefile │ ├── MakefileWorker.mk │ ├── MakefileWorkerOverrides.mk │ ├── README.md │ ├── header_overrides/ │ │ ├── Arduino.h │ │ └── Preferences.h │ ├── makefiles/ │ │ ├── .gitkeep │ │ └── Makefile_Tests.mk │ ├── mocks/ │ │ ├── WStringMock.cpp │ │ ├── WStringMock.h │ │ └── log_w_mock.h │ ├── raindata2test.pl │ ├── src/ │ │ ├── .gitkeep │ │ ├── AllTests.cpp │ │ ├── TestLightning.cpp │ │ ├── TestRainGauge.cpp │ │ ├── TestRainGaugeReal.cpp │ │ ├── TestRainGaugeReal_head.txt │ │ ├── TestRollingCounter.cpp │ │ └── TestWeatherUtils.cpp │ └── unit_test_001.cpp └── weather_sensor_receiver_config.yaml
SYMBOL INDEX (344 symbols across 47 files)
FILE: .vscode/arduino_compile_helper.py
function read_arduino_json (line 21) | def read_arduino_json(workspace):
function find_nearest_ino (line 31) | def find_nearest_ino(active_path: Path, workspace: Path):
function find_wrapper (line 46) | def find_wrapper(workspace: Path):
function write_arduino_json (line 55) | def write_arduino_json(workspace: Path, data: dict) -> None:
function detect_upload_ports (line 62) | def detect_upload_ports() -> list[str]:
function try_upload (line 70) | def try_upload(wrapper: str | None, fqbn: str | None, port: str, sketch:...
function main (line 90) | def main():
FILE: .vscode/serial_logger.py
function _workspace (line 57) | def _workspace() -> Path:
function _read_arduino_json (line 65) | def _read_arduino_json() -> dict:
function _port_stem (line 77) | def _port_stem(port: str) -> str:
function _log_filename (line 82) | def _log_filename(port: str) -> str:
function _ts_prefix (line 88) | def _ts_prefix() -> str:
function run (line 99) | def run(port: str, baud: int, reset: bool, log_dir: Path,
function main (line 205) | def main():
FILE: .vscode/serial_reset_monitor.py
function reset_board (line 25) | def reset_board(port: str, baud: int) -> int:
function main (line 47) | def main():
FILE: examples/BresserWeatherSensorCanvasGauges/data/script.js
function limitValue (line 522) | function limitValue(value, min, max) {
function formatTimestampDetailed (line 526) | function formatTimestampDetailed(ms) {
function updateLastUpdate (line 538) | function updateLastUpdate() {
function getReadings (line 545) | function getReadings() {
function sendClientTimeToDevice (line 605) | function sendClientTimeToDevice() {
FILE: examples/BresserWeatherSensorM5Core2/src/utils.cpp
function unixtime_to_iso8601 (line 55) | void unixtime_to_iso8601(char *buffer, size_t len, time_t t)
function time_t (line 71) | time_t convert_time(char const *time = __TIME__, char const *date = __DA...
function syncRTCWithExtRTC (line 101) | void syncRTCWithExtRTC(void)
function set_rtc (line 122) | void set_rtc(void)
function initLed (line 139) | void initLed(void)
function setLed (line 146) | void setLed(bool on)
FILE: examples/BresserWeatherSensorMQTT/src/mqtt_comm.cpp
function sensorName (line 86) | bool sensorName(uint32_t sensor_id, char* buf, size_t buf_size)
function messageReceived (line 101) | void messageReceived(String &topic, String &payload)
function publishWeatherdata (line 141) | void publishWeatherdata(bool complete, bool retain)
function publishRadio (line 426) | void publishRadio(void)
function haAutoDiscovery (line 440) | void haAutoDiscovery(void)
function publishStatusDiscovery (line 642) | void publishStatusDiscovery(const char* name, const char* topic)
function publishControlDiscovery (line 676) | void publishControlDiscovery(const char* name, const char* topic)
function publishAutoDiscovery (line 743) | void publishAutoDiscovery(const struct sensor_info info, const char *sen...
FILE: examples/BresserWeatherSensorMQTT/src/mqtt_comm.h
type MQTTTopics (line 76) | struct MQTTTopics {
type sensor_info (line 95) | struct sensor_info
type sensor_info (line 149) | struct sensor_info
FILE: examples/BresserWeatherSensorMQTTCustom/src/InitBoard.cpp
function initBoard (line 54) | void initBoard(void)
FILE: examples/BresserWeatherSensorMQTTCustom/src/Lightning.cpp
type tm (line 266) | struct tm
FILE: examples/BresserWeatherSensorMQTTCustom/src/Lightning.h
type nvLightning_t (line 116) | typedef struct {
function class (line 144) | class Lightning : public RollingCounter {
FILE: examples/BresserWeatherSensorMQTTCustom/src/RainGauge.cpp
type tm (line 281) | struct tm
FILE: examples/BresserWeatherSensorMQTTCustom/src/RainGauge.h
type nvData_t (line 124) | typedef struct {
function class (line 164) | class RainGauge : public RollingCounter {
FILE: examples/BresserWeatherSensorMQTTCustom/src/RollingCounter.cpp
type tm (line 50) | struct tm
type tm (line 74) | struct tm
type tm (line 171) | struct tm
FILE: examples/BresserWeatherSensorMQTTCustom/src/RollingCounter.h
function class (line 77) | class RollingCounter
FILE: examples/BresserWeatherSensorMQTTCustom/src/WeatherSensor.cpp
type WeatherSensorReceiver (line 127) | namespace WeatherSensorReceiver
function femEnable (line 178) | static void femEnable(void)
function femDisable (line 186) | static void femDisable(void)
function setFlag (line 201) | void setFlag(void)
function DecodeStatus (line 444) | DecodeStatus WeatherSensor::getMessage(void)
FILE: examples/BresserWeatherSensorMQTTCustom/src/WeatherSensor.h
function namespace (line 109) | namespace WeatherSensorReceiver {
type DecodeStatus (line 166) | typedef enum DecodeStatus {
type SensorMap (line 176) | typedef struct SensorMap {
function class (line 188) | class WeatherSensor {
type sensor_t (line 349) | typedef struct Sensor sensor_t;
type Sensor (line 510) | struct Sensor
function log_message (line 646) | void log_message(const char *descr, const uint8_t *msg, uint8_t msgSize) {
FILE: examples/BresserWeatherSensorMQTTCustom/src/WeatherSensorConfig.cpp
function String (line 172) | String WeatherSensor::getSensorsJson(std::vector<uint32_t> &ids)
function String (line 199) | String WeatherSensor::getSensorsIncJson(void)
function String (line 205) | String WeatherSensor::getSensorsExcJson(void)
FILE: examples/BresserWeatherSensorMQTTCustom/src/WeatherSensorDecoders.cpp
function DecodeStatus (line 149) | DecodeStatus WeatherSensor::decodeMessage(const uint8_t *msg, uint8_t ms...
function DecodeStatus (line 240) | DecodeStatus WeatherSensor::decodeBresser5In1Payload(const uint8_t *msg,...
function DecodeStatus (line 439) | DecodeStatus WeatherSensor::decodeBresser6In1Payload(const uint8_t *msg,...
function DecodeStatus (line 718) | DecodeStatus WeatherSensor::decodeBresser7In1Payload(const uint8_t *msg,...
function DecodeStatus (line 882) | DecodeStatus WeatherSensor::decodeBresserLightningPayload(const uint8_t ...
function DecodeStatus (line 1008) | DecodeStatus WeatherSensor::decodeBresserLeakagePayload(const uint8_t *m...
FILE: examples/BresserWeatherSensorMQTTCustom/src/WeatherUtils.cpp
function windspeed_ms_to_bft (line 36) | uint8_t windspeed_ms_to_bft(float ms)
function calcdewpoint (line 88) | float calcdewpoint(float celsius, float humidity)
function calcwindchill (line 125) | float calcwindchill(float celsius, float windspeed_ms)
function calcheatindex (line 139) | float calcheatindex(float celsius, float humidity) {
function calcnaturalwetbulb (line 153) | float calcnaturalwetbulb(float temperature, float humidity)
function calcwbgt (line 169) | float calcwbgt(float t_wet, float t_globe, float t_dry)
function calchumidex (line 179) | float calchumidex(float temperature, float humidity) {
function perceived_temperature (line 185) | float perceived_temperature(float celsius, float windspeed, float humidity)
FILE: examples/BresserWeatherSensorMQTTCustom/src/mqtt_comm.cpp
function sensorName (line 86) | bool sensorName(uint32_t sensor_id, char* buf, size_t buf_size)
function messageReceived (line 101) | void messageReceived(String &topic, String &payload)
function publishWeatherdata (line 141) | void publishWeatherdata(bool complete, bool retain)
function publishRadio (line 426) | void publishRadio(void)
function haAutoDiscovery (line 440) | void haAutoDiscovery(void)
function publishStatusDiscovery (line 642) | void publishStatusDiscovery(const char* name, const char* topic)
function publishControlDiscovery (line 676) | void publishControlDiscovery(const char* name, const char* topic)
function publishAutoDiscovery (line 743) | void publishAutoDiscovery(const struct sensor_info info, const char *sen...
FILE: examples/BresserWeatherSensorMQTTCustom/src/mqtt_comm.h
type MQTTTopics (line 76) | struct MQTTTopics {
type sensor_info (line 95) | struct sensor_info
type sensor_info (line 149) | struct sensor_info
FILE: examples/BresserWeatherSensorMQTTWifiMgr/src/mqtt_comm.cpp
function sensorName (line 86) | bool sensorName(uint32_t sensor_id, char* buf, size_t buf_size)
function messageReceived (line 101) | void messageReceived(String &topic, String &payload)
function publishWeatherdata (line 141) | void publishWeatherdata(bool complete, bool retain)
function publishRadio (line 426) | void publishRadio(void)
function haAutoDiscovery (line 440) | void haAutoDiscovery(void)
function publishStatusDiscovery (line 642) | void publishStatusDiscovery(const char* name, const char* topic)
function publishControlDiscovery (line 676) | void publishControlDiscovery(const char* name, const char* topic)
function publishAutoDiscovery (line 743) | void publishAutoDiscovery(const struct sensor_info info, const char *sen...
FILE: examples/BresserWeatherSensorMQTTWifiMgr/src/mqtt_comm.h
type MQTTTopics (line 76) | struct MQTTTopics {
type sensor_info (line 95) | struct sensor_info
type sensor_info (line 149) | struct sensor_info
FILE: examples/BresserWeatherSensorSDCard/src/utils.cpp
function setupM5StackCore2 (line 62) | void setupM5StackCore2(void)
function unixtime_to_iso8601 (line 84) | void unixtime_to_iso8601(char *buffer, size_t len, time_t t)
function time_t (line 100) | time_t convert_time(char const *time = __TIME__, char const *date = __DA...
function set_rtc (line 139) | void set_rtc(void)
function syncRTCWithExtRTC (line 181) | void syncRTCWithExtRTC(void)
function set_rtc (line 204) | void set_rtc(void)
function syncRTCWithExtRTC (line 224) | void syncRTCWithExtRTC(void)
function set_rtc (line 247) | void set_rtc(void)
function initLed (line 266) | void initLed(void)
function initLed (line 274) | void initLed(void)
function setLed (line 283) | void setLed(bool on)
function setLed (line 295) | void setLed(bool on)
FILE: extras/hw_test/pm/Python-Sensirion-SPS30/sps30.py
class SPS30 (line 38) | class SPS30:
method __init__ (line 39) | def __init__(self, port):
method start (line 43) | def start(self):
method stop (line 46) | def stop(self):
method monitor_values (line 50) | def monitor_values(self):
method read_values (line 62) | def read_values(self):
method read_serial_number (line 93) | def read_serial_number(self):
method read_firmware_version (line 116) | def read_firmware_version(self):
method close_port (line 142) | def close_port(self):
FILE: scripts/datacake_uplink_decoder.js
function Decoder (line 42) | function Decoder(topic, payload) {
FILE: src/InitBoard.cpp
function initBoard (line 54) | void initBoard(void)
FILE: src/Lightning.cpp
type tm (line 266) | struct tm
FILE: src/Lightning.h
type nvLightning_t (line 116) | typedef struct {
function class (line 144) | class Lightning : public RollingCounter {
FILE: src/RainGauge.cpp
type tm (line 281) | struct tm
FILE: src/RainGauge.h
type nvData_t (line 124) | typedef struct {
function class (line 164) | class RainGauge : public RollingCounter {
FILE: src/RollingCounter.cpp
type tm (line 50) | struct tm
type tm (line 74) | struct tm
type tm (line 171) | struct tm
FILE: src/RollingCounter.h
function class (line 77) | class RollingCounter
FILE: src/WeatherSensor.cpp
type WeatherSensorReceiver (line 127) | namespace WeatherSensorReceiver
function femEnable (line 178) | static void femEnable(void)
function femDisable (line 186) | static void femDisable(void)
function setFlag (line 201) | void setFlag(void)
function DecodeStatus (line 444) | DecodeStatus WeatherSensor::getMessage(void)
FILE: src/WeatherSensor.h
function namespace (line 110) | namespace WeatherSensorReceiver {
type DecodeStatus (line 167) | typedef enum DecodeStatus {
type SensorMap (line 177) | typedef struct SensorMap {
function class (line 189) | class WeatherSensor {
type sensor_t (line 350) | typedef struct Sensor sensor_t;
type Sensor (line 519) | struct Sensor
function log_message (line 655) | void log_message(const char *descr, const uint8_t *msg, uint8_t msgSize) {
FILE: src/WeatherSensorConfig.cpp
function String (line 173) | String WeatherSensor::getSensorsJson(std::vector<uint32_t> &ids)
function String (line 200) | String WeatherSensor::getSensorsIncJson(void)
function String (line 206) | String WeatherSensor::getSensorsExcJson(void)
FILE: src/WeatherSensorDecoders.cpp
function DecodeStatus (line 149) | DecodeStatus WeatherSensor::decodeMessage(const uint8_t *msg, uint8_t ms...
function DecodeStatus (line 240) | DecodeStatus WeatherSensor::decodeBresser5In1Payload(const uint8_t *msg,...
function DecodeStatus (line 439) | DecodeStatus WeatherSensor::decodeBresser6In1Payload(const uint8_t *msg,...
function DecodeStatus (line 718) | DecodeStatus WeatherSensor::decodeBresser7In1Payload(const uint8_t *msg,...
function DecodeStatus (line 882) | DecodeStatus WeatherSensor::decodeBresserLightningPayload(const uint8_t ...
function DecodeStatus (line 1008) | DecodeStatus WeatherSensor::decodeBresserLeakagePayload(const uint8_t *m...
FILE: src/WeatherUtils.cpp
function windspeed_ms_to_bft (line 36) | uint8_t windspeed_ms_to_bft(float ms)
function calcdewpoint (line 88) | float calcdewpoint(float celsius, float humidity)
function calcwindchill (line 125) | float calcwindchill(float celsius, float windspeed_ms)
function calcheatindex (line 139) | float calcheatindex(float celsius, float humidity) {
function calcnaturalwetbulb (line 153) | float calcnaturalwetbulb(float temperature, float humidity)
function calcwbgt (line 169) | float calcwbgt(float t_wet, float t_globe, float t_dry)
function calchumidex (line 179) | float calchumidex(float temperature, float humidity) {
function perceived_temperature (line 185) | float perceived_temperature(float celsius, float windspeed, float humidity)
FILE: test/mocks/WStringMock.cpp
function reverse (line 108) | static void reverse(char s[]) {
function itoa (line 118) | void itoa(int n, char s[]) {
function String (line 416) | String& String::copy(const char *cstr, unsigned int length) {
function String (line 426) | String& String::copy(const __FlashStringHelper *pstr, unsigned int lengt...
function String (line 442) | String& String::operator =(const String &rhs) {
function String (line 452) | String& String::operator =(String &&rval) noexcept {
function String (line 458) | String& String::operator =(const char *cstr) {
function String (line 466) | String& String::operator =(const __FlashStringHelper *pstr) {
function StringSumHelper (line 589) | StringSumHelper& operator +(const StringSumHelper &lhs, const String &rh...
function StringSumHelper (line 596) | StringSumHelper& operator +(const StringSumHelper &lhs, const char *cstr) {
function StringSumHelper (line 603) | StringSumHelper& operator +(const StringSumHelper &lhs, char c) {
function StringSumHelper (line 610) | StringSumHelper& operator +(const StringSumHelper &lhs, unsigned char nu...
function StringSumHelper (line 617) | StringSumHelper& operator +(const StringSumHelper &lhs, int num) {
function StringSumHelper (line 624) | StringSumHelper& operator +(const StringSumHelper &lhs, unsigned int num) {
function StringSumHelper (line 631) | StringSumHelper& operator +(const StringSumHelper &lhs, long num) {
function StringSumHelper (line 638) | StringSumHelper& operator +(const StringSumHelper &lhs, unsigned long nu...
function StringSumHelper (line 645) | StringSumHelper& operator +(const StringSumHelper &lhs, float num) {
function StringSumHelper (line 652) | StringSumHelper& operator +(const StringSumHelper &lhs, double num) {
function StringSumHelper (line 659) | StringSumHelper& operator +(const StringSumHelper &lhs,
function String (line 873) | String String::substring(unsigned int left, unsigned int right) const {
FILE: test/mocks/WStringMock.h
type prog_void (line 38) | typedef void prog_void;
type prog_char (line 39) | typedef char prog_char;
type prog_uchar (line 40) | typedef unsigned char prog_uchar;
type prog_int8_t (line 41) | typedef int8_t prog_int8_t;
type prog_uint8_t (line 42) | typedef uint8_t prog_uint8_t;
type prog_int16_t (line 43) | typedef int16_t prog_int16_t;
type prog_uint16_t (line 44) | typedef uint16_t prog_uint16_t;
type prog_int32_t (line 45) | typedef int32_t prog_int32_t;
type prog_uint32_t (line 46) | typedef uint32_t prog_uint32_t;
type prog_int64_t (line 47) | typedef int64_t prog_int64_t;
type prog_uint64_t (line 48) | typedef uint64_t prog_uint64_t;
function class (line 132) | class String {
function operator (line 305) | unsigned char operator ==(const String &rhs) const {
function operator (line 311) | unsigned char operator !=(const String &rhs) const {
function startsWith (line 324) | unsigned char startsWith(const char *prefix) const {
function startsWith (line 327) | unsigned char startsWith(const __FlashStringHelper *prefix) const {
function endsWith (line 332) | unsigned char endsWith(const char *suffix) const {
function endsWith (line 335) | unsigned char endsWith(const __FlashStringHelper *suffix) const {
function charAt (line 340) | char charAt(unsigned int index) const {
function String (line 380) | String substring(unsigned int beginIndex) const {
function replace (line 388) | void replace(const char *find, const String &replace) {
function replace (line 391) | void replace(const __FlashStringHelper *find, const String &replace) {
function replace (line 394) | void replace(const char *find, const char *replace) {
function replace (line 397) | void replace(const __FlashStringHelper *find, const char *replace) {
function replace (line 400) | void replace(const __FlashStringHelper *find,
type _ptr (line 418) | struct _ptr {
type _ptr (line 425) | struct _ptr
type _sso (line 427) | struct _sso {
type _ptr (line 436) | struct _ptr
type _sso (line 437) | struct _sso
function setSSO (line 449) | void setSSO(bool set) {
function setLen (line 452) | void setLen(int len) {
function setCapacity (line 459) | void setCapacity(int cap) {
function setBuffer (line 463) | void setBuffer(char *buff) {
FILE: test/src/AllTests.cpp
function main (line 30) | int main(int argc, char **argv) {
FILE: test/src/TestLightning.cpp
function setTime (line 62) | static void setTime(const char *time, tm &tm, time_t &ts)
function TEST_GROUP (line 70) | TEST_GROUP(TG_LightningBasic) {
function TEST_GROUP (line 78) | TEST_GROUP(TG_LightningHourly) {
function TEST_GROUP (line 86) | TEST_GROUP(TG_LightningHourlyRateChg) {
function TEST_GROUP (line 94) | TEST_GROUP(TG_LightningDouble) {
function TEST_GROUP (line 102) | TEST_GROUP(TG_LightningSkip) {
function TEST_GROUP (line 110) | TEST_GROUP(TG_LightningOv) {
function TEST_GROUP (line 118) | TEST_GROUP(TG_LightningStartup) {
function TEST_GROUP (line 126) | TEST_GROUP(TG_LightningIrregular) {
function TEST (line 137) | TEST(TG_LightningBasic, Test_LightningBasic) {
function TEST (line 201) | TEST(TG_LightningHourly, Test_LightningHourly) {
function TEST (line 366) | TEST(TG_LightningHourlyRateChg, Test_LightningHourlyRateChg) {
function TEST (line 551) | TEST(TG_LightningDouble, Test_LightningDouble) {
function TEST (line 594) | TEST(TG_LightningSkip, Test_LightningSkip) {
function TEST (line 772) | TEST(TG_LightningOv, Test_LightningOv) {
function TEST (line 813) | TEST(TG_LightningStartup, Test_LightningStartup) {
function TEST (line 863) | TEST(TG_LightningIrregular, Test_LightningIrregular) {
function TEST_GROUP (line 921) | TEST_GROUP(TG_LightningUpdateRate) {
function TEST (line 932) | TEST(TG_LightningUpdateRate, Test_LightningSetUpdateRateInvalid) {
FILE: test/src/TestRainGauge.cpp
function setTime (line 64) | static void setTime(const char *time, tm &tm, time_t &ts)
function TEST_GROUP (line 72) | TEST_GROUP(TestRainGaugeHour) {
function TEST_GROUP (line 80) | TEST_GROUP(TestRainGaugeHourTimeBack) {
function TEST_GROUP (line 88) | TEST_GROUP(TestRainGaugeHourShortInterval) {
function TEST_GROUP (line 96) | TEST_GROUP(TestRainGaugeHourLongInterval) {
function TEST_GROUP (line 104) | TEST_GROUP(TestRainGaugeHourExtremeInterval) {
function TEST_GROUP (line 112) | TEST_GROUP(TestRainGaugeDaily) {
function TEST_GROUP (line 120) | TEST_GROUP(TestRainGaugeWeekly) {
function TEST_GROUP (line 128) | TEST_GROUP(TestRainGaugeMonthly) {
function TEST_GROUP (line 136) | TEST_GROUP(TestRainGaugeHourOv) {
function TEST_GROUP (line 144) | TEST_GROUP(TestRainGaugeHourOvMidnight) {
function TEST_GROUP (line 152) | TEST_GROUP(TestRainGaugeHourRate10) {
function TEST_GROUP (line 160) | TEST_GROUP(TestRainGaugeDailyOv) {
function TEST_GROUP (line 168) | TEST_GROUP(TestRainGaugeWeeklyOv) {
function TEST_GROUP (line 176) | TEST_GROUP(TestRainGaugeMonthlyOv) {
function TEST_GROUP (line 184) | TEST_GROUP(TestRainGaugeStartup) {
function TEST_GROUP (line 192) | TEST_GROUP(TestRainGaugeInvReq) {
function TEST (line 204) | TEST(TestRainGaugeHour, Test_RainHour) {
function TEST (line 302) | TEST(TestRainGaugeHourTimeBack, Test_RainHourTimeBack) {
function TEST (line 338) | TEST(TestRainGaugeHourShortInterval, Test_RainHourShort) {
function TEST (line 415) | TEST(TestRainGaugeHourLongInterval, Test_RainHourLong) {
function TEST (line 480) | TEST(TestRainGaugeHourExtremeInterval, Test_RainHourExtreme) {
function TEST (line 523) | TEST(TestRainGaugeHourRate10, Test_RainHourRate10) {
function TEST (line 689) | TEST(TestRainGaugeDaily, Test_RainDaily) {
function TEST (line 734) | TEST(TestRainGaugeWeekly, Test_RainWeekly) {
function TEST (line 792) | TEST(TestRainGaugeMonthly, Test_RainMonthly) {
function TEST (line 919) | TEST(TestRainGaugeHourOv, Test_RainHourOv) {
function TEST (line 986) | TEST(TestRainGaugeHourOvMidnight, Test_RainHourOvMidnight) {
function TEST (line 1056) | TEST(TestRainGaugeDailyOv, Test_RainDailyOv) {
function TEST (line 1103) | TEST(TestRainGaugeWeeklyOv, Test_RainWeeklyOv) {
function TEST (line 1162) | TEST(TestRainGaugeMonthlyOv, Test_RainMonthlyOv) {
function TEST (line 1290) | TEST(TestRainGaugeStartup, TestRainStartup) {
function TEST (line 1328) | TEST(TestRainGaugeInvReq, TestRainInvReq) {
function TEST_GROUP (line 1338) | TEST_GROUP(TestRainGauge24Hours) {
function TEST (line 1349) | TEST(TestRainGauge24Hours, Test_Rain24Hours) {
function TEST_GROUP (line 1464) | TEST_GROUP(TestRainGaugeConstructor) {
function TEST (line 1475) | TEST(TestRainGaugeConstructor, Test_Constructor_CustomMax) {
function TEST (line 1508) | TEST(TestRainGaugeConstructor, Test_Constructor_QualityThreshold) {
function TEST_GROUP (line 1540) | TEST_GROUP(TestRainGaugeSetMax) {
function TEST (line 1551) | TEST(TestRainGaugeSetMax, Test_SetMax) {
function TEST_GROUP (line 1583) | TEST_GROUP(TestRainGaugeReset) {
function TEST (line 1594) | TEST(TestRainGaugeReset, Test_Reset_IndividualFlags) {
function TEST (line 1681) | TEST(TestRainGaugeReset, Test_Reset_24H) {
function TEST (line 1712) | TEST(TestRainGaugeReset, Test_Reset_Combined) {
function TEST (line 1747) | TEST(TestRainGaugeReset, Test_Reset_Full) {
function TEST_GROUP (line 1785) | TEST_GROUP(TestRainGaugeEdgeCases) {
function TEST (line 1796) | TEST(TestRainGaugeEdgeCases, Test_SmallMaxValue) {
function TEST (line 1820) | TEST(TestRainGaugeEdgeCases, Test_AccumulatorBoundary) {
function TEST (line 1849) | TEST(TestRainGaugeEdgeCases, Test_NoRainExtended) {
function TEST (line 1875) | TEST(TestRainGaugeEdgeCases, Test_LightContinuousRain) {
function TEST_GROUP (line 1899) | TEST_GROUP(TestRainGaugeSetUpdateRate) {
function TEST (line 1910) | TEST(TestRainGaugeSetUpdateRate, Test_SetUpdateRateInvalid) {
FILE: test/src/TestRainGaugeReal.cpp
function setTime (line 70) | static void setTime(const char *time, tm &tm, time_t &ts)
function TEST_GROUP (line 78) | TEST_GROUP(TestRainGaugePotteryFields) {
function TEST (line 90) | TEST(TestRainGaugePotteryFields, Test_PotteryFields) {
FILE: test/src/TestRollingCounter.cpp
class TestableRollingCounter (line 10) | class TestableRollingCounter : public RollingCounter {
method TestableRollingCounter (line 17) | TestableRollingCounter(float q = DEFAULT_QUALITY_THRESHOLD) : RollingC...
method hist_init (line 18) | void hist_init(int16_t value = -1) override {}
method getQualityThreshold (line 19) | float getQualityThreshold() const { return qualityThreshold; }
type PublicHistory (line 20) | struct PublicHistory {
method PublicHistory (line 25) | static PublicHistory makeHistory(int16_t* h, size_t s, uint8_t r) {
method sumHistoryPublic (line 30) | float sumHistoryPublic(const PublicHistory& ph, bool *valid = nullptr,...
function TEST_GROUP (line 36) | TEST_GROUP(RollingCounterBasics) {
function TEST (line 42) | TEST(RollingCounterBasics, DefaultConstructor) {
function TEST (line 49) | TEST(RollingCounterBasics, CustomQualityThreshold) {
function TEST (line 54) | TEST(RollingCounterBasics, CalculateIndexHourly) {
function TEST (line 63) | TEST(RollingCounterBasics, CalculateIndexSubHourly) {
function TEST (line 71) | TEST(RollingCounterBasics, MarkMissedEntriesNoCrashOnZeroRate) {
function TEST (line 78) | TEST(RollingCounterBasics, SumHistoryAllValid) {
function TEST (line 92) | TEST(RollingCounterBasics, SumHistorySomeInvalid) {
function TEST (line 113) | TEST(RollingCounterBasics, MarkMissedEntriesOutOfBounds) {
function TEST (line 136) | TEST(RollingCounterBasics, SumHistoryUpdateRateZero) {
function TEST (line 153) | TEST(RollingCounterBasics, SumHistoryUpdateRateGT60) {
function TEST (line 169) | TEST(RollingCounterBasics, SumHistoryEffectiveBinsZero) {
FILE: test/src/TestWeatherUtils.cpp
function TEST_GROUP (line 48) | TEST_GROUP(TestDewPoint) {
function TEST_GROUP (line 56) | TEST_GROUP(TestWindChill) {
function TEST_GROUP (line 64) | TEST_GROUP(TestHeatIndex) {
function TEST_GROUP (line 72) | TEST_GROUP(TestHumidex) {
function TEST_GROUP (line 80) | TEST_GROUP(TestWetBulb) {
function TEST_GROUP (line 88) | TEST_GROUP(TestWBGT) {
function TEST_GROUP (line 96) | TEST_GROUP(TestPerceivedTemp) {
function TEST_GROUP (line 104) | TEST_GROUP(TestWindConversions) {
function TEST (line 115) | TEST(TestDewPoint, Test_DewPoint_Positive) {
function TEST (line 135) | TEST(TestDewPoint, Test_DewPoint_Negative) {
function TEST (line 151) | TEST(TestDewPoint, Test_DewPoint_Extremes) {
function TEST (line 164) | TEST(TestWindChill, Test_WindChill_Normal) {
function TEST (line 184) | TEST(TestWindChill, Test_WindChill_WindSpeeds) {
function TEST (line 197) | TEST(TestHeatIndex, Test_HeatIndex_Normal) {
function TEST (line 217) | TEST(TestHeatIndex, Test_HeatIndex_Humidity) {
function TEST (line 230) | TEST(TestHumidex, Test_Humidex_Normal) {
function TEST (line 246) | TEST(TestWetBulb, Test_WetBulb_Normal) {
function TEST (line 264) | TEST(TestWBGT, Test_WBGT_Normal) {
function TEST (line 278) | TEST(TestWBGT, Test_WBGT_Weights) {
function TEST (line 290) | TEST(TestPerceivedTemp, Test_PerceivedTemp_WindChill) {
function TEST (line 304) | TEST(TestPerceivedTemp, Test_PerceivedTemp_HeatIndex) {
function TEST (line 318) | TEST(TestPerceivedTemp, Test_PerceivedTemp_Neutral) {
function TEST (line 331) | TEST(TestWindConversions, Test_Beaufort_Calm) {
function TEST (line 338) | TEST(TestWindConversions, Test_Beaufort_Light) {
function TEST (line 352) | TEST(TestWindConversions, Test_Beaufort_Moderate) {
function TEST (line 370) | TEST(TestWindConversions, Test_Beaufort_Strong) {
function TEST (line 393) | TEST(TestWindConversions, Test_Beaufort_Boundaries) {
function TEST (line 408) | TEST(TestWindConversions, Test_WindDirection_Cardinals) {
function TEST (line 431) | TEST(TestWindConversions, Test_WindDirection_Ordinals) {
function TEST (line 451) | TEST(TestWindConversions, Test_WindDirection_Secondary) {
FILE: test/unit_test_001.cpp
function setTime (line 42) | static void setTime(const char *time, tm &tm, time_t &ts)
function unittest_setup (line 48) | unittest_setup()
function unittest_teardown (line 53) | unittest_teardown()
function unittest (line 58) | unittest(test_constructor)
Condensed preview — 149 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (3,388K chars).
[
{
"path": ".github/ISSUE_TEMPLATE/bug_report.md",
"chars": 1364,
"preview": "---\nname: Bug report\nabout: Create a report to help us improve\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n**Context**\n- Whi"
},
{
"path": ".github/ISSUE_TEMPLATE/feature_request.md",
"chars": 595,
"preview": "---\nname: Feature request\nabout: Suggest an idea for this project\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n\n**Is your fea"
},
{
"path": ".github/dependabot.yml",
"chars": 676,
"preview": "# To get started with Dependabot version updates, you'll need to specify which\n# package ecosystems to update and where "
},
{
"path": ".github/workflows/CI.yml",
"chars": 7622,
"preview": "name: CI\n\non:\n push:\n branches: [ \"main\" ]\n pull_request:\n branches: [ \"main\" ]\n workflow_dispatch:\n\njobs:\n\n b"
},
{
"path": ".github/workflows/CppUTest.yml",
"chars": 1529,
"preview": "# Unit testing with CppUTest (including code coverage)\n\nname: CppUTest\n\n# Controls when the workflow will run\non:\n # Tr"
},
{
"path": ".github/workflows/arduino-lint.yml",
"chars": 262,
"preview": "name: Arduino-lint\n\non: [push, pull_request]\njobs:\n lint:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/c"
},
{
"path": ".github/workflows/doxygen.yml",
"chars": 879,
"preview": "name: Doxygen\n\non:\n push:\n branches: [ \"main\" ]\n workflow_dispatch:\n\njobs:\n doxygen:\n runs-on: ubuntu-latest\n "
},
{
"path": ".github/workflows/spell-check-exclude.txt",
"chars": 102,
"preview": " * Die Berechnung des Taupunktes erfolgt aus den Messwerten Temperatur (°C) und Luftfeuchtigkeit (%).\n"
},
{
"path": ".github/workflows/spell-check.yml",
"chars": 642,
"preview": "name: Spell Check\n\non:\n workflow_dispatch:\n push:\n branches:\n - main\n pull_request:\n branches:\n - mai"
},
{
"path": ".gitignore",
"chars": 760,
"preview": "# 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"
},
{
"path": ".vscode/arduino-cli-wrapper.sh",
"chars": 2006,
"preview": "#!/usr/bin/env bash\n# arduino-cli-wrapper.sh — wrapper to locate and run Arduino CLI from VS Code\n#\n# Purpose:\n# - Pref"
},
{
"path": ".vscode/arduino-compile-runner.sh",
"chars": 701,
"preview": "#!/usr/bin/env bash\nset -euo pipefail\nSCRIPT_DIR=\"$(cd \"$(dirname \"${BASH_SOURCE[0]}\")\" && pwd)\"\nPY=\"$SCRIPT_DIR/arduino"
},
{
"path": ".vscode/arduino_compile_helper.py",
"chars": 7430,
"preview": "#!/usr/bin/env python3\n\"\"\"\narduino_compile_helper.py\n\nHelper to determine `fqbn` and sketch path and invoke arduino-cli "
},
{
"path": ".vscode/serial_logger.py",
"chars": 8438,
"preview": "#!/usr/bin/env python3\n\"\"\"\nserial_logger.py — Serial monitor with timestamped logging.\n\nOpens a serial port, optionally "
},
{
"path": ".vscode/serial_reset_monitor.py",
"chars": 1565,
"preview": "#!/usr/bin/env python3\n\"\"\"\nserial_reset_monitor.py — Toggle DTR to reset an Arduino/ESP32 board.\n\nMonitoring and log-fil"
},
{
"path": ".vscode/settings.json",
"chars": 38,
"preview": "{\n \"cmake.configureOnOpen\": false\n}"
},
{
"path": ".vscode/tasks.json",
"chars": 5776,
"preview": "{\n \"version\": \"2.0.0\",\n \"tasks\": [\n {\n \"label\": \"Compile Arduino Sketch\",\n \"type\": \"s"
},
{
"path": "BUILD.md",
"chars": 4602,
"preview": "# SW Build\n\nTested with Arduino 1.8.19 and an empty Arduino library directory.\n\n1. Check that the required Board Manager"
},
{
"path": "Bresser_HA_MQTT_custom_config.yaml",
"chars": 7415,
"preview": "mqtt:\r\n sensor:\r\n - name: \"Temperatuur\"\r\n unique_id: \"Bresstat_temp\"\r\n state_topic: \"ESPWeather/961c/data\""
},
{
"path": "CODE_OF_CONDUCT.md",
"chars": 5223,
"preview": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participa"
},
{
"path": "DEBUG_OUTPUT.md",
"chars": 1605,
"preview": "# Debug Output Configuration in Arduino IDE\n\n## ESP32\n\n1. Select appropriate (USB-)serial port for your board\n \n !["
},
{
"path": "Doxyfile",
"chars": 112144,
"preview": "# Doxyfile 1.8.15\n\n# This file describes the settings to be used by the documentation system\n# doxygen (www.doxygen.org)"
},
{
"path": "LICENSE",
"chars": 1068,
"preview": "MIT License\n\nCopyright (c) 2022 matthias-bs\n\nPermission is hereby granted, free of charge, to any person obtaining a cop"
},
{
"path": "LICENSE.KeywordsTxtGenerator",
"chars": 6982,
"preview": " CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT\n PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUM"
},
{
"path": "README.md",
"chars": 39718,
"preview": "# BresserWeatherSensorReceiver\n[![CI](https://github.com/matthias-bs/BresserWeatherSensorReceiver/actions/workflows/CI.y"
},
{
"path": "copilot-instructions.md",
"chars": 13541,
"preview": "# GitHub Copilot Instructions for BresserWeatherSensorReceiver\n\n## Project Overview\n\n**BresserWeatherSensorReceiver** is"
},
{
"path": "docs/BUG_FIX_SIOF_SPICLASS.md",
"chars": 5049,
"preview": "# Bug Fix: Static Initialization Order Fiasco (SIOF) in SPIClass for LilyGo T3S3 Boards\n\n## Symptom\n\nRunning `BresserWea"
},
{
"path": "docs/MQTT_REFACTORING.md",
"chars": 14858,
"preview": "# MQTT Communication Refactoring Guide\n\n**Created**: February 21, 2026 \n**Last updated**: April 3, 2026 \n**Applied to*"
},
{
"path": "docs/RollingCounter.md",
"chars": 7141,
"preview": "\n# RollingCounter Class Documentation\n\n## Overview\n\n\n**What is a Rolling Counter?** \nA rolling counter is a data struct"
},
{
"path": "docs/TEST_COVERAGE_SUMMARY.md",
"chars": 5854,
"preview": "# Test Coverage Improvement Summary\n\n## Overview\nThis document summarizes the test coverage improvements made to the Bre"
},
{
"path": "docs/TEST_RAINGAUGE_COVERAGE.md",
"chars": 6329,
"preview": "# RainGauge Test Coverage Improvements\n\n## Overview\nThis document details the test coverage improvements made to RainGau"
},
{
"path": "doxygen2keywords.xsl",
"chars": 1983,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<!-- Copying and distribution of this file, with or without modif"
},
{
"path": "examples/BresserWeatherSensorBasic/.gitkeep",
"chars": 1,
"preview": "\n"
},
{
"path": "examples/BresserWeatherSensorBasic/BresserWeatherSensorBasic.ino",
"chars": 8921,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// BresserWeatherSen"
},
{
"path": "examples/BresserWeatherSensorBasic/example.log",
"chars": 1116,
"preview": "Id: [83750871] Typ: [4] Battery: [OK ] Ch: [1] Temp: [ 26.8C] Hum: [---%] Wind max: [--.-m/s] Wind avg: [--.-m/s] Wind d"
},
{
"path": "examples/BresserWeatherSensorCallback/.gitkeep",
"chars": 1,
"preview": "\n"
},
{
"path": "examples/BresserWeatherSensorCallback/BresserWeatherSensorCallback.ino",
"chars": 7498,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// BresserWeatherSen"
},
{
"path": "examples/BresserWeatherSensorCallback/example.log",
"chars": 2897,
"preview": "................................................................................................\nId: [39582376] Typ: [1]"
},
{
"path": "examples/BresserWeatherSensorCanvasGauges/BresserWeatherSensorCanvasGauges.ino",
"chars": 12617,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\r\n// BresserWeatherSe"
},
{
"path": "examples/BresserWeatherSensorCanvasGauges/config.h",
"chars": 3049,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// config.h\n//\n// Ke"
},
{
"path": "examples/BresserWeatherSensorCanvasGauges/data/index.html",
"chars": 1943,
"preview": "<!DOCTYPE html>\r\n<html>\r\n <head>\r\n <title>Bresser Weather Sensor Dashboard</title>\r\n <meta name=\"viewport\" conten"
},
{
"path": "examples/BresserWeatherSensorCanvasGauges/data/script.js",
"chars": 15826,
"preview": "// Get current sensor readings when the page loads \r\nwindow.addEventListener('load', getReadings);\r\n\r\n// send immediate"
},
{
"path": "examples/BresserWeatherSensorCanvasGauges/data/style.css",
"chars": 724,
"preview": "html {\r\n font-family: Arial, Helvetica, sans-serif; \r\n display: inline-block; \r\n text-align: center;\r\n}\r\nh1 {\r\n font"
},
{
"path": "examples/BresserWeatherSensorDomoticz/.gitkeep",
"chars": 1,
"preview": "\n"
},
{
"path": "examples/BresserWeatherSensorDomoticz/BresserWeatherSensorDomoticz.ino",
"chars": 21802,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// BresserWeatherSen"
},
{
"path": "examples/BresserWeatherSensorDomoticz/example.log",
"chars": 1340,
"preview": "\nBresserWeatherSensorDomoticz 20220815\n\nAttempting to connect to SSID: ******...connected!\nChecking wifi...\nMQTT connect"
},
{
"path": "examples/BresserWeatherSensorFreqTest/BresserWeatherSensorFreqTest.ino",
"chars": 11491,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// BresserWeatherSen"
},
{
"path": "examples/BresserWeatherSensorFreqTest/README.md",
"chars": 5270,
"preview": "# Bresser Weather Sensor Frequency Test\n\nThis example helps you find the optimal carrier frequency offset for your CC110"
},
{
"path": "examples/BresserWeatherSensorFreqTest/example_output.log",
"chars": 4959,
"preview": "========================================\nBresser Weather Sensor Frequency Test\n========================================\n"
},
{
"path": "examples/BresserWeatherSensorM5Core2/BresserWeatherSensorM5Core2.ino",
"chars": 16932,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// BresserWeatherSen"
},
{
"path": "examples/BresserWeatherSensorM5Core2/src/utils.cpp",
"chars": 4190,
"preview": "//////////////////////////////////////////////////////////////////////////////////////////////////\n// utils.cpp\n//\n// Ut"
},
{
"path": "examples/BresserWeatherSensorM5Core2/src/utils.h",
"chars": 1591,
"preview": "//////////////////////////////////////////////////////////////////////////////////////////////////\n// utils.h\n//\n// Util"
},
{
"path": "examples/BresserWeatherSensorMQTT/BresserWeatherSensorMQTT.ino",
"chars": 24018,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// BresserWeatherSen"
},
{
"path": "examples/BresserWeatherSensorMQTT/example.log",
"chars": 1428,
"preview": "\nBresserWeatherSensorMQTT 20220815\n\nAttempting to connect to SSID: ******...connected!\nChecking wifi...\nMQTT connecting."
},
{
"path": "examples/BresserWeatherSensorMQTT/src/mqtt_comm.cpp",
"chars": 38609,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// mqtt_comm.cpp\n//\n"
},
{
"path": "examples/BresserWeatherSensorMQTT/src/mqtt_comm.h",
"chars": 5705,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// mqtt_comm.h\n//\n//"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/.gitkeep",
"chars": 1,
"preview": "\n"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/BresserWeatherSensorMQTTCustom.ino",
"chars": 24049,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// BresserWeatherSen"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/Readme.md",
"chars": 1425,
"preview": "# BresserWeatherSensorMQTTCustom\nCustomized version of the example [BresserWeatherSensorMQTT](https://github.com/matthia"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/.gitkeep",
"chars": 1,
"preview": "\n"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/InitBoard.cpp",
"chars": 2628,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// InitBoard.cpp\n//\n"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/InitBoard.h",
"chars": 1615,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// InitBoard.h\n//\n//"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/Lightning.cpp",
"chars": 11128,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// Lightning.cpp\n//\n"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/Lightning.h",
"chars": 9801,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// Lightning.h\n//\n//"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/RainGauge.cpp",
"chars": 17301,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// RainGauge.cpp\n//\n"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/RainGauge.h",
"chars": 11406,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// RainGauge.h\n//\n//"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/RollingCounter.cpp",
"chars": 7404,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// RollingCounter.cp"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/RollingCounter.h",
"chars": 7779,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// RollingCounter.h\n"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/WeatherSensor.cpp",
"chars": 23312,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// WeatherSensor.cpp"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/WeatherSensor.h",
"chars": 26638,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// WeatherSensor.h\n/"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/WeatherSensorCfg.h",
"chars": 24685,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// WeatherSensorCfg."
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/WeatherSensorConfig.cpp",
"chars": 7849,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// WeatherSensorConf"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/WeatherSensorDecoders.cpp",
"chars": 43308,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// WeatherSensorDeco"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/WeatherUtils.cpp",
"chars": 5309,
"preview": "#include <Arduino.h>\n#include <math.h>\n#if defined(ESP32) || defined(ESP8266)\n #include <string>\n#endif\n#include <strin"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/WeatherUtils.h",
"chars": 2706,
"preview": "#if !defined(WEATHER_UTILS_H)\n#define WEATHER_UTILS_H\n\n#ifdef ARDUINO_ARCH_AVR\n #include <stdint.h>\n#endif\n\n/*!\n * \\bri"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/mqtt_comm.cpp",
"chars": 38609,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// mqtt_comm.cpp\n//\n"
},
{
"path": "examples/BresserWeatherSensorMQTTCustom/src/mqtt_comm.h",
"chars": 5705,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// mqtt_comm.h\n//\n//"
},
{
"path": "examples/BresserWeatherSensorMQTTWifiMgr/BresserWeatherSensorMQTTWifiMgr.ino",
"chars": 31321,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// BresserWeatherSen"
},
{
"path": "examples/BresserWeatherSensorMQTTWifiMgr/src/mqtt_comm.cpp",
"chars": 38609,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// mqtt_comm.cpp\n//\n"
},
{
"path": "examples/BresserWeatherSensorMQTTWifiMgr/src/mqtt_comm.h",
"chars": 5705,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// mqtt_comm.h\n//\n//"
},
{
"path": "examples/BresserWeatherSensorOLED/BresserWeatherSensorOLED.ino",
"chars": 6541,
"preview": "//////////////////////////////////////////////////////////////////////////////////////////////////\n// BresserWeatherSens"
},
{
"path": "examples/BresserWeatherSensorOptions/.gitkeep",
"chars": 1,
"preview": "\n"
},
{
"path": "examples/BresserWeatherSensorOptions/BresserWeatherSensorOptions.ino",
"chars": 8701,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// BresserWeatherSen"
},
{
"path": "examples/BresserWeatherSensorOptions/example.log",
"chars": 12140,
"preview": "16:31:35.893 -> 1 -- Flags: (none)\n16:31:35.893 -> --------------------------------------------------------------\n16:31:"
},
{
"path": "examples/BresserWeatherSensorSDCard/BresserWeatherSensorSDCard.ino",
"chars": 11962,
"preview": "//////////////////////////////////////////////////////////////////////////////////////////////////\n// BresserWeatherSens"
},
{
"path": "examples/BresserWeatherSensorSDCard/config.h",
"chars": 2511,
"preview": "//////////////////////////////////////////////////////////////////////////////////////////////////\n// config.h\n//\n// Con"
},
{
"path": "examples/BresserWeatherSensorSDCard/src/utils.cpp",
"chars": 8273,
"preview": "//////////////////////////////////////////////////////////////////////////////////////////////////\n// utils.cpp\n//\n// Ut"
},
{
"path": "examples/BresserWeatherSensorSDCard/src/utils.h",
"chars": 1704,
"preview": "//////////////////////////////////////////////////////////////////////////////////////////////////\n// utils.h\n//\n// Util"
},
{
"path": "examples/BresserWeatherSensorTest/BresserWeatherSensorTest.ino",
"chars": 10780,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// BresserWeatherSen"
},
{
"path": "examples/BresserWeatherSensorTest/example.log",
"chars": 1337,
"preview": "[0] Bat: [OK ] RSSI: [ -56.0dBm] Temp: [ 32.7C] Hum: [ 23%] Wmax-%] Light: [--.-Klux] \ntestData[3]\nId: [21103427] Typ: ["
},
{
"path": "examples/BresserWeatherSensorTestCfg/BresserWeatherSensorTestCfg.ino",
"chars": 2926,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// BresserWeatherSen"
},
{
"path": "examples/BresserWeatherSensorWaiting/.gitkeep",
"chars": 1,
"preview": "\n"
},
{
"path": "examples/BresserWeatherSensorWaiting/BresserWeatherSensorWaiting.ino",
"chars": 6938,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// BresserWeatherSen"
},
{
"path": "examples/BresserWeatherSensorWaiting/example.log",
"chars": 1309,
"preview": "Id: [39582376] Typ: [1] Battery: [OK ] Ch: [0] Temp: [ 21.2C] Hum: [ 93%] Wind max: [ 0.7m/s] Wind avg: [ 0.7m/s] Wind d"
},
{
"path": "extras/hw_test/docs/flowcharts/data_storage.txt",
"chars": 319,
"preview": "% mermaidchart.com\n---\ntitle: Sensor Data Storage\n---\nflowchart TB\n A[RX Data] --> B{ID already stored?} \n B -- Y "
},
{
"path": "extras/hw_test/docs/flowcharts/reception+filtering.txt",
"chars": 512,
"preview": "% mermaidchart.com\n---\ntitle: Sensor Reception and Filtering\n---\nflowchart TB\n A[Start Reception] --> B>Receive] \n "
},
{
"path": "extras/hw_test/find_transmitter/find_transmitter.ino",
"chars": 5993,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// find_transmitter."
},
{
"path": "extras/hw_test/lightning/lightning_tester/README.md",
"chars": 498,
"preview": "# Lightning Sensor Tester\n\nLightning emulator for AS3935 chips based on circuit and sketch from [AS3935 Workbook](https:"
},
{
"path": "extras/hw_test/lightning/lightning_tester/lightning_tester.ino",
"chars": 3298,
"preview": "// Arduino sketch for AS3935 lightning generator\n//\n// Configures Timer 2 to produce 500kHz output\n// Turns on and off p"
},
{
"path": "extras/hw_test/pm/Python-Sensirion-SPS30/LICENSE",
"chars": 1072,
"preview": "MIT License\n\nCopyright (c) 2020 Szymon Jakubiak\n\nPermission is hereby granted, free of charge, to any person obtaining a"
},
{
"path": "extras/hw_test/pm/Python-Sensirion-SPS30/README.md",
"chars": 66,
"preview": "Forked from https://github.com/szajakubiak/Python-Sensirion-SPS30\n"
},
{
"path": "extras/hw_test/pm/Python-Sensirion-SPS30/log_monitor.py",
"chars": 4252,
"preview": "\"\"\"\r\n Program to read and save data from Sensirion SPS30 sensor\r\n\r\n by\r\n Szymon Jakubiak\r\n Twitter: @SzymonJ"
},
{
"path": "extras/hw_test/pm/Python-Sensirion-SPS30/sps30.py",
"chars": 5413,
"preview": "\"\"\"\r\n Library to read data from Sensirion SPS30 particulate matter sensor\r\n\r\n by\r\n Szymon Jakubiak\r\n Twitter"
},
{
"path": "keywords.txt",
"chars": 3427,
"preview": "#######################################\n# Syntax Coloring Map For the current project.\n# This file was generated by doxy"
},
{
"path": "library.properties",
"chars": 560,
"preview": "name=BresserWeatherSensorReceiver\nversion=0.41.0\nauthor=Matthias Prinke <matthias-bs@web.de>\nmaintainer=Matthias Prinke "
},
{
"path": "package.json",
"chars": 1410,
"preview": "{\n \"name\": \"BresserWeatherSensorReceiver\",\n \"version\": \"0.41.0\",\n \"description\": \"Bresser 5-in-1/6-in-1/7-in-1 868 MH"
},
{
"path": "scripts/.gitkeep",
"chars": 1,
"preview": "\n"
},
{
"path": "scripts/datacake_uplink_decoder.js",
"chars": 4610,
"preview": "///////////////////////////////////////////////////////////////////////////////\n// datacake_uplink_decoder.js\n// \n// Dat"
},
{
"path": "scripts/raindata2test.pl",
"chars": 3053,
"preview": "eval 'exec perl -w -S $0 ${1+\"$@\"}'\nif 0; # not running under some shell\n\nuse strict;\nuse warnings;\nuse Time::Piece;\n\n# "
},
{
"path": "src/.gitkeep",
"chars": 1,
"preview": "\n"
},
{
"path": "src/InitBoard.cpp",
"chars": 2628,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// InitBoard.cpp\n//\n"
},
{
"path": "src/InitBoard.h",
"chars": 1615,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// InitBoard.h\n//\n//"
},
{
"path": "src/Lightning.cpp",
"chars": 11128,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// Lightning.cpp\n//\n"
},
{
"path": "src/Lightning.h",
"chars": 9801,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// Lightning.h\n//\n//"
},
{
"path": "src/RainGauge.cpp",
"chars": 17301,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// RainGauge.cpp\n//\n"
},
{
"path": "src/RainGauge.h",
"chars": 11406,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// RainGauge.h\n//\n//"
},
{
"path": "src/RollingCounter.cpp",
"chars": 7404,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// RollingCounter.cp"
},
{
"path": "src/RollingCounter.h",
"chars": 7779,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// RollingCounter.h\n"
},
{
"path": "src/WeatherSensor.cpp",
"chars": 23312,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// WeatherSensor.cpp"
},
{
"path": "src/WeatherSensor.h",
"chars": 27037,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// WeatherSensor.h\n/"
},
{
"path": "src/WeatherSensorCfg.h",
"chars": 24685,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// WeatherSensorCfg."
},
{
"path": "src/WeatherSensorConfig.cpp",
"chars": 8334,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// WeatherSensorConf"
},
{
"path": "src/WeatherSensorDecoders.cpp",
"chars": 43308,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// WeatherSensorDeco"
},
{
"path": "src/WeatherUtils.cpp",
"chars": 5309,
"preview": "#include <Arduino.h>\n#include <math.h>\n#if defined(ESP32) || defined(ESP8266)\n #include <string>\n#endif\n#include <strin"
},
{
"path": "src/WeatherUtils.h",
"chars": 2702,
"preview": "#if !defined(WEATHER_UTILS_H)\n#define WEATHER_UTILS_H\n\n#ifdef ARDUINO_ARCH_AVR\n #include <stdint.h>\n#endif\n\n/*!\n * \\bri"
},
{
"path": "test/.gitignore",
"chars": 7,
"preview": "build/\n"
},
{
"path": "test/.gitkeep",
"chars": 1,
"preview": "\n"
},
{
"path": "test/Makefile",
"chars": 1382,
"preview": "# Convenience defines that can be used by individual tests in makefiles/\nexport UNITTEST_BUILD_DIR = build\nexport PROJEC"
},
{
"path": "test/MakefileWorker.mk",
"chars": 18816,
"preview": "#---------\n#\n# MakefileWorker.mk\n#\n# Include this helper file in your makefile\n# It makes\n# A static library\n# A t"
},
{
"path": "test/MakefileWorkerOverrides.mk",
"chars": 2187,
"preview": "# where the CppUTest includes and *.a are located\n\n# Uncomment the following values depending on which system\n# This is "
},
{
"path": "test/README.md",
"chars": 5258,
"preview": "# Unit Tests for BresserWeatherSensorReceiver\n\nThis directory contains comprehensive unit tests for the BresserWeatherSe"
},
{
"path": "test/header_overrides/Arduino.h",
"chars": 287,
"preview": "#include \"WStringMock.h\"\n\n#define RTC_DATA_ATTR static\n#define log_e(...) { printf(__VA_ARGS__); printf(\"\\n\"); }\n#define"
},
{
"path": "test/header_overrides/Preferences.h",
"chars": 27,
"preview": "// Intentionally left empty"
},
{
"path": "test/makefiles/.gitkeep",
"chars": 1,
"preview": "\n"
},
{
"path": "test/makefiles/Makefile_Tests.mk",
"chars": 517,
"preview": "COMPONENT_NAME=RainGauge\n\nSRC_FILES = \\\n $(PROJECT_SRC_DIR)/RollingCounter.cpp \\\n $(PROJECT_SRC_DIR)/RainGauge.cpp \\\n "
},
{
"path": "test/mocks/WStringMock.cpp",
"chars": 24364,
"preview": "/*\n WString.cpp - String library for Wiring & Arduino\n ...mostly rewritten by Paul Stoffregen...\n Copyright (c) 2009-10 "
},
{
"path": "test/mocks/WStringMock.h",
"chars": 18293,
"preview": "/*\n WString.h - String library for Wiring & Arduino\n ...mostly rewritten by Paul Stoffregen...\n Copyright (c) 2009-10 He"
},
{
"path": "test/mocks/log_w_mock.h",
"chars": 238,
"preview": "#ifndef LOG_W_MOCK_H\n#define LOG_W_MOCK_H\n\n\n// Simple stub for log_w macro for unit testing: print to stdout\n#include <c"
},
{
"path": "test/raindata2test.pl",
"chars": 4706,
"preview": "###################################################################################################\n# raindata2test.pl\n#"
},
{
"path": "test/src/.gitkeep",
"chars": 1,
"preview": "\n"
},
{
"path": "test/src/AllTests.cpp",
"chars": 1742,
"preview": "/*\n * Copyright (c) 2007, Michael Feathers, James Grenning and Bas Vodde\n * All rights reserved.\n *\n * Redistribution an"
},
{
"path": "test/src/TestLightning.cpp",
"chars": 23243,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// TestLightning.cpp"
},
{
"path": "test/src/TestRainGauge.cpp",
"chars": 55494,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// TestRainGauge.cpp"
},
{
"path": "test/src/TestRainGaugeReal.cpp",
"chars": 1964178,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// TestRainGauge.cpp"
},
{
"path": "test/src/TestRainGaugeReal_head.txt",
"chars": 2748,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// TestRainGauge.cpp"
},
{
"path": "test/src/TestRollingCounter.cpp",
"chars": 6090,
"preview": "// TestRollingCounter.cpp\n// Unit tests for RollingCounter base class\n//\n#include <CppUTest/TestHarness.h>\n#include \"Rol"
},
{
"path": "test/src/TestWeatherUtils.cpp",
"chars": 11859,
"preview": "///////////////////////////////////////////////////////////////////////////////////////////////////\n// TestWeatherUtils."
},
{
"path": "test/unit_test_001.cpp",
"chars": 1664,
"preview": "//\n// FILE: unit_test_001.cpp\n// AUTHOR: Rob Tillaart\n// DATE: 2020-12-27\n// PURPOSE: unit tests for the MCP4725\n"
},
{
"path": "weather_sensor_receiver_config.yaml",
"chars": 1167,
"preview": "# weather_sensor_receiver_config.yaml\n#\n# - Add the following to your configuration.yaml file\n# - Replace the AAAE6C wit"
}
]
About this extraction
This page contains the full source code of the matthias-bs/BresserWeatherSensorReceiver GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 149 files (3.1 MB), approximately 825.4k tokens, and a symbol index with 344 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.