muhlba91 / onyx-client Goto Github PK

Is your feature request related to a problem? Please describe.
The ONYX API introduced a new endpoint /events in v2 which sends JSON PATCH updates on an open connection.

Use Case: polling services can lower their polling interval for full updates and rely on automatic pushes

Describe the solution you'd like.
Implement the new endpoint through streaming.

Additional context.
See hella-info/onyx_api#4.

aiohttp throws Unexpected exception: ClientPayloadError('Response payload is not completed') after 10-15 minutes of streaming.

this is the cause for muhlba91/onyx-homeassistant-integration#30

With hella-info/onyx_api#7 (comment) an update to the API documentation will be provided. Once updated, implement mappings for all expected device types.

The client class (https://github.com/muhlba91/onyx-client/blob/main/onyx_client/client.py) is 400+ lines long. The test cases for it are 1100+ lines.

With time, this is not maintainable and there's no overview guaranteed. Some of the methods are typical "utility/helper" functions which can be extracted.

cross created for muhlba91/onyx-homeassistant-integration#8

all devices should contain their properties when calling the /devices/<id> endpoint.
however, as shown, some devices do not contain them (under investigation).

despite working around and not relying on properties, we need to know the implications to any integrations (like HA).
possible work-arounds are error-correction (empty/0 values) or filtering those devices.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Describe the bug.
API v2 was unstable; hence, Hella release v3. v3 breaks the integration due to property changes.

To Reproduce.
Steps to reproduce the behavior:

• setup client
• check returned values

Expected behavior.
Values are updated properly and according to v3.