TMC5160 Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
 ▼Ntmc5160The TMC5160 driver: everything it declares lives here; internals in detail
 ▼NregThe TMC5160 register map
 CRegInfoWhat the driver knows about one register
 ▼Nunits
 CCurrentPlanThe registers a current request turns into (page 36, 38)
 CAckSetA set of acknowledgements
 CBeginReportWhat start-up learned about the chip
 CBoardThe power stage as built: the sense resistor and the supply
 CBridgeGate driver settings (DRV_CONF, section 6.1 page 35); written only when declared
 CCheckedConfigA configuration proven valid at build time
 CChopperChopper configuration (CHOPCONF, section 6.5.2 page 51)
 CClockThe clock: internal 12 MHz or an external clock on CLK (page 119)
 CConfigEverything EnsureInitialized() writes to the chip. See docs/configuration.md
 CCoolStepCoolStep (COOLCONF, section 13, page 87)
 CCurrentRun and hold current requests, RMS in mA; PlanCurrent() turns them into registers
 CDcStepDcStep (VDCMIN, DCCTRL, section 17, page 100)
 CDiagDIAG0 and DIAG1 outputs (GCONF bits 5 to 13, section 6.1 page 32)
 CDriverStatusDRV_STATUS, decoded (page 56)
 CEncoderIncremental encoder (ABN), written only when declared
 CEncoderScaleThe ENC_CONST accumulation factor (page 45, 107)
 CEncoderStatusENC_STATUS, decoded (page 45)
 CEventsWhat Service() found and cleared
 CFlagsGeneral flags (GCONF)
 CGlobalStatusGSTAT, decoded (page 33)
 CInputPinsIOIN, decoded (page 34)
 CMicrostepCurrentsMSCURACT, decoded (page 47): the unscaled microstep currents, -255 to 255
 CMicrostepTableA microstep table (MSLUT, MSLUTSEL, MSLUTSTART, section 6.5 page 47)
 CMotorThe motor as its data sheet declares it; the current ceiling comes from here
 CNEventEncoder N-channel event conditions (ENCMODE, page 46)
 COffsetsOFFSET_READ, decoded (page 36)
 COtpImageOTP_READ, decoded (page 35, 37)
 CProtectionShort protection (SHORT_CONF, section 11.2 page 78); written only when declared
 CRampProfileThe six-point ramp (page 40). Defaults are the datasheet's quick-start values (page 116)
 CRampStatusRAMP_STAT, decoded (page 44)
 CResultThe value of a call, or why there is none
 CResult< void >The result of a call that returns no value
 CSnapshotOne pipelined batch of the values a monitor wants together
 CSpiInterfaceCRTP base of the platform SPI port
 CSpiOptionsThe SPI options (used by an SPI port only)
 CStallGuardStallGuard2 (COOLCONF, section 13, page 87)
 CStandstillStandstill behaviour (IHOLD_IRUN.IHOLDDELAY, TPOWERDOWN, GCONF.faststandstill)
 CStealthChopStealthChop settings (PWMCONF, GCONF.en_pwm_mode, section 6.5.2 page 54)
 CStealthChopStatePWM_SCALE and PWM_AUTO, decoded (page 48)
 CSwitchesReference switches and stop behaviour (SW_MODE, page 43)
 CThresholdsVelocity thresholds as TSTEP values (page 39); 0 disables
 CTMC5160Driver for one TMC5160 on a platform port
 CUartInterfaceCRTP base of the platform UART port
 CUartOptionsThe UART options (used by a UART port only)