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

First try to export the api keys directly from the firmware #222

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

Conversation

0xFEEDC0DE64
Copy link
Contributor

@0xFEEDC0DE64 0xFEEDC0DE64 commented Jun 5, 2024

I have added a mechanism to export the api docs directly from our firmware, and of course it differs between different hardware generations v3, v4, v5,
and I think on github there is sometimes additional information on specific api keys, better documented than the description coming from the firmware.
we have to check, that we dont eliminate any good docs from github by overwriting the texts from the firmware

This new api docs list can be browsed here:
https://github.com/goecharger/go-eCharger-API-v2/blob/export_api_docs_from_firmware/apikeys-en.md

@schinagl
Copy link
Contributor

schinagl commented Jun 5, 2024

Take GitHub docu and merge it into Firmware? Use Firmware as single source for docu export?

@0xFEEDC0DE64
Copy link
Contributor Author

Yes but this is a very time consuming task, will see when I can do this

@0xFEEDC0DE64
Copy link
Contributor Author

Also the firmware doesnt have german descriptions at all

@schinagl
Copy link
Contributor

schinagl commented Jun 6, 2024

I see your point and know problems like this from my day time job ;-)

Manually merging is a pain and once you are done, it is outdated 3 weeks later. Sorry for doing stupid proposals , but just my 2 cents:

  • output API cmds alphabetically, this will ease later merges
  • add a hardware version column
  • add a column with german description
  • merge once manually, add to source of firmware and export anytime later
  • hire a summer intern to do this ;-)

Sry, I know it is your firmware, we can't contribute, just making obvious comments. :-)

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