Skip to content

Commit 78dd88b

Browse files
techpoststechposts
authored andcommitted
Add hardware photos to all README files
Hardware Photos Added: ✅ Transmitter image.JPG (5.2 MB) - Actual transmitter hardware photo ✅ Receiver Image.jpg (5.5 MB) - Actual receiver hardware photo Documentation Updates: - Main README.md: Added "Hardware Photos" section after system overview * Shows actual transmitter unit (battery powered) * Shows actual receiver unit (USB powered) * Provides visual reference before hardware requirements section - Transmitter/README.md: Added hardware photo at top * Immediately shows users what the transmitter looks like * Placed after title, before hardware specifications - Receiver/README.md: Added hardware photo after architecture * Shows complete receiver assembly with OLED display * Placed after modular design benefits, before hardware specs Benefits for Users: 📸 Visual reference of actual hardware 🔧 See component layout and assembly 💡 Understand physical size and connections ✅ Verify their build matches reference design 🎯 Better planning before starting assembly Image Placement Strategy: 1. Main README: After system diagram, before requirements 2. Transmitter README: Right at top, immediate visual 3. Receiver README: After architecture, before technical details All images use relative paths (../docs/) for proper rendering in: - GitHub repository browser - Markdown editors - Documentation generators - Local clones Total image size: 10.7 MB (high-quality reference photos)
1 parent 21aac4b commit 78dd88b

5 files changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,16 @@ esptool.py --chip esp32c3 --port COM3 --baud 921600 write_flash 0x0 firmware.bin
118118
└─────────────────────────────────────────────────────────────────────────────┘
119119
```
120120

121+
### Hardware Photos
122+
123+
**Transmitter Unit** (Tank Side - Battery Powered):
124+
125+
![Transmitter Hardware](docs/Transmitter%20image.JPG)
126+
127+
**Receiver Unit** (Indoor - USB Powered):
128+
129+
![Receiver Hardware](docs/Receiver%20Image.jpg)
130+
121131
## 🛠 Hardware Requirements
122132

123133
### Transmitter (Tank Side)

Receiver/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Receiver.ino - Main program loop
2323
- Better for team collaboration
2424
- Clearer code organization
2525

26+
![Receiver Hardware](../docs/Receiver%20Image.jpg)
27+
2628
## Hardware
2729

2830
- **MCU**: ESP32-C3 SuperMini

Transmitter/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Battery-powered transmitter unit that measures water level using ultrasonic sensor and transmits data via LoRa. Optimized for ultra-low power consumption with deep sleep mode.
44

5+
![Transmitter Hardware](../docs/Transmitter%20image.JPG)
6+
57
## Hardware
68

79
- **MCU**: ESP32-C3 SuperMini

docs/Receiver Image.jpg

5.44 MB
Loading

0 commit comments

Comments
 (0)