Skip to content

Commit

Permalink
updated "Contributing" directions
Browse files Browse the repository at this point in the history
  • Loading branch information
doudar committed Aug 15, 2024
1 parent 69961f3 commit bea59da
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Removed extra logging when loading table.
- Prevent table returns from going in the wrong direction.
- Fixed bug with stepper speed not updating.
- Removed driver temp checking. It's not accurate on the ESP32.


### Hardware
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,11 @@ Everything you need to know is in the [SS2K Wiki](https://github.com/doudar/Smar
## Contributing
1. Install Microsoft Visual Code. https://code.visualstudio.com/
2. Install PlatformIO into Visual Code. https://platformio.org/platformio-ide
3. Install Pre-commit. https://pre-commit.com
4. Install pre-push git hooks: `pre-commit install --hook-type pre-push`
5. Open this project in PlatformIO.
3. Install Python https://www.python.org/downloads/
4. Install Pre-commit. https://pre-commit.com `py -m pip install pre-commit`
5. Follow any install warnings to add pre-commit to your path.
6. Install pre-push git hooks: `pre-commit install --hook-type pre-push`
7. Open this project in PlatformIO.

## Important announcement for existing users
If you experience an issue after upgrading firmware, please follow these instructions in the Wiki. Flashing instructions are available [HERE.](https://github.com/doudar/SmartSpin2k/wiki/Loading-Software)
Expand Down
4 changes: 3 additions & 1 deletion src/Main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,9 @@ void SS2K::maintenanceLoop(void *pvParameters) {

// Things to do every 20 loops
if (loopCounter > 20) {
ss2k->checkDriverTemperature();
// Removed driver temp checking. This really doesn't do anything benificial anyway, because the thermistors in the ESP32 are not accurate.
// The Driver itsself will throttle automatically if the temp is too high.
// ss2k->checkDriverTemperature();

#ifdef DEBUG_STACK
Serial.printf("Step Task: %d \n", uxTaskGetStackHighWaterMark(moveStepperTask));
Expand Down

0 comments on commit bea59da

Please sign in to comment.