Skip to content

Commit cf61686

Browse files
committed
DOCS readme update
1 parent 5ce4b48 commit cf61686

File tree

1 file changed

+29
-10
lines changed

1 file changed

+29
-10
lines changed

README.md

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,25 @@ Therefore this is an attempt to:
1111
- Develop a modular BLDC driver board: [Arduino *SimpleFOCShield*](https://docs.simplefoc.com/arduino_simplefoc_shield_showcase).
1212
- ***New 📢:** Develop a modular Stepper motor board for FOC control:* <b>Arduino <span class="simple">Stepper<span class="foc">FOC</span>Shield</span></b>
1313

14-
<blockquote class="info"><p> <b>NEW RELEASE 📢:</b> <i>Simple<b>FOC</b>library v1.6.0</i><br></p><ul><li><strong>Stepper motor FOC support 🎨🎉 🎊 <a href="https://docs.simplefoc.com/motors">See in docs!</a></strong><ul><li>No losing steps</li><li>Backdrivable</li><li>Better dynamics than open-loop, Smoother than open-loop</li><li>short demo <a href="https://youtu.be/w_yIY0eXM5E">youtube video</a></li></ul></li><li>Teensy support by <em>Christopher Parrott</em> <br></li><li>Pull requests by <a href="https://github.com/cousinitt">@cousinitt</a><ul><li>refactoring and c++11 improvements</li><li>pid + low pass filter refactoring</li></ul></li><li>Extended configurability of the sensor classes by <a href="https://github.com/owennewo">@owennewo</a> <b><a href="https://docs.simplefoc.com/magnetic_sensor">See in docs!</a></b></li><li>configurable pwm frequency <b><a href="https://docs.simplefoc.com/motor_initialization#step-33-pwm-frequency-configuration-optional">See in docs!</a></b><ul><li>stm32,teensy,eps32 - not for Arduino</li><li>stm32 added 12bit pwm resolution by <em>Jürgen Frisch</em></li></ul></li><li>Huge refactoring done in the library 😄</li></ul></blockquote>
14+
<blockquote class="info"><p> <b>NEW RELEASE 📢:</b> <i>Simple<b>FOC</b>library v1.7.0</i><br></p><ul>
15+
<li><strong>6PWM support </strong>
16+
<ul>
17+
<li>Arduino UNO</li>
18+
<li>stm32 boards</li>
19+
</ul>
20+
</li>
21+
<li>BLDC driver code separated
22+
<ul>
23+
<li> BLDC: 6pwm and 3pwm</li>
24+
<li> Stepper: 4pwm</li>
25+
<li> Hardware specific code in separate files</li>
26+
<li> PWM config</li>
27+
</ul>
28+
</li>
29+
<li>Refactoring </li>
30+
</ul>
31+
<i>The library version 1.7.0 will be released once when it is properly tested and documented!</i>
32+
</blockquote>
1533

1634
## Arduino *SimpleFOCShield*
1735

@@ -121,8 +139,10 @@ NOTE: This program uses all the default control parameters.
121139
```cpp
122140
#include <SimpleFOC.h>
123141

124-
// BLDCMotor( pin_pwmA, pin_pwmB, pin_pwmC, pole_pairs, enable (optional))
125-
BLDCMotor motor = BLDCMotor(9, 10, 11, 11, 8);
142+
// BLDCMotor( pole_pairs )
143+
BLDCMotor motor = BLDCMotor(11);
144+
// BLDCDriver( pin_pwmA, pin_pwmB, pin_pwmC, enable (optional) )
145+
BLDCDriver3PWM motor = BLDCDriver3PWM(9, 10, 11, 8);
126146
// Encoder(pin_A, pin_B, CPR)
127147
Encoder encoder = Encoder(2, 3, 2048);
128148
// channel A and B callbacks
@@ -138,10 +158,12 @@ void setup() {
138158
// link the motor to the sensor
139159
motor.linkSensor(&encoder);
140160

141-
// use monitoring with the BLDCMotor
142-
Serial.begin(115200);
143-
// monitoring port
144-
motor.useMonitoring(Serial);
161+
// power supply voltage [V]
162+
driver.voltage_power_supply = 12;
163+
// initialise driver hardware
164+
driver.init();
165+
// link driver
166+
motor.linkDriver(&driver);
145167

146168
// set control loop type to be used
147169
motor.controller = ControlType::velocity;
@@ -159,9 +181,6 @@ void loop() {
159181
// velocity control loop function
160182
// setting the target velocity or 2rad/s
161183
motor.move(2);
162-
163-
// monitoring function outputting motor variables to the serial terminal
164-
motor.monitor();
165184
}
166185
```
167186
You can find more details in the [SimpleFOC documentation](https://docs.simplefoc.com/).

0 commit comments

Comments
 (0)