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

API: fix documentation for legacy enable/disable #935

Merged
merged 2 commits into from
Oct 29, 2024

Conversation

barsnick
Copy link
Contributor

@barsnick barsnick commented Oct 28, 2024

Describe your changes

The API module provides an "easy" legacy interface for enabling/disabling a connector.

The generic enable/disable call it maps to was not documented correctly. A value used incorrect case, and the priority did not reflect what the actual code did.

I'm not sure whether it was actually intentional that the priority is set to 100 in the code.

types::evse_manager::EnableDisableSource enable_source{types::evse_manager::Enable_source::LocalAPI,
types::evse_manager::Enable_state::Enable, 100};

The priority is a range from 0 to 10000, and 0 seems more reasonable:
Evaluation will be done based on priorities. 0 is the highest priority, 10000 the lowest, so in this example the

Issue ticket number and link

Checklist before requesting a review

  • I have performed a self-review of my code
  • I have made corresponding changes to the documentation
  • I read the contribution documentation and made sure that my changes meet its requirements

Signed-off-by: Moritz Barsnick <moritz.barsnick@chargebyte.com>
@hikinggrass hikinggrass merged commit b152b3e into main Oct 29, 2024
10 checks passed
@hikinggrass hikinggrass deleted the cb/fix_api_documentation_legacy_enable branch October 29, 2024 11:06
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.

2 participants