Skip to main content

Additional Features

Overview of advanced AquaGen features including SCADA/HMI visualization, Water Sustainability indices, Analytics & Reports, Manual Data Entry, and specialized monitoring tools.

1. SCADA Editor & Viewer​

Supervisory Control and Data Acquisition (SCADA) interface for visual monitoring and control.

Dedicated docs

This is a summary. For full, code-verified detail see SCADA Viewer and SCADA Editor.

Overview​

SCADA feature provides graphical representation of water infrastructure with real-time data visualization, allowing users to create custom diagrams and monitor live values on a visual schematic.

Routes (registered in production and demo apps only):

  • /scadaEditor - SCADA diagram editor (apps/production/src/routes/routes.js:196)
  • /scadaViewer - View-only SCADA interface (apps/production/src/routes/routes.js:192)

Permissions:

  • SCADA_EDITOR - Edit and create diagrams
  • SCADA_VIEWER - View existing diagrams

Key capabilities​

  • SCADA Editor — visual graph editor built on ReactFlow; 28 node types (tanks, equipment, status indicators, general shapes) plus pipe/edge types, multi-page diagrams, formula binding ({unitId} / {unitId -> param}), and JSON import/export. Loads and saves via POST scada/graphEditor.
  • SCADA Viewer — read-only ReactFlow render of the saved diagram with live, date-scoped values from scada/data, colour-coded device status, and a Remote Control panel (POST plc/write-registers with a confirm dialog + PLC ACK verification).

Both sidebar entries are SidebarAccess.STRICT_HIDDEN (hidden without the permission, no super-user bypass).

→ Full, code-verified detail (data model, edge cases, dependencies, visibility) lives in the dedicated docs: SCADA Viewer · SCADA Editor.

2. Water Sustainability Features​

Comprehensive water sustainability metrics and indices.

Water Balance​

Track water inputs vs outputs for sustainability analysis.

Route: /water-balance Permission: WATER_BALANCE

Metrics:

  • Water Credited (Augmented):

    • Rainwater harvested
    • Rainwater recharged
    • Wastewater treated and reused

  • Water Debited (Consumed):

    • Groundwater extracted
    • Municipal water used
    • External water (tankers)

  • Balance Calculation:

    Water Balance = Water Credited - Water Debited
    Neutrality % = (Water Credited / Water Debited) × 100

Features:

  • Monthly water balance reports
  • Trend graphs (credited vs debited)
  • Neutrality score tracking
  • Export balance sheet (PDF, Excel)

Water Neutrality​

Percentage of water augmented compared to water consumed.

Route: /water-neutrality

Display:

  • Current neutrality percentage
  • Historical trend (monthly, yearly)
  • Target vs actual comparison
  • Sustainability score

Color Coding:

  • Green (≥100%): Positive water balance
  • Yellow (75-99%): Near neutral
  • Orange (50-74%): Needs improvement
  • Red (<50%): Critical deficit

Water Indices​

Four key sustainability indices:

Rain Water Index (RWI)​

Measures rainwater harvesting efficiency — full detail in Rainfall (RWI).

RWI = (Rainwater Harvested / Total Rainfall) × 100

Route: /rwi (production + demo). The standalone rwi/AquaRain app mounts the same page at /home (apps/rwi/src/routes/routes.js:42). Permission (sidebar gate): RWI. Note: RWI_EFFICIENCY_SAVINGS is defined but not actually enforced in the current UI — see the dedicated doc.

Urban Water Index (UWI)​

Used-water / STP performance metric — shipped as the AquaRecycle standalone app. Full detail in STP / AquaRecycle (UWI).

Routes: /uwi → /uwi/plant-view, /uwi/uwms-energy (production + uwms app). Permission (sidebar gate): UWI. Note: UWI_DASHBOARD does not gate /uwi — it toggles the separate main-app dashboard variant (a super-user exception). UWI_SHOW_ENERGY_SAVING gates the energy/CO₂ cards.

