How to properly contribute API data?

Question

How to properly contribute API data?

hzulla opened this issue a year ago · comments

Hanno Zulla commented a year ago

Hi there,

my Vaillant system comes with these components:

sensocomfort VRC 702
aguaflow (hot drinking water using the heating water tank as a heat source)
auroflow (solar thermal heating the water tank)
flexotherm (heat pump heating the water tank)

The home assistant integration is missing several sensors that are present in the myVaillant app.

I'd love to help adding those to your library. Can you add a guide on how to identify the strings you need for that and how to do the MITM thing?

Hanno Zulla · Answer 1 · Tue Jul 11 2023 20:57:26 GMT+0800 (China Standard Time)

Fwiw, running myPyllant.tests.generate_test_data returns nothing, no error message and no JSON result.

Running myPyllant.export results in

Traceback (most recent call last):
  File "/usr/lib/python3.10/runpy.py", line 196, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "/usr/lib/python3.10/runpy.py", line 86, in _run_code
    exec(code, run_globals)
  File "/home/hanno/.local/lib/python3.10/site-packages/myPyllant/export.py", line 93, in <module>
    asyncio.run(main(**kwargs))
  File "/usr/lib/python3.10/asyncio/runners.py", line 44, in run
    return loop.run_until_complete(main)
  File "/usr/lib/python3.10/asyncio/base_events.py", line 646, in run_until_complete
    return future.result()
  File "/home/hanno/.local/lib/python3.10/site-packages/myPyllant/export.py", line 63, in main
    async for system in api.get_systems():
  File "/home/hanno/.local/lib/python3.10/site-packages/myPyllant/api.py", line 262, in get_systems
    system = System(
  File "/home/hanno/.local/lib/python3.10/site-packages/myPyllant/models.py", line 161, in __init__
    self.circuits = [Circuit(system_id=self.id, **c) for c in self._merged_circuits]
  File "/home/hanno/.local/lib/python3.10/site-packages/myPyllant/models.py", line 161, in <listcomp>
    self.circuits = [Circuit(system_id=self.id, **c) for c in self._merged_circuits]
  File "/home/hanno/.local/lib/python3.10/site-packages/pydantic/main.py", line 150, in __init__
    __pydantic_self__.__pydantic_validator__.validate_python(data, self_instance=__pydantic_self__)
pydantic_core._pydantic_core.ValidationError: 1 validation error for Circuit
min_flow_temperature_setpoint
  Field required [type=missing, input_value={'system_id': '00000000-0...ack_mode_enabled': True}, input_type=dict]
    For further information visit https://errors.pydantic.dev/2.1.2/v/missing

(system_id value removed from trace)

signalkraft · Answer 2 · Wed Jul 26 2023 05:07:46 GMT+0800 (China Standard Time)

@hzulla thanks for wanting to contribute. I made that missing field in your error message optional in the latest version, would you mind rerunning export + generate_test_data?

You should be able to contribute data by following the steps in https://github.com/signalkraft/myPyllant#contributing and then running generate_test_data. The README also explains where the test data pops up in the filesystem: https://github.com/signalkraft/myPyllant#contributing-test-data

Hanno Zulla · Answer 3 · Fri Jul 28 2023 06:15:45 GMT+0800 (China Standard Time)

Okay, here it is.
cf6a60bfab7c00bc4bd13cc80618315d9cec2129.zip

signalkraft · Answer 4 · Mon Jul 31 2023 06:56:53 GMT+0800 (China Standard Time)

@hzulla was there another folder with test data after running the command? The one you uploaded looks like the one I generated from my own setup.

If you pull the latest version and rerun the command, it'll now print the name of the folder.

Hanno Zulla · Answer 5 · Tue Aug 01 2023 07:22:28 GMT+0800 (China Standard Time)

Indeed, that's your directory from the git repo.

Calling python3 -m myPyllant.tests.generate_test_data [myuser] [mypw] germany vaillant

No error message. No directory being created.

signalkraft · Answer 6 · Wed Aug 02 2023 07:04:03 GMT+0800 (China Standard Time)

@hzulla the latest version needs a --country argument and should output a path. Here is what it does on my machine (with the latest version on the main branch):

$ python3 -m myPyllant.tests.generate_test_data user password vaillant --country germany
Wrote test data to /home/user/Development/myPyllant/src/myPyllant/tests/json/56f4c513b87875849a089b83cafbe6fdd6020b55

Could you check again if you're on the latest one?

Hanno Zulla · Answer 7 · Wed Aug 02 2023 23:18:32 GMT+0800 (China Standard Time)

Okay, it's definitely helpful to actually read the instructions and do as told in there. Sorry for wasting your time.

Here's the actual output with the latest version of the software (with some serial numbers and UUIDs redacted).

d3a0d9a2f8d536dc37b3237c3a552cb74a4104e2.zip

Thom Ritterfeld · Answer 8 · Sun Aug 27 2023 14:35:41 GMT+0800 (China Standard Time)

hi @signalkraft my system also has issues. I attached my configuration too:
17732fb10772dccf2d0451bff2b4992c38d2c7ec.zip

Thanks a lot for the great work!

When I run the sample my output is:

pydantic_core._pydantic_core.ValidationError: 3 validation errors for Zone
desired_room_temperature_setpoint_cooling
  Field required [type=missing, input_value={'system_id': '8545c5f0-f...iated_circuit_index': 0}, input_type=dict]
    For further information visit https://errors.pydantic.dev/2.3/v/missing
quick_veto_start_date_time
  Field required [type=missing, input_value={'system_id': '8545c5f0-f...iated_circuit_index': 0}, input_type=dict]
    For further information visit https://errors.pydantic.dev/2.3/v/missing
quick_veto_end_date_time
  Field required [type=missing, input_value={'system_id': '8545c5f0-f...iated_circuit_index': 0}, input_type=dict]
    For further information visit https://errors.pydantic.dev/2.3/v/missing