|
TMC9660 Driver 0.1.0
API reference
|
Optional ESP-IDF layer: a Config built from the CONFIG_TMC9660_* Kconfig options.
More...
#include "tmc9660_types.hpp"Go to the source code of this file.
Namespaces | |
| namespace | tmc9660 |
The TMC9660 driver: everything it declares lives here; internals in detail. | |
Macros | |
| #define | CONFIG_TMC9660_DEVICE_ADDRESS 1 |
| #define | CONFIG_TMC9660_BOOT_TIMEOUT_MS 500 |
Functions | |
| constexpr Config | tmc9660::KconfigDefaults () noexcept |
The configuration menuconfig selected, on top of the Config{} defaults. | |
Optional ESP-IDF layer: a Config built from the CONFIG_TMC9660_* 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 Config{} default, so KconfigDefaults() equals Config{}.
Kconfig writes a bool option set to "n" as an absent macro, so an absent option means off.
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 (handbook KB-CPP20-018).
| #define CONFIG_TMC9660_BOOT_TIMEOUT_MS 500 |
Wait for the chip after a reset when Kconfig does not set it.
| #define CONFIG_TMC9660_DEVICE_ADDRESS 1 |
UART device address when Kconfig does not set it: 1, the chip's default.