Skip to content

Commit e3c7901

Browse files
Merge pull request #2 from PCrnjak/main
small link updates
2 parents 8d73d72 + f78a884 commit e3c7901

12 files changed

Lines changed: 37 additions & 33 deletions
File renamed without changes.
File renamed without changes.
File renamed without changes.

‎docs/can.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Node with smallest Node ID is strongest in CAN bus arbitration.
2121

2222
**If you want to learn more about CAN bus we recommend you read this [article!]()**
2323

24-
**This page describes can protocol; Go to [CAN bus guide](https://source-robotics.github.io/Spectral-BLDC-docs/Guides/CAN%20bus%20guide/) for hardware setup and examples** <br />
24+
**This page describes can protocol**<br />
2525
**You can use our [Python CAN bus API](https://github.com/PCrnjak/Spectral-BLDC-Python/tree/main) to communicate with your Spectral BLDC controllers!** <br />
2626
**If you want to se more examples on how to write Python scripts to control your motor over CAN [check this guide!](https://source-robotics.github.io/Spectral-BLDC-docs/Guides/Python%20guide/)**
2727

‎docs/flashing_firmware.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
## **Flashing using visual studio code**
3232
Download visual studio code: [Link](https://code.visualstudio.com/download)<br />
3333

34-
1. Open [Spectral BLDC firmware](https://github.com/PCrnjak/Spectral-Micro-BLDC-controller/tree/main/Spectral%20BLDC%20Firmware) folder in VS code. (You need to have platformio installed)
34+
1. Open [STEPFOC firmware](https://github.com/PCrnjak/STEPFOC-stepper-controller/tree/main/STEPFOC%20firmware) folder in VS code. (You need to have platformio installed)
3535
2. Press uplaod in VS code (Bottom left corner in VS code)
3636
<p align="left"> <img src="../assets/VSUPLOAD.png" alt="drawing" width="800"/> <br /> </p>
3737

@@ -43,7 +43,7 @@ Download STM32 ST-LINK utility [Link](https://www.st.com/en/development-tools/st
4343
!!! Note annotate "HEX and binaries"
4444
Using STM32 ST-LINK Utility you can flash only Binary or HEX files. These can be obtained from compiling source code of spectral BLDC firmware
4545

46-
**Open STM32 ST-LINK utility Drag and drop the [binary file](https://github.com/PCrnjak/Spectral-Micro-BLDC-controller/tree/main/Binaries) inside.**
46+
**Open STM32 ST-LINK utility Drag and drop the [binary file](https://github.com/PCrnjak/STEPFOC-stepper-controller/tree/main/Binaries) inside.**
4747

4848
<p align="left"> <img src="../assets/stlink2.PNG" alt="drawing" width="700"/> <br /> </p>
4949

‎docs/getting_started.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
## **Spectral Micro BLDC driver**
44

5-
You can buy a STEPFOC starter kit here: [Link](https://source-robotics.com/products/spectral-micro-bldc-starter-kit) <br />
6-
Or buy a single motor driver here: [Link](https://source-robotics.com/products/spectral-micro-bldc-controller)
5+
**Soon for sale**
6+
7+
You can buy a STEPFOC starter kit here: [Link](https://source-robotics.com/products/STEPFOC-starter-kit) <br />
8+
Or buy a single motor driver here: [Link](https://source-robotics.com/products/STEPFOC-stepper-controller)
79

810
## **Recommended hardware**
911

@@ -80,7 +82,7 @@ Normal operation | Calibration | Error mode
8082
---- | ---- | ----
8183
3 short flashed and a pause <p align="left"> <img src="../assets/Normal.gif" alt="drawing" width="180"/> <br /> </p> | Flashing every 0.5 seconds <p align="left"> <img src="../assets/Calib.gif" alt="drawing" width="180"/> <br /> </p> | Solid LED, no flashing. <p align="left"> <img src="../assets/Error2.PNG" alt="drawing" width="180"/> <br /> </p>
8284

83-
If you have [STEPFOC firmware](https://github.com/PCrnjak/Spectral-Micro-BLDC-controller/tree/main/Spectral%20BLDC%20Firmware) uploaded on your STEPFOC, LEDs will be in one of 3 states.
85+
If you have [STEPFOC firmware](https://github.com/PCrnjak/STEPFOC-stepper-controller/tree/main/STEPFOC%20firmware) uploaded on your STEPFOC, LEDs will be in one of 3 states.
8486

8587
!!! Note annotate "STEPFOC controllers come **PRELOADED** with STEPFOC firmware"
8688

@@ -102,9 +104,9 @@ If you have [STEPFOC firmware](https://github.com/PCrnjak/Spectral-Micro-BLDC-co
102104

103105
## **What next?**
104106

105-
* **Optional** - > Flash the [latest firmware](https://github.com/PCrnjak/Spectral-Micro-BLDC-controller/tree/main/Spectral%20BLDC%20Firmware) to your driver (Note that drivers arrive with preflashed firmware)
106-
* You will need to [calibrate your motor](https://source-robotics.github.io/Spectral-BLDC-docs/apage4_calibration/)
107-
* [Tune your PID loops](https://source-robotics.github.io/Spectral-BLDC-docs/apage5_PID_tuning/)
107+
* **Optional** - > Flash the [latest firmware](https://github.com/PCrnjak/STEPFOC-stepper-controller/tree/main/STEPFOC%20firmware) to your driver (Note that drivers arrive with preflashed firmware)
108+
* You will need to [calibrate your motor](https://source-robotics.github.io/STEPFOC-docs/calibration/)
109+
* [Tune your PID loops](https://source-robotics.github.io/STEPFOC-docs/PID_tuning/)
108110
* Follow one of the guides or examples to start using Spectral driver
109111

110112
!!! Note annotate ""

‎docs/index.md‎

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,32 @@
55

66
**STEPFOC driver is in beta stage and docs and firmware are under constant development!**
77

8-
You can buy a STEPFOC starter kit here: [Link](https://source-robotics.com/products/spectral-micro-bldc-starter-kit) <br />
9-
Or buy a single motor driver here: [Link](https://source-robotics.com/products/spectral-micro-bldc-controller)
8+
**Soon for sale**
9+
10+
You can buy a STEPFOC starter kit here: [Link](https://source-robotics.com/products/STEPFOC-starter-kit) <br />
11+
Or buy a single motor driver here: [Link](https://source-robotics.com/products/STEPFOC-stepper-controller)
1012

1113
!!! Note annotate ""
1214

13-
* [STEPFOC datasheet](https://source-robotics.github.io/FOC-STEPPER-DOCS/apage1_specs/)
14-
* [Getting started](https://source-robotics.github.io/FOC-STEPPER-DOCS/apage2_getting_started/)
15-
* [Flashing firmware](https://source-robotics.github.io/FOC-STEPPER-DOCS/apage3_flashing_firmware/)
16-
* [Calibration](https://source-robotics.github.io/FOC-STEPPER-DOCS/apage4_calibration/)
17-
* [PID tuning](https://source-robotics.github.io/FOC-STEPPER-DOCS/apage5_PID_tuning/)
18-
* [UART interface](https://source-robotics.github.io/FOC-STEPPER-DOCS/apage6_uart/)
19-
* [CAN interface](https://source-robotics.github.io/FOC-STEPPER-DOCS/apage7_can/)
20-
* [Tested motors](https://source-robotics.github.io/FOC-STEPPER-DOCS/apage9_3_tested_motors/)
21-
* [Theory corner](https://source-robotics.github.io/FOC-STEPPER-DOCS/apage9_4_theory_corner/)
22-
* [Troubleshooting](https://source-robotics.github.io/FOC-STEPPER-DOCS/apage9_5_troublestooting/)
15+
* [STEPFOC datasheet](https://source-robotics.github.io/STEPFOC-docs/specs/)
16+
* [Getting started](https://source-robotics.github.io/STEPFOC-docs/getting_started/)
17+
* [Flashing firmware](https://source-robotics.github.io/STEPFOC-docs/flashing_firmware)
18+
* [Calibration](https://source-robotics.github.io/STEPFOC-docs/calibration/)
19+
* [PID tuning](https://source-robotics.github.io/STEPFOC-docs/PID_tuning/)
20+
* [UART interface](https://source-robotics.github.io/STEPFOC-docs/uart/)
21+
* [CAN interface](https://source-robotics.github.io/STEPFOC-docs/can/)
22+
* [Tested motors](https://source-robotics.github.io/STEPFOC-docs/tested_motors/)
23+
* [Theory corner](https://source-robotics.github.io/STEPFOC-docs/theory_corner/)
24+
* [Troubleshooting](https://source-robotics.github.io/STEPFOC-docs/troubleshooting/)
2325

2426
!!! Note annotate ""
2527

2628
**Guides**
2729

28-
* [Python guide](https://source-robotics.github.io/FOC-STEPPER-DOCS/Guides/Python%20guide/)
29-
* [Quadruped robot guide](https://source-robotics.github.io/FOC-STEPPER-DOCS/Guides/Quadruped%20guide/)
30-
* [Gravity compensation guide]()
31-
* [Bilateral teleoperation guide](https://source-robotics.github.io/FOC-STEPPER-DOCS/Guides/Bilateral%20teleoperation%20guide/)
30+
* [Python guide](https://source-robotics.github.io/FOC-STEPPER-DOCS/Guides/Python_guide/)
31+
* [Quadruped robot guide](https://source-robotics.github.io/FOC-STEPPER-DOCS/Guides/Quadruped_guide/)
32+
* [Gravity compensation guide](https://source-robotics.github.io/STEPFOC-docs/Guides/Gravity_compensation_guide/)
33+
* [Bilateral teleoperation guide](https://source-robotics.github.io/STEPFOC-docs/Guides/Bilateral_teleoperation_guide/)
3234

3335

3436

‎docs/specs.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Motor phases are conneceted to U,V and W. Power is connected to DC+ and DC-
5757

5858
## **CAD and dimensions**
5959

60-
[You can download Spectral micro STEP files here!](https://github.com/PCrnjak/Spectral-Micro-BLDC-controller/tree/main/STEP%20files)
60+
[You can download Spectral micro STEP files here!](https://github.com/PCrnjak/STEPFOC-stepper-controller/tree/main/STEP%20files)
6161
<p align="left"> <img src="../assets/STEPFOC_STEP.png" alt="drawing" width="600"/> <br /> </p>
6262

6363
STEPFOC uses same hole spacing as NEMA17 format motors.

‎docs/troubleshooting.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Normal operation | Calibration | Error mode
77
---- | ---- | ----
88
3 short flashed and a pause <p align="left"> <img src="../assets/Normal.gif" alt="drawing" width="180"/> <br /> </p> | Flashing every 0.5 seconds <p align="left"> <img src="../assets/Calib.gif" alt="drawing" width="180"/> <br /> </p> | Solid LED, no flashing. <p align="left"> <img src="../assets/Error2.PNG" alt="drawing" width="180"/> <br /> </p>
99

10-
If you have [STEPFOC firmware](https://github.com/PCrnjak/Spectral-Micro-BLDC-controller/tree/main/Spectral%20BLDC%20Firmware) uploaded on your STEPFOC LEDs will be in one of 3 states.
10+
If you have [STEPFOC firmware](https://github.com/PCrnjak/STEPFOC-stepper-controller/tree/main/STEPFOC%20firmware) uploaded on your STEPFOC LEDs will be in one of 3 states.
1111

1212
* **Normal operation** is when motor controller has no active errors and is calibrated
1313
* **Error mode** is active if any error on the motor driver is active. List of possible errors:
@@ -89,7 +89,7 @@ If driver gets over some temperature it will automatically shut down. This is ha
8989

9090
## **Calibration issuses**
9191

92-
Check [calibration page]() for these issues.
92+
Check [calibration page](https://source-robotics.github.io/STEPFOC-docs/calibration/) for these issues.
9393

9494
!!! Note annotate ""
9595

0 commit comments

Comments
 (0)