Skip to content

Commit 878a47f

Browse files
committed
minimal branch link
1 parent f6d9ebb commit 878a47f

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Arduino Field Oriented Control (FOC) library
1+
# Arduino Simple Field Oriented Control (FOC) library
22

33

44
![Library Compile](https://github.com/askuric/Arduino-FOC/workflows/Library%20Compile/badge.svg)
@@ -14,6 +14,8 @@ Proper low cost FOC supporting boards are very hard to find these days and even
1414
and demistify FOC control in a simple way.
1515

1616

17+
For minimal version of the code more suitable for experimenting please visit the [minimal branch](https://github.com/askuric/Arduino-FOC/tree/minimal).
18+
1719
#### The closest you can get to FOC support and low cost (I was able to find) is:
1820

1921
<a href="https://odriverobotics.com/" >Odroid</a> | <a href="https://www.youtube.com/watch?v=g2BHEdvW9bU">Trinamic</a>
@@ -45,13 +47,13 @@ Alternatively the library supports the arduino based gimbal controllers such as:
4547
- HMBGC V2.2 ([Ebay](https://www.ebay.com/itm/HMBGC-V2-0-3-Axle-Gimbal-Controller-Control-Plate-Board-Module-with-Sensor/351497840990?hash=item51d6e7695e:g:BAsAAOSw0QFXBxrZ:rk:1:pf:1))
4648

4749

48-
## Arduino FOC Shield V1.2
50+
## Arduino Simple FOC Shield V1.2
4951

5052
At this moment we are developing an open source version of Arduin shiled specifically for FOC motor control.
5153
We already have prototypes of the board and we are in the testing phase. We will be coming out with the details very soon!
5254

5355
### Features
54-
- Plug and play capability with the Arduino FOC library
56+
- Plug and play capability with the Arduino Simple FOC library
5557
- Price in the range of \$20-\$40
5658
- Gerber files and BOM available Open Source
5759

@@ -105,7 +107,7 @@ Motor phases `a`,`b`,`c` and encoder channels `A` and `B` have to be oriented ri
105107

106108

107109

108-
# Arduino FOC library code
110+
# Arduino Simple FOC library code
109111
The code is organised into a librarie. The library contains two classes `BLDCmotor` and `Endcoder`. `BLDCmotor` contains all the necessary FOC algorithm funcitons as well as PI controllers for the velocity and angle control. `Encoder` deals with the encoder interupt funcitons, calcualtes motor angle and velocity( using the [Mixed Time Frequency Method](https://github.com/askuric/Arduino-Mixed-Time-Frequency-Method)).
110112

111113
## Encoder setup
@@ -316,7 +318,7 @@ This function aligns encoder and motor zero positions and intialises FOC variabl
316318

317319
### Real-time execution `loop()`
318320

319-
The real time execution of the Arduino FOC library is govenred by two funcitons `motor.loopFOC()` and `motor.move(float target)`.
321+
The real time execution of the Arduino Simple FOC library is govenred by two funcitons `motor.loopFOC()` and `motor.move(float target)`.
320322
```cpp
321323
// iterative state calculation calculating angle
322324
// and setting FOC pahse voltage

0 commit comments

Comments
 (0)