Skip to content

Commit 1612549

Browse files
committed
README examples description
1 parent d7e0ccc commit 1612549

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,34 @@
66

77
This is the minimal Arduino example of the [Simple FOC](https://github.com/askuric/Arduino-FOC) arduino library intended for mostly for easier experiemtation and modification!
88

9+
### Minimal repository structure
10+
```shell
11+
├───arduino_foc_minimal_encoder # Arduino minimal code for running a motor with Encoder
12+
13+
└───arduino_foc_minimal_magnetic # Arduino minimal code for running a motor with magentic sensor
14+
# AS5048/47
15+
```
16+
17+
Each of the examples will give you the opportunity to change the PI celocity parameters `P` and `I`, Low pass filter time constant `Tf`, change the control loop in real time and check the average loop execution time, all from the serial terminal.
18+
```
19+
PI controller parameters change:
20+
- P value : Prefix P (ex. P0.1)
21+
- I value : Prefix I (ex. I0.1)
22+
23+
Velocity filter:
24+
- Tf value : Prefix F (ex. F0.001)
25+
26+
Average loop execution time:
27+
- Type T
28+
29+
Control loop type:
30+
- C0 - angle control
31+
- C1 - velocity control
32+
- C2 - voltage control
33+
34+
Initial parameters:
35+
PI velocity P: 0.20, I: 20.00, Low passs filter Tf: 0.0000
36+
```
937
## Arduino FOC repo structure
1038
Branch | Description | Status
1139
------------ | ------------- | ------------

0 commit comments

Comments
 (0)