Graphical user interface for the SimpleFOClibrary. This application allows to tune and configure any BLDC/Stepper SimpleFOClibrary controlled device, using serial port communications and the Commander interface.
- Plug and play with the SimpleFOClibrary version 2.1
- Real-time tuning and configuration of the motors
- Real-time plotting and monitoring of motor variables
- Code generation for easier integration of the tuned parameters in your code
- Built on PyQt5 and a standardized
SimpleFOCConnectorinterface that can be used as a gateway form python to the SimpleFOClibrary device.
Don't worry, SimpleFOCStudio is easy to install even if you have never used the terminal before! 😃 There are just couple of steps to take:
- Install Python if you don't have it installed yet
- We suggest to use Anaconda. Here is how to install it.
- Once you have your Anaconda running open your terminal (on windows anaconda prompt) and run:
conda create -n simplefoc python=3.9.0
- Once this is done you will never have to run that command again, from now on you will just need:
conda activate simplefoc
- Clone this repository or download the zip file
- Enter the folder containing the repository using the terminal
- the command will be something like this:
cd some_path_on_disk/SimpleFOCStudio - Final step of the installation is installing all the necessary libraries for the SimpleFOCStudio :
pip install -r "requirements.txt"
Once you have done all the steps above you do not need to repeat them any more. All you need to do the next time is open your terminal in the SimpleFOCStudio directory and run the command:
python simpleFOCStudio.pyOr if using Anaconda:
conda activate simplefoc
python simpleFOCStudio.pySimpleFOCStudio has several useful features:
- A simple approach to tuning your motor setup
- Form view for fast motion control PID/LPF tuning
- TreeView for more in depth tunning and experimenting
- Code generation for transferring the found parameters into your arduino code
- Serial terminal integrated with various commander features
Once you have your application running add a device by clicking the 
motor button in the toolbar. You can choose either the 
TreeView or the 
FormView.
- To connect to your device first configure the serial port by clicking on
Configure button - Add your com port info and click OK
- Then add the device command ID that you've added to the commander usually its
M- Command
M, Arduino code :command.add('M',doMotor,"my motor") - Command
A, Arduino code :command.add('A',doMotor,"my motor")
- Command
- Then click to the
Connect button and you should be ready to go!
SimpleFOCStudio helps you to easier transfer your carefully tuned parameters to the Arduino code. Once you are happy with the performance of your system you can automatically generate the arduino code of the parameters you have tuned. To generate the code :
- Click on the
Arudino button in the toolbar. - Choose which sets of parameters you wish to generate the code for and click OK
- In the new tab you will have a code of your tuned parameters.
The generated code you can just copy/paste in your setup() function, just before calling the motor.init()
You can create your own custom commands if you extend the Commnader interface in your sketch. This can be used for example to do things like change register settings for SPI devicesor any oyher functionality. Each custom command has a name and a value as you can see at the below image.
- Fast Reverse button: reduces the current target by 2 times the specified increment.
- Reverse button: reduces the current target by the specified increment.
- Fordward button: Increase the current target by the specified increment.
- Fast Fordward button: Increase the current target by 2 times the specified increment.
- Stop button: in angle control mode, sets the current angle as target angle and in velocity control sets the target to zero.
SimpleFOCStudio also has integrated serial terminal for easier debugging and monitoring.
Basically there are two things you need to do:
- Use the commander interface and add the motor to the commander
- Use the monitoring and add the
motor.monitor()in the loop
Here is a mockup of the code:
#include <SimpleFOC.h>
....
// include commander interface
Commander command = Commander(Serial);
void doMotor(char* cmd) { command.motor(&motor, cmd); }
void setup(){
....
// add the motor to the commander interface
// The letter (here 'M') you will provide to the SimpleFOCStudio
command.add('M',doMotor,'motor');
// tell the motor to use the monitoring
motor.useMonitoring(Serial);
motor.monitor_downsample = 0; // disable monitor at first - optional
...
}
void loop(){
....
....
// real-time monitoring calls
motor.monitor();
// real-time commander calls
command.run();
}
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent