Setup Git
This commit is contained in:
108
docs/Build Guide - 0004-DenshaBekutoru.md
Normal file
108
docs/Build Guide - 0004-DenshaBekutoru.md
Normal file
@ -0,0 +1,108 @@
|
||||
# [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 |
|
||||
108
docs/Technical Manual - 0004-DenshaBekutoru.md
Normal file
108
docs/Technical Manual - 0004-DenshaBekutoru.md
Normal file
@ -0,0 +1,108 @@
|
||||
# [Project Name] — Technical Manual
|
||||
|
||||
**Device:** [Device Name]
|
||||
**Version:** [Document Version]
|
||||
**Date:** [YYYY-MM-DD]
|
||||
**Author:** [Name / Contact]
|
||||
**Reviewed by:** [Reviewer]
|
||||
|
||||
---
|
||||
|
||||
## 1. Purpose and Scope
|
||||
- **Purpose:** Short description of what the device does.
|
||||
- **Scope:** Define the application area.
|
||||
- **Target Audience:** Who should use this manual (e.g., service technicians, engineers).
|
||||
- **Limitations:** What is not covered or not allowed.
|
||||
|
||||
---
|
||||
|
||||
## 2. Safety Information
|
||||
⚠️ **Read before use!**
|
||||
|
||||
### 2.1 General Safety
|
||||
- Only trained personnel may operate the device.
|
||||
- Follow standard ESD and laboratory safety rules.
|
||||
|
||||
### 2.2 Electrical Safety
|
||||
- Max. internal voltage: [X V].
|
||||
- Use only insulated test leads and approved measurement devices.
|
||||
|
||||
### 2.3 Residual Risks
|
||||
- [List possible hazards in failure scenarios.]
|
||||
|
||||
---
|
||||
|
||||
## 3. Device Overview
|
||||
### 3.1 Description
|
||||
Short text describing device and functionality.
|
||||
|
||||
### 3.2 Front Panel Elements
|
||||
| ID | Name | Function |
|
||||
|:-----:|:------------------|:--------------------------|
|
||||
| SW1 | Channel Switch 1 | Activates channel 1 |
|
||||
| LED1 | Status LED | Indicates request active |
|
||||
| J1.1 | Connector | Test input/output |
|
||||
|
||||
### 3.3 Block Diagram
|
||||
*(Insert diagram or schematic here)*
|
||||
|
||||
---
|
||||
|
||||
## 4. Intended Use
|
||||
- The device is designed only for [specific purpose].
|
||||
- Any other use is not permitted and voids responsibility of manufacturer.
|
||||
|
||||
---
|
||||
|
||||
## 5. Setup and Operation
|
||||
### 5.1 Preconditions
|
||||
- Batteries charged.
|
||||
- All switches OFF.
|
||||
|
||||
### 5.2 Step-by-Step Procedure
|
||||
| Step | Action | Expected Result | Remarks |
|
||||
|:-----:|:----------------------------------|:----------------------|:--------------------------|
|
||||
| 1 | Switch ON | LED lights green | — |
|
||||
| 2 | Connect test cable J1.0 red/black | Channel LED active | — |
|
||||
| 3 | Trigger tool GUI request | LED1 ON | Only one channel active |
|
||||
|
||||
*(Add additional steps as needed)*
|
||||
|
||||
---
|
||||
|
||||
## 6. Maintenance and Troubleshooting
|
||||
### 6.1 Maintenance
|
||||
- Replace fuse [specification].
|
||||
- Replace batteries [specification].
|
||||
|
||||
### 6.2 Troubleshooting
|
||||
| Symptom | Possible Cause | Remedy |
|
||||
|:--------------------------|:------------------|:----------------------------------|
|
||||
| No LED response | Battery empty | Replace batteries |
|
||||
| Incorrect channel active | Miswiring | Check tool GUI configuration |
|
||||
|
||||
---
|
||||
|
||||
## 7. Technical Data
|
||||
| Parameter | Value |
|
||||
|:------------------|:------------------|
|
||||
| Supply Voltage | [X V] |
|
||||
| Fuse | [specification] |
|
||||
| Battery | [type] |
|
||||
| Max. current | [value] |
|
||||
| Dimensions | [mm] |
|
||||
| Weight | [g] |
|
||||
|
||||
---
|
||||
|
||||
## 8. References and Resources
|
||||
- CAD files: [Link]
|
||||
- Schematics: [Link]
|
||||
- Git repository: [Link]
|
||||
|
||||
---
|
||||
|
||||
## 9. Document Control
|
||||
| Version | Date | Author | Changes |
|
||||
|:-------:|:----------:|:-----------|:------------------------------------------|
|
||||
| 1.0 | YYYY-MM-DD | [Name] | Initial release |
|
||||
Reference in New Issue
Block a user