Water Risk Index (WRI)​

Assess water stress and risk levels

Route: /wri Permission: WRI

Risk Factors:

  • Groundwater depletion rate
  • Dependency on external sources
  • Seasonal variability
  • Demand growth trends

Risk Levels:

  • Low Risk (0-25)
  • Medium Risk (26-50)
  • High Risk (51-75)
  • Critical Risk (76-100)

Ground Water Index (GWI)​

Ground water sustainability indicator

Route: /gwi Permission: GWI

Calculations:

  • Extraction vs recharge ratio
  • Water table decline rate
  • Aquifer health score
  • Sustainability forecast

3. Analytics & Reports​

Comprehensive reporting and data export capabilities.

Report Types​

Consumption Report​

Detailed breakdown of water consumption

Contents:

  • Daily/monthly/yearly consumption
  • Category-wise breakdown
  • Unit-wise analysis
  • Peak consumption periods
  • Trend analysis

Export Formats: PDF, Excel, CSV

Quality Report​

Water quality parameter analysis

Contents:

  • Parameter readings (pH, TDS, Turbidity, etc.)
  • Threshold violation summary
  • Compliance status
  • Historical trends
  • Lab test results

Stock Report​

Storage tank inventory report

Contents:

  • Current stock levels
  • Capacity utilization
  • Fill/drain patterns
  • Stock trends
  • Low stock alerts

Alert Summary Report​

Comprehensive alert analytics

Contents:

  • Alert frequency by type
  • Response time analysis
  • Resolution status
  • Top alerting units
  • Alert trends

Scheduled Reports​

Automated report generation and distribution

Features:

  • Daily/Weekly/Monthly Schedule
  • Email Distribution: Send to multiple recipients
  • Auto-Generate: Run at specified time
  • Template Customization: Choose report sections
  • Format Selection: PDF or Excel

Configuration:

{
  reportType: 'consumption',
  schedule: 'daily',
  time: '08:00',
  recipients: ['manager@example.com', 'admin@example.com'],
  format: 'PDF',
  sections: ['summary', 'trends', 'alerts']
}

Data Export​

Bulk data export for external analysis

Export Options:

  • CSV: Raw data export
  • Excel: Formatted workbook with charts
  • PDF: Presentation-ready report
  • JSON: API data dump

Time Ranges:

  • Last 24 hours
  • Last 7 days
  • Last 30 days
  • Custom date range

4. Manual Data Entry​

Manual input for offline sensors or manual readings.

Route: /manual-entry Permission: MANUAL_ENTRY

Features​

Entry Forms:

  • Unit selection dropdown
  • Parameter selection
  • Value input with validation
  • Timestamp entry
  • Notes/comments field

Validation:

  • Min/max range checks
  • Unit type verification
  • Duplicate entry detection
  • Mandatory field validation

Use Cases:

  • Offline sensor backup
  • Lab test results entry
  • Manual meter readings
  • Calibration data
  • Historical data import

Audit Trail:

  • User who entered data
  • Entry timestamp
  • Original vs edited values
  • Edit history

API:

POST /manual/entry
Request Body: {
  unitId: 'UNIT_1',
  parameter: 'stock',
  value: 850.5,
  timestamp: '25/02/2026 10:30',
  notes: 'Manual reading from gauge',
  enteredBy: 'user123'
}

5. User Management​

User roles, permissions, and account management.

Route: /users (Admin only) Permission: SUPER_USER

Features​

User Roles​

  • Super User: Full access, user management
  • Admin: All features except user management
  • Manager: View and basic operations
  • Operator: Limited to assigned units
  • Viewer: Read-only access

Permission Management​

  • Granular permission assignment (33+ permissions)
  • Role-based templates
  • Custom permission sets
  • Unit-level access control

