From e1a9fb1f6ef412625e938eae82946fbac99d31d9 Mon Sep 17 00:00:00 2001 From: joshr120 <120012174+joshr120@users.noreply.github.com> Date: Wed, 25 Jun 2025 18:05:31 +1200 Subject: [PATCH] Update README.md First time ESPHome instruction added --- Software/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Software/README.md b/Software/README.md index 32d7063..3e0a591 100644 --- a/Software/README.md +++ b/Software/README.md @@ -3,7 +3,7 @@ #### If you just received your PD Stepper see the [Setup Instructions](https://github.com/joshr120/PD-Stepper/tree/main/Getting%20Started) for how to get started ## Arduino Upload settings: ## -When uploading software with the Arduino IDE ensure you have firtst installed the ESP32 Add-on in Arduino IDE there are [many tutorials](https://randomnerdtutorials.com/installing-esp32-arduino-ide-2-0/) on how to do this. +When uploading software with the Arduino IDE ensure you have first installed the ESP32 Add-on in Arduino IDE there are [many tutorials](https://randomnerdtutorials.com/installing-esp32-arduino-ide-2-0/) on how to do this. The Board type should be set as "ESP32S3 Dev Module" @@ -13,10 +13,12 @@ USB CDC on Boot should be set to "Enabled" ## ESPHome: ## +>If you have not used ESPHome before follow the offical [getting started guide](https://esphome.io/guides/getting_started_hassio.html). Select ESP32-S3 as the board type. The custom .yaml can then be copied from the repo into the configuration editor. Ensure you also add you WiFi SSID and password to your "Secrets". + The **PD-Stepper-Blinds-Advanced.yaml** config file uses the [custom TMC2209](https://github.com/slimcdk/esphome-custom-components/tree/master/esphome/components/tmc2209) component by [slimcdk](https://github.com/slimcdk). It also uses the AS5600 encoder so that if the blinds are manually moved it will not lose its end positions. Thanks to the custom componenet the example can also be modified to use stall gaurd for sensorless homing. PD voltage can be configured and it set an startup. > By default this will use the power on position as the OPEN position. -> If the motor spins but the cover stays in the "open" position it means either your encoder is not working or your motor is spinning in the opposite direction releative to your encoder. You can swap which lambda function is commneted out to reverse the encoder direction. +> If the motor spins but the cover stays in the "open" position it means either your encoder is not working or your motor is spinning in the opposite direction releative to your encoder. You can swap which lambda function is commented out to reverse the encoder direction. > You can enable sensorless homeing (Stallguard) by uncommenting line 129, you may need to tune the threshold and current values to get this to work well.