update

Author: nerdyscout

.devcontainer/esphome/Dockerfile

@@ -0,0 +1,10 @@
+FROM esphome/esphome:latest
+
+# Create a non-root user
+RUN adduser --disabled-password --gecos '' vscode && \
+    usermod -aG dialout vscode && \
+    mkdir -p /home/vscode/.esphome && \
+    chown -R vscode:vscode /home/vscode/.esphome
+
+USER vscode
+WORKDIR /workspace

.devcontainer/esphome/devcontainer.json

@@ -0,0 +1,18 @@
+{
+    "name": "ESPHome",
+    "build": {
+        "dockerfile": "Dockerfile",
+        "context": ".."
+    },
+    "runArgs": [
+        "--privileged",
+        "--network=host"
+    ],
+    "settings": {
+        "terminal.integrated.defaultProfile.linux": "/bin/bash"
+    },
+    "extensions": [
+        "esphome.vscode-esphome"
+    ],
+    "remoteUser": "vscode"
+}

.devcontainer/kibot/devcontainer.json

@@ -0,0 +1,18 @@
+{
+    "name": "KiBot",
+    "image": "ghcr.io/inti-cmnb/kicad9_auto_full:latest",
+    "runArgs": [
+        "-v",
+        "/var/run/docker.sock:/var/run/docker.sock"
+    ],
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "danielmeza.kicad-syntax-highlighter",
+                "argmaster.gerber-x3-x2-format-support",
+                "ms-python.python",
+                "github.vscode-github-actions"
+            ]
+        }
+    }
+}

.github/workflows/release.yaml

@@ -9,10 +9,12 @@ on:
     branches:
       - main
       - develop
-      
+            
 jobs:
   release:
     runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/inti-cmnb/kicad9_auto_full:latest
     permissions:
       contents: write
     steps:
@@ -39,7 +41,7 @@ jobs:
         with:
         # commit_message: Automated Change
           file_pattern:
-              'docs/bom/* docs/*.pdf docs/*.svg docs/img/*.svg cad/*.stl cad/*.step'
+              'pcb/docs/bom/*.* pcb/docs/*.*  pcb/docs/img/*.svg cad/*.stl cad/*.step cad/img/*.png'
 
       # generate changelog
       - name: Conventional Changelog Action
@@ -50,6 +52,7 @@ jobs:
           output-file: 'CHANGELOG.md'
 
       # upload artifact
+      - run: rm pcb/fp-info-cache
       - name: upload artifact
         uses: actions/upload-artifact@v4
         with:

.gitignore

@@ -15,7 +15,7 @@ _autosave-*
 *.tmp
 *-save.pro
 *-save.kicad_pcb
-fp-info-cache
+pcb/fp-info-cache
 ~*.lck
 \#auto_saved_files#
 
@@ -41,3 +41,5 @@ _site
 .jekyll-cache
 .jekyll-metadata
 vendor
+
+firmware/esphome/.esphome/*

README.md

@@ -4,51 +4,79 @@ current state: untested :warning:
 
 inspired by [joshr120/PD-Stepper](https://github.com/joshr120/PD-Stepper) but being fully open hardware/software.
 
-Stepper motor controller using silent Trinamic TMC2209, ESP32-S3 and USB-PD mountable onto any NEMA17 motor. 
+Stepper motor controller using Trinamic TMC2208, ESP32-S3 and USB-PD mountable onto any NEMA17 motor. 
 
 ## Main Features:
-- **TMC2209** stepper motor driver
 - **ESP32-S3**
-  - alternatively NE555 pulse generator
+  - alternatively a LM555 pulse generator can be used.
 - **USB Power Delivery** providing up to 20V operation
-  - alternatively external voltage supply possible
-- **MPU-6050** 6axis accelerometer
-- **BME280** temperature sensor
-- **QWIIC** connector for external I2C components
-- 2x **WS2812** RGB LEDs
-- 2x **Push Buttons**
-- optional 0.96" 128x96 **LC-Display**
-- **JTAG** pins accessible
-- **3 GPIO** pins and **UART** available
+  - alternatively 9-24 Volt external supply 
+- **TMC2208** silent stepper motor driver
+- optional
+  - rotary encoder:
+    - **AS5048B** 14-Bit angular position sensor
+    - **MPU-9250** 9-axis motion sensor
+  - 0.96" 128x96 **LC-Display**
+  - **BME280** temperature sensor
+  - **QWIIC** connector for external I2C components
+  - **JTAG** pins accessible
+  - **3 GPIO** pins and **UART** available
+  - 2x **WS2812** RGB LEDs
+  - 2x **Push Buttons**
 
 ## PCB
 
 ### Schematic
 
-[![schematic](docs/esp32stepper-schematic.svg)](docs/esp32stepper-schematic.pdf)
+[![schematic](pcb/docs/img/esp32stepper-schematic.svg)](pcb/docs/esp32stepper-schematic.pdf)
 
 ### Bill of Materials
 
 The complete BOM is available in different formats:
-  - [Excel](docs/bom/esp32stepper-bom.xlsx)
-  - interactive [HTML](https://nerdyscout.github.io/esp32stepper/docs/bom/esp32stepper-ibom.html)
+  - interactive [HTML](https://nerdyscout.github.io/esp32stepper/pcb/docs/bom/esp32stepper-ibom.html)
+  - [octopart](pcb/docs/bom/esp32stepper-octopart.csv)
+  - [Excel](pcb/docs/bom/esp32stepper-bom.xlsx)
 
-### Layout
+### Fabrication
 
-| Top                                        | Bottom                                           |
-| ------------------------------------------ | ------------------------------------------------ |
-| ![top view](docs/img/esp32stepper-top.svg) | ![bottom view](docs/img/esp32stepper-bottom.svg) |
+[![fabrication](pcb/docs/img/esp32stepper-fabrication.svg)](pcb/docs/esp32stepper-fabrication.pdf)
+
+#### Layout
+
+<table border="0" width="100%">
+  <tr>
+    <th><strong>Top</strong></th>
+    <th><strong>Bottom</strong></th>
+  </tr>
+  <tr>
+    <td><img src="pcb/docs/img/esp32stepper-top.svg" alt="PCB top view" width="400"></td>
+    <td><img src="pcb/docs/img/esp32stepper-bottom.svg" alt="PCB bottom view" width="400"></td>
+  </tr>
+</table>
 
-### Gerbers
 
 All fabrication files needed to produce this PCB are located within the [release package](https://github.com/nerdyscout/esp32stepper/releases).
 
+#### Assembly Variants
+
+There are two options to power this board, do not connect both at the same time!
+- via connector *PWR* an **external 9-24 Voltage** can be applied which than also will be used to power the stepper motor. 
+- **USB-PD** by setting the CFG pins a voltage is selected. This can be made either by assembling the resistors or in firmware of the ESP32.
+
+There are as well two options for controlling the board:
+- The **LM555** gives some basic PWM frequency driving the stepper controller. Instead of the external rotary encoder a potentiometer can be connected and choosing R15, R16 and C18 correctly should allow any stepping frequency.
+- using the **ESP32-S3** gives much more options as it allows to utilize the I2C components (LC Display, accelerometer, temperature sensor), two RGB Leds and dynamically sets USB voltage.
+
+Microstepping can be enabled by setting jumper MS1 and MS2.
+
 ## Mechanics
 
-in the folder `cad` the spacers between motor and PCB, as well as the housing, can be found. One of the two spacer parts can be made out of metal to act as heatsink for the TMC2209. 
+![render](cad/img/render.png) 
+
+in the folder `cad` the spacers between motor and PCB, as well as the top housing, can be found. The spacer below the stepper controller should be made out of metal so it could act as heat sink, the other part can be simply 3D printed. If the external power connector is not assembled those two spacer parts could be manufactured with less hight, this brings the hall sensor closer to the magnet which needs to be glued onto the motor axis. 
 
 ## Firmware
 
 ### ESPHome
 
-There is a [esphome](https://esphome.io/) config file supporting different features located at `firmware/esphome`
+There is a [esphome](https://esphome.io/) config file supporting various features located at `firmware/esphome`

_config.yml

@@ -20,7 +20,7 @@
 
 title: ESP32STEPPER
 email: stefan.herold@posteo.de
-description: "Stepper motor controller using TMC2209, ESP32-S3 and USB-PD mountable onto any NEMA17 motor."
+description: "Stepper motor controller using TMC2208, ESP32-S3 and USB-PD mountable onto any NEMA17 motor."
 baseurl: "esp32stepper" # the subpath of your site, e.g. /blog
 url: "" # the base hostname & protocol for your site, e.g. http://example.com
 github_username: nerdyscout