Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

Harine19
Copy link

@Harine19 Harine19 commented Apr 26, 2024

Closes #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!

@Harine19 Harine19 changed the title FIXED AND ADDED : Create Use Case Document for EV Charging Transaction #2 Closes https://github.com/beckn/Unified-Energy-Interface/issues/2: Create Use Case Document for EV Charging Transaction May 19, 2024
@Harine19 Harine19 changed the title Closes https://github.com/beckn/Unified-Energy-Interface/issues/2: Create Use Case Document for EV Charging Transaction Closes #2 : Create Use Case Document for EV Charging Transaction May 19, 2024
@Harine19 Harine19 changed the title Closes #2 : Create Use Case Document for EV Charging Transaction Fixed and added: Create Use Case Document for EV Charging Transaction #2 May 19, 2024
@ravi-prakash-v
Copy link

Hi @Harine19 thank you for articulating the EV charging workflows in so much detail. However the sequence diagrams need to convey an open network architecture. Currently the diagrams look more relevant to a platform model.

Also, it would be helpful to show the high level architecture of the UEI network containing "Transaction Layer (Beckn)", "Payments Layer", "Application Layer (UEI)", "Trust Layer", "Support Layer", "Real-time data streaming layer", etc, corresponding to various interactions you have outlined, with different color codes.

It would be useful if you could do the following:

  1. Draw the architecture diagram at the beginning as mentioned above
  2. Use the same colors to indicate the respective actor categories in the sequence diagrams
  3. Annotate the relevant transaction layer actors i.e BAP, BPP in the workflows
  4. Indicate the relevant Beckn API endpoints being called on the arrows.
  5. Clearly demarcate which workflows are protocol APIs (BAP <> BPP) and which are not (UI <> BAP, UI <> BPP), maybe using different colors

Once done, please resubmit the PR for review.

@VedantKhairnar
Copy link

VedantKhairnar commented Aug 23, 2024

Hello @Harine19,
Are you currently working on this PR?
Please let us know if you need any assistance.
Thanks.

@VedantKhairnar
Copy link

Any updates @Harine19 ?
Pls do let us know if you need any assistance. Thanks.

@Harine19
Copy link
Author

Harine19 commented Sep 9, 2024

@VedantKhairnar Sorry for the late reply, I had requested for this PR for C4GT DMP in April, so I hadn't checked. I'll look into the feedback and get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create Use Case Document for EV Charging Transaction
3 participants