|
TMC9660 Driver 0.1.0
API reference
|
TMC9660 driver: the one header to include. More...
#include <algorithm>#include <array>#include <bit>#include <concepts>#include <cstddef>#include <cstdint>#include <limits>#include <span>#include <type_traits>#include <utility>#include "tmc9660_bootconfig.hpp"#include "tmc9660_detail.hpp"#include "tmc9660_frames.hpp"#include "tmc9660_globals.hpp"#include "tmc9660_params.hpp"#include "tmc9660_registers.hpp"#include "tmc9660_spi_interface.hpp"#include "tmc9660_types.hpp"#include "tmc9660_uart_interface.hpp"#include "tmc9660_version.h"#include "../src/tmc9660.ipp"Go to the source code of this file.
Classes | |
| struct | tmc9660::BlWriteOptions |
Options of TMC9660::BlWriteConfig(). More... | |
| struct | tmc9660::TmclInstruction |
| One instruction of a script download. More... | |
| struct | tmc9660::GateDriverRegConfig |
| Gate-driver start-up of register mode: the words of the manual's start sequence. More... | |
| struct | tmc9660::LastReply |
The last parameter-mode reply as received (see TMC9660::GetLastReply()). More... | |
| class | tmc9660::TMC9660< Port > |
| Driver for one TMC9660 on a platform port. More... | |
Namespaces | |
| namespace | tmc9660 |
The TMC9660 driver: everything it declares lives here; internals in detail. | |
Concepts | |
| concept | tmc9660::AnyPort |
Satisfied by a port that derives from exactly one of SpiInterface and UartInterface. | |
Enumerations | |
| enum class | tmc9660::MemQuery : uint8_t { tmc9660::Configured = 0 , tmc9660::Connected , tmc9660::Busy } |
| Queries about the external memory of the bootloader. More... | |
| enum class | tmc9660::PowerDownTime : uint8_t { tmc9660::Ms250 = 0 , tmc9660::Ms500 , tmc9660::S1 , tmc9660::S2 , tmc9660::S4 , tmc9660::S8 , tmc9660::S16 , tmc9660::S32 } |
Power-down durations of TMC9660::PowerDown() (global parameter 11). More... | |
TMC9660 driver: the one header to include.
tmc9660::TMC9660<Port> drives one TMC9660 servo controller and gate driver through a platform port you write (see tmc9660_spi_interface.hpp and tmc9660_uart_interface.hpp). The driver has no platform code, allocates nothing, throws nothing, takes no lock and is not thread-safe: give each object one owner, or guard it with one mutex.