From 94deb572a034393c2020450e072c7bbd0292879c Mon Sep 17 00:00:00 2001 From: askuric Date: Sat, 18 Mar 2023 12:08:26 +0100 Subject: [PATCH] final preparations for v2.3.0 --- docs/simplefoc_libraries/index.md | 2 +- docs/simplefoc_libraries/tools/index.md | 2 +- .../tools/webcontroller.md | 6 +- .../code/current_sense/index.md | 1 + docs/simplefoc_library/hardware/mcus/index.md | 1 + docs/simplefoc_library/hardware/mcus/stm32.md | 13 ++++ index.md | 68 ++++++++----------- 7 files changed, 49 insertions(+), 44 deletions(-) diff --git a/docs/simplefoc_libraries/index.md b/docs/simplefoc_libraries/index.md index e19b71d..e1b7916 100644 --- a/docs/simplefoc_libraries/index.md +++ b/docs/simplefoc_libraries/index.md @@ -46,7 +46,7 @@ In the context of the SimpleFOCpro This is a controller interface for the SimpleFOClibrary. It uses WebSerial to communicate with a suitable micro-controller using serial port communications and the [Commander](commander_interface) interface. [Read more ... ](webcontroller) - Github repo Open SimpleFOCwebcontroller + Github repo Open SimpleFOCwebcontroller - ### SimpleFOCGenerator by [@stijnsprojects](https://github.com/stijnsprojects) A web application which helps you generate SimpleFOClibrary arduino sketches based on the hardware that you are using. diff --git a/docs/simplefoc_libraries/tools/index.md b/docs/simplefoc_libraries/tools/index.md index aafd38b..f8179de 100644 --- a/docs/simplefoc_libraries/tools/index.md +++ b/docs/simplefoc_libraries/tools/index.md @@ -26,7 +26,7 @@ In the context of the SimpleFOCpro This is a controller interface for the SimpleFOClibrary. It uses WebSerial to communicate with a suitable micro-controller using serial port communications and the [Commander](commander_interface) interface. [Read more ... ](webcontroller) - Github repo Open SimpleFOCwebcontroller + Github repo Open SimpleFOCwebcontroller - ### SimpleFOCGenerator by [@stijnsprojects](https://github.com/stijnsprojects) diff --git a/docs/simplefoc_libraries/tools/webcontroller.md b/docs/simplefoc_libraries/tools/webcontroller.md index 31aa4b3..9b11845 100644 --- a/docs/simplefoc_libraries/tools/webcontroller.md +++ b/docs/simplefoc_libraries/tools/webcontroller.md @@ -14,7 +14,7 @@ This is a controller interface for the Simple Github repo Open SimpleFOCwebcontroller + Github repo Open SimpleFOCwebcontroller @@ -22,7 +22,7 @@ Our app is a fork of his code, that has been further extended to support more de

πŸ“’ Early stage project

