Skip to content

Commit bc4d4ec

Browse files
committed
Merge branch 'dev'
2 parents 8ca6a5c + 4a7917a commit bc4d4ec

File tree

42 files changed

+2382
-1841
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+2382
-1841
lines changed

.github/workflows/ccpp.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Library Compile
22
on: push
33
jobs:
44
build:
5-
name: Test compiling examples for UNO
5+
name: Test compiling
66
runs-on: ubuntu-latest
77
steps:
88
- name: Checkout
@@ -11,3 +11,4 @@ jobs:
1111
uses: ArminJo/arduino-test-compile@v1.0.0
1212
with:
1313
libraries: PciManager
14+
examples-exclude: bluepill_position_control

README.md

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,39 @@
77

88
Proper low-cost and low-power FOC supporting boards are very hard to find these days and even may not exist. Even harder to find is a stable and simple FOC algorithm code capable of running on Arduino devices.
99
Therefore this is an attempt to:
10-
- Demystify FOC algorithm and make a robust but simple Arduino library: [Arduino SimpleFOC library](https://askuric.github.io/Arduino-FOC/arduino_simplefoc_library_showcase)
11-
- Develop a modular BLDC driver board: [Arduino SimpleFOC shield](https://askuric.github.io/Arduino-FOC/arduino_simplefoc_shield_showcase).
10+
- Demystify FOC algorithm and make a robust but simple Arduino library: [Arduino *SimpleFOClibrary*](https://docs.simplefoc.com/arduino_simplefoc_library_showcase)
11+
- Develop a modular BLDC driver board: [Arduino *SimpleFOCShield*](https://docs.simplefoc.com/arduino_simplefoc_shield_showcase).
1212

13-
## Arduino SimpleFOCShield
13+
14+
> ***UPDATE:*** Arduino *SimpleFOClibrary* now supports STM32 boards [Nucleo](https://www.st.com/en/evaluation-tools/stm32-nucleo-boards.html) and [Bluepill](https://stm32-base.org/boards/STM32F103C8T6-Blue-Pill.html).
15+
16+
## Arduino *SimpleFOCShield*
1417

1518
<p align="">
1619
<a href="https://youtu.be/G5pbo0C6ujE">
17-
<img src="https://askuric.github.io/Arduino-FOC/extras/Images/foc_shield_video.jpg" height="320px">
20+
<img src="https://docs.simplefoc.com/extras/Images/foc_shield_video.jpg" height="320px">
1821
</a>
1922
</p>
2023

2124
### Features
2225
- **Plug & play**: In combination with Arduino <span class="simple">Simple<span class="foc">FOC</span>library</span>
23-
- **Low-cost**: Price of €20 - [Check the pricing](https://askuric.github.io/simplefoc_shield_product)
24-
- **Open Source**: Fully available fabrication files - [how to make it yourself](https://askuric.github.io/Arduino-FOC/arduino_simplefoc_shield_fabrication)
26+
- **Low-cost**: Price of €20 - [Check the pricing](https://www.simplefoc.com/simplefoc_shield_product)
27+
- **Open Source**: Fully available fabrication files - [how to make it yourself](https://docs.simplefoc.com/arduino_simplefoc_shield_fabrication)
2528
- **Stackable**: running 2 motors in the same time
2629
- **Encoder interface**: Integrated 3kOhm pullups (configurable)
2730
- **Configurable pinout**: Hardware configuration - soldering connections
31+
- **Arduino headers**: Arduino UNO, Arduino MEGA, STM32 Nucleo boards...
2832

29-
##### If you are interested in this board, preorder your version on this link: [Arduino Simple FOC Shield](https://askuric.github.io/simplefoc_shield_product)
33+
##### If you are interested in this board, order your version on this link: [Arduino Simple FOC Shield](https://www.simplefoc.com/simplefoc_shield_product)
3034

31-
<p align=""><img src="https://askuric.github.io/Arduino-FOC/extras/Images/shield_to_v13.jpg" height="180px"> <img src="https://askuric.github.io/Arduino-FOC/extras/Images/shield_bo_v13.jpg" height="180px"> <img src="https://askuric.github.io/Arduino-FOC/extras/Images/simple_foc_shield_v13_small.gif" height="180x"></p>
35+
<p align=""><img src="https://docs.simplefoc.com/extras/Images/shield_to_v13.jpg" height="180px"> <img src="https://docs.simplefoc.com/extras/Images/shield_bo_v13.jpg" height="180px"> <img src="https://docs.simplefoc.com/extras/Images/simple_foc_shield_v13_small.gif" height="180x"></p>
3236

3337

34-
## Arduino SimpleFOClibrary
38+
## Arduino *SimpleFOClibrary*
3539

3640
<p align="">
3741
<a href="https://youtu.be/Y5kLeqTc6Zk">
38-
<img src="https://askuric.github.io/Arduino-FOC/extras/Images/youtube.png" height="320px">
42+
<img src="https://docs.simplefoc.com/extras/Images/youtube.png" height="320px">
3943
</a>
4044
</p>
4145

@@ -45,19 +49,23 @@ This video demonstrates the Simple FOC library basic usage, electronic connectio
4549
- **Arduino compatible**: Arduino library code
4650
- **Easy to setup and configure**:
4751
- Easy hardware configuration
48-
- Easy [tuning the control loops](https://askuric.github.io/Arduino-FOC/control_loops)
52+
- Easy [tuning the control loops](https://docs.simplefoc.com/control_loops)
4953
- **Modular**:
50-
- Supports as many [sensors , BLDC motors and driver boards](https://askuric.github.io/Arduino-FOC/supported_hardware) as possible
54+
- Supports as many [sensors , BLDC motors and driver boards](https://docs.simplefoc.com/supported_hardware) as possible
5155
- Supports as many application requirements as possible
52-
- **Plug & play**: Arduino SimpleFOC shield
56+
- Supports multiple [MCU architectures](https://docs.simplefoc.com/microcontrollers):
57+
- Arduino: UNO, MEGA, any board with ATMega328 chips
58+
- STM32 boards: [Nucleo](https://www.st.com/en/evaluation-tools/stm32-nucleo-boards.html) and [Bluepill](https://stm32-base.org/boards/STM32F103C8T6-Blue-Pill.html)
59+
- ESP32 (very soon)
60+
- **Plug & play**: Arduino *SimpleFOCShield*
5361

54-
<p align=""> <img src="https://askuric.github.io/Arduino-FOC/extras/Images/uno_l6234.jpg" height="170px"> <img src="https://askuric.github.io/Arduino-FOC/extras/Images/hmbgc_v22.jpg" height="170px"> <img src="https://askuric.github.io/Arduino-FOC/extras/Images/foc_shield_v13.jpg" height="170px"></p>
62+
<p align=""> <img src="https://docs.simplefoc.com/extras/Images/uno_l6234.jpg" height="170px"> <img src="https://docs.simplefoc.com/extras/Images/hmbgc_v22.jpg" height="170px"> <img src="https://docs.simplefoc.com/extras/Images/foc_shield_v13.jpg" height="170px"></p>
5563

5664
## Getting Started
5765
Depending on if you want to use this library as the plug and play Arduino library or you want to get insight in the algorithm and make changes there are two ways to install this code.
5866

59-
- Full library installation [Docs](https://askuric.github.io/Arduino-FOC/library_download)
60-
- Minimal code installation [Docs](https://askuric.github.io/Arduino-FOC/minimal_download)
67+
- Full library installation [Docs](https://docs.simplefoc.com/library_download)
68+
- Minimal code installation [Docs](https://docs.simplefoc.com/minimal_download)
6169

6270
### Arduino SimpleFOC library installation to Arduino IDE
6371
#### Arduino Library Manager
@@ -109,7 +117,7 @@ NOTE: This program uses all the default control parameters.
109117
// BLDCMotor( pin_pwmA, pin_pwmB, pin_pwmC, pole_pairs, enable (optional))
110118
BLDCMotor motor = BLDCMotor(9, 10, 11, 11, 8);
111119
// Encoder(pin_A, pin_B, CPR)
112-
Encoder encoder = Encoder(arduinoInt1, arduinoInt2, 2048);
120+
Encoder encoder = Encoder(2, 3, 2048);
113121
// channel A and B callbacks
114122
void doA(){encoder.handleA();}
115123
void doB(){encoder.handleB();}
@@ -150,15 +158,15 @@ void loop() {
150158
motor.monitor();
151159
}
152160
```
153-
You can find more details in the [SimpleFOC documentation](https://askuric.github.io/Arduino-FOC/).
161+
You can find more details in the [SimpleFOC documentation](https://docs.simplefoc.com/).
154162

155163
## Example projects
156164
Here are some of the SimpleFOC application examples.
157165
### Arduino Field Oriented Controlled Reaction Wheel Inverted Pendulum
158166
This is a very cool open-source project of one of the simplest setups of the Reaction wheel inverted pendulum. Check out all the components and projects notes in the [github repository](https://github.com/askuric/Arduino-FOC-reaction-wheel-inverted-pendulum).
159167
<p align="">
160168
<a href="https://youtu.be/Ih-izQyXJCI">
161-
<img src="https://askuric.github.io/Arduino-FOC/extras/Images/youtube_pendulum.png" height="320px">
169+
<img src="https://docs.simplefoc.com/extras/Images/youtube_pendulum.png" height="320px">
162170
</a>
163171
</p>
164172

@@ -172,7 +180,7 @@ This is a very cool open-source project of one of the simplest setups of the Rea
172180

173181

174182
## Documentation
175-
Find out more information about the Arduino SimpleFOC project in [docs website](https://askuric.github.io/Arduino-FOC/)
183+
Find out more information about the Arduino SimpleFOC project in [docs website](https://docs.simplefoc.com/)
176184

177185

178186
## Arduino FOC repo structure

examples/encoder_examples/HMBGC_example/HMBGC_example.ino

Lines changed: 0 additions & 136 deletions
This file was deleted.

0 commit comments

Comments
 (0)