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

[C4GT] Implement Beckn for Energy Sandbox Interface #1

Open
ravi-prakash-v opened this issue May 20, 2023 · 6 comments
Open

[C4GT] Implement Beckn for Energy Sandbox Interface #1

ravi-prakash-v opened this issue May 20, 2023 · 6 comments
Labels
good first issue Good for newcomers

Comments

@ravi-prakash-v
Copy link

ravi-prakash-v commented May 20, 2023

Project Details

Beckn protocol is a set of open specifications aimed to create a common language, that is machine-readable and enables interoperability for economic transactions between disparate platforms of any size and form - be it a cab reservation, or booking a stay, or confirming a doctor’s appointment, and many more. Thus it enables the creation of inclusive and equitable open networks offering a multitude of choices to the citizens, while at the same time negating the dependence on intermediaries to freely operate and generate economic transactions of value. It is akin to what SMTP is to E-mails or HTTP is to the Internet.

Since its inception in 2019 as a set of specifications, Beckn has been adopted across geographies in sectors such as mobility, retail, hyperlocal logistics, healthcare, skills, agriculture sectors, etc. Few notable examples of open networks built on the Beckn protocol are Open Network for Digital Commerce (ONDC), Namma Yatri at Bangalore, Kochi Open Mobility Network (KOMN), Unified Health Interface (UHI), etc.

The Beckn Energy Interface is an API that emulates the behaviour of an Open Energy Network like the Unified Energy Interface. BAPs can build rich integrated experiences by combining services offered by multiple BPPs on the network. BPPs can build complex products by analyzing the nature of input from multiple BAPs. This is an important step in the set up and expansion of open networks. Businesses can test their implementations for protocol compliance by plugging into this sandbox.

Features to be implemented

  • Beckn-protocol compliant catalogs across multiple EV-charging services
  • BPP endpoints : search, select, init, confirm, status, update, track, cancel, rating, support
  • BAP endpoint : on_search, on_select, on_init, on_confirm, on_status, on_update, on_track, on_cancel, on_rating, on_support
  • BG endpoint : search
  • Registry endpoints : lookup
  • EV Charger emulator

What exists

What needs to be built

  • A fully functioning scalable energy sandbox compliant to beckn protocol specifications
  • A charger bot that emulates various types of EV-charging stations and hubs

Learning Path

Complexity

Medium

Skills Required

  • Open API 3.0
  • JSON Schema
  • NodeJS
  • JavaScript
  • TypeScript
  • MongoDB

Mentors:

Product Understanding

Protocol Specification Design

Project Setup and Guidance

Product Setup

Product Architecture

Frontend Development

Backend Development

Deployment and Devops

Testing and QA

Project size

4-6 Weeks

Project Setup Guide

To set up this project, please connect with the Project Setup and Guidance mentor for this project and follow their instructions

Product Set Up

To set up this project, please connect with the Product Setup and Guidance mentor for this project and follow their instructions

Acceptance Criteria

  • End-to-end simulation of typical EV Charging use cases on a beckn energy reference application
  • End-to-end simulation of typical EV Charging use cases on the Pulse Energy WhatsApp application
  • End-to-end simulation of typical EV Charging use cases on the Instacharge application

Out of Scope

  • UI development, (however contributions to existing UI implementations are welcome)

Milestones

  • Understanding beckn protocol
  • Understanding beckn protocol for energy
  • Development of search / on_search API
  • Development of select / on_select API
  • Development of init / on_init API
  • Development of confirm / on_confirm API
  • Development of status / on_status API
  • Development of update / on_update API
  • Development of track / on_track API
  • Development of cancel / on_cancel API
  • Development of rating / on_rating API
  • Development of support / on_support API
  • Creation of charger emulator
@ravi-prakash-v ravi-prakash-v added the good first issue Good for newcomers label May 20, 2023
@ravi-prakash-v ravi-prakash-v changed the title Create Sandbox Create Beckn for Energy Sandbox May 20, 2023
@ravi-prakash-v ravi-prakash-v changed the title Create Beckn for Energy Sandbox [C4GT] Create Beckn for Energy Sandbox May 20, 2023
@ravi-prakash-v ravi-prakash-v changed the title [C4GT] Create Beckn for Energy Sandbox [C4GT] Implement Beckn for Energy Sandbox Interface May 20, 2023
@starks-and-wolves
Copy link

Hey @ravi-prakash-v, @nikhil2128, @ujjwal502, @faizmagic,
I am Hritish, a final-year student at BITS Hyderabad. I have a good working experience as a Backend developer. I went through Beckn protocol videos and would love to contribute to the immense possibilities that Beckn opens the door to.
Can you please help me understand the architectural requirements and how I can get started with this project?

@pulse-aj
Copy link

pulse-aj commented May 30, 2023 via email

@NIKU-SINGH
Copy link

Hey @ravi-prakash-v, @nikhil2128, @ujjwal502, @faizmagic,. I find this project interesting. I have gone through the setup docs and have installed bap, bpp client and server up and running. Could you tell me more where should I head over to better understand the project

@abhikumar63
Copy link

Hey,
I have gone through the project and the task at hand. I think I am a very good fit because I have previous work experience with Nodejs, JavaScript, JSON and MongoDB. I will be delighted to work with industry experts as my mentor. You can check some of my projects at my github. I am really interested in this project. I will be waiting to hear from you soon.

@dhirajshettyyy
Copy link

@NIKU-SINGH @abhikumar63 , It's great to see your interest in this project, you can make an active contribution via issue creation and by submitting your Pull Requests.

For support from fellow contributors, Join Beckn Open Collective server:https://bit.ly/bocWebInvite
You can check out the #uei-pilot-wg on BOC server for more details

@ap766
Copy link

ap766 commented Jul 25, 2023

Hey! I have experience with some of technical skills mentioned here like nodejs,javascript,MongoDB.Could I also work on this?

Sudheesh2609 added a commit to Sudheesh2609/DENT-Protocol that referenced this issue Aug 27, 2023
Updated the energy transaction workflow beckn#1 with much more clarity and revisioned the parts discussed in meet.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

7 participants