Skip to content
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

Create Use Case Document for EV Charging Transaction #2

Open
ravi-prakash-v opened this issue Jun 16, 2023 · 14 comments · May be fixed by #20
Open

Create Use Case Document for EV Charging Transaction #2

ravi-prakash-v opened this issue Jun 16, 2023 · 14 comments · May be fixed by #20
Labels
C4GT Community documentation Improvements or additions to documentation

Comments

@ravi-prakash-v
Copy link

ravi-prakash-v commented Jun 16, 2023


Name: Beckn for Energy
About: EV Charging has many workflows. Developers implementing beckn protocol for EV charging must understand the Various workflows that exist in typical EV charging use cases.
Title: "Create Use Case Document for EV Charging Transaction"
Labels: C4GT Community, Documentation


Description

Context:
EV Charging has many workflows. Developers implementing beckn protocol for EV charging must understand the various workflows that exist in typical EV charging use cases.

Problem:
There is no documentation that clearly explains EV-charging sector in detail with typical workflows that occur when charging an electric vehicle

Goals

To create a use case document to allow implementers to understand EV charging use cases containing interactions like

  • Discovery of charging sources (By location, charger type, vehicle type, operator, etc)
  • Placing an order for charge (By time, money, number of units, etc) containing,
  • Fetching quote
  • Terms of service (various terms of service, payment, cancellation, and refunds)
  • Confirmation (Advance, instant etc)
  • Fulfillment of a charging order
  • status updates,
  • order updates,
  • cancellation, and
  • real-time tracking of power delivery
  • Post-charging interactions
  • Rating
  • Grievance and Support
  • Refunds

Expected Outcome

Any implementer of beckn protocol for charging should be able to understand how to map their business workflows to beckn API calls.

Acceptance Criteria

  • By reading this document, any BAP implementer should be able to understand the workflows involved in EV charging use cases

Implementation Details

  • Create a folder called docs/. Add a document called EV-Charging-use-case.md that details the following actions / interactions between a consumer and a charging point operator (with added sequence diagrams).

Project

Beckn

Organization Name:

Beckn Open Collective

Domain

Others

Tech Skills Needed:

Markdown Syntax
Mermaid UML

Mentor(s)

Akhil Jayaprakash
Ravi Prakash

Complexity

Medium

Category

Documentation

Sub Category

Research

@ravi-prakash-v ravi-prakash-v added the documentation Improvements or additions to documentation label Jun 16, 2023
@starks-and-wolves
Copy link

Hey @ravi-prakash-v @dhirajshettyyy, I am interested in creating the use-case workflows. I have done the initial research on the EV-charging sector while submitting the proposal for beckn-energy project. I created a workflow diagram for identifying the nearest charger based on your location and how the beckn endpoints workflow will work to confirm and complete the order. I would love to contribute to this issue. Please let me know the steps forward.

@Aishwarya-Narayanan03
Copy link

@ravi-prakash-v Create Use Case Document for EV Charging Transaction - I'm interested in working on this issue

@c4gt-community-support
Copy link

Hi!
Mandatory Details - The following details essential to submit tickets to C4GT Community Program are missing. Please add them!

  • Product Name - Please add a heading called Product Name and mention the name of the product below it.

Without these details, the ticket cannot be listed on the C4GT Community Listing.

Please update the ticket

@UdAyAn123
Copy link

@ravi-prakash-v Is this issue free to be taken up? Would love to contribute

@jaivardhan-bhola
Copy link

hi, @ravi-prakash-v Can i work on this?

@SanjayRam07
Copy link

hello @ravi-prakash-v , can I work on this issue?
Could you please assign and mentor me?

@UdAyAn123
Copy link

Is this issue open to work on?

@Harine19
Copy link

Harine19 commented Apr 26, 2024

@ravi-prakash-v @dhirajshettyyy I have created a PR please check it out! I have fully completed working on the issue. Can you assign me?

@Harine19
Copy link

Harine19 commented May 2, 2024

@ravi-prakash-v @dhirajshettyyy I have raised PR last week, can you please review it?

@Harine19
Copy link

Closes #2

@techy4shri
Copy link

is this issue still open for taking? @ravi-prakash-v

@PredictiveManish
Copy link

is this issue still open for taking? @ravi-prakash-v

Opened but work is done as someone has made the complete documentation now you can try for better one by taking reference but I think that one is good though.

@Harine19
Copy link

@techy4shri @PredictiveManish There is something to be worked on in this, here is the feedback I received:

"Hi, 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."

If anyone wants to work on this they can, I have done 90% of the work but I unfortunately don't have the time to incorporate the changes requested, hope I can still be stated as contributor in this.

@techy4shri
Copy link

got it @Harine19 ! thank you for the info. I have checked the PR and your work is extensive.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C4GT Community documentation Improvements or additions to documentation
Projects
None yet
10 participants