API Reference

Complete API documentation for ESP32 Distance Sensor components using Sphinx-Needs methodology.

Each API is documented with full traceability to requirements and design specifications.

Overview

The ESP32 Distance Sensor provides modular components for common IoT patterns:

• Configuration Management - JSON schema-driven configuration with NVS storage

• Web Server - HTTP server with captive portal support

• WiFi Management - Station and Access Point mode management

• Network Tunneling - QEMU network bridge for emulation

• Certificate Handling - HTTPS certificate management

Component APIs

API Documentation

• Config Manager API
  • Lifecycle Functions
  • String Parameter Access
  • Integer Parameter Access
  • Boolean Parameter Access
  • Bulk JSON Configuration API
• LED Controller API
  • Data Types
  • Lifecycle Functions
  • Pixel Control Functions
  • Utility Functions
  • Query and State Functions
• Distance Sensor API
  • Lifecycle Functions
  • Data Access Functions
  • Statistics & Monitoring Functions
  • Data Types
• Display Logic API
  • Lifecycle Functions
• Startup Tests API
  • Test Functions
• Network Tunnel API
  • Configuration Structure
  • Lifecycle Functions
• Certificate Handler API
  • Lifecycle Functions
  • Certificate Access Functions
• Web Server API
  • Lifecycle Functions
  • Static File Handler
  • Data Types
• WiFi Manager API
  • Lifecycle Functions
  • Configuration/Status Functions
  • Utility Functions
  • Data Types