SOLARAI PRO Preparing documentation scene...
Project Playbook

Documentation For Build & Deploy

This page keeps the cinematic style but stays practical: quick start, feature behavior, API contracts, and provider integration needed for implementation.

Read 01

Quick Start

Setup, map workflow, and first feasibility run in minutes.

Read 02

API Contracts

Endpoint list, payload patterns, and expected outputs.

Read 03

Test Live

Open dashboard and validate docs behavior against runtime UI.

Documentation aligned to active project workflow

Documentation

Welcome to the SolarAI Pro documentation. This guide will help you understand and use all 20 AI features of our comprehensive solar analysis platform.

About SolarAI Pro

SolarAI Pro is a comprehensive solar feasibility analysis tool powered by OpenAI GPT-4o, Google Gemini, and Groq AI. It combines satellite imagery, 20 AI-powered analysis features, and real-time vendor data to help you plan your solar installation.

Quick Start Guide

Follow these steps to get your first solar analysis in under 5 minutes:

Navigate to Dashboard

Click "Dashboard" in the navigation bar or the "Get Started" button to access the solar analysis tool.

Find Your Location

Use the search bar or zoom/pan the map to locate your property. The map uses HD satellite imagery.

Draw Your Rooftop

Click the polygon tool (pentagon icon) and draw around your rooftop. Click each corner, then close the shape.

Calculate Feasibility

Click "Calculate Solar Feasibility" to get instant results including capacity, cost, and savings estimates.

Explore AI Features

After calculation, use the AI Analysis Panel to detect obstacles, optimize layout, and get AI explanations.

System Requirements

ComponentRequirement
BrowserChrome, Firefox, Edge (latest versions)
InternetStable connection for satellite imagery
JavaScriptMust be enabled
Screen1024px+ width recommended

Map & Drawing Tools

The interactive map is powered by Leaflet.js with multiple satellite imagery providers.

Map Layers

  • Google Satellite - High-resolution imagery (default)
  • ESRI World Imagery - Alternative satellite view
  • Bing Aerial - Microsoft's satellite imagery
  • AI Enhanced - Super-resolution processing for clearer views
  • Roof Edge AI - Sobel edge detection overlay

Drawing Controls

  • Polygon Tool - Draw rooftop boundary (required for analysis)
  • Rectangle Tool - Quick rectangular selection
  • Edit - Modify existing drawings
  • Delete - Remove drawn shapes
Important

Draw accurately around your rooftop edges for best results. The calculated area directly affects all estimates.

Solar Analysis

The core calculation engine analyzes your drawn area and provides comprehensive results with location-based irradiance data for 10 Indian cities.

Output Metrics

MetricDescription
Actual AreaTotal rooftop area in square meters
Usable Area70% of actual area (accounting for spacing)
System CapacityKilowatt capacity based on panel technology
Daily GenerationExpected kWh per day with temperature derating
25-Year ProjectionLifetime generation with degradation modeling
Monthly/Yearly SavingsBased on your electricity rate

Panel Technologies

  • Mono PERC - 21% efficiency, standard choice
  • TOPCon - 22.5% efficiency, premium option
  • HJT - 23% efficiency, best temperature performance
  • Bifacial - 21.5% efficiency + 10% rear gain

Hardware Quote System

Get detailed Bill of Materials with real product pricing from verified vendors.

Components Included

  • Solar Panels - 540-545W panels from Waaree, Adani, Jinko, Tata, Vikram
  • Inverters - String inverters with MPPT configuration from Sungrow, GoodWe, Huawei
  • Mounting Structure - HDG/Aluminum RCC mounting with cable sizing
  • Electrical - DCDB, ACDB, cabling, earthing
  • Battery Storage - Optional lithium battery backup
  • Installation - Labor, commissioning, net-metering

AI Obstacle Detection

Uses AI to identify common rooftop obstacles that may affect panel placement.

Detected Obstacles

  • Water tanks (overhead/underground)
  • AC outdoor units
  • Exhaust vents and chimneys
  • Staircase headrooms
  • Satellite dishes and antennas
  • Parapet walls and skylights
