Add notes about save_configuration() rebooting the board.

This commit is contained in:
Samuel Sadok
2021-07-26 08:03:33 +02:00
parent e109d2d6b5
commit 96caaedcfd
2 changed files with 2 additions and 1 deletions
+1
View File
@@ -72,6 +72,7 @@ Please add a note of your changes below this heading if you make a Pull Request.
* Circular setpoint mode must be enabled when the step/dir interface is used.
* Replaced inline enum in ODriveArduino class by including new autogenerated ODriveEnums.h header file.
* Changed the example ODriveArduinoTest.ino file to reflect the new GetPosition member function. Also removed the scope resolution operator to access the enums as it can now be accessed from the global namespace.
* `save_configuration()` reboots the board.
### API Migration Notes
* `axis.config.turns_per_step` changed to `axis.controller.config.steps_per_circular_range`
+1 -1
View File
@@ -262,7 +262,7 @@ This is 4x the Pulse Per Revolution (PPR) value. Usually this is indicated in th
Please see the [Thermistors](thermistors.md) page for setup.
### 3. Save configuration
You can save all `.config` parameters to persistent memory so the ODrive remembers them between power cycles.
You can save all `.config` parameters to persistent memory so the ODrive remembers them between power cycles. This will reboot the board.
* `odrv0.save_configuration()` <kbd>Enter</kbd>.