Skip to content

Latest commit

 

History

History
195 lines (154 loc) · 10.2 KB

README.md

File metadata and controls

195 lines (154 loc) · 10.2 KB
Raw

Arduino Simple Field Oriented Control (FOC) library

Library Compile License: MIT arduino-library-badge

Proper low-cost and low-power FOC supporting boards are very hard to find today and even may not exist. Even harder to find is a stable and simple FOC algorithm code for BLDC and Stepper motors capable of running on Arduino devices. Therefore this is an attempt to:

  • Demystify FOC algorithm and make a robust but simple Arduino library: Arduino SimpleFOClibrary
  • Develop a modular BLDC driver board: Arduino SimpleFOCShield.
  • New 📢: Develop a modular Stepper motor board for FOC control: Arduino StepperFOCShield

NEW RELEASE 📢: SimpleFOClibrary v2.0.1

  • ESP32 bugfix
    • frequency setting
    • pwm resolution
  • 2PWM stepper class added StepperMotor2PWM
  • some refactoring of examples

SimpleFOClibrary v2.0

  • 6PWM support See in docs!
    • Arduino UNO (atmega328)
    • stm32 boards
    • esp32 boards
  • BLDC driver code separated See in docs!
    • BLDC: 6pwm and 3pwm
    • Stepper: 4pwm
    • Hardware specific code in separate files
    • PWM config
  • I2C and SPI sensors multiple busses support by @owennewo See in docs!
  • Hall sensor refactoring @owennewo
  • A lot of refactoring
Experimental features
  • Initial implementation of Block commutation by @owennewo
    • FOCModulationType::Trapezoid_120
    • FOCModulationType::Trapezoid_150
  • Added support for separate setting of Ud and Uq setting.
    • Preparations for current control
    • Working only for SinePWM modulation at the moment

Arduino SimpleFOCShield

Features

  • Plug & play: In combination with Arduino SimpleFOClibrary
  • Low-cost: Price of €15 - Check the pricing
  • Max power 100W - max current 5A, power-supply 12-24V
    • Designed for Gimbal motors with the internal resistance >10 Ω.
  • Stackable: running 2 motors in the same time
  • Encoder/Hall sensor interface: Integrated 3.3kΩ pullups (configurable)
  • I2C interface: Integrated 4.7kΩ pullups (configurable)
  • Configurable pinout: Hardware configuration - soldering connections
  • Arduino headers: Arduino UNO, Arduino MEGA, STM32 Nucleo boards...
  • Open Source: Fully available fabrication files - how to make it yourself,
If you are interested in this board, order your version on this link: Shop

Arduino SimpleFOClibrary

This video demonstrates the SimpleFOClibrary basic usage, electronic connections and shows its capabilities.

Features

  • Arduino compatible:
    • Arduino library code
    • Arduino Library Manager integration
  • Open-Source: Full code and documentation available on github
  • Easy to setup and configure:
  • Modular:
  • Plug & play: Arduino SimpleFOCShield

Getting Started

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
  • Minimal project builder Docs

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
  • 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

  • Open terminal and run
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.

SimpleFOClibrary minimal project builder

For those willing to experiment and to modify the code I suggest using the minimal project builder minimal branch.

This code is completely independent and you can run it as any other Arduino Sketch without the need for any libraries.

All you need to do is:

  • Go to minimal branch
  • 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.

NOTE: This program uses all the default control parameters.

#include <SimpleFOC.h>

//  BLDCMotor( pole_pairs )
BLDCMotor motor = BLDCMotor(11);
//  BLDCDriver( pin_pwmA, pin_pwmB, pin_pwmC, enable (optional) )
BLDCDriver3PWM driver = 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();}
void doB(){encoder.handleB();}


void setup() {  
  // initialize encoder hardware
  encoder.init();
  // hardware interrupt enable
  encoder.enableInterrupts(doA, doB);
  // 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();
}

void loop() {
  // FOC algorithm function
  motor.loopFOC();

  // velocity control loop function
  // setting the target velocity or 2rad/s
  motor.move(2);
}

You can find more details in the SimpleFOC documentation.

Example projects

Here are some of the SimpleFOClibrary and SimpleFOCShield application examples.

Documentation

Find out more information about the Arduino SimpleFOC project in docs website

Arduino FOC repo structure

Branch Description Status
master Stable and tested library version Library Compile
dev Development library version Library Dev Compile
minimal Minimal Arduino example with integrated library MinimalBuild