Unavailable Gateway is adding an error to the logs

[noseshimself]

The problem

After turning my heating system off (for insertion of a power meter between external unit and heating -- I feel uncomfortable working on 3-phase-power without breaking the circuits) the ViCare integration logged quite a number of these:

PyViCare.PyViCareUtils.PyViCareInvalidDataError: {'viErrorId': '|5682535d-4229fe2a4c76a528.', 'statusCode': 400, 'errorType': 'DEVICE_COMMUNICATION_ERROR', 'message': '', 'extendedPayload': {'httpStatusCode': 'NotFound', 'code': '404', 'reason': 'GATEWAY_OFFLINE'}}

First observation: These were counted against the number of monthly transactions permitted. Greedy censoreds.

Would it be possible to handle the "GATEWAY_OFFLINE" state a bit more gracefully than just ignoring it and logging it as an error?

What version of Home Assistant Core has the issue?

core-2024.10.4

What was the last working version of Home Assistant Core?

No response

What type of installation are you running?

Home Assistant OS

Integration causing the issue

ViCare

Link to integration documentation on our website

https://www.home-assistant.io/integrations/vicare

Diagnostics information

No response

Example YAML snippet

No response

Anything in the logs that might be useful for us?

PyViCare.PyViCareUtils.PyViCareInvalidDataError: {'viErrorId':
'|5682535d-4229fe2a4c76a528.', 'statusCode': 400, 'errorType':
'DEVICE_COMMUNICATION_ERROR', 'message': '', 'extendedPayload':
{'httpStatusCode': 'NotFound', 'code': '404', 'reason': 'GATEWAY_OFFLINE'}}

Additional information

Maybe adding detection of this state (and a few more, there are indications like the account being temporarily disabled, permanently disabled or the monthly quota being exceeded) and turn them into a text sensor (or a numeric sensor with a text attribute so automations could be launched based on this sensor).

[home-assistant]

Hey there @CFenner, mind taking a look at this issue as it has been labeled with an integration (vicare) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of vicare can trigger bot actions by commenting:

• @home-assistant close Closes the issue.
• @home-assistant rename Awesome new title Renames the issue.
• @home-assistant reopen Reopen the issue.
• @home-assistant unassign vicare Removes the current integration label and assignees on the issue, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

_{^{(message by CodeOwnersMention)}}

---

vicare documentation
vicare source
_{^{(message by IssueLinks)}}

[noseshimself]

I'm not saying it was the worst way to handle it; I had to manually restart the integration after the heating system came back online and it did not waste valuable access permissions but maybe a switch "I'm taking the gateway offline, stop polling data" would be a way to deal with it. I remember having read that additional Viessmann hardware like TRVs and other home automation devices drive the number of requests, too...

[riessal]

My heating systems gateway is said to be “offline” for nearly two weeks now. Again. I turned everything off and on again. Reloaded the integration, reinstalled the integration. Everything is plugged in. The ViCare app is running and receiving data, not the HA integration.

[noseshimself]

What about opening your own issue as this is at least a different set of symptoms?

My heating systems gateway is said to be “offline” for nearly two weeks now. Again. I turned everything off and on again. Reloaded the integration, reinstalled the integration.

First: Did you check whether you ran out of API logins for the month? If your gateway went down and you connected more than one device to the gateway it's easy to run out of free API accesses within a few days. (Which reminds me to ask: How is the ViCare app accessing the data without being counted against the monthly quota, especially if you have a dozen or more additional devices like TRVs on your gateway?)

Did you try shutting down the entire system Home Assistant is running on and rebooting it? Last time I did not get any data although the ViCare app got something turning it off and on again revived it.

[CFenner]

How is the ViCare app accessing the data without being counted against the monthly quota, especially if you have a dozen or more additional devices like TRVs on your gateway?

The calls are counted per API client and the ViCare App uses an internal client that is not limited to the basic API plan.

[riessal]

What about opening your own issue as this is at least a different set of symptoms?

Well, the error-message is the same and I wanted to avoid opening another issue.

My heating systems gateway is said to be “offline” for nearly two weeks now. Again. I turned everything off and on again. Reloaded the integration, reinstalled the integration.

First: Did you check whether you ran out of API logins for the month? If your gateway went down and you connected more than one device to the gateway it's easy to run out of free API accesses within a few days. (Which reminds me to ask: How is the ViCare app accessing the data without being counted against the monthly quota, especially if you have a dozen or more additional devices like TRVs on your gateway?)

The Viessmann Dashboard states 350 polls this month. I have a Vitocal 250. That's it.

Did you try shutting down the entire system Home Assistant is running on and rebooting it? Last time I did not get any data although the ViCare app got something turning it off and on again revived it.

I did all that and nothing changed.