Rate Limits - thoukydides/homebridge-homeconnect GitHub Wiki

Home Connect Rate Limiting

The Home Connect API applies very strict rate limits as specified in the Home Connect documentation. This plugin does its best to minimise the number of requests that it issues, especially those that might result in an error response. If a rate limit is exceeded then the plugin respects any Retry-After headers and retries requests after the specified delay.

When a rate limit is exceeded it typically blocks further requests for 1 minute, 10 minutes, or 24 hours. However, it is worth noting that the Home Documentation states:

Please make sure not to reach the limits regularly, otherwise your account may be locked.

Be careful how you use this plugin!

Starting Programs

Some particularly strict limits are:

  • 5 program starts per client and Home Connect user account per minute
  • 5 program stops per client and Home Connect user account per minute
  • 10 successive requests per client and Home Connect user account per 10 minutes which result in an error
  • 1000 requests per client and Home Connect user account per day

These limits are especially easy to exceed by repeatedly clicking on a program's Switch when something is preventing remote control. Triggering programs via HomeKit automation could also result in excessive requests. This plugin attempts to trap the main scenarios where a start/stop would fail due to the appliance not being in a suitable state, but there may be some that it misses.

Note that with Hood appliances, turning the fan on or switching it between manual and automatic mode counts as a program start. Turning the fan off counts as a program stop. (The functional and ambient lights do not involve programs.)