Merge branch 'dev' of https://github.com/simplefoc/Arduino-FOC.git into dev

Author: runger1101001

README.md

@@ -16,14 +16,32 @@ Therefore this is an attempt to:
    - ***NEW*** 📢: *Medium-power* BLDC driver (<30Amps): [Arduino <span class="simple">Simple<b>FOC</b>PowerShield</span> ](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)
 
-##### <b> Release notes:</b> <i>Simple<b>FOC</b>library</i> v2.2
-> - Sensor floating point error bugfux #83
-> - Support for portenta h7 board
-> - Support for arduino leonardo #108
-> - Support for esp8266
-> - Low side current sensing support for esp32
-> - Restructured the generic code and simplified adding new mcus
-> - Awesome :smiley: Low side current sening support for B_G431B_ESC1 by [@sDessens](https://github.com/sDessens): PR #73 
+
+<blockquote class="info">
+   <p class="heading">NEW RELEASE 📢: <span class="simple">Simple<span class="foc">FOC</span>library</span> v2.2 - <a href="https://github.com/simplefoc/Arduino-FOC/releases/tag/v2.2">see release</a></p>
+   <ul>
+   <li>Sensor floating point error bugfix (initial solution) #83, #37</li>
+   <li>Sensor class restructuring - <b>slight API change</b> - <a href="https://docs.simplefoc.com/sensors">docs</a></li>
+   <li>Restructured the generic code and simplified adding new mcus: <b>IMPORTANT: an additional compiler flag needed for PlatformIO</b> see <a href="https://github.com/simplefoc/Arduino-FOC/issues/99">issue</a> and <a href="https://docs.simplefoc.com/library_platformio">PlatformIO docs</a></li>
+   <li>Removed initial jump #110, #111</li>
+   <li>Double to float transformation of the code - performance increase by <a href="https://github.com/sDessens">@sDessens</a> (#100), <a href="https://github.com/KaSroka">@KaSroka</a> (#100)  </li>
+   <li> <a href="https://docs.simplefoc.com/docs_chinese"><b>Docs webiste translated to Chinese!</b></a> 🎉: Awesome work 😃 by <a href="https://github.com/MINQING1101">@MINQING1101</a>, <a href="https://github.com/Deng-ge-open-source">@Deng-ge-open-source</a> and <a href="https://github.com/mingggggggg">@mingggggggg</a></li>
+   <li>New MCU support - <a href="https://docs.simplefoc.com/microcontrollers">docs</a>
+      <ul>
+         <li>Support for arduino leonardo #108 </li>
+         <li>Initial support for portenta h7 board in collaboration with <img src="https://docs.simplefoc.com/extras/Images/arduino.png" height="15px"><a href="https://www.arduino.cc/">Arduino</a></li>
+         <li>Initial support for esp8266</li>
+      </ul>
+   </li>
+   <li>Low side current sensing initial support - <a href="https://docs.simplefoc.com/current_sense">docs</a>
+      <ul>
+         <li>Initial support for stm32 B_G431B_ESC1 by <a href="https://github.com/sDessens">@sDessens</a>: PR #73</li>
+         <li>Initial support for samd21 by <a href="https://github.com/maxlem">@maxlem</a>: PR #79</li>
+         <li>Initial support for esp32 by <a href="https://github.com/maxlem">@byDagor</a></li>
+      </ul> 
+   </li>
+   </ul>
+</blockquote>
 
 ## Arduino *SimpleFOClibrary* v2.1
 

examples/hardware_specific_examples/B_G431B_ESC1/B_G431B_ESC1.ino

@@ -7,7 +7,7 @@
 // Motor instance
 BLDCMotor motor = BLDCMotor(11);
 BLDCDriver6PWM driver = BLDCDriver6PWM(PHASE_UH, PHASE_UL, PHASE_VH, PHASE_VL, PHASE_WH, PHASE_WL);
-InlineCurrentSense currentSense = InlineCurrentSense(0.003, -64.0/7.0, OP1_OUT, OP2_OUT, OP3_OUT);
+LowsideCurrentSense currentSense = LowsideCurrentSense(0.003, -64.0/7.0, OP1_OUT, OP2_OUT, OP3_OUT);
 
 
 // encoder instance
@@ -43,6 +43,8 @@ void setup() {
 
   // current sensing
   currentSense.init();
+  // no need for aligning
+  currentSense.skip_align = true;
   motor.linkCurrentSense(&currentSense);
 
   // aligning voltage [V]
@@ -97,15 +99,8 @@ float target_angle = 0;
 
 void loop() {
   // main FOC algorithm function
-  // the faster you run this function the better
-  // Arduino UNO loop  ~1kHz
-  // Bluepill loop ~10kHz 
-  motor.loopFOC();
 
   // Motion control function
-  // velocity, position or voltage (defined in motor.controller)
-  // this function can be run at much lower frequency than loopFOC() function
-  // You can also use motor.move() and set the motor.target in the code
   motor.move(target_angle);
 
   // function intended to be used with serial plotter to monitor motor variables

src/common/base_classes/Sensor.h

@@ -28,8 +28,8 @@ enum Pullup{
  * Encoders, Magnetic Encoders and Hall Sensor implementations. This base class extracts the
  * most basic common features so that a FOC driver can obtain the data it needs for operation.
  * 
- * To implement your own sensors, create a sub-class of this class, and implement the getAngle()
- * method. getAngle() returns a float value, in radians, representing the current shaft angle in the
+ * To implement your own sensors, create a sub-class of this class, and implement the getSensorAngle()
+ * method. getSensorAngle() returns a float value, in radians, representing the current shaft angle in the
  * range 0 to 2*PI (one full turn). 
  * 
  * To function correctly, the sensor class update() method has to be called sufficiently quickly. Normally,

src/common/pid.cpp

@@ -28,7 +28,6 @@ float PIDController::operator() (float error){
     float proportional = P * error;
     // Tustin transform of the integral part
     // u_ik = u_ik_1  + I*Ts/2*(ek + ek_1)
-    // method uses the antiwindup Foxboro method : https://core.ac.uk/download/pdf/289952713.pdf
     float integral = integral_prev + I*Ts*0.5f*(error + error_prev);
     // antiwindup - limit the output
     integral = _constrain(integral, -limit, limit);

src/current_sense/LowsideCurrentSense.cpp

@@ -75,11 +75,7 @@ int LowsideCurrentSense::driverSync(BLDCDriver *driver){
 // 3 - success but gains inverted
 // 4 - success but pins reconfigured and gains inverted
 int LowsideCurrentSense::driverAlign(BLDCDriver *driver, float voltage){
-    //gain_a *= -1;
-    //gain_b *= -1;
-    //gain_c *= -1;
-
-    /*
+    
     int exit_flag = 1;
     if(skip_align) return exit_flag;
 
@@ -90,9 +86,9 @@ int LowsideCurrentSense::driverAlign(BLDCDriver *driver, float voltage){
     // read the current 100 times ( arbitrary number )
     for (int i = 0; i < 100; i++) {
         PhaseCurrent_s c1 = getPhaseCurrents();
-        c.a = c.a*0.6 + 0.4f*c1.a;
-        c.b = c.b*0.6 + 0.4f*c1.b;
-        c.c = c.c*0.6 + 0.4f*c1.c;
+        c.a = c.a*0.6f + 0.4f*c1.a;
+        c.b = c.b*0.6f + 0.4f*c1.b;
+        c.c = c.c*0.6f + 0.4f*c1.c;
         _delay(3);
     }
     driver->setPwm(0, 0, 0);
@@ -165,7 +161,7 @@ int LowsideCurrentSense::driverAlign(BLDCDriver *driver, float voltage){
         // read the adc voltage 500 times ( arbitrary number )
         for (int i = 0; i < 50; i++) {
             PhaseCurrent_s c1 = getPhaseCurrents();
-            c.c = (c.c+c1.c)/50.0;
+            c.c = (c.c+c1.c)/50.0f;
         }
         driver->setPwm(0, 0, 0);
         gain_c *= _sign(c.c);
@@ -180,6 +176,4 @@ int LowsideCurrentSense::driverAlign(BLDCDriver *driver, float voltage){
     // 4 - success but pins reconfigured and gains inverted
 
     return exit_flag;
-    */
-    return 1;
 }

src/current_sense/hardware_api.h

@@ -43,7 +43,4 @@ float _readADCVoltageLowSide(const int pinA);
  */
 void _driverSyncLowSide();
 
-
-void _startADC3PinConversionLowSide();
-
 #endif

src/current_sense/hardware_specific/stm32g4_mcu.cpp

@@ -34,6 +34,10 @@ float _readADCVoltageInline(const int pin){
 
   return raw_adc * _ADC_CONV;
 }
+// do the same for low side sensing
+float _readADCVoltageLowSide(const int pin){
+  return _readADCVoltageInline(pin);
+}
 
 void _configureOPAMP(OPAMP_HandleTypeDef *hopamp, OPAMP_TypeDef *OPAMPx_Def){
   // could this be replaced with LL_OPAMP calls??
@@ -108,6 +112,10 @@ void _configureADCInline(const int pinA,const int pinB,const int pinC){
     Error_Handler();
   }
 }
+// do the same for low side
+void _configureADCLowSide(const int pinA,const int pinB,const int pinC){
+  _configureADCInline(pinA, pinB, pinC);
+}
 
 extern "C" {
 void DMA1_Channel1_IRQHandler(void) {