Merge pull request #10 from Morgritech/release/updates-for-v1

Release: updates for v1

README.md

@@ -42,7 +42,7 @@ The following libraries (available via the [Arduino library manager](https://www
 
 The image below shows a high level overview of the system:
 
-![UML class diagram](docs/uml-class-diagram-overview.png)
+![UML class diagram](images/uml-class-diagram-overview.png)
 
 ## Setup and build
 

arduino-libs.txt

@@ -1,3 +1,3 @@
 MT-arduino-momentary-button@3.0.0
-MT-arduino-stepper-driver@2.0.0
+MT-arduino-stepper-driver@3.0.0
 ArduinoLog@1.1.1

src/configuration.h

@@ -91,16 +91,16 @@ class Configuration {
 
   // Stepper driver properties.
   const uint16_t kMicrostepMode_ = 32; ///< Stepper driver microstep mode.
-  const float kPulDelay_us_ = 1.0; ///< Minimum delay (us) for the stepper driver PUL pin. 2.5 for TB6600 is not required since the library functions are slow enough.
+  const float kPulDelay_us_ = 1.0; ///< Minimum delay (us) for the stepper driver PUL pin.
   const float kDirDelay_us_ = 5.0F; ///< Minimum delay (us) for the stepper driver Dir pin.
   const float kEnaDelay_us_ = 5.0F; ///< Minimum delay (us) for the stepper driver Ena pin.
   const mt::StepperDriver::MotionDirection kDefaultMotionDirection_ = mt::StepperDriver::MotionDirection::kPositive; ///< Initial/default motion direction (Clockwise (CW)).
   static const uint8_t kSizeOfSweepAngles_ = 4; ///< No. of sweep angles in the lookup table.
   const float kSweepAngles_degrees_[kSizeOfSweepAngles_] = {45.0F, 90.0F, 180.0F, 360.0F}; ///< Lookup table for sweep angles (degrees) during oscillation.
-  const uint8_t kDefaultSweepAngleIndex_ = 0; ///< Index of initial/default sweep angle, i.e., 45 degrees.
+  const uint8_t kDefaultSweepAngleIndex_ = 0; ///< Index of initial/default sweep angle.
   static const uint8_t kSizeOfSpeeds_ = 4; ///< No. of speeds in the lookup table.
-  const float kSpeeds_RPM_[kSizeOfSpeeds_] = {5.0F, 10.0F, 15.0F, 20.0F}; ///< Lookup table for rotation speeds (RPM).
-  const uint8_t kDefaultSpeedIndex_ = 0; ///< Index of initial/default speed, i.e., 5 RPM.
+  const float kSpeeds_RPM_[kSizeOfSpeeds_] = {7.0F, 10.0F, 13.0F, 16.0F}; ///< Lookup table for rotation speeds (RPM).
+  const uint8_t kDefaultSpeedIndex_ = 0; ///< Index of initial/default speed.
   const float kAcceleration_microsteps_per_s_per_s_ = 6000.0; //8000.0; ///< Acceleration (microsteps per second-squared).
   const mt::StepperDriver::AccelerationAlgorithm kAccelerationAlgorithm_ = mt::StepperDriver::AccelerationAlgorithm::kMorgridge24; ///< Acceleration algorithm.
 

src/version.h

@@ -17,7 +17,7 @@ inline constexpr char* kName = "mtspin-mcu-firmware-";
 inline constexpr uint16_t kMajor = 1;
 inline constexpr uint16_t kMinor = 0;
 inline constexpr uint16_t kPatch = 0;
-inline constexpr char* kSuffix = "-rc.1";
+inline constexpr char* kSuffix = "";
 
 } // namespace mtspin