Skip to content

Commit 6ca765e

Browse files
docs: section on API usage for backend owners (#25)
Added a section addressing users from Dimplex, Faber, or Real Flame about the library's API usage and performance considerations.
1 parent bcf2bd0 commit 6ca765e

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,12 @@ uv run mutmut run --paths-to-mutate=src/flameconnect/protocol.py
259259
Please follow [Conventional Commits](https://www.conventionalcommits.org/) for
260260
commit messages.
261261

262+
## Do you work at Dimplex, Faber, or Real Flame, or support the underlying web services?
263+
264+
This library and app aims to follow the same patterns as the official apps to minimize load on back-end infrastructure. We avoid making API calls whenever possible, and mirror the app by making data refreshes a specific user action. This library implementation is a last resort. We're glad to implement improvements if this library is causing any challenges on the back-end servers.
265+
266+
But really... making these remote calls is laggy and complex! As a comparison, take a look at the Lennox iComfort S30 and similar line of themostats. They have a cloud API, but also have a fully local API that works even when the internet is down. And, it's way, way faster to respond. If a local API is made available, I'd be glad to drop this library in favour of it. Let's talk!
267+
262268
## License
263269

264270
Apache-2.0

0 commit comments

Comments
 (0)