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

Updated Smart Charging Documentation v201 #800

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

couryrr-afs
Copy link
Contributor

@couryrr-afs couryrr-afs commented Sep 23, 2024

Describe your changes

  • Updated README.md to describe v201 of OCPP
  • Added diagrams for completed flow of K. Smart Charging
    • K01 SetChargingProfile
    • K08 Get Composite Schedule
    • K09 Get Charging Profiles
    • K10 Clear Charging Profile
  • Added context / conversation where needed.

Note

Changes to documentation have been removed from this PR. An additional PR including these will be created.

Issue ticket number and link

Checklist before requesting a review

@couryrr-afs
Copy link
Contributor Author

@shankari - this is ready for your review.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
Comment on lines 507 to 516
- `ChargingProfileFirstStartScheduleIsNotZero`

The `startPeriod` of the first `chargingSchedulePeriod` needs to be 0.
[K01.FR.31]

- `ChargingProfileNoChargingSchedulePeriods`

Happens when the `ChargingProfile` doesn't have any Charging Schedule
Periods.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, I don't think this should go into the README. I don't even think it should go into the architecture diagram. Instead, it should be a separate document so it can be linked to directly. From a formatting perspective, most error tables are ... tables and not lists.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shankari - just wanted to add a note here too. Do you have a preference on location. If not I was leaning towards the doc directory.

@shankari
Copy link

shankari commented Oct 5, 2024

I am fine with this location. However, I don't see the errors being formatted as tables

From a formatting perspective, most error tables are ... tables and not lists.

or any explanation of why the current formatting is better

@couryrr-afs
Copy link
Contributor Author

I am fine with this location. However, I don't see the errors being formatted as tables

From a formatting perspective, most error tables are ... tables and not lists.

or any explanation of why the current formatting is better

@shankari - updated the format to a table.

@couryrr-afs couryrr-afs force-pushed the feature/smart-charging-documentation branch from c1b05ab to 96c8d26 Compare October 11, 2024 19:34
@shankari
Copy link

doc/v201/smart_charging_flow.md has been removed from this PR, so I am unable to review it.

Screenshot 2024-10-13 at 9 41 25 AM

https://github.com/EVerest/libocpp/compare/c1b05ab6ff2cd32c68c4b7eebe1af1e75919132c..96c8d265a240b18af53e43e133d392911e436f23

@Pietfried Pietfried self-assigned this Oct 14, 2024
@Pietfried Pietfried marked this pull request as ready for review October 23, 2024 14:49
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.

4 participants