Skip to content

Commit 8faf934

Browse files
committed
README better minimal setup explanation
1 parent d01d351 commit 8faf934

File tree

11 files changed

+30
-23
lines changed

11 files changed

+30
-23
lines changed

README.md

Lines changed: 30 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Proper low cost FOC supporting boards are very hard to find these days and even
2020

2121

2222
## A short library YouTube demonstration video
23-
[![](https://img.youtube.com/vi/N_fRYf7Z80k/0.jpg)](https://youtu.be/N_fRYf7Z80k)
23+
[![](extras/Images/youtube.png)](https://youtu.be/N_fRYf7Z80k)
2424

2525
This video explains the Simple FOC library basic usage, electronic connections and demonstrates its capabilities.
2626

@@ -107,34 +107,41 @@ The code is place in the [minimal branch](https://github.com/askuric/Arduino-FOC
107107
# Electrical connections
108108

109109
## All you need for this project
110-
All you need for this project is:
111-
- Brushless DC (BLDC) motor
110+
The components you need to have to run the SimpleFOC algorithm:
111+
112+
- BLDC motor
112113
- BLDC driver
113114
- Position sensor
114-
- Arduino
115+
- Arduino
116+
115117
### BLDC motor
116118
This library is compatible with any 3 phase BLDC motor out there. Feel free to choose anything that suites your applications. The most tests have been done using gimbal morots (up to 2A).
117-
Examples:
118-
- IPower GBM4198H-120T [Ebay](https://www.ebay.com/itm/iPower-Gimbal-Brushless-Motor-GBM4108H-120T-for-5N-7N-GH2-ILDC-Aerial-photo-FPV/252025852824?hash=item3aade95398:g:q94AAOSwPcVVo571:rk:2:pf:1&frcectupt=true)
119-
- GARTT ML5010 300KV [Ebay](https://www.ebay.com/itm/GARTT-ML5010-300KV-Brushless-Motor-For-T960-T810-RC-Multirotor-Quadcopter-MT-092/302082779179?hash=item465589682b:g:h00AAOSwmfhX44X2)
119+
Examples | Description | Link | Price
120+
---- | ---- | ---- | ---
121+
[<img src="extras/Images/mot.jpg" height="150px">](https://www.ebay.com/itm/iPower-Gimbal-Brushless-Motor-GBM4108H-120T-for-5N-7N-GH2-ILDC-Aerial-photo-FPV/254541115855?hash=item3b43d531cf:g:q94AAOSwPcVVo571) | IPower GBM4198H-120T | [Ebay](https://www.ebay.com/itm/iPower-Gimbal-Brushless-Motor-GBM4108H-120T-for-5N-7N-GH2-ILDC-Aerial-photo-FPV/252025852824?hash=item3aade95398:g:q94AAOSwPcVVo571:rk:2:pf:1&frcectupt=true) | 25$
122+
[<img src="extras/Images/mot2.jpg" height="150px">](https://www.ebay.com/itm/JMT-MT3508-380KV-Motor-Disk-Motor-for-Multi-axis-Aircraft-DIY-Quadcopter-Drone/263422397574?hash=item3d5532cc86:g:31oAAOSw11BcQs6V) | GARTT ML5010 300KV | [Ebay](https://www.ebay.com/itm/GARTT-ML5010-300KV-Brushless-Motor-For-T960-T810-RC-Multirotor-Quadcopter-MT-092/302082779179?hash=item465589682b:g:h00AAOSwmfhX44X2) | 30$
123+
[<img src="extras/Images/mot3.jpg" height="150px">](https://www.ebay.com/itm/Alloy-2208-90KV-Gimbal-Brushless-Motor-for-Gopro3-RC-Drone-Camera-100-200g/223195701385?hash=item33f7802089:g:cjUAAOSw1iVbyccJ) | 2208 90KV Gimbal motor | [Ebay](https://www.ebay.com/itm/Alloy-2208-90KV-Gimbal-Brushless-Motor-for-Gopro3-RC-Drone-Camera-100-200g/223195701385?hash=item33f7802089:g:cjUAAOSw1iVbyccJ) | 15$
120124
### BLDC motor driver
121125
This library will be compatible with the most of the 3 phase bldc motor dirvers. Such as L6234, DRV8305 or L293.
122-
Examples:
123-
- L6234 driver [Drotek](https://store-drotek.com/212-brushless-gimbal-controller-l6234.html), [Ebay](https://www.ebay.fr/itm/L6234-Breakout-Board-/153204519965)
124-
- Alternatively the library supports the arduino based gimbal controllers such as: 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))
125-
- [Arduino Simple FOC shield](#arduino-simple-foc-shield-v12)
126+
127+
Examples | Description | Link | Price
128+
---- | ---- | ---- | ---
129+
[<img src="extras/Images/shield_top_v13.png" height="150px">](https://askuric.github.io/simplefoc.html)| Arduino Simple FOC shield | [More info](https://askuric.github.io/simplefoc.html) | 35$
130+
[<img src="extras/Images/l6234.jpg" height="150px">](https://www.ebay.com/itm/L6234-Breakout-Board/153204519965?hash=item23abb3741d:g:LE4AAOSwe35bctgg) | Dorotek L6234 breakout board| [Drotek](https://store-drotek.com/212-brushless-gimbal-controller-l6234.html), [Ebay](https://www.ebay.fr/itm/L6234-Breakout-Board-/153204519965) | 30$
131+
[<img src="extras/Images/pinout.jpg" height="150px">](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) | 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) | 20$
132+
126133

127134
### Position sensor
128135
This library supports two types of position sensors: Encoder and Magnetic sensor.
129136
#### Encoders
130-
Encoders are by far most popular position sensors, both in industry and in hobby community. The main benefits are the precision, standardisation and very low noise level. The main problem with encoders is the efficiency.
131-
132-
Examples:
133-
- Optical Encoder
134-
- 2400cpr | ~10$ [Ebay](https://www.ebay.com/itm/600P-R-Photoelectric-Incremental-Rotary-Encoder-5V-24V-AB-2-Phases-Shaft-6mm-New/173145939999?epid=19011022356&hash=item28504d601f:g:PZsAAOSwdx1aKQU-:rk:1:pf:1)
135-
- 490-AMT103-V | 8192cpr | ~30$ [Mouser](https://www.mouser.fr/ProductDetail/CUI-Devices/AMT103-V?qs=%2Fha2pyFaduiAsBlScvLoAWHUnKz39jAIpNPVt58AQ0PVb84dpbt53g%3D%3D)
136-
- Magnetic Encoders
137-
- AS5047 | 16384cpr | ~15$ [Mouser](https://www.mouser.fr/ProductDetail/ams/AS5X47U-TS_EK_AB?qs=sGAEpiMZZMve4%2FbfQkoj%252BBDLPCj82ZLyYIPEtADg0FE%3D) [Youtube](https://www.youtube.com/watch?v=Gl-DiOqXXJ8)
137+
Encoders are by far most popular position sensors, both in industry and in hobby community. The main benefits are the precision, standardisation and very low noise level. The main problem with encoders is the code efficiency, since you need to continously count the impulses in order to have precise position.
138+
139+
Examples | Description | Link | Price
140+
---- | ---- | ---- | ----
141+
[<img src="extras/Images/enc.jpg" height="150px">](https://www.ebay.com/itm/360-600P-R-Photoelectric-Incremental-Rotary-Encoder-5V-24V-AB-Two-Phases-Shaft/254214673272?hash=item3b30601378:m:mDiuW1F2qXINSH51TqAjhTg) | Optical encoder<br>2400cpr | [Drotek](https://store-drotek.com/212-brushless-gimbal-controller-l6234.html), [Ebay](https://www.ebay.fr/itm/L6234-Breakout-Board-/153204519965) | 10$
142+
[<img src="extras/Images/enc1.png" height="150px">](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) | Optical encoder<br>AMT103 <br>8192cpr | [Mouser](https://www.mouser.fr/ProductDetail/CUI-Devices/AMT103-V?qs=%2Fha2pyFaduiAsBlScvLoAWHUnKz39jAIpNPVt58AQ0PVb84dpbt53g%3D%3D) | 20$
143+
[<img src="extras/Images/mag.jpg" height="150px">](hhttps://www.mouser.fr/ProductDetail/ams/AS5X47U-TS_EK_AB?qs=sGAEpiMZZMve4%2FbfQkoj%252BBDLPCj82ZLyYIPEtADg0FE%3D) | Margetic encoder <br> AS5047U <br> 16384cpr | [Mouser](https://www.mouser.fr/ProductDetail/ams/AS5X47U-TS_EK_AB?qs=sGAEpiMZZMve4%2FbfQkoj%252BBDLPCj82ZLyYIPEtADg0FE%3D)<br> [Youtube demo](https://www.youtube.com/watch?v=Gl-DiOqXXJ8) | 15$
144+
138145
139146
#### Magnetic sensors | SPI interface
140147
Magentic position sensor has many benefits over the encoders:
@@ -145,10 +152,10 @@ Magentic position sensor has many benefits over the encoders:
145152
- Very low price
146153
- Very simple to mount
147154

148-
Examples:
149-
- AS5048 | 16384cpr | ~15$ [Aliexpress](https://fr.aliexpress.com/item/4000034013999.html?spm=a2g0o.productlist.0.0.4a7f5c25mYwpN3&algo_pvid=8f452506-7081-4d0a-8f66-d0b725d6de66&algo_expid=8f452506-7081-4d0a-8f66-d0b725d6de66-0&btsid=0b0a0ad815873142372227604ed134&ws_ab_test=searchweb0_0,searchweb201602_,searchweb201603_)
150-
- AS5047 | 16384cpr | ~15$ [Mouser](https://www.mouser.fr/ProductDetail/ams/AS5X47U-TS_EK_AB?qs=sGAEpiMZZMve4%2FbfQkoj%252BBDLPCj82ZLyYIPEtADg0FE%3D) [Youtube](https://www.youtube.com/watch?v=Gl-DiOqXXJ8)
151-
155+
Examples | Description | Link | Price
156+
---- | ---- | ---- | ----
157+
[<img src="extras/Images/mag.jpg" height="150px">](https://www.mouser.fr/ProductDetail/ams/AS5X47U-TS_EK_AB?qs=sGAEpiMZZMve4%2FbfQkoj%252BBDLPCj82ZLyYIPEtADg0FE%3D) | Margetic encoder <br> AS5047<br> absolute <br>16384cpr | [Mouser](https://www.mouser.fr/ProductDetail/ams/AS5X47U-TS_EK_AB?qs=sGAEpiMZZMve4%2FbfQkoj%252BBDLPCj82ZLyYIPEtADg0FE%3D) | 15$
158+
[<img src="extras/Images/mag2.jpg" height="150px">](https://www.ebay.com/itm/AS5048-Magnetic-Encoder-PWM-SPI-Interface-14-Bit-Precision-For-Brushless-Motor/153636871434?hash=item23c5789d0a:g:oOMAAOSwd-5ddaWQ) | Margetic encoder <br> AS5048<br> absolute <br>16384cpr | [Mouser](https://www.ebay.com/itm/AS5048-Magnetic-Encoder-PWM-SPI-Interface-14-Bit-Precision-For-Brushless-Motor/153636871434?hash=item23c5789d0a:g:oOMAAOSwd-5ddaWQ) | 10$
152159

153160
## Arduino Simple FOC Shield
154161

extras/Images/enc.jpg

30.8 KB
Loading

extras/Images/enc1.png

224 KB
Loading

extras/Images/l6234.jpg

31.5 KB
Loading

extras/Images/mag.jpg

5.65 KB
Loading

extras/Images/mag2.jpg

25 KB
Loading

extras/Images/mot.jpg

5.07 KB
Loading

extras/Images/mot2.jpg

114 KB
Loading

extras/Images/mot3.jpg

66.5 KB
Loading

extras/Images/side_shield.jpg

224 KB
Loading

0 commit comments

Comments
 (0)