System Requirements Document (SRD)

Project Name: retro-cable

1. Introduction

The retro-cable project is a cutting-edge tool designed to automate the calculation of critical parameters for LT XLPE cables. This system is tailored for electrical engineers and contractors in India, providing an intuitive interface to streamline cable selection and performance analysis. By leveraging data from the Polycab catalog, the system ensures accurate calculations for resistance, reactance, derating factors, temperature effects, and voltage drop. Users can simply select the cable size (in sq mm), and the system will handle the rest, delivering detailed outputs in real-time.

This document outlines the functional and non-functional requirements, user personas, design concepts, and technical specifications for the retro-cable project.

2. System Overview

The retro-cable system is designed to simplify and automate the process of cable parameter calculations. It eliminates manual errors and provides engineers with precise data for decision-making. The system will:

• Allow users to select a cable size (in sq mm) from a dropdown menu.
• Automatically calculate resistance, reactance, voltage drop, temperature impact, and derating factors.
• Pull resistance and reactance values directly from the Polycab catalog.
• Provide outputs in a detailed table format, with options to download results as a PDF.
• Be accessible across both mobile and desktop platforms for maximum usability.

This tool is ideal for professionals working on electrical installations, ensuring compliance with industry standards and improving efficiency.

3. Functional Requirements

• As a User, I should be able to select an LT XLPE cable size (in sq mm) from a dropdown menu.
• As a User, I should be able to view resistance and reactance values automatically fetched from the Polycab catalog.
• As a User, I should be able to calculate voltage drop based on the selected cable size and length.
• As a User, I should be able to calculate the derating factor based on temperature and other environmental conditions.
• As a User, I should be able to view all calculations in a detailed table format.
• As a User, I should be able to download the calculation results as a PDF.
• As a User, I should be able to input multiple cable lengths for comparative analysis.
• As a User, I should be able to access the tool on both mobile and desktop devices.

4. User Personas

1. Electrical Engineer

• Role: Designs and implements electrical systems.
• Needs: Accurate and quick calculations for cable parameters to ensure compliance with standards.
• Pain Points: Manual calculations are time-consuming and prone to errors.

2. Electrical Contractor

• Role: Executes electrical installations on-site.
• Needs: Easy-to-use tool for quick decision-making during installations.
• Pain Points: Lack of access to detailed calculations on mobile devices.

3. Project Manager

• Role: Oversees electrical projects and ensures timely delivery.
• Needs: High-level summaries and downloadable reports for project documentation.
• Pain Points: Difficulty in consolidating data from multiple sources.

5. Visuals Colors and Theme

The retro-cable project will use a retro-inspired color palette to align with its name while maintaining a professional and modern aesthetic.

• Background: #1E1E2F (Deep Midnight Blue)
• Surface: #2A2A3C (Charcoal Gray)
• Text: #E8E8F2 (Soft White)
• Accent: #FF6F61 (Retro Coral)
• Muted Tones: #6C6C80 (Muted Slate)

This palette ensures readability and a visually appealing interface that resonates with the retro theme.

6. Signature Design Concept

The retro-cable homepage will feature a retro terminal aesthetic with interactive animations.

Key Features:

• Dynamic Typing Effect: The homepage will mimic a retro computer terminal, where the system "types out" a welcome message and prompts users to select a cable size.
• Interactive Dropdown: When users hover over the dropdown menu, it will glow with a neon effect, reinforcing the retro theme.
• Real-Time Calculations: As users input parameters, the calculations will appear as if being "typed" on the screen, with a subtle sound effect for each keypress.
• Graphical Output: The results page will transition into a modern, clean table format, maintaining the retro aesthetic with subtle neon highlights.
• Micro-Interactions: Buttons will "click" with a mechanical sound, and transitions between pages will feature a flickering screen effect, reminiscent of old CRT monitors.

This design concept ensures a memorable and engaging user experience while maintaining functionality and professionalism.

7. Non-Functional Requirements

• The system must fetch resistance and reactance values from the Polycab catalog in under 2 seconds.
• The system must support both desktop and mobile browsers, including Chrome, Firefox, and Safari.
• The system must generate downloadable PDFs in under 5 seconds.
• The system must handle up to 10,000 concurrent users without performance degradation.
• The system must comply with Indian electrical standards and regulations.

8. Tech Stack

Frontend

• React for Web
• React Native for Mobile

Backend

• Python
• FastAPI

Database

• MySQL (with Alembic for migrations)

AI Tools

• GPT 5.4 for user-friendly responses

Local Orchestration

• Docker
• Docker-Compose

Server-Side Orchestration

• Kubernetes

9. Assumptions and Constraints

Assumptions

• Users will have access to the Polycab catalog for reference.
• The system will primarily be used in India, so all calculations will adhere to Indian electrical standards.
• Users will input accurate environmental conditions for derating factor calculations.

Constraints

• The system must be compatible with both mobile and desktop platforms.
• The system must integrate seamlessly with the Polycab catalog API.
• The system must support calculations for LT XLPE cables only.

10. Glossary

• LT XLPE Cable: Low Tension Cross-Linked Polyethylene Cable, commonly used in electrical installations.
• Resistance: The opposition to the flow of electric current, measured in ohms (Ω).
• Reactance: The opposition to the change in current flow, measured in ohms (Ω).
• Derating Factor: A multiplier applied to reduce the current-carrying capacity of a cable based on environmental conditions.
• Voltage Drop: The reduction in voltage in an electrical circuit between the source and load.
• Polycab Catalog: A reference document containing specifications for Polycab cables.