|
TMC5160 Driver 0.1.0
API reference
|
| ▼Ntmc5160 | The TMC5160 driver: everything it declares lives here; internals in detail |
| ▼Nreg | The TMC5160 register map |
| CRegInfo | What the driver knows about one register |
| CAckSet | A set of acknowledgements |
| CBeginReport | What start-up learned about the chip |
| CBoard | The power stage as built: the sense resistor and the supply |
| CBridge | Gate driver settings (DRV_CONF, section 6.1 page 35); written only when declared |
| CCheckedConfig | A configuration proven valid at build time |
| CChopper | Chopper configuration (CHOPCONF, section 6.5.2 page 51) |
| CClock | The clock: internal 12 MHz or an external clock on CLK (page 119) |
| CConfig | Everything EnsureInitialized() writes to the chip. See docs/configuration.md |
| CCoolStep | CoolStep (COOLCONF, section 13, page 87) |
| CCurrent | Run and hold current requests, RMS in mA; PlanCurrent() turns them into registers |
| CDcStep | DcStep (VDCMIN, DCCTRL, section 17, page 100) |
| CDiag | DIAG0 and DIAG1 outputs (GCONF bits 5 to 13, section 6.1 page 32) |
| CDriverStatus | DRV_STATUS, decoded (page 56) |
| CEncoder | Incremental encoder (ABN), written only when declared |
| CEncoderScale | The ENC_CONST accumulation factor (page 45, 107) |
| CEncoderStatus | ENC_STATUS, decoded (page 45) |
| CEvents | What Service() found and cleared |
| CFlags | General flags (GCONF) |
| CGlobalStatus | GSTAT, decoded (page 33) |
| CInputPins | IOIN, decoded (page 34) |
| CMicrostepCurrents | MSCURACT, decoded (page 47): the unscaled microstep currents, -255 to 255 |
| CMicrostepTable | A microstep table (MSLUT, MSLUTSEL, MSLUTSTART, section 6.5 page 47) |
| CMotor | The motor as its data sheet declares it; the current ceiling comes from here |
| CNEvent | Encoder N-channel event conditions (ENCMODE, page 46) |
| COffsets | OFFSET_READ, decoded (page 36) |
| COtpImage | OTP_READ, decoded (page 35, 37) |
| CProtection | Short protection (SHORT_CONF, section 11.2 page 78); written only when declared |
| CRampProfile | The six-point ramp (page 40). Defaults are the datasheet's quick-start values (page 116) |
| CRampStatus | RAMP_STAT, decoded (page 44) |
| CResult | The value of a call, or why there is none |
| CResult< void > | The result of a call that returns no value |
| CSnapshot | One pipelined batch of the values a monitor wants together |
| CSpiInterface | CRTP base of the platform SPI port |
| CSpiOptions | The SPI options (used by an SPI port only) |
| CStallGuard | StallGuard2 (COOLCONF, section 13, page 87) |
| CStandstill | Standstill behaviour (IHOLD_IRUN.IHOLDDELAY, TPOWERDOWN, GCONF.faststandstill) |
| CStealthChop | StealthChop settings (PWMCONF, GCONF.en_pwm_mode, section 6.5.2 page 54) |
| CStealthChopState | PWM_SCALE and PWM_AUTO, decoded (page 48) |
| CSwitches | Reference switches and stop behaviour (SW_MODE, page 43) |
| CThresholds | Velocity thresholds as TSTEP values (page 39); 0 disables |
| CTMC5160 | Driver for one TMC5160 on a platform port |
| CUartInterface | CRTP base of the platform UART port |
| CUartOptions | The UART options (used by a UART port only) |
| RAnyPort | Satisfied by a port of exactly one bus kind |
| RSpiPort | Satisfied by a class that derives from SpiInterface<Port> and implements the required hooks with exactly the types above, noexcept (KB-CPP20-006) |
| RUartPort | Satisfied by a class that derives from UartInterface<Port> and implements the required hooks with exactly the types above |