# sparkfun/sparkfun_autodriver_arduino_library architecture

> Architecture diagram of the GitHub repository sparkfun/sparkfun_autodriver_arduino_library, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sparkfun/sparkfun_autodriver_arduino_library
- Repository: https://github.com/sparkfun/sparkfun_autodriver_arduino_library

## Overview

This is an Arduino library for controlling an L6470-based bipolar stepper driver. An Arduino application uses the AutoDriver API to issue motion commands or configure the driver; the library converts user-facing speed and acceleration values, accesses device registers, and communicates with the hardware over SPI. The excerpts show configuration and command paths into shared register/transfer helpers. The SPI transfer implementation is only partially shown, so its connection to the Arduino SPI dependency is not asserted here.

Main entry points: [`src/SparkFunAutoDriverSupport.cpp`](https://github.com/sparkfun/sparkfun_autodriver_arduino_library/blob/master/src/SparkFunAutoDriverSupport.cpp) (Register access), [`src/SparkFunAutoDriverCommands.cpp`](https://github.com/sparkfun/sparkfun_autodriver_arduino_library/blob/master/src/SparkFunAutoDriverCommands.cpp) (Motion commands), [`src/SparkFunAutoDriverConfig.cpp`](https://github.com/sparkfun/sparkfun_autodriver_arduino_library/blob/master/src/SparkFunAutoDriverConfig.cpp) (Driver configuration), [`src/SparkFunAutoDriver.h`](https://github.com/sparkfun/sparkfun_autodriver_arduino_library/blob/master/src/SparkFunAutoDriver.h) (AutoDriver interface)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["AutoDriver API"]
  node_api_decl["AutoDriver interface"]
  node_command_constants["L6470 constants"]
end

subgraph group_control["Motion and setup"]
  node_motion["Motion commands"]
  node_configuration["Driver configuration"]
end

subgraph group_protocol["Device protocol"]
  node_unit_conversion["Unit conversion"]
  node_register_access["Register access"]
end

node_arduino_app(("Arduino application"))
node_driver["L6470 driver"]

node_arduino_app -.->|"uses API"| node_api_decl
node_motion -->|"converts speed"| node_unit_conversion
node_motion -->|"transfers commands"| node_register_access
node_configuration -->|"reads and writes"| node_register_access
node_register_access -.->|"accesses registers"| node_driver

click node_api_decl "https://github.com/sparkfun/sparkfun_autodriver_arduino_library/blob/master/src/SparkFunAutoDriver.h"
click node_motion "https://github.com/sparkfun/sparkfun_autodriver_arduino_library/blob/master/src/SparkFunAutoDriverCommands.cpp"
click node_configuration "https://github.com/sparkfun/sparkfun_autodriver_arduino_library/blob/master/src/SparkFunAutoDriverConfig.cpp"
click node_unit_conversion "https://github.com/sparkfun/sparkfun_autodriver_arduino_library/blob/master/src/SparkFunAutoDriverSupport.cpp"
click node_register_access "https://github.com/sparkfun/sparkfun_autodriver_arduino_library/blob/master/src/SparkFunAutoDriverSupport.cpp"
click node_command_constants "https://github.com/sparkfun/sparkfun_autodriver_arduino_library/blob/master/src/SparkFundSPINConstants.h"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_api_decl,node_command_constants toneBlue
class node_motion,node_configuration toneAmber
class node_unit_conversion,node_register_access toneMint
class node_arduino_app,node_driver toneIndigo
```

## Components

### AutoDriver API

- [AutoDriver interface](https://github.com/sparkfun/sparkfun_autodriver_arduino_library/blob/master/src/SparkFunAutoDriver.h): `src/SparkFunAutoDriver.h`
- [L6470 constants](https://github.com/sparkfun/sparkfun_autodriver_arduino_library/blob/master/src/SparkFundSPINConstants.h): `src/SparkFundSPINConstants.h`

### Motion and setup

- [Motion commands](https://github.com/sparkfun/sparkfun_autodriver_arduino_library/blob/master/src/SparkFunAutoDriverCommands.cpp): `src/SparkFunAutoDriverCommands.cpp`
- [Driver configuration](https://github.com/sparkfun/sparkfun_autodriver_arduino_library/blob/master/src/SparkFunAutoDriverConfig.cpp): `src/SparkFunAutoDriverConfig.cpp`

### Device protocol

- [Unit conversion](https://github.com/sparkfun/sparkfun_autodriver_arduino_library/blob/master/src/SparkFunAutoDriverSupport.cpp): `src/SparkFunAutoDriverSupport.cpp`
- [Register access](https://github.com/sparkfun/sparkfun_autodriver_arduino_library/blob/master/src/SparkFunAutoDriverSupport.cpp): `src/SparkFunAutoDriverSupport.cpp`

### Other components

- **Arduino application**
- **L6470 driver**

## Connections

- Arduino application → AutoDriver interface: uses API
- Motion commands → Unit conversion: converts speed (evidence: `src/SparkFunAutoDriverCommands.cpp`)
- Motion commands → Register access: transfers commands (evidence: `src/SparkFunAutoDriverCommands.cpp`)
- Driver configuration → Register access: reads and writes (evidence: `src/SparkFunAutoDriverConfig.cpp`)
- Register access → L6470 driver: accesses registers