User Operations​

  • Create/edit/delete users
  • Reset passwords
  • Enable/disable accounts
  • View activity logs
  • Bulk user import

6. Settings & Configuration​

System-wide and user-specific settings.

Route: /settings

Categories​

Account Settings​

  • Profile information
  • Email preferences
  • Notification settings
  • Language/timezone
  • Theme (light/dark)

Facility Settings (Admin)​

  • Organization details
  • Site information
  • Contact details
  • Logo upload
  • Subscription details

Monitoring Configuration​

  • Threshold values
  • Alert rules
  • Refresh intervals
  • Data retention
  • Unit mappings

Integration Settings​

  • API keys
  • Webhook URLs
  • SMTP configuration
  • SSO settings
  • Third-party integrations

7. Energy Monitoring​

Dedicated doc

Full detail in Energy Monitoring. The summary below is a high-level overview only.

Track energy consumption related to water operations.

Route: /energy Permission: ENERGY_CATEGORY

Features​

Metrics:

  • Total energy consumption (kWh)
  • Energy per unit water (kWh/kL)
  • Pump efficiency
  • Peak demand
  • Cost analysis

Visualizations:

  • Energy consumption trends
  • Time-of-day analysis
  • Equipment-wise breakdown
  • Renewable vs non-renewable
  • Cost savings from efficiency

Integration:

  • Links to water pumping data
  • Correlates with flow rates
  • Treatment plant energy
  • Distribution network energy

8. Mobile App Features​

Capacitor-based mobile application.

Capabilities​

Platform Support:

  • iOS (native)
  • Android (native)
  • Progressive Web App (PWA)

Mobile-Specific Features:

  • Push notifications
  • Offline mode
  • Camera for issue reporting
  • GPS for field readings
  • Barcode scanner for unit identification

Optimizations:

  • Touch-friendly UI
  • Responsive layouts
  • Reduced data usage
  • Battery-efficient updates
  • App shortcuts

9. Comparison Tools​

Side-by-side comparison of units, periods, or categories.

Route: /compare

Comparison Types​

Unit Comparison​

  • Compare two or more units
  • Side-by-side graphs
  • Performance benchmarking
  • Best/worst performers

Period Comparison​

  • Month-over-month
  • Year-over-year
  • Custom date ranges
  • Seasonal analysis

Category Comparison​

  • Source vs Consumption
  • Stock vs Flow
  • Expected vs Actual
  • Budget vs Actual

10. Geospatial Features​

Map-based visualization and monitoring.

Library: Leaflet.js

Features​

Map Views:

  • Facility overview map
  • Unit location markers
  • Cluster view for dense areas
  • Satellite/terrain layers
  • Custom boundaries

Interactive Elements:

  • Click marker for unit details
  • Color-coded by status
  • Real-time value tooltips
  • Navigate to unit on click
  • Heatmaps for consumption

Use Cases:

  • Locate offline units
  • Identify leakage zones
  • Plan maintenance routes
  • Visualize distribution network

Summary​

All Additional Features:

FeatureRoutePermissionKey Functionality
SCADA Editor/scadaEditorSCADA_EDITORCreate visual diagrams
SCADA Viewer/scadaViewerSCADA_VIEWERView live diagrams
Water Balance/water-balanceWATER_BALANCETrack inputs vs outputs
Water Neutrality/water-neutrality-Sustainability percentage
RWI/rwiRWIRainwater harvesting index
UWI/uwiUWIUsed-water / STP (AquaRecycle)
WRI/wriWRIWater risk assessment
GWI/gwiGWIGround water index
Reports/reportsREPORTSGenerate & schedule reports
Manual Entry/manual-entryMANUAL_ENTRYManual data input
User Management/usersSUPER_USERManage users & permissions
Settings/settings-System configuration
Energy/energyENERGY_CATEGORYEnergy monitoring
Comparison/compare-Compare units/periods
Maps/maps-Geospatial visualization

Last Updated: July 2026