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

Add samples from other vehicles #48

Open
16 of 33 tasks
epenet opened this issue Nov 20, 2020 · 7 comments
Open
16 of 33 tasks

Add samples from other vehicles #48

epenet opened this issue Nov 20, 2020 · 7 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@epenet
Copy link
Collaborator

epenet commented Nov 20, 2020

It would be great to get samples from more vehicles and from extra functionalities.

Vehicles:

  • Captur 2
  • Twingo ZE
  • Zoe phase 1 / Zoe 40
  • Zoe phase 2 / Zoe 50
  • Other

Data:

  • battery-inhibition-status
  • battery-status
  • charge-history
  • charge-mode
  • charge-schedule
  • charges
  • charging-settings
  • cockpit (for fuel vehicles)
  • location
  • hvac-history
  • hvac-sessions
  • hvac-settings
  • hvac-status (with data)
  • lock-status
  • notification-settings
  • res-state
  • Other

Action:

  • charge-mode
  • charge-schedule
  • charging-start
  • hvac-start
  • hvac-schedule
  • hvac-start
  • notification-settings
  • send-navigation
  • Other

Errors:

  • Access denied
  • Other

To add a fixture:

  1. grab a trace from your favourite tool, for example using the renault-api CLI:
$ pip install renault-api[cli]
$ renault-api --log status
  1. add the json file to the correct test/fixtures/kamereon folder (vehicles or vehicle_data)
  2. ensure that the registration number starts with REG-, that the vin starts with VF1AAAA and that the radio code is equal to 1234.
  3. beautify the json (2 spaces indentation) either manually, through pre-commit or through an online tool (eg https://codebeautify.org/jsonviewer)
  4. create a Pull Request

Note: registration number, vin and radio code are currently the only keys which need to be obfuscated. If you feel that extra data should be automatically obfuscated, then please tweak tests/model/test_kamereon.py and add a separate PR.

@oncleben31
Copy link
Member

Be careful I've seen data linked to vehicle registered id and security code for the radio.

@epenet
Copy link
Collaborator Author

epenet commented Nov 20, 2020

@oncleben31 if you have spotted anything extra, can you add checks on https://github.com/hacf-fr/renault-api/blob/develop/tests/model/test_kamereon.py#L52 ?

@TheSleepySlee
Copy link

@epenet why do you say VIN has to start with VF1AAAAA555777 ?
VF1 ok, but then depends on vehicule.

@epenet
Copy link
Collaborator Author

epenet commented Nov 30, 2020

@TheSleepySlee this is simply to ensure private data is not added to the GIT repository by mistake.

@TheSleepySlee
Copy link

ok makes sense, I thought you were stating that VIN had 5 letters then 6 numbers after VF1, which is not always the case. I will try to add my data. There is no documentation. Should assume same working as with Pyze?

@epenet
Copy link
Collaborator Author

epenet commented Nov 30, 2020

There is not yet a CLI (only an API) and I am working on the documentation. If in doubt, you can get the trace from PyZE and add it here...

@epenet
Copy link
Collaborator Author

epenet commented Dec 17, 2020

@TheSleepySlee you can now use the renault-api CLI to generate traces.

$ pip install renault-api[cli]
$ renault-api --log status

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 help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants