Skip to content

Commit c670870

Browse files
Merge pull request #37 from Valar-Systems/docs/bom-hardware-corrections
docs: BOM/hardware corrections + Valar store links + wiki sync
2 parents 97635e2 + c70a018 commit c670870

7 files changed

Lines changed: 57 additions & 55 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The current revision is **v1.1**. Open the print plate at [hardware/plastics/v1.
5454

5555
## How to install it
5656

57-
Either use command strips (which is recommended) or 4 small nails (for drywall only), or two screws/anchors. It's very easy to install.
57+
Either use the included foam mounting squares (recommended), small nails (for drywall only), or two screws/anchors. It's very easy to install.
5858

5959

6060
## Sending commands

‎docs/BOM-V2.0.md‎

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,43 @@
11
# BOM V2.0
22

3-
> Reflects the **v1.1** hardware. What changed from v1.0: a smaller-diameter **MK8** drive gear (pull strength 11 lb → 15 lb), **one larger 633ZZ bearing per arm** instead of two small bearings, and **pre-cut PTFE tubes** (no razor-cutting). Quantities are per unit.
3+
> Reflects the **v1.1** hardware. What changed from v1.0: a smaller-diameter **MK8** drive gear (pull strength 11 lb → 15 lb), **one larger 633ZZ bearing per arm** instead of two small bearings, and **pre-cut PTFE tubes** (no razor-cutting). Quantities are per unit. Every purchasable part links to the [Valar Systems store](https://valarsystems.com).
44
55
## Body Assembly
66

77
| Part | Qty | Description |
88
| :--- | :---: | :--- |
9-
| VAL3000 PCB | 1 | [Custom PCB designed for this project](https://github.com/Valar-Systems/VAL3000) |
10-
| NEMA 17 motor, 48 mm body | 1 | [Smaller length NEMA 17 will also work](https://amzn.to/4a2OnDi) |
11-
| 12V / 2A+ power adapter w/ 5.5×2.1 mm plug | 1 | [Technically 5–29 V will work, but 12 V is best due to low speeds](https://amzn.to/3YauHG6) |
12-
| Extension cable | 1 | [Extends the length of the power adapter](https://amzn.to/4oHaTVT) |
13-
| M3 × 10 mm screw, self-tapping | 8 | |
14-
| M3 × 35 mm screw, button head | 3 | |
15-
| M3 square nut | 1 | |
16-
| M3 × 16 mm screw, button head | 2 | |
17-
| M3 × 10 mm screw, flat head | 2 | |
18-
| Gear | 1 | MK8 (5 mm bore, 9 mm OD) |
19-
| Bearing | 2 | 633ZZ, 3 mm × 13 mm × 5 mm |
9+
| VAL3000 PCB | 1 | [Custom ESP32 + Trinamic TMC2209 PCB](https://valarsystems.com/products/val3000). [Open-hardware design](https://github.com/Valar-Systems/VAL3000). |
10+
| NEMA 17 motor, 48 mm body | 1 | [NEMA 17, 48 mm body](https://valarsystems.com/products/stepper-motor-nema-17) — a shorter one also works. |
11+
| 24 V 1.5 A power adapter | 1 | [24 V 1.5 A, 5.5 × 2.1 mm barrel plug](https://valarsystems.com/products/power-adapter). |
12+
| Extension cable | 1 | [Straight barrel-plug extension](https://valarsystems.com/products/barrel-plug-extension-cable). |
13+
| M3 × 10 mm screw, self-tapping | 8 | [Thread-forming screw](https://valarsystems.com/products/m3-x-10mm-thread-forming-screw). |
14+
| M3 × 35 mm screw, button head | 3 | [Arm assembly screws](https://valarsystems.com/products/m3-x-35mm-button-head-screw). |
15+
| M3 square nut | 3 | [Square nut](https://valarsystems.com/products/m3-square-nut) — arm nuts (2) + clamp nut (1). |
16+
| M3 × 15 mm screw, button head | 3 | [Arm screws (2) + curtain-pulley screw (1)](https://valarsystems.com/products/m3-x-15mm-button-head-screw). |
17+
| M3 × 10 mm screw, flat head | 2 | [Flat-head screw](https://valarsystems.com/products/m3-x-10mm-flat-head-screw). |
18+
| Gear | 1 | MK8, 5 mm bore / 9 mm OD — [buy](https://valarsystems.com/products/ropener-drive-gear). |
19+
| Bearing | 2 | 633ZZ, 3 mm × 13 mm × 5 mm — [buy](https://valarsystems.com/products/633zz-bearing). |
2020

2121
## Curtain Assembly
2222

2323
| Part | Qty | Description |
2424
| :--- | :---: | :--- |
25-
| PTFE tubing, 3 mm ID × 5 mm OD (pre-cut) | 6 | 2 × 10 mm, 2 × 40 mm, 2 × 70 mm |
26-
| M3 × 10 mm screw, self-tapping | 11 | |
27-
| M3 square nut | 1 | |
28-
| M3 × 12 mm screw, flat head | 1 | |
29-
| Zip tie | 1 | Small, 2–3 mm wide |
30-
| V623ZZ pulley | 1 | 3 × 12 × 4 mm size |
31-
| Rope | 1 | 1.6 mm diameter |
25+
| PTFE tubing, 3 mm ID × 5 mm OD (pre-cut) | 6 | 2 × 10 mm, 2 × 40 mm, 2 × 70 mm — [buy](https://valarsystems.com/products/ptfe-tube). |
26+
| M3 × 10 mm screw, self-tapping | 14 | [Thread-forming screw](https://valarsystems.com/products/m3-x-10mm-thread-forming-screw). |
27+
| M3 square nut | 1 | [Curtain-pulley nut](https://valarsystems.com/products/m3-square-nut). |
28+
| Zip tie | 1 | Small, 2–3 mm wide — [buy](https://valarsystems.com/products/zip-tie). |
29+
| V623ZZ pulley | 1 | 3 × 12 × 4 mm — [V-groove pulley](https://valarsystems.com/products/v-groove-pulley). |
30+
| Rope | 1 | 1.6 mm diameter — [buy](https://valarsystems.com/products/rope). |
3231

3332
### Mounting Hardware
3433

3534
| Part | Qty | Description |
3635
| :--- | :---: | :--- |
37-
| Command strips | 2 | The easiest way to mount to any wall |
38-
| #17 × 1 1/4" wire nail | 3 | Use to nail to drywall only |
36+
| Foam mounting squares (set of 5) | 5 | 1" square double-sided foam. Wipe the surface clean and dry, then press firmly — [buy](https://valarsystems.com/products/foam-mounting-squares). |
3937

4038
## Assembly Tools Required
4139

4240
| Part | Qty | Description |
4341
| :--- | :---: | :--- |
44-
| Screwdriver, Phillips No. 1 | 1 | |
45-
| Hex driver, 2 mm | 1 | |
42+
| Screwdriver, Phillips No. 1 | 1 | [Phillips No. 1](https://valarsystems.com/products/phillips-no-1-screw-driver). |
43+
| Hex driver, 2 mm | 1 | [2 mm hex driver](https://valarsystems.com/products/allen-wrench-2mm). |

‎docs/make_bom.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,8 +207,8 @@ def bom_table(rows, widths=(2.7, 0.7, 3.0)):
207207
intro = doc.add_paragraph()
208208
intro.add_run(
209209
"Everything needed to build one Ropener. Quantities are per unit. Links in "
210-
"the Description column point to the custom PCB and suggested suppliers; "
211-
"equivalent parts may be substituted where noted."
210+
"the Description column point to the Valar Systems store; equivalent parts "
211+
"may be substituted where noted."
212212
)
213213

214214
# ---------------------------------------------------------------------------

‎docs/wiki-Build-Guide.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Everything the build needs is below. For the full, maintained list see the [Bill
8787
| NEMA 17 stepper motor | 1 |
8888
| 24 V 1.5 A power adapter | 1 |
8989
| Cable extension | as needed |
90-
| 3M Command Strips | 4 |
90+
| Foam mounting squares (set of 5) | 5 |
9191
| 1.6 mm rope | 30 ft |
9292
| PTFE tubing (pre-cut: 2 × 10 mm, 2 × 40 mm, 2 × 70 mm) | 6 |
9393
| M3 square nut | 4 |
@@ -98,7 +98,7 @@ Everything the build needs is below. For the full, maintained list see the [Bill
9898
| Bearing (633ZZ, 3 × 13 × 5 mm) | 2 |
9999
| MK8 drive gear | 1 |
100100
| Zip tie | 4 |
101-
| M3 × 10 mm thread-forming screw | 23 |
101+
| M3 × 10 mm thread-forming screw | 22 |
102102

103103
---
104104

@@ -133,20 +133,20 @@ This device works on the following curtain types.
133133
<!-- 📷 media/build-guide/08-drive-pulley.png — drive pulley on motor shaft -->
134134
4. **Attach the drive pulley.** Fit it onto the motor shaft. You'll fine-tune its position later.
135135

136-
<!-- 📷 media/build-guide/09-arms.png — arm with M3×12mm button head (red), one 633ZZ bearing (green), M3 square nut (orange) -->
137-
5. **Assemble the two arms.** Each arm uses an **M3 × 12 mm button-head screw**, **one 633ZZ bearing (3 × 13 × 5 mm)**, and an **M3 square nut**. Build both arms the same way.
136+
<!-- 📷 media/build-guide/09-arms.png — arm with M3×15mm button head (red), one 633ZZ bearing (green), M3 square nut (orange) -->
137+
5. **Assemble the two arms.** Each arm uses an **M3 × 15 mm button-head screw**, **one 633ZZ bearing (3 × 13 × 5 mm)**, and an **M3 square nut**. **On one of the two arms, also seat a third M3 square nut into its pocket now** — that pocket is inaccessible once the arms are mated, and the **M3 × 35 mm clamp screw** in Step 8 threads into this nut to pull the arm pair against the drive pulley. Build both arms the same way.
138138

139-
<!-- 📷 media/build-guide/10-arms-connector.png — plastic connector + both arms on motor, 2× M3×30mm screws -->
140-
6. **Attach the arms to the motor.** Fasten the plastic connector and **both arms** to the motor using **two M3 × 30 mm screws**.
139+
<!-- 📷 media/build-guide/10-arms-connector.png — plastic connector + both arms on motor, 2× M3×35mm screws -->
140+
6. **Attach the arms to the motor.** Fasten the plastic connector and **both arms** to the motor using **two M3 × 35 mm button-head screws** (two of the three arm assembly screws).
141141

142142
<!-- 📷 media/build-guide/11-pulley-alignment.png — drive pulley aligned with the two idler pulleys -->
143143
7. **Check alignment.** Make sure the **drive pulley is perfectly aligned** with the two idler pulleys.
144144

145-
<!-- 📷 media/build-guide/12-arms-bottom.png — M3×30mm screw joining bottom of both arms (do not tighten) -->
146-
8. **Join the bottom of the arms.** Use an **M3 × 30 mm screw** to connect the bottom of both arms. **Do not tighten yet** — you'll do this after the rope is connected to the pulley.
145+
<!-- 📷 media/build-guide/12-arms-bottom.png — M3×35mm screw joining bottom of both arms (do not tighten) -->
146+
8. **Join the bottom of the arms.** Use the third **M3 × 35 mm screw** to connect the bottom of both arms — it threads into the square nut you seated in Step 5 and clamps the arm pair against the drive pulley. **Do not tighten yet** — you'll do this after the rope is connected to the pulley.
147147

148-
<!-- 📷 media/build-guide/13-command-strips.png — 3M command strips applied to the marked area on the back -->
149-
9. **Apply the mounting strips.** Attach the **3M Command Strips** to the marked area on the back of the body.
148+
<!-- 📷 media/build-guide/13-mounting-squares.png — foam mounting squares applied to the marked area on the back -->
149+
9. **Apply the mounting squares.** Wipe the marked area on the back of the body clean and dry, then press the **five 1" foam mounting squares** firmly into place.
150150

151151
---
152152

@@ -167,8 +167,8 @@ The **PTFE tubes come pre-cut** — no cutting needed. You'll have **two of each
167167
<!-- 📷 media/build-guide/16-long-tubes.png — 2 long tubes placed, top plastic attached with 2 screws -->
168168
1. **Long tubes.** Place the **two long tubes**, then attach the top plastic using **two M3 thread-forming screws**.
169169

170-
<!-- 📷 media/build-guide/17-pulley-end.png — pulley end: short tubes, V-groove pulley with M3×12mm flathead, square nut, M3 thread-forming -->
171-
2. **Pulley end.** Fit the **short tubes**, then the **V-groove pulley** held by an **M3 × 12 mm flat-head screw**, secured with a **square nut** and an **M3 thread-forming screw**.
170+
<!-- 📷 media/build-guide/17-pulley-end.png — pulley end: short tubes, V-groove pulley with M3×15mm button head, square nut, M3 thread-forming -->
171+
2. **Pulley end.** Fit the **short tubes**, then the **V-groove pulley** held by an **M3 × 15 mm button-head screw**, secured with an **M3 square nut** and an **M3 thread-forming screw**.
172172

173173
<!-- 📷 media/build-guide/18-carriages-medium.png — 1 medium tube per carriage, top plastic over tubes, 4 side screws -->
174174
3. **Carriages.** Place **one medium tube** into each carriage, set the top plastic over the tubes, and drive **four M3 thread-forming screws** into the sides.

‎docs/wiki-Firmware-Guide.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ If you've never used ESPHome, the official [Getting Started guide](https://espho
4141

4242
## 2. How the Ropener firmware is built
4343

44-
At a high level, the curtain hardware is an **ESP32** microcontroller driving a **TMC2209** silent stepper driver, which turns a **NEMA-17 motor** and an **MK7 gear** that pulls the poly rope. The YAML wires all of that together. The main building blocks in the file:
44+
At a high level, the curtain hardware is an **ESP32** microcontroller driving a **TMC2209** silent stepper driver, which turns a **NEMA-17 motor** and an **MK8 gear** that pulls the poly rope. The YAML wires all of that together. The main building blocks in the file:
4545

4646
| YAML section | What it does |
4747
| --- | --- |
@@ -53,7 +53,7 @@ At a high level, the curtain hardware is an **ESP32** microcontroller driving a
5353
| `ota:` | Over-the-air update support, so later updates don't need a USB cable. |
5454
| `stepper:` + `cover:` | The motion engine. Position is tracked in motor *steps* and reported to the UI as a 0–1 (closed→open) ratio. |
5555
| `binary_sensor:` (buttons) | The three physical buttons (close/home, open, Wi-Fi reset). |
56-
| `number:` / `select:` / `switch:` / `text:` / `datetime:` | The runtime-tunable settings — travel distance, speed, motor direction, schedule times, timezone, latitude/longitude, StallGuard thresholds. |
56+
| `number:` / `switch:` / `text:` / `datetime:` | The runtime-tunable settings — travel distance, speed, motor direction, schedule times, timezone, latitude/longitude, StallGuard thresholds. |
5757
| `time:` + `sun:` + `interval:` | The daily schedule, including the optional sunrise/sunset mode. |
5858

5959
You don't need to understand every line to update the firmware — but it's all commented in the file itself if you want to dig in.

‎docs/wiki-Home.md‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,30 @@ Control it from its built-in web page, the on-device buttons, or your smart home
1414

1515
---
1616

17-
## 🚀 Quick Start
17+
## Quick Start
1818

1919
| Step | What you'll do | Guide |
2020
| :--: | :--- | :--- |
2121
| **1** | Get the parts — buy a kit or 3D-print the plastics. | [🛒 Kit](https://valarsystems.com/products/ropener) · [📋 BOM](https://github.com/Valar-Systems/Ropener/blob/main/docs/BOM-V2.0.md) |
22-
| **2** | Build it (~20 min). | [🔧 Build Guide](Build-Guide) |
23-
| **3** | Install it on your curtains. | [🪟 Installation Guide](Installation-Guide) |
24-
| **4** | Flash & configure the firmware. | [⚙️ ESPHome Guide](ESPHome-guide) |
25-
| **5** | Use it every day. | [📖 User Guide](User-Guide) |
22+
| **2** | Build it (~20 min). | [Build Guide](Build-Guide) |
23+
| **3** | Install it on your curtains. | [Installation Guide](Installation-Guide) |
24+
| **4** | Flash & configure the firmware. | [Firmware Guide](Firmware-Guide) |
25+
| **5** | Use it every day. | [User Guide](User-Guide) |
2626

2727
> 💬 Having trouble? [Open an issue](https://github.com/Valar-Systems/Ropener/issues) or improve this wiki.
2828
2929
---
3030

31-
## ✨ Why Ropener
31+
## Why Ropener
3232

3333
- **🔇 Silent** — Trinamic TMC2209 stepper driver.
34-
- **💪 Strong** — v1.1's MK8 drive gear pulls up to **15 lb** (up from 11 lb).
3534
- **📶 Wi-Fi built in** — control from any browser at `http://ropener-XXXXXX.local`, no cloud needed.
3635
- **🏠 Smart-home ready** — Home Assistant via ESPHome; Alexa, Apple & Google via Matterbridge.
3736
- **⏰ Scheduling** — set daily open/close times, or any position in between.
38-
- **🛠️ Easy install** — command strips mean no holes in the wall.
37+
- **🛠️ Easy install** — foam mounting squares mean no holes in the wall.
38+
39+
---
40+
41+
<p align="center">
42+
<a href="https://valarsystems.com">Valar Systems</a> · <a href="https://valarsystems.com/products/ropener">Buy a kit</a> · <a href="https://github.com/Valar-Systems/Ropener">Repo</a> · <a href="https://github.com/Valar-Systems/Ropener/issues">Issues</a>
43+
</p>

‎docs/wiki-_Sidebar.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,16 @@
66
---
77

88
**Getting Started**
9-
- [🏠 Home](Home)
9+
- [Home](Home)
1010

1111
**Build & Install**
12-
- [🔧 Build Guide](Build-Guide)
13-
- [🪟 Installation Guide](Installation-Guide)
14-
- [📋 Bill of Materials](https://github.com/Valar-Systems/Ropener/blob/main/docs/BOM-V2.0.md)
12+
- [Build Guide](Build-Guide)
13+
- [Installation Guide](Installation-Guide)
14+
- [Bill of Materials](https://github.com/Valar-Systems/Ropener/blob/main/docs/BOM-V2.0.md)
1515

1616
**Firmware & Use**
17-
- [⚙️ Firmware Guide](Firmware-Guide)
18-
- [⚙️ ESPHome Guide](ESPHome-guide)
19-
- [📖 User Guide](User-Guide)
17+
- [Firmware Guide](Firmware-Guide)
18+
- [User Guide](User-Guide)
2019

2120
---
2221

0 commit comments

Comments
 (0)