Skip to content

Commit 30992aa

Browse files
committed
Update hardware_recipes_guide.md
1 parent 961b216 commit 30992aa

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

hardware_recipes_guide.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ display:
2121
# __LAMBDA_PLACEHOLDER__
2222
```
2323
24+
> [!NOTE]
25+
> **Philosophy Alignment:** The Designer strictly separates hardware definition from application logic. Any system-level configuration (like `wifi`, `api`, `captive_portal`) in your recipe will be automatically commented out during export to prevent conflicts.
26+
2427
---
2528

2629
## 📝 Recipe Structure
@@ -58,12 +61,13 @@ The Designer looks for specific metadata in the form of comments at the top of y
5861

5962
---
6063

61-
## 👩‍🍳 Creating Your Own Recipe
64+
## 👩‍🍳 Creating Your Own Recipe (The Easy Way)
6265

6366
1. **Start with a working ESPHome YAML**: Take an existing, working configuration for your device.
6467
2. **Add Metadata**: Add the `# TARGET DEVICE`, `# Resolution`, and `# Shape` comments at the top.
65-
3. **Clean Up**: Remove any existing UI drawing logic (like `it.print`, `it.fill_screen`, etc.) from your `display` lambda.
66-
4. **Insert Placeholder**: Add `# __LAMBDA_PLACEHOLDER__` inside the lambda block.
68+
3. **Smart Sanitization (Optional)**: You can leave your system configuration (`esphome:`, `wifi:`, `api:`, etc.) in the file for testing. The Designer is "philosophy-aware" and will automatically comment these out when generating the final code.
69+
4. **Clean Up (Recommended)**: Remove any existing UI drawing logic (like `it.print`, `it.fill_screen`, etc.) from your `display` lambda.
70+
5. **Insert Placeholder**: Add `# __LAMBDA_PLACEHOLDER__` inside the lambda block.
6771
5. **Save**: Save the file with a `.yaml` extension (e.g., `my_awesome_device.yaml`).
6872

6973
> [!IMPORTANT]

0 commit comments

Comments
 (0)