108 lines
3.5 KiB
Markdown
108 lines
3.5 KiB
Markdown
# [DIY Kit Name] — Build Guide
|
||
|
||
**Version:** [v1.0]
|
||
**Date:** [YYYY-MM-DD]
|
||
**Author:** [Name / Contact]
|
||
|
||
---
|
||
|
||
## 1. Introduction
|
||
- What this kit does (short description).
|
||
- Skill level required (Beginner / Intermediate / Advanced).
|
||
- Estimated build time: [X hours].
|
||
- Tools required: [Soldering iron, multimeter, etc.].
|
||
|
||
---
|
||
|
||
## 2. Circuit Description
|
||
### 2.1 General Idea
|
||
- Short explanation of the concept.
|
||
- Example: *The kit demonstrates low-power control using an ATtiny85 microcontroller. It blinks an LED in Morse code and sleeps when ambient light is detected.*
|
||
|
||
### 2.2 Annotated Schematic
|
||
*(Insert schematic image exported from KiCad, e.g., as PNG or PDF)*
|
||
|
||
Use numbered blocks for explanation. Example:
|
||
|
||
**Figure 1: Schematic with annotation numbers**
|
||
|
||
| Block | Circuit Section | Description |
|
||
|:-----:|:------------------|:------------------------------------------------------------------------------------------------------|
|
||
| 1 | Power Supply | 2×AA batteries → DC/DC regulator (U1) → 5 V rail. Decoupling capacitors (C1, C2) smooth the voltage. |
|
||
| 2 | Controller | ATtiny85 (U2) running firmware. Pull-up resistors (R1, R2) ensure stable inputs. |
|
||
| 3 | LED Output | LED D1 driven by PB0. Current limited by R3 (330 Ω). |
|
||
| 4 | Light Sensor | LED D2 reverse biased → generates photocurrent. Read on PB2. |
|
||
| 5 | Programming Header| ISP 6-pin header for flashing firmware. |
|
||
| 6 | Test Points | Labeled pads J1–J3 for debugging with a multimeter. |
|
||
|
||
*(Link to the KiCad schematic file in Git repo, e.g.: [GitHub/Gitea link])*
|
||
|
||
### 2.3 Functional Flow
|
||
- Add a block diagram showing logic signal flow (KiCad → export block diagram or draw in Mermaid).
|
||
- Example: *Battery → DC/DC → ATtiny85 → LED driver → LED.*
|
||
|
||
---
|
||
|
||
## 3. Mechanical Parts
|
||
### 3.1 2D CAD Files
|
||
- Mechanical drawings in DXF for front panel / housing.
|
||
- Dimensions, hole positions, and cut-outs for connectors.
|
||
|
||
### 3.2 3D Models
|
||
- STL/STEP files for 3D printing, if available.
|
||
- Assembly orientation, support recommendations.
|
||
|
||
*(Link to repo with mechanical CAD files.)*
|
||
|
||
---
|
||
|
||
## 4. Kit Contents
|
||
*(BOM table)*
|
||
|
||
---
|
||
|
||
## 5. Safety Notes
|
||
⚠️ Soldering involves heat. Work on a non-flammable surface.
|
||
⚠️ Observe polarity on diodes, electrolytic capacitors, and ICs.
|
||
|
||
---
|
||
|
||
## 6. Assembly Instructions
|
||
*(step-by-step with images/photos)*
|
||
|
||
---
|
||
|
||
## 7. First Power-Up
|
||
*(preconditions + test steps)*
|
||
|
||
---
|
||
|
||
## 8. Adjustments / Calibration
|
||
*(potentiometer trim, jumper setting, firmware config)*
|
||
|
||
---
|
||
|
||
## 9. Troubleshooting
|
||
*(table with symptoms and remedies)*
|
||
|
||
---
|
||
|
||
## 10. Next Steps / Modifications
|
||
*(extensions, software mods, hardware mods)*
|
||
|
||
---
|
||
|
||
## 11. Resources
|
||
- **Git Repository:** [link]
|
||
- **KiCad Project Files:** [link]
|
||
- **DXF Mechanical Files:** [link]
|
||
- **STL/3D Models:** [link]
|
||
- **Firmware Source Code:** [link]
|
||
- **Datasheets:** [links]
|
||
|
||
---
|
||
|
||
## 12. Document Control
|
||
| Version | Date | Author | Changes |
|
||
|:-------:|:----------:|:-----------|:------------------------------------------|
|
||
| 1.0 | YYYY-MM-DD | [Name] | Initial release | |