Skip to content

Commit 94deb57

Browse files
committed
final preparations for v2.3.0
1 parent a3950b0 commit 94deb57

File tree

7 files changed

+49
-44
lines changed

7 files changed

+49
-44
lines changed

docs/simplefoc_libraries/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ In the context of the <span class="simple">Simple<span class="foc">FOC</span>pro
4646

4747
This is a controller interface for the <span class="simple">Simple<span class="foc">FOC</span>library</span>. It uses WebSerial to communicate with a suitable micro-controller using serial port communications and the [Commander](commander_interface) interface. [Read more ... ](webcontroller)
4848

49-
<a href ="https://github.com/geekuillaume/simplefoc-webcontroller" class="btn btn"><i class="fa fa-github"></i> Github repo</a> <a href ="https://docs.simplefoc.com/simplefoc-webcontroller/" class="btn btn-primary"><i class="fa fa-github"></i> Open <span class="simple">Simple<span class="foc">FOC</span>webcontroller</span></a>
49+
<a href ="https://github.com/geekuillaume/simplefoc-webcontroller" class="btn btn"><i class="fa fa-github"></i> Github repo</a> <a href ="https://webcontroller.simplefoc.com/" class="btn btn-primary"><i class="fa fa-github"></i> Open <span class="simple">Simple<span class="foc">FOC</span>webcontroller</span></a>
5050
- ### <span class="simple">Simple<span class="foc">FOC</span>Generator</span> by [@stijnsprojects](https://github.com/stijnsprojects)
5151

5252
A web application which helps you generate <span class="simple">Simple<span class="foc">FOC</span>library</span> arduino sketches based on the hardware that you are using.

docs/simplefoc_libraries/tools/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ In the context of the <span class="simple">Simple<span class="foc">FOC</span>pro
2626

2727
This is a controller interface for the <span class="simple">Simple<span class="foc">FOC</span>library</span>. It uses WebSerial to communicate with a suitable micro-controller using serial port communications and the [Commander](commander_interface) interface. [Read more ... ](webcontroller)
2828

29-
<a href ="https://github.com/geekuillaume/simplefoc-webcontroller" class="btn btn"><i class="fa fa-github"></i> Github repo</a> <a href ="https://docs.simplefoc.com/simplefoc-webcontroller/" class="btn btn-primary"><i class="fa fa-github"></i> Open <span class="simple">Simple<span class="foc">FOC</span>webcontroller</span></a>
29+
<a href ="https://github.com/geekuillaume/simplefoc-webcontroller" class="btn btn"><i class="fa fa-github"></i> Github repo</a> <a href ="https://webcontroller.simplefoc.com/" class="btn btn-primary"><i class="fa fa-github"></i> Open <span class="simple">Simple<span class="foc">FOC</span>webcontroller</span></a>
3030

3131
- ### <span class="simple">Simple<span class="foc">FOC</span>Generator</span> by [@stijnsprojects](https://github.com/stijnsprojects)
3232

