Home - jjaroztegi/BuildingSignalSimulator GitHub Wiki

Building Signal Simulator Wiki

🇪🇸 Ver en español

Welcome to the Building Signal Simulator Wiki! This documentation will help you understand, set up, and use the Building Signal Simulator application.

Overview

Building Signal Simulator is a web-based application that simulates and optimizes signal distribution across multiple floors in buildings. The system helps calculate signal levels, optimize network configurations, and ensure signal quality meets predefined standards while maintaining cost-effectiveness.

Quick Navigation

  1. Getting Started

    • Prerequisites
    • Installation
    • Quick Start Guide
  2. Architecture

    • Technical Stack
    • Project Structure
    • Component Overview
  3. Database

    • Schema Overview
    • Tables Structure
    • Relationships
    • Example Data
  4. API Reference

    • Endpoints
    • Request/Response Formats
    • Authentication
    • Examples
  5. Frontend Guide

    • UI Components
    • JavaScript Modules
    • Theme System
    • Best Practices
  6. Development Guide

    • Setup Development Environment
    • Build Process
    • Testing
    • Deployment
  7. Features

    • Signal Level Calculation
    • Configuration Management
    • Component Management
    • Signal Simulation
    • Optimization (TODO)

Key Features

  • Signal Level Calculation: Computes signal levels floor-by-floor based on network components
  • Real-time Simulation: Interactive adjustment of parameters with instant signal level updates
  • Cost Optimization: Identifies most cost-effective component configuration while maintaining signal quality
  • Quality Validation: Ensures signal levels meet predefined margins at each floor
  • Visual Feedback: Clear visualization of signal levels with color-coded quality indicators
  • Dark Mode Support: Built-in dark mode for better visibility in low-light conditions

Contributing

Please read our Contributing Guidelines before submitting pull requests or reporting issues.

License

This project is under the MIT License. See LICENSE file for details.