Fixed typos on examples

Author: byDagor

examples/motion_control/open_loop_motor_control/open_loop_position_example/open_loop_position_example.ino

@@ -1,16 +1,19 @@
-// Open loop motor control example 
+// Open loop motor control example
  #include <SimpleFOC.h>
 
 
 // BLDC motor & driver instance
+// BLDCMotor motor = BLDCMotor(pole pair number);
 BLDCMotor motor = BLDCMotor(11);
+// BLDCMotor motor = BLDCMotor(pole pair number);
 BLDCDriver3PWM driver = BLDCDriver3PWM(9, 5, 6, 8);
+
 // Stepper motor & driver instance
 //StepperMotor motor = StepperMotor(50);
 //StepperDriver4PWM driver = StepperDriver4PWM(9, 5, 10, 6,  8);
 
 void setup() {
-  
+
   // driver config
   // power supply voltage [V]
   driver.voltage_power_supply = 12;
@@ -19,24 +22,24 @@ void setup() {
   motor.linkDriver(&driver);
 
   // limiting motor movements
-  motor.voltage_limit = 3;   // rad/s
-  motor.velocity_limit = 20; // rad/s
+  motor.voltage_limit = 3;   // [V]
+  motor.velocity_limit = 20; // [rad/s]
   // open loop control config
   motor.controller = ControlType::angle_openloop;
 
   // init motor hardware
   motor.init();
-  
+
 
   Serial.begin(115200);
   Serial.println("Motor ready!");
   _delay(1000);
 }
 
-float target_position = 0; // rad/s
+float target_position = 0; // [rad/s]
 
 void loop() {
-  // open  loop angle movements 
+  // open  loop angle movements
   // using motor.voltage_limit and motor.velocity_limit
   motor.move(target_position);
 
@@ -47,25 +50,25 @@ void loop() {
 // utility function enabling serial communication with the user to set the target values
 // this function can be implemented in serialEvent function as well
 void serialReceiveUserCommand() {
-  
+
   // a string to hold incoming data
   static String received_chars;
-  
+
   while (Serial.available()) {
     // get the new byte:
     char inChar = (char)Serial.read();
     // add it to the string buffer:
     received_chars += inChar;
     // end of user input
     if (inChar == '\n') {
-      
+
       // change the motor target
       target_position = received_chars.toFloat();
       Serial.print("Target position: ");
       Serial.println(target_position);
-      
-      // reset the command buffer 
+
+      // reset the command buffer
       received_chars = "";
     }
   }
-}
+}

examples/motion_control/open_loop_motor_control/open_loop_velocity_example/open_loop_velocity_example.ino

@@ -1,16 +1,19 @@
-// Open loop motor control example 
+// Open loop motor control example
 #include <SimpleFOC.h>
 
 
 // BLDC motor & driver instance
+// BLDCMotor motor = BLDCMotor(pole pair number);
 BLDCMotor motor = BLDCMotor(11);
+// BLDCDriver3PWM driver = BLDCDriver3PWM(pwmA, pwmB, pwmC, Enable(optional));
 BLDCDriver3PWM driver = BLDCDriver3PWM(9, 5, 6, 8);
+
 // Stepper motor & driver instance
 //StepperMotor motor = StepperMotor(50);
 //StepperDriver4PWM driver = StepperDriver4PWM(9, 5, 10, 6,  8);
 
 void setup() {
-  
+
   // driver config
   // power supply voltage [V]
   driver.voltage_power_supply = 12;
@@ -19,25 +22,24 @@ void setup() {
   motor.linkDriver(&driver);
 
   // limiting motor movements
-  motor.voltage_limit = 3;   // rad/s
-  motor.velocity_limit = 20; // rad/s
+  motor.voltage_limit = 3;   // [V]
+  motor.velocity_limit = 20; // [rad/s]
 
   // open loop control config
   motor.controller = ControlType::velocity_openloop;
 
   // init motor hardware
   motor.init();
-  
 
   Serial.begin(115200);
   Serial.println("Motor ready!");
   _delay(1000);
 }
 
-float target_velocity = 0; // rad/s
+float target_velocity = 0; // [rad/s]
 
 void loop() {
-  // open loop velocity movement 
+  // open loop velocity movement
   // using motor.voltage_limit and motor.velocity_limit
   motor.move(target_velocity);
 
@@ -48,25 +50,25 @@ void loop() {
 // utility function enabling serial communication with the user to set the target values
 // this function can be implemented in serialEvent function as well
 void serialReceiveUserCommand() {
-  
+
   // a string to hold incoming data
   static String received_chars;
-  
+
   while (Serial.available()) {
     // get the new byte:
     char inChar = (char)Serial.read();
     // add it to the string buffer:
     received_chars += inChar;
     // end of user input
     if (inChar == '\n') {
-      
+
       // change the motor target
       target_velocity = received_chars.toFloat();
       Serial.print("Target velocity ");
       Serial.println(target_velocity);
-      
-      // reset the command buffer 
+
+      // reset the command buffer
       received_chars = "";
     }
   }
-}
+}