# bsgip/envoy-schema architecture

> Architecture diagram of the GitHub repository bsgip/envoy-schema, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bsgip/envoy-schema
- Repository: https://github.com/bsgip/envoy-schema

## Overview

##### Main Components

a) Core Schema Components:
- Server Schema Module
- SEP2 (Smart Energy Profile) Components
- CSIP AUS (Common Smart Inverter Profile Australia) Components
- Admin Schema Module
- Administrative Components
- Utility Server Integration Components

b) External Standards Integration:
- IEEE 2030.5-2018
- Sunspec CSIP
- CSIP Australia

**┌─ Envoy Schema ──────────────────────────────────────┐**

- ┌─ Server Schema ─┐      ┌─ Admin Schema ─┐       │

- [SEP2]         │      │ [Site]          │       │
- [CSIP AUS]     │      │ [Billing]       │       │
- [Pricing]       │       │
- ┘      └─────────────────┘       │

- ┘

##### Component Details

a) Server Schema Section:
- DER (Distributed Energy Resources)
- Device Capability
- End Device
- Metering
- Pricing
- Time Management
- Error Handling
- CSIP AUS components:
- Connection Point

b) Admin Schema Section:
- Related components:
- Site Management (site.py, site_group.py)
- Financial (billing.py, pricing.py)
- System (aggregator.py, archive.py)
- Monitoring (log.py)

##### Relationship Indicators

- Dependencies between components
- Data flow directions
- Integration points with external standards
- Inheritance relationships between schema classes

##### Additional Elements

Include:
- Version compatibility information
- External dependency interfaces
- Testing coverage indicators

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph EnvoySchema["Envoy Schema Package"]
        subgraph ServerSchema["Server Schema"]
            SEP2["SEP2 Components"]:::server
            CSIPAUS["CSIP AUS Components"]:::server

            subgraph SEP2Components["SEP2 Detailed Components"]
                DER["DER"]:::sep2
                DevCap["Device Capability"]:::sep2
                EndDev["End Device"]:::sep2
                Meter["Metering"]:::sep2
                Price["Pricing"]:::sep2
                Time["Time Management"]:::sep2
                Error["Error Handling"]:::sep2
            end

            subgraph CSIPComponents["CSIP AUS Components"]
                ConnPoint["Connection Point"]:::csip
            end

            SEP2 --> SEP2Components
            CSIPAUS --> CSIPComponents
        end

        subgraph AdminSchema["Admin Schema"]
            SiteMgmt["Site Management"]:::admin
            Financial["Financial"]:::admin
            System["System"]:::admin
            Monitoring["Monitoring"]:::admin

            subgraph SiteComponents["Site Components"]
                Site["Site"]:::admin
                SiteGroup["Site Group"]:::admin
            end

            subgraph FinancialComponents["Financial Components"]
                Billing["Billing"]:::admin
                Pricing["Pricing"]:::admin
            end

            subgraph SystemComponents["System Components"]
                Aggregator["Aggregator"]:::admin
                Archive["Archive"]:::admin
            end

            subgraph MonitoringComponents["Monitoring Components"]
                Log["Logging"]:::admin
            end

            SiteMgmt --> SiteComponents
            Financial --> FinancialComponents
            System --> SystemComponents
            Monitoring --> MonitoringComponents
        end

        subgraph Standards["External Standards"]
            IEEE["IEEE 2030.5-2018"]:::standard
            CSIP["CSIP Australia"]:::standard
        end

        Standards --> ServerSchema
    end

    %% Click events for component mapping
    click ServerSchema "https://github.com/bsgip/envoy-schema/tree/main/src/envoy_schema/server/schema/"
    click SEP2 "https://github.com/bsgip/envoy-schema/tree/main/src/envoy_schema/server/schema/sep2/"
    click DER "https://github.com/bsgip/envoy-schema/blob/main/src/envoy_schema/server/schema/sep2/der.py"
    click DevCap "https://github.com/bsgip/envoy-schema/blob/main/src/envoy_schema/server/schema/sep2/device_capability.py"
    click EndDev "https://github.com/bsgip/envoy-schema/blob/main/src/envoy_schema/server/schema/sep2/end_device.py"
    click Meter "https://github.com/bsgip/envoy-schema/blob/main/src/envoy_schema/server/schema/sep2/metering.py"
    click Price "https://github.com/bsgip/envoy-schema/blob/main/src/envoy_schema/server/schema/sep2/pricing.py"
    click Time "https://github.com/bsgip/envoy-schema/blob/main/src/envoy_schema/server/schema/sep2/time.py"
    click Error "https://github.com/bsgip/envoy-schema/blob/main/src/envoy_schema/server/schema/sep2/error.py"
    click CSIPAUS "https://github.com/bsgip/envoy-schema/tree/main/src/envoy_schema/server/schema/csip_aus/"
    click ConnPoint "https://github.com/bsgip/envoy-schema/blob/main/src/envoy_schema/server/schema/csip_aus/connection_point.py"
    click AdminSchema "https://github.com/bsgip/envoy-schema/tree/main/src/envoy_schema/admin/schema/"
    click Site "https://github.com/bsgip/envoy-schema/blob/main/src/envoy_schema/admin/schema/site.py"
    click SiteGroup "https://github.com/bsgip/envoy-schema/blob/main/src/envoy_schema/admin/schema/site_group.py"
    click Billing "https://github.com/bsgip/envoy-schema/blob/main/src/envoy_schema/admin/schema/billing.py"
    click Pricing "https://github.com/bsgip/envoy-schema/blob/main/src/envoy_schema/admin/schema/pricing.py"
    click Aggregator "https://github.com/bsgip/envoy-schema/blob/main/src/envoy_schema/admin/schema/aggregator.py"
    click Archive "https://github.com/bsgip/envoy-schema/blob/main/src/envoy_schema/admin/schema/archive.py"
    click Log "https://github.com/bsgip/envoy-schema/blob/main/src/envoy_schema/admin/schema/log.py"
    click IEEE "https://github.com/bsgip/envoy-schema/blob/main/tests/xsd/sep.xsd"
    click CSIP "https://github.com/bsgip/envoy-schema/blob/main/tests/xsd/csipaus-core.xsd"

    %% Styling
    classDef server fill:#2374ab
    classDef sep2 fill:#2374ab,stroke:#666
    classDef csip fill:#2374ab,stroke:#666
    classDef admin fill:#57a773
    classDef standard fill:#878787
    
    %% Legend
    subgraph Legend
        ServerComp["Server Components"]:::server
        AdminComp["Admin Components"]:::admin
        StandardComp["External Standards"]:::standard
    end
```
