Skip to content

Latest commit

 

History

History
191 lines (133 loc) · 6.9 KB

File metadata and controls

191 lines (133 loc) · 6.9 KB

LAN IoT Documentation

Comprehensive documentation, tutorials, and hardware designs for the LAN IoT Project

License GitHub

Disclosure: As an Amazon Associate I earn from qualifying purchases made with links from the products in this documentation.


About LAN IoT

LAN IoT is a LAN-first IoT platform designed for secure, local communication in remote locations with intermittent internet connectivity. Unlike cloud-dependent IoT solutions, LAN IoT enables secure RS-232/UART data access via HTTPS and WebSocket Secure (WSS) without requiring constant internet access.

Key Features

  • 🔒 Secure Local Communication - HTTPS/WSS with proper SSL/TLS certificates
  • 📡 RS-232/UART Bridge - Real-time serial data streaming to browsers and TCP clients
  • 🌐 Browser-Compatible - Modern browsers can connect directly to devices
  • 🏭 Industrial Ready - Designed for remote locations (farms, mines, oil fields)
  • 🔧 No Cloud Dependency - Operates independently after initial certificate acquisition

📚 Documentation Structure

Getting Started

Hardware

Software Guides

Tutorials

Use Cases

Contributing


🔗 Project Repositories

Repository Description Language Link
core ESP32-S3 firmware with HTTPS, WSS, TCP, RS-232 bridge C github.com/laniot/core
signer Certificate signing service for device certificates JavaScript github.com/laniot/signer
docs Documentation, tutorials, and hardware designs Markdown github.com/laniot/docs

🚀 Quick Links


📖 What's Included in This Repository

Hardware Designs

  • 3D printable enclosures (STL files)
  • FreeCAD source files for customization
  • Assembly fixtures and tooling
  • Reference photos and diagrams

Documentation

  • Comprehensive setup guides
  • API documentation
  • Troubleshooting resources
  • Real-world use case examples

Tutorials

  • Step-by-step walkthroughs
  • Configuration examples
  • Best practices
  • Integration guides

🛠️ Technology Stack

Core Firmware (ESP32-S3)

  • Framework: ESP-IDF v5.5.1
  • RTOS: FreeRTOS
  • Security: mbedTLS (SSL/TLS)
  • Storage: NVS (Non-Volatile Storage)
  • Protocols: HTTPS, WebSocket Secure (WSS), TCP

Certificate Signer (Node.js)

  • Runtime: Node.js
  • Certificate Generation: PKI utilities
  • API: RESTful HTTP service

💡 Why LAN-First?

Traditional IoT solutions rely on cloud connectivity, which fails in remote industrial locations with:

  • ❌ Intermittent or unreliable internet
  • ❌ Expensive or bandwidth-limited connections
  • ❌ Security concerns with cloud data storage

LAN IoT solves this by:

  • ✅ Operating entirely on local networks
  • ✅ Using proper SSL/TLS security (not self-signed certificates)
  • ✅ Enabling browser-based access without cloud servers
  • ✅ Supporting legacy RS-232/UART devices
  • ✅ Providing real-time data streaming via WSS and TCP

📸 Hardware Gallery

See the Images directory for hardware reference photos including:

  • Assembly procedures
  • Hardware components
  • Enclosure designs
  • Real-world deployments

🤝 Contributing

We welcome contributions! Please see:


📄 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Copyright 2025 Carlos Huggins & LAN-IOT Project Contributors

Third-Party Components

  • ESP-IDF: Apache License 2.0
  • FreeRTOS: MIT License
  • mbedTLS: Apache License 2.0

See NOTICE file for complete attribution.


📞 Support & Consulting

Design reviews, integration, and deployment consulting available.

Contact via LinkedIn: Carlos Huggins


Built with ❤️ for the Industrial IoT Community

GitHubLinkedIn