search

beckn / Unified-Energy-Interface

Adaptation of beckn protocol for energy sector
Other
16 stars 10 forks source link

Fixed and added: Create Use Case Document for EV Charging Transaction #2 #20

Open Harine19 opened 2 months ago

Harine19 commented 2 months ago

Closes https://github.com/beckn/Unified-Energy-Interface/issues/2

This PR fixes issue: "Create Use Case Document for EV Charging Transaction #2"

Purpose: For developers to understand the various workflows present in EV Charging.

Diagrams: Sequence diagrams (4)

Tech-stack:

  1. Markdown (for the use case document
  2. Mermaid UML (for the sequence diagrams)

Use cases covered:

  1. Discovery of Charging Sources
  2. Order Placement
  3. Fetching a quote
  4. Terms of Service
  5. Confirmation
  6. Fulfillment of Charging Order
  7. Updates and Tracking:
    • Status Updates
    • Order Updates
    • Cancellation, and
    • Real-Time Tracking of Power Delivery
  8. Post-Charging Interactions:
    • Rating
    • Grievance, and
    • Support

Main Actors:

  1. Electric Vehicle Owner (Customer)
  2. Charging Station Operator
  3. Unified Energy Interface (UEI) System: Acts as a central hub for communication and data exchange between EV owners and charging station operators
    • Other Potential Actors (depending on context):
  4. Urban Planners: May be involved in charging infrastructure
  5. Public Transit Authorities: May be involved in partnerships or integration with the charging infrastructure
  6. Legal Advisors: May be involved in the Terms of Service use-case
  7. Support Staff (Potential)

Mermaid UML diagrams included:

Diagram 1: Discovery and Order Placement Diagram 2: Fulfillment and Cancellation Diagram 3: Real-time Tracking and Post-charging Interactions Diagram 4: Final combined sequence diagram

I have spent a lot of time on this and opened a pull request (PR) please check it out!