Skip to content

README.md

Latest commit

 

History

History
112 lines (84 loc) · 2.54 KB

README.md

File metadata and controls

112 lines (84 loc) · 2.54 KB
Raw

Hardware Images

This directory contains reference photos and images for the LAN IoT project hardware.

Overview

This directory is organized to hold:

  • Hardware assembly procedures
  • Component placement and routing
  • Enclosure designs and 3D prints
  • Real-world installations
  • Troubleshooting references

Image Categories

Assembly Photos

Photos showing step-by-step assembly process:

  • Component identification
  • Soldering procedures
  • Wire routing
  • Enclosure installation
  • Quality checkpoints

Hardware Components

Detailed photos of:

  • ESP32-S3 development boards
  • RS-232 to TTL converters (MAX3232)
  • DB9 connectors
  • Wiring harnesses
  • Power supplies

Enclosures

3D printed enclosure documentation:

  • IoTBox V1 design
  • IoTBox V2 design (current)
  • Soldering Rig fixture
  • Print quality examples
  • Fit and finish details

Installations

Real-world deployment photos:

  • Wall-mounted installations
  • DIN rail mounting
  • Industrial environments
  • Remote location deployments
  • Integration with serial devices

Adding Images

When you add hardware photos to this directory:

  1. Use descriptive filenames:

    • Good: esp32-uart-wiring.jpg, iotbox-v2-assembly-step3.jpg
    • Bad: IMG_1234.jpg, photo.jpg

  2. Update this README with:

    • Brief description of what the image shows
    • Which documentation it relates to
    • Any special notes

  3. File formats:

    • JPEG/JPG for compatibility
    • HEIC for iOS photos (provide conversion info)
    • PNG for diagrams and screenshots

Converting HEIC to JPEG

If you have HEIC format photos from iPhone/iOS:

macOS:

sips -s format jpeg image.HEIC --out image.jpg

Linux:

convert image.HEIC image.jpg

Online: Use heictojpg.com

Using Images in Documentation

To reference images in markdown files:

![Description](../images/filename.jpg)

From docs/ subdirectories:

![Description](../../images/filename.jpg)

Contributing Images

We welcome hardware photos! Please:

  • Use good lighting
  • Focus on the relevant details
  • Include a brief description
  • Follow the naming convention
  • See CONTRIBUTING.md

Related Documentation

Note: This directory was reorganized from the original "Images/" folder. Original photos have been preserved but should be renamed with descriptive names as they are used in documentation.