POST /detect_obstacles { "area_sqm": 150.5, "roof_type": "RCC Flat", "provider": "gemini", "model": "gemini-2.5-flash" }

API Reference

SolarAI Pro exposes RESTful API endpoints for all AI features and core functionality.

Core Endpoints

EndpointMethodDescription
/coordsPOSTCalculate solar feasibility from polygon
/hardware_quotePOSTGenerate hardware BOM and pricing
/generate_rfq_emailPOSTGenerate vendor RFQ emails
/catalogGETGet product catalog
/realtime_productsGETFetch live product listings

AI Analysis Endpoints

EndpointMethodAI Feature
/detect_obstaclesPOSTAI Obstacle Detection
/optimize_usable_areaPOSTAI Usable Area Optimizer
/generate_panel_layoutPOSTAI Panel Layout Generator
/tilt_advisorPOSTAI Tilt & Orientation Advisor
/explain_calculationPOSTAI Calculation Explainer
/validate_inputPOSTAI Input Validation
/classify_roof_typePOSTAI Roof Type Classification
/estimate_structural_riskPOSTAI Structural Load Estimator
/analyze_shape_efficiencyPOSTAI Shape Efficiency Analyzer
/estimate_shadingPOSTAI Shading Probability Estimator
/seasonal_yieldPOSTAI Seasonal Yield Adjuster
/optimize_spacingPOSTAI Panel Spacing Optimizer
/confidence_scorePOSTAI Confidence Score Generator
/suitability_scorePOSTAI Rooftop Suitability Score
/safety_compliancePOSTAI Safety & Compliance Reminder
/generate_summaryPOSTAI Human-Readable Summary

LLM Integration

SolarAI Pro supports multiple AI providers for intelligent analysis. Choose the best model for your needs.

Supported Providers

ProviderModelsBest For
OpenAIGPT-4o, GPT-4o Mini, GPT-4 Turbo, O1 PreviewBest quality & reasoning
Geminigemini-2.5-flashComplex reasoning (default)
GroqLlama 3.3 70B, DeepSeek R1, Mixtral 8x7B, Qwen 3 32BFast inference
Switching Providers

Use the "AI Provider" dropdown in the dashboard to switch between OpenAI, Gemini, and Groq. Each provider has different strengths - OpenAI for quality, Gemini for reasoning, Groq for speed.

// API Request with Provider Selection POST /detect_obstacles { "area_sqm": 150.5, "roof_type": "RCC Flat", "provider": "openai", // or "gemini", "groq" "model": "gpt-4o-mini" // optional }

Advanced AI Features

These advanced AI features provide deep analysis for professional solar installations.

Roof Type Classification

Classifies roof material (RCC flat, metal sheet, tile, asbestos) with mounting recommendations.

Structural Load Estimator

Calculates total system weight (23kg/panel + 15kg mounting) and estimates load risk.

Shape Efficiency Analyzer

Analyzes polygon rectangularity using bounding box ratio. Scores 0-100% efficiency.

Shading Probability Estimator

Estimates shading risk based on location type, orientation, with temporal analysis (morning/midday/afternoon).

Seasonal Yield Adjuster

Calculates generation variations across summer (+10%), monsoon (-25%), autumn (+5%), winter (-5%).

Panel Spacing Optimizer

Optimal row spacing using formula: panel_height x tan(90 - solar_altitude).

Confidence Score Generator

Rates analysis reliability 0-100% with component breakdown for area, layout, capacity, cost, generation.

Rooftop Suitability Score

Composite 0-100 score with letter grade (A+ to F) combining all factors.

Safety & Compliance Reminder

Safety reminders with clearance requirements: parapet height, edge setback, fire pathways.

Human-Readable Summary

Comprehensive summary with headline, quick stats, key findings, and actionable next steps.

Disclaimer

All AI-generated analyses are estimates only. Always consult a certified structural engineer for load assessments and a licensed solar installer for final system design.