TMC5160 Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Classes | Namespaces
tmc5160_status.hpp File Reference

Decoded status registers of the TMC5160 and the pure decoders and encoders that build and read register words. More...

#include <array>
#include <cstdint>
#include "tmc5160_registers.hpp"
#include "tmc5160_types.hpp"
#include "tmc5160_units.hpp"

Go to the source code of this file.

Classes

struct  tmc5160::GlobalStatus
 GSTAT, decoded (page 33). More...
 
struct  tmc5160::DriverStatus
 DRV_STATUS, decoded (page 56). More...
 
struct  tmc5160::RampStatus
 RAMP_STAT, decoded (page 44). More...
 
struct  tmc5160::EncoderStatus
 ENC_STATUS, decoded (page 45). More...
 
struct  tmc5160::InputPins
 IOIN, decoded (page 34). More...
 
struct  tmc5160::Offsets
 OFFSET_READ, decoded (page 36). More...
 
struct  tmc5160::OtpImage
 OTP_READ, decoded (page 35, 37). More...
 
struct  tmc5160::StealthChopState
 PWM_SCALE and PWM_AUTO, decoded (page 48). More...
 
struct  tmc5160::MicrostepCurrents
 MSCURACT, decoded (page 47): the unscaled microstep currents, -255 to 255. More...
 
struct  tmc5160::Events
 What Service() found and cleared. More...
 
struct  tmc5160::Snapshot
 One pipelined batch of the values a monitor wants together. More...
 
struct  tmc5160::BeginReport
 What start-up learned about the chip. More...
 

Namespaces

namespace  tmc5160
 The TMC5160 driver: everything it declares lives here; internals in detail.
 

Detailed Description

Decoded status registers of the TMC5160 and the pure decoders and encoders that build and read register words.

Everything here is constexpr and free of I/O. The encoders turn a Config into the exact register word the chip receives, with every reserved bit 0 (section 6, pages 31 to 56).