|
FDO2 Driver 0.1.0
API reference
|
Optional ESP-IDF layer: a Config built from the CONFIG_FDO2_* Kconfig options.
More...
#include "fdo2_types.hpp"Go to the source code of this file.
Namespaces | |
| namespace | fdo2 |
The FDO2 driver: everything it declares lives here; internals in detail. | |
Macros | |
| #define | CONFIG_FDO2_POWER_UP_MS 1500 |
| #define | CONFIG_FDO2_MEASUREMENT_MS 300 |
| #define | CONFIG_FDO2_RETRIES 1 |
| #define | CONFIG_FDO2_MAX_FLASH_WRITES 8 |
Functions | |
| constexpr Config | fdo2::KconfigDefaults () noexcept |
The configuration menuconfig selected, on top of the defaults of Config{}. | |
Optional ESP-IDF layer: a Config built from the CONFIG_FDO2_* Kconfig options.
Include this header only where you want menuconfig to choose the defaults; the driver never includes it and no driver signature depends on it. Under ESP-IDF the values come from sdkconfig.h. Without Kconfig every option falls back to the default of Config{}, so KconfigDefaults() equals Config{}.
Kconfig writes a bool option set to "n" as an absent macro, so an absent option means off in both cases.
One configuration per program: the inline function below depends on the CONFIG_ macros, so every translation unit of one program must see the same values (ESP-IDF has one sdkconfig.h per build; each host test is its own program). No driver or library header includes this one (handbook KB-CPP20-018).
| #define CONFIG_FDO2_MAX_FLASH_WRITES 8 |
Flash-writing calls per driver lifetime when Kconfig does not set it.
| #define CONFIG_FDO2_MEASUREMENT_MS 300 |
Measurement allowance in milliseconds when Kconfig does not set it.
| #define CONFIG_FDO2_POWER_UP_MS 1500 |
Power-up wait in milliseconds when Kconfig does not set it: Config{}.power_up_ms.
| #define CONFIG_FDO2_RETRIES 1 |
Extra attempts of an idempotent read when Kconfig does not set it.