home-assistant / core

:house_with_garden: Open source home automation that puts local control and privacy first.
https://www.home-assistant.io
Apache License 2.0
71.54k stars 29.91k forks source link

Documentation for Sure Pet is not complete #31104

Closed i00 closed 4 years ago

i00 commented 4 years ago

Additional information

The documentation just states:

For now, please use the sp_cli.py from @rcastberg to fetch the IDs from the Sure Petcare API. With default setting, the IDs will be written as JSON to ~/.surepet.cache

This method doesn't even work.. It failed to obtain a mac address and crashed - so I changed the getmac() function to return my mac. Then it bombed out while getting json data... the surepet.cache file was somewhat readable but too corrupted to get useful information out of.

Rather than just fix the documentation, this lib should be built into the HA integration ... my advice would be to put the username / password in the config and have an entry with an attribute (rather than state so it is not logged) that contains all of the pets, flaps etc.

frenck commented 4 years ago

Please open up issues for our documentation here: https://github.com/home-assistant/home-assistant.io/issues/new/choose

Secondly, could you please fill out the issue template, instead of removing large chunks of it? Thanks! 👍

probot-home-assistant[bot] commented 4 years ago

Hey there @benleb, mind taking a look at this issue as its been labeled with a integration (surepetcare) you are listed as a codeowner for? Thanks!

benleb commented 4 years ago

Feel free to make a PR @i00... it worked for many other users by the way. I will focus on the implementing more info/attributes available via the API first

Theres another, probably easier way to get the IDs, I will update the docs soon :)

springstan commented 4 years ago

Closing this issue as this is a documentation issue.