-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. +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.
### Features: @@ -34,7 +34,7 @@ This project is still in its early stage, we are counting on your patience and l ## Using the *Simple**FOC**WebController* - Open SimpleFOCwebcontroller + Open SimpleFOCwebcontroller *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). diff --git a/docs/simplefoc_library/code/current_sense/index.md b/docs/simplefoc_library/code/current_sense/index.md index 9ef9df6..c73001b 100644 --- a/docs/simplefoc_library/code/current_sense/index.md +++ b/docs/simplefoc_library/code/current_sense/index.md @@ -51,6 +51,7 @@ stm32 (in general) | βœ”οΈ | ❌ | ❌ stm32f1 family | βœ”οΈ | βœ”οΈ (one motor) | ❌ stm32f4 family | βœ”οΈ | βœ”οΈ (one motor) | ❌ stm32g4 family | βœ”οΈ | βœ”οΈ (one motor) | ❌ +stm32l4 family | βœ”οΈ | βœ”οΈ (initial) | ❌ stm32 B_G431B_ESC1 | ❌ | βœ”οΈ (one motor) | ❌ esp32/esp32s3 | βœ”οΈ | βœ”οΈ | ❌ esp32s2/esp32c3 | βœ”οΈ | ❌ | ❌ diff --git a/docs/simplefoc_library/hardware/mcus/index.md b/docs/simplefoc_library/hardware/mcus/index.md index c4a690d..caaf252 100644 --- a/docs/simplefoc_library/hardware/mcus/index.md +++ b/docs/simplefoc_library/hardware/mcus/index.md @@ -79,6 +79,7 @@ stm32 (in general) | βœ”οΈ | ❌ | ❌ stm32f1 family | βœ”οΈ | βœ”οΈ (one motor) | ❌ stm32f4 family | βœ”οΈ | βœ”οΈ (one motor) | ❌ stm32g4 family | βœ”οΈ | βœ”οΈ (one motor) | ❌ +stm32l4 family | βœ”οΈ | βœ”οΈ (initial) | ❌ stm32 B_G431B_ESC1 | ❌ | βœ”οΈ (one motor) | ❌ esp32/esp32s3 | βœ”οΈ | βœ”οΈ | ❌ esp32s2/esp32c3 | βœ”οΈ | ❌ | ❌ diff --git a/docs/simplefoc_library/hardware/mcus/stm32.md b/docs/simplefoc_library/hardware/mcus/stm32.md index 0d8ae15..081ef1e 100644 --- a/docs/simplefoc_library/hardware/mcus/stm32.md +++ b/docs/simplefoc_library/hardware/mcus/stm32.md @@ -12,10 +12,23 @@ grand_grand_parent: Arduino SimpleFOCSimpleFOClibrary and will work with all driver types. Arduino SimpleFOClibrary 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. diff --git a/index.md b/index.md index 3c732f7..7775bcc 100644 --- a/index.md +++ b/index.md @@ -21,54 +21,44 @@ We live in very exciting times πŸ˜ƒ! BLDC motors are entering the hobby communit The solutions that can be found on-line are almost exclusively very specific for certain hardware configuration and the microcontroller architecture used. 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.
Therefore this is an attempt to: -- 🎯 Demystify FOC algorithm and make a robust but simple Arduino library: [Arduino SimpleFOClibrary ](#arduino-simplefoclibrary-v160) +- 🎯 Demystify FOC algorithm and make a robust but simple Arduino library: [Arduino SimpleFOClibrary ](arduino_simplefoc_library_showcase) - Support as many motor + sensor + current sense + driver + mcu combinations out there - 🎯 Develop a modular FOC supporting BLDC driver boards: - ***NEW*** πŸ“’: *Minimalistic* BLDC driver (<3Amps) : [SimpleFOCMini ](simplefocmini). - *Low-power* gimbal driver (<5Amps) : [Arduino SimpleFOCShield ](arduino_simplefoc_shield_showcase). - *Medium-power* BLDC driver (<30Amps): [Arduino SimpleFOCPowerShield ](https://github.com/simplefoc/Arduino-SimpleFOC-PowerShield). - - See also [@byDagor](https://github.com/byDagor)'s *fully-integrated* ESP32 based board: [Dagor Brushless Controller](https://github.com/byDagor/Dagor-Brushless-Controller) - - -
-

NEWS πŸ“’: SimpleFOClibrary has been published in the Journal of Open Source Software read more

- -SimpleFOC: A Field Oriented Control (FOC) Library for Controlling Brushless Direct Current (BLDC) and Stepper Motors.
-A. Skuric, HS. Bank, R. Unger, O. Williams, D. GonzΓ‘lez-Reyes
-Journal of Open Source Software, 7(74), 4232
-
-

NEW RELEASE πŸ“’: SimpleFOClibrary v2.2.3 see release

-- stm32 low-side current sensing - - g4 supported - - thoroughly tested f1/f4/g4 - [#187](https://github.com/simplefoc/Arduino-FOC/issues/187) - - bg431b: added support for VBAT and TEMPERATURE readings [#222](https://github.com/simplefoc/Arduino-FOC/pull/222) -- bugfixing - - leonardo - - mega2560 [#190](https://github.com/simplefoc/Arduino-FOC/issues/190) - - inline current sense without driver [#188](https://github.com/simplefoc/Arduino-FOC/issues/188) - - bg431b support current sense fix [#210](https://github.com/simplefoc/Arduino-FOC/pull/210) - - `StepperDriver4PWM` wrong init [#182](https://github.com/simplefoc/Arduino-FOC/issues/182) - - open loop back-emf voltage issue [#219](https://github.com/simplefoc/Arduino-FOC/issues/219) - - SAMD51 compile issue [#217](https://github.com/simplefoc/Arduino-FOC/issues/217) - - ESP32-S3 compile issue [#198](https://github.com/simplefoc/Arduino-FOC/issues/198) - - ESP32 compile issue [#208](https://github.com/simplefoc/Arduino-FOC/issues/208), [#207](https://github.com/simplefoc/Arduino-FOC/issues/207) - - magnetic sensor direction finding more robust [#173](https://github.com/simplefoc/Arduino-FOC/issues/173), [#164](https://github.com/simplefoc/Arduino-FOC/pull/164) - - `StepDirListener` improved timing [#169](https://github.com/simplefoc/Arduino-FOC/issues/169), [#209](https://github.com/simplefoc/Arduino-FOC/pull/209) - - `HallSensor` velocity calculation fix [#192](https://github.com/simplefoc/Arduino-FOC/issues/192) -- API changes - - `setPhaseVoltage` is now public function - - `getVelocity` can now be called as many times as necessary - [see in docs](encoder#standalone-sensor) - - it recalculates the velocity if the time between calls is longer then `min_elapsed_time` - default 0.1ms - - `HallSensor` velocity calculation outlier removal using max expected velocity `velocity_max` - [see in docs](hall_sensors#step-21-velocity-outlier-removal) - - BG431 board can be used only with `LowsideCurrentSense` class! - [see in docs](current_sense#current-sensing-support-per-mcu-architecture) - - `initFOC` fails if current sense not initialised - [see in docs](bldcdriver3pwm#step-23-initialisation) - - 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) - - `cs.init()` and `driver.init()` return `1` if well initialised and `0` if failed +

NEW RELEASE πŸ“’: SimpleFOClibrary v2.3.0 see release

+ - Arduino Mega 6pwm more timers supported + - Arduino boards - frequency change support either 32kHz or 4kHz + - Arduino Uno - synched timers in 3pwm and 6pwm mode [#71](https://github.com/simplefoc/Arduino-FOC/issues/71) + - Teensy 3.x initial support for 6pwm + - Teensy 4.x initial support for 6pwm + - Example for v3.1 SimpleFOCShield + - RP2040 compatibility for earlehillpower core [#234](https://github.com/simplefoc/Arduino-FOC/pull/234) [#236](https://github.com/simplefoc/Arduino-FOC/pull/236) + - More flexible monitoring API + - start, end and separator characters + - decimal places (settable through commander) + - Added machine readable verbose mode in `Commander` [#233](https://github.com/simplefoc/Arduino-FOC/pull/233) + - *Simple**FOC**WebController* - Web based user interface for SimpleFOC by [@geekuillaume](https://github.com/geekuillaume) - [webcontroller.simplefoc.com](webcontroller.simplefoc.com) + - bugfix - `MagneticSensorPWM` multiple occasions - [#258](https://github.com/simplefoc/Arduino-FOC/pull/258) + - bugfix - current sense align - added offset exchange when exchanging pins + - bugfix - trapezoid 150 fixed + - bugfix - 4pwm on ESP8266 [#224](https://github.com/simplefoc/Arduino-FOC/pull/224) + - Additional `InlineCurrentSense` and `LowsideCurrentSense` constructor using milliVolts per Amp [#253](https://github.com/simplefoc/Arduino-FOC/pull/253) + - STM32L4xx current sense support by [@Triple6](https://github.com/Triple6) (discord) [#257](https://github.com/simplefoc/Arduino-FOC/pull/257) + - phase disable in 6pwm mode + - stm32 - software and hardware 6pwm + - atmega328 + - atmega2560 + - Lag compensation using motor inductance [#246](https://github.com/simplefoc/Arduino-FOC/issues/246) + - current control through voltage torque mode enhancement + - extended `BLDCMotor` and `StepperMotor` constructors to receive the inductance paramerer + - can also be set using `motor.phase_inductance` or through `Commander`
-## Arduino SimpleFOClibrary v2.2.3 +## Arduino SimpleFOClibrary v2.3.0 This video demonstrates the Simple FOC library basic usage, electronic connections and shows its capabilities.