Repository navigation
Expand file tree
/
Copy pathversions.yml
More file actions
53 lines (49 loc) · 2.89 KB
/
Copy pathversions.yml
File metadata and controls
53 lines (49 loc) · 2.89 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# The version facts of this documentation, in ONE place (the same system as Source-Robotics/par6).
#
# Edit them here, never in a page. hooks/versions.py writes them into each document's version box
# (<!-- doc-meta: KEY --> on its landing page) and into the list of documents (<!-- documents-table -->), and the
# publishing workflow reads docs_version. README.md, "Versions and releases", says when to change what.
# The documentation version: the STEPFOC firmware release these pages describe. The publishing workflow publishes
# the site under this name (the version selector in the header) and points "latest" at it. Older firmware releases
# keep their own version of the site (103 is the last release from the main branch, before the bootloader).
docs_version: "110"
# The firmware release the pages describe, and the generated pages come from. Its tag must be V<docs_version>.
# Releases are cut from the bootloader-version branch (see the firmware repository's release_guide.md).
firmware:
repository: https://github.com/Source-Robotics/STEPFOC-stepper-controller
tag: V110
# The firmware's source folder in that repository, and its Controller_mode numbers with their names (for the
# "enters mode" column of the UART reference). tools/sync_firmware.py reads both.
src: STEPFOC firmware/src
modes: {0: idle, 1: position, 2: velocity, 3: current, 4: PD, 5: open loop, 6: voltage torque,
7: gripper calibration, 8: HALL, 9: angle-offset calibration, 10: open-loop steps, 11: gripper,
12: encoder table}
# The date of the GitHub release of that tag (the downloads page writes it beside the version); null until then.
released: 2026-11-13
# The other software the pages describe, at the version they describe. The downloads page links each at its tag
# (<!-- version-link: software.KEY -->); the compatibility table says which versions work with which firmware.
software:
python_library:
name: Spectral-BLDC Python library
repository: https://github.com/Source-Robotics/Spectral-BLDC-Python
tag: v1.22
version: "1.22"
released: 2026-11-13
bootloader:
name: stm32f103c-bootloader
repository: https://github.com/Source-Robotics/stm32f103c-bootloader
tag: V0.1
released: 2026-06-05
# One entry per document. revision: YEAR.LETTER, a new letter for every published revision of that document.
# status: draft until the document is published; published: the date of the revision's publication, or null.
# firmware: true for a document that describes one firmware release (docs_version) and shows it in its version box.
manuals:
stepfoc:
number: SR-5001
title: STEPFOC Manual
revision: 2026.C
status: published
published: 2026-11-13
firmware: true
applies_to: STEPFOC driver PCB v1
covers: "the STEPFOC stepper driver: quick start, safety, technical data, mounting, setup with Motor GUI or a terminal, operation, firmware; the API reference; guides"