FEAT a bit of docs update

Author: askuric

README.md

@@ -1,7 +1,7 @@
 # Arduino Simple Field Oriented Control (FOC) library 
 
 
-![Library Compile](https://github.com/askuric/Arduino-FOC/workflows/Library%20Compile/badge.svg)
+![Library Compile](https://github.com/simplefoc/Arduino-FOC/workflows/Library%20Compile/badge.svg)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![arduino-library-badge](https://www.ardu-badge.com/badge/Simple%20FOC.svg?)](https://www.ardu-badge.com/badge/Simple%20FOC.svg)
 
@@ -14,7 +14,7 @@ Therefore this is an attempt to:
 <blockquote class="info"><p> <b>NEW RELEASE 📢:</b> <i>Simple<b>FOC</b>library v1.7.0</i><br></p><ul>
 <li><strong>6PWM support </strong>
   <ul>
-    <li>Arduino UNO</li>
+    <li>Arduino UNO (atmega328)</li>
     <li>stm32 boards</li>
     <li>esp32 boards</li>
   </ul>
@@ -52,7 +52,7 @@ Therefore this is an attempt to:
 - **Arduino headers**: Arduino UNO, Arduino MEGA, STM32 Nucleo boards...
 - **Open Source**: Fully available fabrication files - [how to make it yourself](https://www.simplefoc.com/arduino_simplefoc_shield_fabrication), 
 
-##### If you are interested in this board, order your version on this link: [Simple FOC Shop](https://www.simplefoc.com/simplefoc_shield_product)
+##### If you are interested in this board, order your version on this link: [Shop](https://www.simplefoc.com/simplefoc_shield_product)
 
 <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>
 
@@ -65,7 +65,7 @@ Therefore this is an attempt to:
 </a>
 </p>
 
-This video demonstrates the Simple FOC library basic usage, electronic connections and shows its capabilities.
+This video demonstrates the *Simple**FOC**library* basic usage, electronic connections and shows its capabilities.
 
 
 ### Features
@@ -91,46 +91,37 @@ This video demonstrates the Simple FOC library basic usage, electronic connectio
 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.
 
 - Full library installation [Docs](https://docs.simplefoc.com/library_download)
-- Minimal code installation [Docs](https://docs.simplefoc.com/minimal_download)
+- Minimal project builder [Docs](https://docs.simplefoc.com/minimal_download)
 
-### Arduino SimpleFOC library installation to Arduino IDE
+### Arduino *SimpleFOClibrary* installation to Arduino IDE
 #### Arduino Library Manager 
 The simplest way to get hold of the library is directly by using Arduino IDE and its integrated Library Manager. 
 - Open Arduino IDE and start Arduino Library Manager by clicking: `Tools > Manage Libraries...`.
 - Search for `Simple FOC` library and install the latest version.
 - Reopen Arduino IDE and you should have the library examples in `File > Examples > Simple FOC`.
 
-### Using Github website 
-- Go to the [github repository](https://github.com/askuric/Arduino-FOC)
+#### Using Github website 
+- Go to the [github repository](https://github.com/simplefoc/Arduino-FOC)
 - Click first on `Clone or Download > Download ZIP`. 
 - Unzip it and place it in `Arduino Libraries` folder. Windows: `Documents > Arduino > libraries`.  
 - Reopen Arduino IDE and you should have the library examples in `File > Examples > Simple FOC`.
 
-### Using terminal
+#### Using terminal
 - Open terminal and run
 ```sh  
-cd *arduino libraries folder*
-git clone https://github.com/askuric/Arduino-FOC.git
+cd #Arduino libraries folder
+git clone https://github.com/simplefoc/Arduino-FOC.git
 ```
 - Reopen Arduino IDE and you should have the library examples in `File > Examples > Simple FOC`.
 
-###  SimpleFOC library minimal sketch example
+###  *SimpleFOClibrary* minimal project builder
 
-For those willing to experiment and to modify the code I suggest using the [minimal version](https://github.com/askuric/Arduino-FOC/tree/minimal) of the code. 
+For those willing to experiment and to modify the code I suggest using the minimal project builder [minimal branch](https://github.com/simplefoc/Arduino-FOC/tree/minimal). 
  > This code is completely independent and you can run it as any other Arduino Sketch without the need for any libraries. 
 
-#### Github website download
-- Go to [minimal branch](https://github.com/askuric/Arduino-FOC/tree/minimal) 
-- Download the code by clicking on the `Clone or Download > Download ZIP`.
-- Unzip it and open the sketch in Arduino IDE. 
-
-#### Using terminal
-- Open the terminal:
-  ```sh
-  cd *to you desired directory*
-  git clone -b minimal https://github.com/askuric/Arduino-FOC.git
-  ```
-- Then you just open it with the Arduino IDE and run it.
+All you need to do is:
+- Go to [minimal branch](https://github.com/simplefoc/Arduino-FOC/tree/minimal) 
+- Follow the tutorial in the README file and choose only the library files that are necessary for your application.
 
 ## Arduino code example
 This is a simple Arduino code example implementing the velocity control program of a BLDC motor with encoder. 
@@ -187,23 +178,22 @@ void loop() {
 You can find more details in the [SimpleFOC documentation](https://docs.simplefoc.com/).
 
 ## Example projects
-Here are some of the SimpleFOC application examples. 
-### Arduino Field Oriented Controlled Reaction Wheel Inverted Pendulum
-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).  
-<p align="">
+Here are some of the *Simple**FOC**library* and *Simple**FOC**Shield* application examples. 
+<p align="center">
 <a href="https://youtu.be/Ih-izQyXJCI">
-<img src="https://docs.simplefoc.com/extras/Images/youtube_pendulum.png"  height="320px">
+<img src="https://docs.simplefoc.com/extras/Images/youtube_pendulum.png"  height="250px" >
+</a>
+<a href="https://youtu.be/xTlv1rPEqv4">
+<img src="https://docs.simplefoc.com/extras/Images/youtube_haptic.png"  height="250px" >
+</a>
+<a href="https://youtu.be/RI4nNMF608I">
+<img src="https://docs.simplefoc.com/extras/Images/youtube_drv8302.png"  height="250px" >
+</a>
+<a href="https://youtu.be/zcb86TRxTxc">
+<img src="https://docs.simplefoc.com/extras/Images/youtube_stepper.png"  height="250px" >
 </a>
 </p>
 
-**The main benefits of using the BLDC motor in this project are:**
-- High torque to weight ratio
-  - The lighter the better
-- Lots of torque for low angular velocities
-  - No need to spin the motor to very high PRM to achieve high torques
-- No gearboxes and backlash
-  - Very smooth operation = very stable pendulum
-
 
 ## Documentation
 Find out more information about the Arduino SimpleFOC project in [docs website](https://docs.simplefoc.com/) 
@@ -212,6 +202,6 @@ Find out more information about the Arduino SimpleFOC project in [docs website](
 ## Arduino FOC repo structure
 Branch  | Description | Status
 ------------ | ------------- | ------------ 
-[master](https://github.com/askuric/Arduino-FOC) | Stable and tested library version | ![Library Compile](https://github.com/askuric/Arduino-FOC/workflows/Library%20Compile/badge.svg)
-[dev](https://github.com/askuric/Arduino-FOC/tree/dev) | Development library version | ![Library Dev Compile](https://github.com/askuric/Arduino-FOC/workflows/Library%20Dev%20Compile/badge.svg?branch=dev)
-[minimal](https://github.com/askuric/Arduino-FOC/tree/minimal) | Minimal Arduino example with integrated library | ![MinimalBuild](https://github.com/askuric/Arduino-FOC/workflows/MinimalBuild/badge.svg?branch=minimal)
+[master](https://github.com/simplefoc/Arduino-FOC) | Stable and tested library version | ![Library Compile](https://github.com/simplefoc/Arduino-FOC/workflows/Library%20Compile/badge.svg)
+[dev](https://github.com/simplefoc/Arduino-FOC/tree/dev) | Development library version | ![Library Dev Compile](https://github.com/simplefoc/Arduino-FOC/workflows/Library%20Dev%20Compile/badge.svg?branch=dev)
+[minimal](https://github.com/simplefoc/Arduino-FOC/tree/minimal) | Minimal Arduino example with integrated library | ![MinimalBuild](https://github.com/simplefoc/Arduino-FOC/workflows/MinimalBuild/badge.svg?branch=minimal)

src/SimpleFOC.h

@@ -20,21 +20,33 @@
  *  - Plug & play: Arduino SimpleFOC shield
  * 
  * @section dependencies Supported Hardware
- *
- * This library supports any arduino device and it is especially optimized for Arduino UNO boards and 
- * other Atmega328 boards. But it supports Arrduinio MEGA boards and similar.
- * 
- * From the version 1.3.0 it will support the STM32 boards such as Bluepill and Nucelo devices.<br>
- * The programming is done the same way as for the Arduino UNO but stm32 devices require STM32Duino package. <br>
- * You can download it directly from library manager.  
+ *  - Motors 
+ *    - BLDC motors
+ *    - Stepper motors
+ * - Drivers 
+ *    - BLDC drivers
+ *    - Gimbal drivers
+ *    - Stepper drivers
+ * - Position sensors 
+ *    - Encoders
+ *    - Magnetic sensors
+ *    - Hall sensors
+ *    - Open-loop control
+ * - Microcontrollers 
+ *    - Arduino
+ *    - STM32
+ *    - ESP32
+ *    - Teensy
  * 
  * @section example_code Example code
  * @code
 #include <SimpleFOC.h>
 
-//  initialize the motor
-BLDCMotor motor = BLDCMotor(9, 10, 11, 11, 8);
-//  initialize the encoder
+//  BLDCMotor( pole_pairs )
+BLDCMotor motor = BLDCMotor(11);
+//  BLDCDriver( pin_pwmA, pin_pwmB, pin_pwmC, enable (optional) )
+BLDCDriver3PWM motor = BLDCDriver3PWM(9, 10, 11, 8);
+//  Encoder(pin_A, pin_B, CPR)
 Encoder encoder = Encoder(2, 3, 2048);
 // channel A and B callbacks
 void doA(){encoder.handleA();}
@@ -46,20 +58,21 @@ void setup() {
   encoder.init();
   // hardware interrupt enable
   encoder.enableInterrupts(doA, doB);
-
-  // set control loop type to be used
-  motor.controller = ControlType::velocity;
-  
-  // use monitoring with the BLDCMotor
-  Serial.begin(115200);
-  // monitoring port
-  motor.useMonitoring(Serial);
-
   // link the motor to the sensor
   motor.linkSensor(&encoder);
+  
+  // power supply voltage [V]
+  driver.voltage_power_supply = 12;
+  // initialise driver hardware
+  driver.init();
+  // link driver
+  motor.linkDriver(&driver);
 
+  // set control loop type to be used
+  motor.controller = ControlType::velocity;
   // initialize motor
   motor.init();
+  
   // align encoder and start FOC
   motor.initFOC();
 }
@@ -71,9 +84,6 @@ void loop() {
   // velocity control loop function
   // setting the target velocity or 2rad/s
   motor.move(2);
-
-  // monitoring function outputting motor variables to the serial terminal 
-  motor.monitor();
 }
  * @endcode 
  *