docs/simplefoc_libraries/tools/webcontroller.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ This is a controller interface for the <span class="simple">Simple<span class="f
1414
Most of the code for this application was provided by [@geekuillaume](https://github.com/geekuillaume), his github repository can be found [here](https://github.com/geekuillaume/simplefoc-webcontroller) and his application can be found [here](https://simplefoc.besson.co/).
1515
Our app is a fork of his code, that has been further extended to support more devices and configuration parameters, as well as to ease the monitoring visualisation.
1616

17-
<a href ="https://github.com/geekuillaume/simplefoc-webcontroller" class="btn btn"><i class="fa fa-github"></i> Github repo</a> <a href ="https://docs.simplefoc.com/simplefoc-webcontroller/" class="btn btn-primary"><i class="fa fa-github"></i> Open <span class="simple">Simple<span class="foc">FOC</span>webcontroller</span></a>
17+
<a href ="https://github.com/geekuillaume/simplefoc-webcontroller" class="btn btn"><i class="fa fa-github"></i> Github repo</a> <a href ="https://webcontroller.simplefoc.com/" class="btn btn-primary"><i class="fa fa-github"></i> Open <span class="simple">Simple<span class="foc">FOC</span>webcontroller</span></a>
1818

1919

2020

2121
<img src="extras/Images/webcontroller.gif" >
2222

2323
<blockquote class="info">
2424
<p class="heading">📢 Early stage project</p>
25-
This project is still in its early stage, we are counting on your patience and looking forward to hear your feedback. As there are many people in the community with far more knowledge about these kinds of apps than we do, don't hesitate to leve the issues and do the pull requests.
25+
This project is still in its early stage, we are counting on your patience and looking forward to hear your feedback. As there are many people in the community with far more knowledge about these kinds of apps than we do, don't hesitate to leave the issues and do the pull requests.
2626
</blockquote>
2727

2828
### Features:
@@ -34,7 +34,7 @@ This project is still in its early stage, we are counting on your patience and l
3434

3535
## Using the *Simple**FOC**WebController*
3636

37-
<a href ="https://docs.simplefoc.com/simplefoc-webcontroller/" class="btn btn-primary"><i class="fa fa-github"></i> Open <span class="simple">Simple<span class="foc">FOC</span>webcontroller</span></a>
37+
<a href ="https://webcontroller.simplefoc.com/" class="btn btn-primary"><i class="fa fa-github"></i> Open <span class="simple">Simple<span class="foc">FOC</span>webcontroller</span></a>
3838

3939
*Simple**FOC**WebController* does not require any installation, its only requirement is that your browser has `WebSerial` support. Check the supportedd browsers [here](https://caniuse.com/web-serial).
4040

docs/simplefoc_library/code/current_sense/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ stm32 (in general) | ✔️ | ❌ | ❌
5151
stm32f1 family | ✔️ | ✔️ (one motor) | ❌
5252
stm32f4 family | ✔️ | ✔️ (one motor) | ❌
5353
stm32g4 family | ✔️ | ✔️ (one motor) | ❌
54+
stm32l4 family | ✔️ | ✔️ (initial) | ❌
5455
stm32 B_G431B_ESC1 | ❌ | ✔️ (one motor) | ❌
5556
esp32/esp32s3 | ✔️ | ✔️ | ❌
5657
esp32s2/esp32c3 | ✔️ | ❌ | ❌

docs/simplefoc_library/hardware/mcus/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ stm32 (in general) | ✔️ | ❌ | ❌
7979
stm32f1 family | ✔️ | ✔️ (one motor) | ❌
8080
stm32f4 family | ✔️ | ✔️ (one motor) | ❌
8181
stm32g4 family | ✔️ | ✔️ (one motor) | ❌
82+
stm32l4 family | ✔️ | ✔️ (initial) | ❌
8283
stm32 B_G431B_ESC1 | ❌ | ✔️ (one motor) | ❌
8384
esp32/esp32s3 | ✔️ | ✔️ | ❌
8485
esp32s2/esp32c3 | ✔️ | ❌ | ❌

docs/simplefoc_library/hardware/mcus/stm32.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,23 @@ grand_grand_parent: Arduino <span class="simple">Simple<span class="foc">FOC</sp
1212
# STM32 boards support
1313

1414

15+
Driver support
16+
1517
MCU | 2 PWM mode | 4PWM mode | 3 PWM mode | 6 PWM mode | pwm frequency config
1618
--- | --- |--- |--- |--- |---
1719
stm32 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️
1820

21+
Current sensing support
22+
23+
MCU | In-line | Low-side | High-side
24+
--- | --- |--- |---
25+
stm32 (in general) | ✔️ | ❌ | ❌
26+
stm32f1 family | ✔️ | ✔️ (one motor) | ❌
27+
stm32f4 family | ✔️ | ✔️ (one motor) | ❌
28+
stm32g4 family | ✔️ | ✔️ (one motor) | ❌
29+
stm32l4 family | ✔️ | ✔️ (initial) | ❌
30+
stm32 B_G431B_ESC1 | ❌ | ✔️ (one motor) | ❌
31+
1932
Stm32 devices have full compatibility using the <span class="simple">Simple<span class="foc">FOC</span>library</span> and will work with all driver types.
2033

2134
Arduino <span class="simple">Simple<span class="foc">FOC</span>library</span> will support most of the stm32 boards out there. Stm32 boards are very powerful and they are the most common choice for implementing motion control applications. Here are two most commonly used families of boards with this library.

index.md

Lines changed: 29 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -21,54 +21,44 @@ We live in very exciting times 😃! BLDC motors are entering the hobby communit
2121
The solutions that can be found on-line are almost exclusively very specific for certain hardware configuration and the microcontroller architecture used.
2222
Additionally, most of the efforts at this moment are still channeled towards the high-power applications of the BLDC motors and proper low-cost and low-power FOC supporting boards are very hard to find today and even may not exist. <br>
2323
Therefore this is an attempt to:
24-
- 🎯 Demystify FOC algorithm and make a robust but simple Arduino library: [Arduino <span class="simple">Simple<span class="foc">FOC</span>library</span> ](#arduino-simplefoclibrary-v160)
24+
- 🎯 Demystify FOC algorithm and make a robust but simple Arduino library: [Arduino <span class="simple">Simple<span class="foc">FOC</span>library</span> ](arduino_simplefoc_library_showcase)
2525
- <i>Support as many <b>motor + sensor + current sense + driver + mcu</b> combinations out there</i>
2626
- 🎯 Develop a modular FOC supporting BLDC driver boards:
2727
- ***NEW*** 📢: *Minimalistic* BLDC driver (<3Amps) : [<span class="simple">Simple<b>FOC</b>Mini</span> ](simplefocmini).
2828
- *Low-power* gimbal driver (<5Amps) : [Arduino <span class="simple">Simple<b>FOC</b>Shield</span> ](arduino_simplefoc_shield_showcase).
2929
- *Medium-power* BLDC driver (<30Amps): [Arduino <span class="simple">Simple<b>FOC</b>PowerShield</span> ](https://github.com/simplefoc/Arduino-SimpleFOC-PowerShield).
30-
- See also [@byDagor](https://github.com/byDagor)'s *fully-integrated* ESP32 based board: [Dagor Brushless Controller](https://github.com/byDagor/Dagor-Brushless-Controller)
31-
32-
33-
<blockquote class="success">
34-
<p class="heading">NEWS 📢: <span class="simple">Simple<span class="foc">FOC</span>library</span> has been published in the Journal of Open Source Software <a href="citing">read more</a></p>
35-
36-
SimpleFOC: A Field Oriented Control (FOC) Library for Controlling Brushless Direct Current (BLDC) and Stepper Motors.<br>
37-
A. Skuric, HS. Bank, R. Unger, O. Williams, D. González-Reyes<br>
38-
Journal of Open Source Software, 7(74), 4232<br>
39-
</blockquote>
4030

4131
<blockquote class="info" markdown="1">
42-
<p class="heading">NEW RELEASE 📢: <span class="simple">Simple<span class="foc">FOC</span>library</span> v2.2.3 <a href="https://github.com/simplefoc/Arduino-FOC/releases/tag/v2.2.3">see release</a></p>
43-
- stm32 low-side current sensing
44-
- g4 supported
45-
- thoroughly tested f1/f4/g4 - [#187](https://github.com/simplefoc/Arduino-FOC/issues/187)
46-
- bg431b: added support for VBAT and TEMPERATURE readings [#222](https://github.com/simplefoc/Arduino-FOC/pull/222)
47-
- bugfixing
48-
- leonardo
49-
- mega2560 [#190](https://github.com/simplefoc/Arduino-FOC/issues/190)
50-
- inline current sense without driver [#188](https://github.com/simplefoc/Arduino-FOC/issues/188)
51-
- bg431b support current sense fix [#210](https://github.com/simplefoc/Arduino-FOC/pull/210)
52-
- `StepperDriver4PWM` wrong init [#182](https://github.com/simplefoc/Arduino-FOC/issues/182)
53-
- open loop back-emf voltage issue [#219](https://github.com/simplefoc/Arduino-FOC/issues/219)
54-
- SAMD51 compile issue [#217](https://github.com/simplefoc/Arduino-FOC/issues/217)
55-
- ESP32-S3 compile issue [#198](https://github.com/simplefoc/Arduino-FOC/issues/198)
56-
- ESP32 compile issue [#208](https://github.com/simplefoc/Arduino-FOC/issues/208), [#207](https://github.com/simplefoc/Arduino-FOC/issues/207)
57-
- magnetic sensor direction finding more robust [#173](https://github.com/simplefoc/Arduino-FOC/issues/173), [#164](https://github.com/simplefoc/Arduino-FOC/pull/164)
58-
- `StepDirListener` improved timing [#169](https://github.com/simplefoc/Arduino-FOC/issues/169), [#209](https://github.com/simplefoc/Arduino-FOC/pull/209)
59-
- `HallSensor` velocity calculation fix [#192](https://github.com/simplefoc/Arduino-FOC/issues/192)
60-
- API changes
61-
- `setPhaseVoltage` is now public function
62-
- `getVelocity` can now be called as many times as necessary - [see in docs](encoder#standalone-sensor)
63-
- it recalculates the velocity if the time between calls is longer then `min_elapsed_time` - default 0.1ms
64-
- `HallSensor` velocity calculation outlier removal using max expected velocity `velocity_max` - [see in docs](hall_sensors#step-21-velocity-outlier-removal)
65-
- BG431 board can be used only with `LowsideCurrentSense` class! - [see in docs](current_sense#current-sensing-support-per-mcu-architecture)
66-
- `initFOC` fails if current sense not initialised - [see in docs](bldcdriver3pwm#step-23-initialisation)
67-
- driver and current sense have to be well initialised for `initFOC` to start - [see in docs](bldcmotor#step-6-align-motor-and-all-the-sensors---field-oriented-control-init)
68-
- `cs.init()` and `driver.init()` return `1` if well initialised and `0` if failed
32+
<p class="heading">NEW RELEASE 📢: <span class="simple">Simple<span class="foc">FOC</span>library</span> v2.3.0 <a href="https://github.com/simplefoc/Arduino-FOC/releases/tag/v2.3.0">see release</a></p>
33+
- Arduino Mega 6pwm more timers supported
34+
- Arduino boards - frequency change support either 32kHz or 4kHz
35+
- Arduino Uno - synched timers in 3pwm and 6pwm mode [#71](https://github.com/simplefoc/Arduino-FOC/issues/71)
36+
- Teensy 3.x initial support for 6pwm
37+
- Teensy 4.x initial support for 6pwm
38+
- Example for v3.1 SimpleFOCShield
39+
- RP2040 compatibility for earlehillpower core [#234](https://github.com/simplefoc/Arduino-FOC/pull/234) [#236](https://github.com/simplefoc/Arduino-FOC/pull/236)
40+
- More flexible monitoring API
41+
- start, end and separator characters
42+
- decimal places (settable through commander)
43+
- Added machine readable verbose mode in `Commander` [#233](https://github.com/simplefoc/Arduino-FOC/pull/233)
44+
- *Simple**FOC**WebController* - Web based user interface for SimpleFOC by [@geekuillaume](https://github.com/geekuillaume) - [webcontroller.simplefoc.com](webcontroller.simplefoc.com)
45+
- bugfix - `MagneticSensorPWM` multiple occasions - [#258](https://github.com/simplefoc/Arduino-FOC/pull/258)
46+
- bugfix - current sense align - added offset exchange when exchanging pins
47+
- bugfix - trapezoid 150 fixed
48+
- bugfix - 4pwm on ESP8266 [#224](https://github.com/simplefoc/Arduino-FOC/pull/224)
49+
- Additional `InlineCurrentSense` and `LowsideCurrentSense` constructor using milliVolts per Amp [#253](https://github.com/simplefoc/Arduino-FOC/pull/253)
50+
- STM32L4xx current sense support by [@Triple6](https://github.com/Triple6) (discord) [#257](https://github.com/simplefoc/Arduino-FOC/pull/257)
51+
- phase disable in 6pwm mode
52+
- stm32 - software and hardware 6pwm
53+
- atmega328
54+
- atmega2560
55+
- Lag compensation using motor inductance [#246](https://github.com/simplefoc/Arduino-FOC/issues/246)
56+
- current control through voltage torque mode enhancement
57+
- extended `BLDCMotor` and `StepperMotor` constructors to receive the inductance paramerer
58+
- can also be set using `motor.phase_inductance` or through `Commander`
6959
</blockquote>
7060

71-
## Arduino <span class="simple">Simple<span class="foc">FOC</span>library</span> <i><small>v2.2.3</small></i>
61+
## Arduino <span class="simple">Simple<span class="foc">FOC</span>library</span> <i><small>v2.3.0</small></i>
7262
<iframe class="youtube" src="https://www.youtube.com/embed/Y5kLeqTc6Zk" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
7363
This video demonstrates the Simple FOC library basic usage, electronic connections and shows its capabilities.
7464

0 commit comments

Comments
 (0)